dtAnim::AnimationWrapper Class Reference

The AnimationWrapper is meant to be a wrapper around a Cal3D animation. More...

#include <animationwrapper.h>

List of all members.

Public Member Functions
	AnimationWrapper (const std::string &pName, int pAnimationID)
int	GetID () const
	The ID of the Animation Wrapper refers to the Cal3D animation ID.
float	GetDuration () const
	The duration of an animation is defined to be the amount of time it takes to play through a single cycle.
void	SetDuration (float duration)
float	GetSpeed () const
	The speed of an animation is defined to be a percentage of the export speed, defaulting to 1.0.
void	SetSpeed (float pSpeed)
const std::string &	GetName () const
	The name of this animation as it is defined in the XML file.
void	SetName (const std::string &pName)
Protected Member Functions
virtual	~AnimationWrapper ()

---

Detailed Description

The AnimationWrapper is meant to be a wrapper around a Cal3D animation.

The wrapper is used to keep our API from passing Cal3D specific objects and to attach additional information to the animation.

---

Constructor & Destructor Documentation

dtAnim::AnimationWrapper::AnimationWrapper	(	const std::string &	pName,
		int	pAnimationID
	)

dtAnim::AnimationWrapper::~AnimationWrapper

(

)

[protected, virtual]

---

Member Function Documentation

int dtAnim::AnimationWrapper::GetID

(

)

const

The ID of the Animation Wrapper refers to the Cal3D animation ID.

Returns:

the Cal3D animation ID

float dtAnim::AnimationWrapper::GetDuration

(

)

const

The duration of an animation is defined to be the amount of time it takes to play through a single cycle.

void dtAnim::AnimationWrapper::SetDuration

(

float

duration

)

float dtAnim::AnimationWrapper::GetSpeed

(

)

const

The speed of an animation is defined to be a percentage of the export speed, defaulting to 1.0.

void dtAnim::AnimationWrapper::SetSpeed

(

float

pSpeed

)

const std::string & dtAnim::AnimationWrapper::GetName

(

)

const

The name of this animation as it is defined in the XML file.

void dtAnim::AnimationWrapper::SetName

(

const std::string &

pName

)

---