Ogre::AnimableObject Class Reference

Defines an interface to classes which have one or more AnimableValue instances to expose. More...

#include <OgreAnimable.h>

Inheritance diagram for Ogre::AnimableObject:

Public Member Functions
	AnimableObject ()
virtual	~AnimableObject ()
virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value. More...
const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object. More...

Detailed Description

Defines an interface to classes which have one or more AnimableValue instances to expose.

Constructor & Destructor Documentation

AnimableObject()

Ogre::AnimableObject::AnimableObject ( )

inline

~AnimableObject()

virtual Ogre::AnimableObject::~AnimableObject ( )

inlinevirtual

Member Function Documentation

getAnimableValueNames()

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void  ) const

inline

Gets a list of animable value names for this object.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

createAnimableValue()

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String &  valueName )

inlinevirtual

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.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

---

The documentation for this class was generated from the following file:

• OgreAnimable.h