AnimationToolBar Class Reference
Manages animation controllers and provides a user interface to play their animations. More...
#include <AnimationToolBar.h>
Public Member Functions | |
| virtual void | setAnimationController (AnimationController *pController)=0 |
| virtual AnimationController * | getAnimationController () const =0 |
| virtual void | setHideTimestamp (bool hideTimestamp)=0 |
| virtual bool | getHideTimestamp () const =0 |
Static Public Member Functions | |
| static std::vector< double > | getSettingFrameSpeeds () |
| static bool | hasSettingFrameSpeeds () |
| static void | setSettingFrameSpeeds (std::vector< double > newValue, bool setIfSame=false) |
| static std::string | getSettingFrameSpeedsKey () |
| static const std::string & | signalControllerChanged () |
Protected Member Functions | |
| virtual | ~AnimationToolBar () |
Detailed Description
Manages animation controllers and provides a user interface to play their animations.The animation tool bar is a tool bar that displays all available animation controllers and widgets to play animations of a currently selected animation controller. This class provides the capability to create, activate, and destroy animation controllers. A pointer to the animation toolbar can be obtained by calling DesktopServices::getWindow() using "Animation" as the window name and TOOLBAR as the window type.
This subclass of Subject will notify upon the following conditions:
- The tool bar is deleted. This will only occur on application shut down.
- The setAnimationController() method is called.
- Other notifications documented in the ToolBar class.
- See also:
- AnimationController, ToolBar
Definition at line 38 of file AnimationToolBar.h.
Constructor & Destructor Documentation
| virtual AnimationToolBar::~AnimationToolBar | ( | ) | [protected, virtual] |
This will be cleaned up during application close.
Plug-ins do not need to destroy it.
Definition at line 144 of file AnimationToolBar.h.
Member Function Documentation
| static std::vector<double> AnimationToolBar::getSettingFrameSpeeds | ( | ) | [static] |
Returns the current value for this setting.
If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.
Please see Settings Macros for more details
- Returns:
- the current value for this setting.
Definition at line 51 of file AnimationToolBar.h.
| static bool AnimationToolBar::hasSettingFrameSpeeds | ( | ) | [static] |
Returns true if this setting exists and has a value in ConfigurationSettings.
Please see Settings Macros for more details
- Returns:
trueif this setting exists,falseotherwise.
Definition at line 58 of file AnimationToolBar.h.
| static void AnimationToolBar::setSettingFrameSpeeds | ( | std::vector< double > | newValue, | |
| bool | setIfSame = false | |||
| ) | [static] |
Changes the current value of this setting to the new value.
Please see Settings Macros for more details
- Parameters:
-
newValue the new value for this setting. setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. Iffalse, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.
Definition at line 74 of file AnimationToolBar.h.
| static std::string AnimationToolBar::getSettingFrameSpeedsKey | ( | ) | [static] |
Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().
Please see Settings Macros for more details
- Returns:
- the key used for this setting.
Definition at line 82 of file AnimationToolBar.h.
| static const std::string& AnimationToolBar::signalControllerChanged | ( | ) | [static] |
Emitted with any<AnimationController*> when the current animation controller is changed.
Definition at line 87 of file AnimationToolBar.h.
| virtual void AnimationToolBar::setAnimationController | ( | AnimationController * | pController | ) | [pure virtual] |
Set the current animation controller in the toolbar.
This method activates the given animation controller in the toolbar's user interface. The controller execution widgets are updated and enabled accordingly.
- Parameters:
-
pController The animation controller to activate in the toolbar. If NULL is passed in, no controller will be active and all controller execution widgets will be disabled.
- Subject Notifications:
- This method will notify signalControllerChanged() with any<AnimationController*> if the given controller is different than the current controller.
| virtual AnimationController* AnimationToolBar::getAnimationController | ( | ) | const [pure virtual] |
Returns the current animation controller.
- Returns:
- A pointer to the current animation controller.
| virtual void AnimationToolBar::setHideTimestamp | ( | bool | hideTimestamp | ) | [pure virtual] |
Hide or show the timestamp on the toolbar.
A plugin may want to hide the timestamp if you are providing the same information in its own window.
- Parameters:
-
hideTimestamp true if the timestamp should be hidden, false otherwise.
- See also:
- getHideTimestamp
| virtual bool AnimationToolBar::getHideTimestamp | ( | ) | const [pure virtual] |
Gets whether the toolbar's timestamp is hidden.
A plugin may want to hide the timestamp if you are providing the same information in its own window.
- Returns:
- true if the timestamp is be hidden, false otherwise.
- See also:
- setHideTimestamp