Defines an interface to classes which have one or more AnimableValue instances to expose. More...
#include <OgreAnimable.h>
Public Member Functions | |
| AnimableObject () | |
| virtual | ~AnimableObject () |
| virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
| Create a reference-counted AnimableValuePtr for the named value. | |
| const StringVector & | getAnimableValueNames (void) const |
| Gets a list of animable value names for this object. | |
Protected Types | |
| typedef map< String, StringVector >::type | AnimableDictionaryMap |
Protected Member Functions | |
| StringVector & | _getAnimableValueNames (void) |
| Get an updateable reference to animable value list. | |
| void | createAnimableDictionary (void) const |
| Internal method for creating a dictionary of animable value names for the class, if it does not already exist. | |
| virtual const String & | getAnimableDictionaryName (void) const |
| Get the name of the animable dictionary for this class. | |
| virtual void | initialiseAnimableDictionary (StringVector &) const |
| Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. | |
Static Protected Attributes | |
| static AnimableDictionaryMap | msAnimableDictionary |
| Static map of class name to list of animable value names. | |
Detailed Description
Defines an interface to classes which have one or more AnimableValue instances to expose.
Definition at line 238 of file OgreAnimable.h.
Member Typedef Documentation
typedef map<String, StringVector>::type Ogre::AnimableObject::AnimableDictionaryMap [protected] |
Definition at line 241 of file OgreAnimable.h.
Constructor & Destructor Documentation
Definition at line 291 of file OgreAnimable.h.
| virtual Ogre::AnimableObject::~AnimableObject | ( | ) | [virtual] |
Definition at line 292 of file OgreAnimable.h.
Member Function Documentation
| StringVector& Ogre::AnimableObject::_getAnimableValueNames | ( | void | ) | [protected] |
Get an updateable reference to animable value list.
Definition at line 267 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND.
| void Ogre::AnimableObject::createAnimableDictionary | ( | void | ) | const [protected] |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
Definition at line 254 of file OgreAnimable.h.
| virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue | ( | const String & | valueName | ) | [virtual] |
Create a reference-counted AnimableValuePtr for the named value.
- Remarks:
- You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.
Reimplemented in Ogre::Light.
Definition at line 320 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND.
| virtual const String& Ogre::AnimableObject::getAnimableDictionaryName | ( | void | ) | const [protected, virtual] |
Get the name of the animable dictionary for this class.
- Remarks:
- Subclasses must override this if they want to support animation of their values.
Reimplemented in Ogre::Light.
Definition at line 249 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
| const StringVector& Ogre::AnimableObject::getAnimableValueNames | ( | void | ) | const |
Gets a list of animable value names for this object.
Definition at line 295 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND.
| virtual void Ogre::AnimableObject::initialiseAnimableDictionary | ( | StringVector & | ) | const [protected, virtual] |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented in Ogre::Light.
Definition at line 287 of file OgreAnimable.h.
Member Data Documentation
AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary [static, protected] |
Static map of class name to list of animable value names.
Definition at line 243 of file OgreAnimable.h.
The documentation for this class was generated from the following file:
