Developer Documentation

Public Member Functions | Private Attributes | List of all members
AnimationHandle Class Reference

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

`#include <Type-Skeleton/ObjectTypes/Skeleton/Animation/AnimationHandle.hh>`

## Public Member Functions
| AnimationHandle ()
| Constructs an invalid animation handle (interpreted as handle of the reference pose)
| AnimationHandle (size_t idAnimation, size_t iFrame=0)
| Constructs a valid handle for the given animation and frame.
bool | isValid () const
| Returns true if the handle is valid.
size_t | animationIndex () const
| Returns the animation index (zero based)
size_t | frame () const
| Returns the selected frame (zero based)
void | setFrame (size_t _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
size_t | idAnimation
| The one based index of the animation, set to 0 for invalid (or reference pose)
size_t | 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 47 of file AnimationHandle.hh.

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

- Type-Skeleton/ObjectTypes/Skeleton/Animation/AnimationHandle.hh