OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::AnimationStateSet Class Reference

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

#include <OgreAnimationState.h>

+ Inheritance diagram for Ogre::AnimationStateSet:
+ Collaboration diagram for Ogre::AnimationStateSet:

Public Member Functions

 AnimationStateSet ()
 Create a blank animation state set. 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...
 
AnimationStatecreateAnimationState (const String &animName, Real timePos, Real length, Real weight=1.0, bool enabled=false)
 Create a new AnimationState instance. More...
 
AnimationStategetAnimationState (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...
 

Public Attributes

 OGRE_AUTO_MUTEX
 Mutex, public for external locking if needed. More...
 

Protected Attributes

AnimationStateMap mAnimationStates
 
unsigned long mDirtyFrameNumber
 
EnabledAnimationStateList mEnabledAnimationStates
 

Detailed Description

Class encapsulating a set of AnimationState objects.

Definition at line 196 of file OgreAnimationState.h.

Constructor & Destructor Documentation

Ogre::AnimationStateSet::AnimationStateSet ( )

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
animNameThe name of the animation
timePosStarting time position
lengthLength of the animation to play
weightWeight to apply the animation with
enabledWhether 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 245 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 250 of file OgreAnimationState.h.

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::AnimationStateSet::removeAllAnimationStates ( void  )

Remove all animation states.

void Ogre::AnimationStateSet::removeAnimationState ( const String name)

Remove animation state with the given name.

Member Data Documentation

AnimationStateMap Ogre::AnimationStateSet::mAnimationStates
protected

Definition at line 261 of file OgreAnimationState.h.

unsigned long Ogre::AnimationStateSet::mDirtyFrameNumber
protected

Definition at line 260 of file OgreAnimationState.h.

EnabledAnimationStateList Ogre::AnimationStateSet::mEnabledAnimationStates
protected

Definition at line 262 of file OgreAnimationState.h.

Ogre::AnimationStateSet::OGRE_AUTO_MUTEX

Mutex, public for external locking if needed.

Definition at line 200 of file OgreAnimationState.h.


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