Ogre::AnimationStateSet Class Reference
Core » Animation

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

`#include <OgreAnimationState.h>`

Inheritance diagram for Ogre::AnimationStateSet:
[legend]

## 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...
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...

## 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

## AnimationStateSet() [1/2]

Ogre::AnimationStateSet::AnimationStateSet | ( |  | ) |

Create a blank animation state set.

## AnimationStateSet() [2/2]

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

Create an animation set by copying the contents of another.

## ~AnimationStateSet()

Ogre::AnimationStateSet::~AnimationStateSet | ( |  | ) |

## Member Function Documentation

## _notifyAnimationStateEnabled()

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

Internal method respond to enable/disable an animation state.

## _notifyDirty()

void Ogre::AnimationStateSet::_notifyDirty | ( | void |  | ) |

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

## copyMatchingState()

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

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

## createAnimationState()

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

## getAnimationState()

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

Get an animation state by the name of the animation.

## getAnimationStateIterator() [1/2]

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.

Referenced by Ogre::SceneManager::getAnimationStateIterator().

## getAnimationStateIterator() [2/2]

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.

## getDirtyFrameNumber()

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

Get the latest animation state been altered frame number.

Definition at line 245 of file OgreAnimationState.h.

## getEnabledAnimationStateIterator()

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.

## hasAnimationState()

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

Tests if state for the named animation is present.

## hasEnabledAnimationState()

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

Tests if exists enabled animation state in this set.

Definition at line 250 of file OgreAnimationState.h.

## operator delete() [1/3]

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## removeAllAnimationStates()

void Ogre::AnimationStateSet::removeAllAnimationStates | ( | void |  | ) |

Remove all animation states.

## removeAnimationState()

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

Remove animation state with the given name.

## Member Data Documentation

## mAnimationStates

AnimationStateMap Ogre::AnimationStateSet::mAnimationStates

protected

Definition at line 261 of file OgreAnimationState.h.

## mDirtyFrameNumber

unsigned long Ogre::AnimationStateSet::mDirtyFrameNumber

protected

Definition at line 260 of file OgreAnimationState.h.

## mEnabledAnimationStates

EnabledAnimationStateList Ogre::AnimationStateSet::mEnabledAnimationStates

protected

Definition at line 262 of file OgreAnimationState.h.

## OGRE_AUTO_MUTEX

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:

- OgreAnimationState.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.