Ogre::AnimationStateControllerValue Class Reference

ControllerValue wrapper class for AnimationState. More...

#include <OgreAnimationState.h>

Inheritance diagram for Ogre::AnimationStateControllerValue:

Public Member Functions
	AnimationStateControllerValue (AnimationState *targetAnimationState, bool addTime=false)
Real	getValue (void) const override
	ControllerValue implementation. More...
void	setValue (Real value) override
	ControllerValue implementation. More...
Public Member Functions inherited from Ogre::ControllerValue< Real >
virtual	~ControllerValue ()

Static Public Member Functions
static ControllerValueRealPtr	create (AnimationState *targetAnimationState, bool addTime=false)
	create an instance of this class More...

Detailed Description

ControllerValue wrapper class for AnimationState.

Remarks

In Azathoth and earlier, AnimationState was a ControllerValue but this actually causes memory problems since Controllers delete their values automatically when there are no further references to them, but AnimationState is deleted explicitly elsewhere so this causes double-free problems. This wrapper acts as a bridge and it is this which is destroyed automatically.

Constructor & Destructor Documentation

AnimationStateControllerValue()

Ogre::AnimationStateControllerValue::AnimationStateControllerValue ( AnimationState *  targetAnimationState, bool  addTime = false  )

inline

Deprecated:

use create instead

Member Function Documentation

create()

static ControllerValueRealPtr Ogre::AnimationStateControllerValue::create ( AnimationState *  targetAnimationState, bool  addTime = false  )

static

create an instance of this class

Parameters

targetAnimationState
addTime	if true, increment time instead of setting to an absolute position

getValue()

Real Ogre::AnimationStateControllerValue::getValue ( void  ) const

inlineoverridevirtual

ControllerValue implementation.

Implements Ogre::ControllerValue< Real >.

References Ogre::AnimationState::getLength(), and Ogre::AnimationState::getTimePosition().

setValue()

void Ogre::AnimationStateControllerValue::setValue ( Real  value )

inlineoverridevirtual

ControllerValue implementation.

Implements Ogre::ControllerValue< Real >.

References Ogre::AnimationState::addTime(), Ogre::AnimationState::getLength(), and Ogre::AnimationState::setTimePosition().

---

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

• OgreAnimationState.h