SO3::SSequenceAnimation Class Reference

#include <SO3SequenceAnimation.h>

Inheritance diagram for SO3::SSequenceAnimation:

Public Member Functions
	SSequenceAnimation (SScene *scene, const std::string &animationName, const unsigned short &id)
	~SSequenceAnimation ()
void	UpdateAnimationLength ()
float	GetLastPos ()
virtual void	SetTimePosition (const float &timePosition)
virtual void	SetEnable (const bool &enable)
virtual bool	GetEnable ()
virtual void	_UpdateImpl (const Ogre::FrameEvent &evt)
Public Member Functions inherited from SO3::SAnim
virtual	~SAnim ()
Ogre::Animation *	GetOgreAnimationPointer ()
SNode *	GetParentNode ()
SScene *	GetParentScene ()
AnimType	GetType ()
bool	IsSequenceUpdated ()
void	SetSequenceUpdated (const bool &value)
unsigned short	GetIndex ()
SAnimTrack *	CreateAnimationTrack (const std::string &newAnimationTrackName)
void	DeleteAnimationTrack (SAnimTrack *existingAnimationTrack)
unsigned short	GetNumAnimationsTracks ()
SAnimTrack *	GetAnimationTrack (const unsigned short &index)
SAnimTrackList	GetAnimationsTracks () const
void	SetLength (const float &length)
float	GetLength ()
float	GetTimePosition ()
void	Apply (const float &timePosition)
virtual void	SetWeight (const float &weight)
virtual float	GetWeight ()
void	SetInitialWeight (const float &weight)
float	GetInitialWeight ()
void	SetInitialLoop (const bool &loop)
bool	GetInitialLoop ()
void	SetInterpolationMode (const AnimInterpolationMode &interpolationMode)
AnimInterpolationMode	GetInterpolationMode ()
void	SetRotationInterpolationMode (const AnimRotationInterpolationMode &interpolationMode)
AnimRotationInterpolationMode	GetRotationInterpolationMode ()
void	SetLoop (const bool &loop)
bool	GetLoop ()
bool	SkipFrame ()
void	SetSkipFrame (const bool &state)
void	SetOptimise (const bool &optimize)
void	SetSpeed (const float &newSpeed)
float	GetSpeed ()
bool	HasEnded ()
void	AddTime (const float &time)
void	SetPaused (const bool &pauseState)
bool	GetPaused ()
void	Update (const Ogre::FrameEvent &evt)
Public Member Functions inherited from SO3::SData
	SData (const std::string &dataName)
virtual	~SData ()
std::string	GetName () const
SUserObjectBindings &	GetUserObjectBindings ()
const SUserObjectBindings &	GetUserObjectBindings () const

Protected Member Functions
virtual Ogre::AnimationState *	_GetOgreAnimationState ()
virtual SAnimTrack *	CreateAnimationTrackImpl (const std::string &newAnimationTrackName)
Protected Member Functions inherited from SO3::SAnim
	SAnim (SScene *scene, const std::string &animationName, SNode *animationAssociatedNode, const unsigned short &animationId, const AnimType &animationType)
void	AddAnimationTrack (SAnimTrack *existingAnimationTrack)
void	RemoveAnimationTrack (SAnimTrack *existingAnimationTrack)

Additional Inherited Members
Public Types inherited from SO3::SAnim
enum	AnimType {   SO3_UNKNOWN_ANIM = 0 , SO3_SCENENODE_ANIM = 1 , SO3_SKELETAL_ANIM = 2 , SO3_VERTEX_ANIM = 3 ,   SO3_FAP_ANIM = 4 , SO3_POSE_ANIM = 5 , SO3_SEQUENCE_ANIM = 6 }
enum	AnimInterpolationMode { SO3_IM_LINEAR , SO3_IM_SPLINE }
enum	AnimRotationInterpolationMode { SO3_RIM_LINEAR , SO3_RIM_SPHERICAL }
Protected Attributes inherited from SO3::SAnim
Ogre::Animation *	ogreAnimation
SAnimTrackList	animationTrackList
SScene *	mScene
Protected Attributes inherited from SO3::SData
std::string	name

Detailed Description

Definition at line 41 of file SO3SequenceAnimation.h.

Constructor & Destructor Documentation

SSequenceAnimation()

SO3::SSequenceAnimation::SSequenceAnimation	(	SScene *	scene,
		const std::string &	animationName,
		const unsigned short &	id
	)

Create a new anim sequence

Definition at line 38 of file SO3SequenceAnimation.cpp.

~SSequenceAnimation()

SO3::SSequenceAnimation::~SSequenceAnimation

(

)

Definition at line 51 of file SO3SequenceAnimation.cpp.

Member Function Documentation

_GetOgreAnimationState()

Ogre::AnimationState * SO3::SSequenceAnimation::_GetOgreAnimationState ( )

protectedvirtual

Get the current Animation State Internal use only

Implements SO3::SAnim.

Definition at line 65 of file SO3SequenceAnimation.cpp.

_UpdateImpl()

void SO3::SSequenceAnimation::_UpdateImpl ( const Ogre::FrameEvent &  evt )

virtual

Internal use

Reimplemented from SO3::SAnim.

Definition at line 133 of file SO3SequenceAnimation.cpp.

CreateAnimationTrackImpl()

SAnimTrack * SO3::SSequenceAnimation::CreateAnimationTrackImpl ( const std::string &  newAnimationTrackName )

protectedvirtual

If the user can manually create animation tracks, then this function must be re-defined in the derived class, otherwise not.

Reimplemented from SO3::SAnim.

Definition at line 60 of file SO3SequenceAnimation.cpp.

GetEnable()

bool SO3::SSequenceAnimation::GetEnable ( )

virtual

Reimplemented from SO3::SAnim.

Definition at line 108 of file SO3SequenceAnimation.cpp.

GetLastPos()

float SO3::SSequenceAnimation::GetLastPos

(

)

Definition at line 128 of file SO3SequenceAnimation.cpp.

SetEnable()

void SO3::SSequenceAnimation::SetEnable ( const bool &  enable )

virtual

Reimplemented from SO3::SAnim.

Definition at line 91 of file SO3SequenceAnimation.cpp.

SetTimePosition()

void SO3::SSequenceAnimation::SetTimePosition ( const float &  timePosition )

virtual

Reimplemented from SO3::SAnim.

Definition at line 70 of file SO3SequenceAnimation.cpp.

UpdateAnimationLength()

void SO3::SSequenceAnimation::UpdateAnimationLength

(

)

Definition at line 113 of file SO3SequenceAnimation.cpp.

---

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

• include/SO3Animation/SO3SequenceAnimation.h
• src/SO3Animation/SO3SequenceAnimation.cpp