Class encapsulating a set of AnimationState objects.
More...
#include <OgreAnimationState.h>
Class encapsulating a set of AnimationState objects.
◆ AnimationStateSet() [1/2]
Ogre::AnimationStateSet::AnimationStateSet |
( |
| ) |
|
Mutex, public for external locking if needed.
Create a blank animation state set
◆ AnimationStateSet() [2/2]
Create an animation set by copying the contents of another.
◆ ~AnimationStateSet()
Ogre::AnimationStateSet::~AnimationStateSet |
( |
| ) |
|
◆ createAnimationState()
Create a new AnimationState instance.
- Parameters
-
animName | The name of the animation |
timePos | Starting time position |
length | Length of the animation to play |
weight | Weight to apply the animation with |
enabled | Whether the animation is enabled |
◆ getAnimationState()
Get an animation state by the name of the animation.
◆ hasAnimationState()
bool Ogre::AnimationStateSet::hasAnimationState |
( |
const String & |
name | ) |
const |
Tests if state for the named animation is present.
◆ removeAnimationState()
void Ogre::AnimationStateSet::removeAnimationState |
( |
const String & |
name | ) |
|
Remove animation state with the given name.
◆ removeAllAnimationStates()
void Ogre::AnimationStateSet::removeAllAnimationStates |
( |
void |
| ) |
|
Remove all animation states.
◆ getAnimationStateIterator() [1/2]
◆ getAnimationStateIterator() [2/2]
◆ getAnimationStates()
Get all the animation states in this set.
- Note
- This method is not threadsafe, you will need to manually lock the public mutex on this class to ensure thread safety if you need it.
◆ copyMatchingState()
Copy the state of any matching animation states from this to another.
◆ _notifyDirty()
void Ogre::AnimationStateSet::_notifyDirty |
( |
void |
| ) |
|
Set the dirty flag and dirty frame number on this state set.
◆ getDirtyFrameNumber()
unsigned long Ogre::AnimationStateSet::getDirtyFrameNumber |
( |
void |
| ) |
const |
|
inline |
Get the latest animation state been altered frame number.
◆ _notifyAnimationStateEnabled()
void Ogre::AnimationStateSet::_notifyAnimationStateEnabled |
( |
AnimationState * |
target, |
|
|
bool |
enabled |
|
) |
| |
Internal method respond to enable/disable an animation state.
◆ hasEnabledAnimationState()
bool Ogre::AnimationStateSet::hasEnabledAnimationState |
( |
void |
| ) |
const |
|
inline |
Tests if exists enabled animation state in this set.
◆ getEnabledAnimationStateIterator()
◆ getEnabledAnimationStates()
Get an iterator over all the enabled animation states in this set.
- Note
- The iterator returned from this method is not threadsafe, you will need to manually lock the public mutex on this class to ensure thread safety if you need it.
The documentation for this class was generated from the following file: