#include <ImFusion/GUI/SelectionWidget.h>
This class provides an interface for creating wrappers that allow playback functionality to a type.
More...
This class provides an interface for creating wrappers that allow playback functionality to a type.
To make a type "Playable" with the SelectionWidget, implement this interface in a concrete wrapper class, and register it with the Selection widget using the registerPlaybackWrapper function.
|
| virtual bool | supported (Data *data)=0 |
| |
| virtual bool | running (Data *data)=0 |
| |
| virtual bool | start (Data *data)=0 |
| | Start the playback.
|
| |
| virtual bool | stop (Data *data)=0 |
| | Stop the playback.
|
| |
| virtual bool | looping (Data *data)=0 |
| |
|
virtual void | setLooping (Data *data, bool isEnabled)=0 |
| | Set looping playback mode.
|
| |
| virtual void | setUpdateGuiCallback (Data *data, const std::function< void(void)> &callback)=0 |
| | Set a callback function for updating the GUI.
|
| |
|
virtual void | setPlaySelected (Data *data, bool isSet)=0 |
| | Set whether only selected frames should be played.
|
| |
◆ supported()
| virtual bool supported |
( |
Data * | data | ) |
|
|
pure virtual |
- Returns
- true iff this wrapper supports the type of Data provided as
data.
◆ running()
| virtual bool running |
( |
Data * | data | ) |
|
|
pure virtual |
- Returns
- true iff the playback is currently running.
◆ start()
| virtual bool start |
( |
Data * | data | ) |
|
|
pure virtual |
Start the playback.
- Returns
- true iff start is successful.
◆ stop()
| virtual bool stop |
( |
Data * | data | ) |
|
|
pure virtual |
Stop the playback.
- Returns
- true iff stop is successful.
◆ looping()
| virtual bool looping |
( |
Data * | data | ) |
|
|
pure virtual |
- Returns
- true iff looping playback is enabled.
◆ setUpdateGuiCallback()
| virtual void setUpdateGuiCallback |
( |
Data * | data, |
|
|
const std::function< void(void)> & | callback ) |
|
pure virtual |
Set a callback function for updating the GUI.
The SelectionWidget will provide a callback function that will run on the GUI thread via this function.
- Parameters
-
| callback | Function for updating the GUI on the main thread. |
The documentation for this class was generated from the following file:
- ImFusion/GUI/SelectionWidget.h
