Class encapsulating a set of AnimationState objects. More...

#include <OgreAnimationState.h>

Inheritance diagram for Ogre::AnimationStateSet:

Collaboration diagram for Ogre::AnimationStateSet:

Public Member Functions
OGRE_AUTO_MUTEX	AnimationStateSet ()
	Mutex, public for external locking if needed. More...

	AnimationStateSet (const AnimationStateSet &rhs)
	Create an animation set by copying the contents of another. More...

	~AnimationStateSet ()

void	_notifyAnimationStateEnabled (AnimationState *target, bool enabled)
	Internal method respond to enable/disable an animation state. More...

void	_notifyDirty (void)
	Set the dirty flag and dirty frame number on this state set. More...

void	copyMatchingState (AnimationStateSet *target) const
	Copy the state of any matching animation states from this to another. More...

AnimationState *	createAnimationState (const String &animName, Real timePos, Real length, Real weight=1.0, bool enabled=false)
	Create a new AnimationState instance. More...

AnimationState *	getAnimationState (const String &name) const
	Get an animation state by the name of the animation. More...

AnimationStateIterator	getAnimationStateIterator (void)
	Get an iterator over all the animation states in this set. More...

ConstAnimationStateIterator	getAnimationStateIterator (void) const
	Get an iterator over all the animation states in this set. More...

unsigned long	getDirtyFrameNumber (void) const
	Get the latest animation state been altered frame number. More...

ConstEnabledAnimationStateIterator	getEnabledAnimationStateIterator (void) const
	Get an iterator over all the enabled animation states in this set. More...

bool	hasAnimationState (const String &name) const
	Tests if state for the named animation is present. More...

bool	hasEnabledAnimationState (void) const
	Tests if exists enabled animation state in this set. More...

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

void	removeAllAnimationStates (void)
	Remove all animation states. More...

void	removeAnimationState (const String &name)
	Remove animation state with the given name. More...

Protected Attributes
AnimationStateMap	mAnimationStates

unsigned long	mDirtyFrameNumber

EnabledAnimationStateList	mEnabledAnimationStates

Detailed Description

Class encapsulating a set of AnimationState objects.

Definition at line 183 of file OgreAnimationState.h.

Constructor & Destructor Documentation

OGRE_AUTO_MUTEX Ogre::AnimationStateSet::AnimationStateSet ( )

Mutex, public for external locking if needed.

Create a blank animation state set

Ogre::AnimationStateSet::AnimationStateSet ( const AnimationStateSet & rhs )

Create an animation set by copying the contents of another.

Ogre::AnimationStateSet::~AnimationStateSet ( )

Member Function Documentation

void Ogre::AnimationStateSet::_notifyAnimationStateEnabled	(	AnimationState *	target,
		bool	enabled
	)

Internal method respond to enable/disable an animation state.

void Ogre::AnimationStateSet::_notifyDirty ( void )

Set the dirty flag and dirty frame number on this state set.

void Ogre::AnimationStateSet::copyMatchingState ( AnimationStateSet * target ) const

Copy the state of any matching animation states from this to another.

AnimationState* Ogre::AnimationStateSet::createAnimationState	(	const String &	animName,
		Real	timePos,
		Real	length,
		Real	weight = `1.0`,
		bool	enabled = `false`
	)

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

AnimationState* Ogre::AnimationStateSet::getAnimationState ( const String & name ) const

Get an animation state by the name of the animation.

AnimationStateIterator Ogre::AnimationStateSet::getAnimationStateIterator ( void )

Get an iterator over all the 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.

ConstAnimationStateIterator Ogre::AnimationStateSet::getAnimationStateIterator ( void ) const

Get an iterator over all the 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.

unsigned long Ogre::AnimationStateSet::getDirtyFrameNumber ( void ) const

inline

Get the latest animation state been altered frame number.

Definition at line 232 of file OgreAnimationState.h.

ConstEnabledAnimationStateIterator Ogre::AnimationStateSet::getEnabledAnimationStateIterator ( void ) const

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.

bool Ogre::AnimationStateSet::hasAnimationState ( const String & name ) const

Tests if state for the named animation is present.

bool Ogre::AnimationStateSet::hasEnabledAnimationState ( void ) const

inline

Tests if exists enabled animation state in this set.

Definition at line 237 of file OgreAnimationState.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >