Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | Related Pages

SkeletonAnimatorController Class Reference

#include <skeletonanimator.h>

Inheritance diagram for SkeletonAnimatorController:

Inheritance graph
[legend]
Collaboration diagram for SkeletonAnimatorController:

Collaboration graph
[legend]
List of all members.

Detailed Description

Animator controller for skeletons.

Author:
Mattias Jansson (mattias@realityrift.com)


Public Member Functions

 SkeletonAnimatorController ()
 SkeletonAnimatorController (const SkeletonAnimatorController &rkController)
virtual ~SkeletonAnimatorController ()
virtual bool AddAnimation (SkeletonAnimation *pkAnimation)
virtual bool SetCurrentAnimation (unsigned int uiID)
virtual bool SetCurrentAnimation (const HashString &rstrName)
virtual void Update (float fDeltaTime)
const std::vector< SkeletonAnimation * > & GetAnimations () const
SkeletonAnimationGetCurrentAnimation ()
bool IsActive () const
virtual void Activate ()
virtual void Deactivate ()
bool Toggle ()

Protected Attributes

std::vector< SkeletonAnimation * > m_vpkAnimations
unsigned int m_uiCurAnim
SkeletonAnimationm_pkCurAnim
bool m_bActive


Constructor & Destructor Documentation

SkeletonAnimatorController  )  [inline]
 

SkeletonAnimatorController const SkeletonAnimatorController rkController  )  [inline]
 

Parameters:
rkController Reference controller object to copy

virtual ~SkeletonAnimatorController  )  [inline, virtual]
 


Member Function Documentation

virtual bool AddAnimation SkeletonAnimation pkAnimation  )  [inline, virtual, inherited]
 

Add new animation

Parameters:
pkAnimation New animation
Returns:
true if added, false if id or name conflicts with already registered animation

virtual bool SetCurrentAnimation unsigned int  uiID  )  [inline, virtual, inherited]
 

Set current animation by ID

Parameters:
uiID Animation ID
Returns:
true if successful, false if animation not found

virtual bool SetCurrentAnimation const HashString rstrName  )  [inline, virtual, inherited]
 

Set current animation by name

Parameters:
rstrName Animation name
Returns:
true if successful, false if animation not found

virtual void Update float  fDeltaTime  )  [inline, virtual, inherited]
 

Update current animation

Parameters:
fDeltaTime Time passed since last update

Reimplemented from UpdateEntity.

Reimplemented in Skeleton.

const std::vector< SkeletonAnimation * >& GetAnimations  )  const [inline, inherited]
 

Returns:
All animations

SkeletonAnimation * GetCurrentAnimation  )  [inline, inherited]
 

Returns:
Current animations

bool IsActive  )  const [inline, inherited]
 

Query state of object

Returns:
true if active, false if not

void Activate  )  [inline, virtual, inherited]
 

Activate object

void Deactivate  )  [inline, virtual, inherited]
 

Deactivate object

bool Toggle  )  [inline, inherited]
 

Toggle active state. This method does not need to be overloaded, it is only a wrapper to Activate and Deactivate

Returns:
true if activated, false if deactivated


Member Data Documentation

std::vector< SkeletonAnimation * > m_vpkAnimations [protected, inherited]
 

Animations

unsigned int m_uiCurAnim [protected, inherited]
 

Current animation

SkeletonAnimation * m_pkCurAnim [protected, inherited]
 

Current animation object ptr

bool m_bActive [protected, inherited]
 

Active flag


The documentation for this class was generated from the following file:
Generated on Wed Jan 21 14:21:15 2004 for NeoEngine by doxygen 1.3.5