Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
AnimationHandle Class Reference

A handle used to refer to an animation or to a specific frame in an animation. More...

#include <ObjectTypes/Skeleton/Animation/AnimationHandle.hh>

Public Member Functions

 AnimationHandle ()
 Constructs an invalid animation handle (interpreted as handle of the reference pose)
 
 AnimationHandle (unsigned int idAnimation, unsigned int iFrame=0)
 Constructs a valid handle for the given animation and frame.
 
bool isValid () const
 Returns true if the handle is valid.
 
unsigned int animationIndex () const
 Returns the animation index (zero based)
 
unsigned int frame () const
 Returns the selected frame (zero based)
 
void setFrame (unsigned int _iFrame)
 Sets the current animation frame (not failsafe)
 
void firstFrame ()
 Returns to the first frame.
 
void operator++ ()
 Increases the handle to the next frame (not failsafe)
 
void operator-- ()
 Decreases the handle to the previous frame (not failsafe)
 
bool operator== (const AnimationHandle &rhs)
 
bool operator!= (const AnimationHandle &rhs)
 

Private Attributes

unsigned int idAnimation
 The one based index of the animation, set to 0 for invalid (or reference pose)
 
unsigned int iFrame
 The frame number.
 

Detailed Description

A handle used to refer to an animation or to a specific frame in an animation.

Definition at line 49 of file AnimationHandle.hh.


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