The Nebula Device 3: Characters::CharacterAnimationController Class Reference

The Nebula Device 3

Characters::CharacterAnimationController Class Reference

#include <characteranimationcontroller.h>


Detailed Description

Allows to control the animation of a character instance, this is basically a convenience wrapper around Animation::AnimSequencer.

(C) 2008 Radon Labs GmbH

Public Member Functions

 CharacterAnimationController ()
 constructor
 ~CharacterAnimationController ()
 destructor
void Setup (const Ptr< Jobs::JobPort > &jobPort, const CharacterAnimationLibrary &animLib)
 setup the anim controller object
void Discard ()
 discard the anim controller object
bool IsValid () const
 return true if object has been setup
void SetupAnimDrivenMotion (IndexT animDrivenMotionJointIndex)
 setup the character instance for anim driven motion
bool IsAnimDrivenMotionEnabled () const
 return true if anim driven motion is enabled on the character instance
const Math::vectorGetAnimDrivenMotionVector ()
 get computed animation driven motion vector
void EnqueueAnimJob (const Ptr< Animation::AnimJob > &animJob)
 enqueue an anim job
void StopTrack (IndexT trackIndex, bool allowFadeOut=true)
 stop all anim jobs on a given track
void StopAllTracks (bool allowFadeOut=true)
 stop all anim jobs
Animation::AnimSequencerAnimSequencer ()
 direct access to embedded anim sequencer object

Member Function Documentation

const Math::vector & Characters::CharacterAnimationController::GetAnimDrivenMotionVector (  )  [inline]

get computed animation driven motion vector

NOTE: caller needs to make sure that the animation evaluation jobs have finished!