Ogre::AnimationState Class Reference

Represents the state of an animation and the weight of it's influence. More...

#include <OgreAnimationState.h>

Inheritance diagram for Ogre::AnimationState:

Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector< float > BoneBlendMask
 typedef for an array of float values used as a bone blend mask

Public Member Functions

 AnimationState (const String &animName, AnimationStateSet *parent, Real timePos, Real length, Real weight=1.0, bool enabled=false)
 Normal constructor with all params supplied.
 AnimationState (AnimationStateSet *parent, const AnimationState &rhs)
 constructor to copy from an existing state with new parent
virtual ~AnimationState ()
 Destructor - is here because class has virtual functions and some compilers would whine if it won't exist.
const StringgetAnimationName () const
 Gets the name of the animation to which this state applies.
Real getTimePosition (void) const
 Gets the time position for this animation.
void setTimePosition (Real timePos)
 Sets the time position for this animation.
Real getLength () const
 Gets the total length of this animation (may be shorter than whole animation).
void setLength (Real len)
 Sets the total length of this animation (may be shorter than whole animation).
Real getWeight (void) const
 Gets the weight (influence) of this animation.
void setWeight (Real weight)
 Sets the weight (influence) of this animation.
void addTime (Real offset)
 Modifies the time position, adjusting for animation length.
bool hasEnded (void) const
 Returns true if the animation has reached the end and is not looping.
bool getEnabled (void) const
 Returns true if this animation is currently enabled.
void setEnabled (bool enabled)
 Sets whether this animation is enabled.
bool operator== (const AnimationState &rhs) const
 Equality operator.
bool operator!= (const AnimationState &rhs) const
void setLoop (bool loop)
 Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered.
bool getLoop (void) const
 Gets whether or not this animation loops.
void copyStateFrom (const AnimationState &animState)
 Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else.
AnimationStateSetgetParent (void) const
 Get the parent animation state set.
void createBlendMask (size_t blendMaskSizeHint, float initialWeight=1.0f)
 create a new blend mask with the given number of entries
void destroyBlendMask ()
 destroy the currently set blend mask
void _setBlendMaskData (const float *blendMaskData)
 set the blend mask data (might be dangerous)
void _setBlendMask (const BoneBlendMask *blendMask)
 set the blend mask
const BoneBlendMaskgetBlendMask () const
 get the current blend mask (const version, may be 0)
bool hasBlendMask () const
 return whether there is currently a valid blend mask set
void setBlendMaskEntry (size_t boneHandle, float weight)
 set the weight for the bone identified by the given handle
float getBlendMaskEntry (size_t boneHandle) const
 get the weight for the bone identified by the given handle
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
void * operator new (size_t sz)
void * operator new (size_t sz, void *ptr)
 placement operator new
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
void * operator new[] (size_t sz)
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 *)

Protected Attributes

BoneBlendMaskmBlendMask
 the blend mask (containing per bone weights)
String mAnimationName
AnimationStateSetmParent
Real mTimePos
Real mLength
Real mWeight
bool mEnabled
bool mLoop


Detailed Description

Represents the state of an animation and the weight of it's influence.

Remarks:
Other classes can hold instances of this class to store the state of any animations they are using.

Definition at line 46 of file OgreAnimationState.h.


Member Typedef Documentation

typedef std::vector<float> Ogre::AnimationState::BoneBlendMask

typedef for an array of float values used as a bone blend mask

Definition at line 51 of file OgreAnimationState.h.


Constructor & Destructor Documentation

Ogre::AnimationState::AnimationState ( const String animName,
AnimationStateSet parent,
Real  timePos,
Real  length,
Real  weight = 1.0,
bool  enabled = false 
)

Normal constructor with all params supplied.

Ogre::AnimationState::AnimationState ( AnimationStateSet parent,
const AnimationState rhs 
)

constructor to copy from an existing state with new parent

virtual Ogre::AnimationState::~AnimationState (  )  [virtual]

Destructor - is here because class has virtual functions and some compilers would whine if it won't exist.


Member Function Documentation

const String& Ogre::AnimationState::getAnimationName (  )  const

Gets the name of the animation to which this state applies.

Real Ogre::AnimationState::getTimePosition ( void   )  const

Gets the time position for this animation.

void Ogre::AnimationState::setTimePosition ( Real  timePos  ) 

Sets the time position for this animation.

Real Ogre::AnimationState::getLength (  )  const

Gets the total length of this animation (may be shorter than whole animation).

void Ogre::AnimationState::setLength ( Real  len  ) 

Sets the total length of this animation (may be shorter than whole animation).

Real Ogre::AnimationState::getWeight ( void   )  const

Gets the weight (influence) of this animation.

void Ogre::AnimationState::setWeight ( Real  weight  ) 

Sets the weight (influence) of this animation.

void Ogre::AnimationState::addTime ( Real  offset  ) 

Modifies the time position, adjusting for animation length.

Remarks:
This method loops at the edges if animation looping is enabled.

bool Ogre::AnimationState::hasEnded ( void   )  const

Returns true if the animation has reached the end and is not looping.

bool Ogre::AnimationState::getEnabled ( void   )  const

Returns true if this animation is currently enabled.

void Ogre::AnimationState::setEnabled ( bool  enabled  ) 

Sets whether this animation is enabled.

bool Ogre::AnimationState::operator== ( const AnimationState rhs  )  const

Equality operator.

bool Ogre::AnimationState::operator!= ( const AnimationState rhs  )  const

void Ogre::AnimationState::setLoop ( bool  loop  ) 

Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered.

Definition at line 99 of file OgreAnimationState.h.

bool Ogre::AnimationState::getLoop ( void   )  const

Gets whether or not this animation loops.

Definition at line 101 of file OgreAnimationState.h.

void Ogre::AnimationState::copyStateFrom ( const AnimationState animState  ) 

Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else.

Parameters:
animState Reference to animation state which will use as source.

AnimationStateSet* Ogre::AnimationState::getParent ( void   )  const

Get the parent animation state set.

Definition at line 110 of file OgreAnimationState.h.

void Ogre::AnimationState::createBlendMask ( size_t  blendMaskSizeHint,
float  initialWeight = 1.0f 
)

create a new blend mask with the given number of entries

In addition to assigning a single weight value to a skeletal animation, it may be desirable to assign animation weights per bone using a 'blend mask'.

Parameters:
blendMaskSizeHint The number of bones of the skeleton owning this AnimationState.
initialWeight The value all the blend mask entries will be initialised with (negative to skip initialisation)

void Ogre::AnimationState::destroyBlendMask (  ) 

destroy the currently set blend mask

void Ogre::AnimationState::_setBlendMaskData ( const float *  blendMaskData  ) 

set the blend mask data (might be dangerous)

The size of the array should match the number of entries the
blend mask was created with.
Stick to the setBlendMaskEntry method if you don't know exactly what you're doing.

void Ogre::AnimationState::_setBlendMask ( const BoneBlendMask blendMask  ) 

set the blend mask

The size of the array should match the number of entries the
blend mask was created with.
Stick to the setBlendMaskEntry method if you don't know exactly what you're doing.

const BoneBlendMask* Ogre::AnimationState::getBlendMask (  )  const

get the current blend mask (const version, may be 0)

Definition at line 142 of file OgreAnimationState.h.

bool Ogre::AnimationState::hasBlendMask (  )  const

return whether there is currently a valid blend mask set

Definition at line 144 of file OgreAnimationState.h.

void Ogre::AnimationState::setBlendMaskEntry ( size_t  boneHandle,
float  weight 
)

set the weight for the bone identified by the given handle

float Ogre::AnimationState::getBlendMaskEntry ( size_t  boneHandle  )  const

get the weight for the bone identified by the given handle

Definition at line 148 of file OgreAnimationState.h.

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 62 of file OgreMemoryAllocatedObject.h.

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

Definition at line 67 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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 79 of file OgreMemoryAllocatedObject.h.

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

Definition at line 84 of file OgreMemoryAllocatedObject.h.

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

Definition at line 89 of file OgreMemoryAllocatedObject.h.

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

Definition at line 95 of file OgreMemoryAllocatedObject.h.

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

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

Definition at line 106 of file OgreMemoryAllocatedObject.h.

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.


Member Data Documentation

the blend mask (containing per bone weights)

Definition at line 155 of file OgreAnimationState.h.

Definition at line 157 of file OgreAnimationState.h.

Definition at line 158 of file OgreAnimationState.h.

Definition at line 159 of file OgreAnimationState.h.

Definition at line 160 of file OgreAnimationState.h.

Definition at line 161 of file OgreAnimationState.h.

Definition at line 162 of file OgreAnimationState.h.

bool Ogre::AnimationState::mLoop [protected]

Definition at line 163 of file OgreAnimationState.h.


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

Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:02:49 2009