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) More...
	AnimationHandle (size_t idAnimation, size_t iFrame=0)
	Constructs a valid handle for the given animation and frame. More...
bool	isValid () const
	Returns true if the handle is valid. More...
size_t	animationIndex () const
	Returns the animation index (zero based) More...
size_t	frame () const
	Returns the selected frame (zero based) More...
void	setFrame (size_t _iFrame)
	Sets the current animation frame (not failsafe) More...
void	firstFrame ()
	Returns to the first frame. More...
void	operator++ ()
	Increases the handle to the next frame (not failsafe) More...
void	operator-- ()
	Decreases the handle to the previous frame (not failsafe) More...
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) More...
size_t	iFrame
	The frame number. More...

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.

Constructor & Destructor Documentation

AnimationHandle() [1/2]

AnimationHandle::AnimationHandle ( )

inline

Constructs an invalid animation handle (interpreted as handle of the reference pose)

Definition at line 51 of file AnimationHandle.hh.

AnimationHandle() [2/2]

AnimationHandle::AnimationHandle ( size_t  idAnimation, size_t  iFrame = 0  )

inline

Constructs a valid handle for the given animation and frame.

Definition at line 53 of file AnimationHandle.hh.

Member Function Documentation

animationIndex()

size_t AnimationHandle::animationIndex ( ) const

inline

Returns the animation index (zero based)

Definition at line 57 of file AnimationHandle.hh.

firstFrame()

void AnimationHandle::firstFrame ( )

inline

Returns to the first frame.

Definition at line 65 of file AnimationHandle.hh.

frame()

size_t AnimationHandle::frame ( ) const

inline

Returns the selected frame (zero based)

Definition at line 60 of file AnimationHandle.hh.

isValid()

bool AnimationHandle::isValid ( ) const

inline

Returns true if the handle is valid.

Definition at line 55 of file AnimationHandle.hh.

operator!=()

bool AnimationHandle::operator!= ( const AnimationHandle &  rhs )

inline

Definition at line 72 of file AnimationHandle.hh.

operator++()

void AnimationHandle::operator++ ( )

inline

Increases the handle to the next frame (not failsafe)

Definition at line 67 of file AnimationHandle.hh.

operator--()

void AnimationHandle::operator-- ( )

inline

Decreases the handle to the previous frame (not failsafe)

Definition at line 69 of file AnimationHandle.hh.

operator==()

bool AnimationHandle::operator== ( const AnimationHandle &  rhs )

inline

Definition at line 71 of file AnimationHandle.hh.

setFrame()

void AnimationHandle::setFrame ( size_t  _iFrame )

inline

Sets the current animation frame (not failsafe)

Definition at line 62 of file AnimationHandle.hh.

Member Data Documentation

idAnimation

size_t AnimationHandle::idAnimation

private

The one based index of the animation, set to 0 for invalid (or reference pose)

Definition at line 76 of file AnimationHandle.hh.

iFrame

size_t AnimationHandle::iFrame

private

The frame number.

Definition at line 78 of file AnimationHandle.hh.

---

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

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