- Cal3D 0.9 API Reference -

             

---

CalAnimation Class Reference

The animation class. More...

#include <animation.h>

Inheritance diagram for CalAnimation:

List of all members.

Public Types
enum	Type { TYPE_NONE = 0, TYPE_CYCLE, TYPE_POSE, TYPE_ACTION }
enum	State {   STATE_NONE = 0, STATE_SYNC, STATE_ASYNC, STATE_IN,   STATE_STEADY, STATE_OUT }
Public Methods
virtual	~CalAnimation ()
	Destructs the animation instance. More...
virtual bool	create (CalCoreAnimation *pCoreAnimation)=0
virtual void	destroy ()
	Destroys the animation instance. More...
CalCoreAnimation *	getCoreAnimation ()
	Provides access to the core animation. More...
State	getState ()
	Returns the state. More...
float	getTime ()
	Returns the time. More...
Type	getType ()
	Returns the type. More...
float	getWeight ()
	Returns the weight. More...
void	setTime (float time)
	Set the time. More...
Protected Methods
	CalAnimation ()
	Constructs the animation instance. More...
Protected Attributes
CalCoreAnimation *	m_pCoreAnimation
Type	m_type
State	m_state
float	m_time
float	m_timeFactor
float	m_weight

---

Detailed Description

The animation class.

---

Constructor & Destructor Documentation

CalAnimation::CalAnimation (    )  [protected]

Constructs the animation instance. This function is the default constructor of the animation instance.

CalAnimation::~CalAnimation (    )  [virtual]

Destructs the animation instance. This function is the destructor of the animation instance.

---

Member Function Documentation

void CalAnimation::destroy (    )  [virtual]

Destroys the animation instance. This function destroys all data stored in the animation instance and frees all allocated memory. Reimplemented in CalAnimationAction.

CalCoreAnimation * CalAnimation::getCoreAnimation (    )

Provides access to the core animation. This function returns the core animation on which this animation instance is based on. Returns: One of the following values: a pointer to the core animation 0 if an error happend

CalAnimation::State CalAnimation::getState (    )

Returns the state. This function returns the state of the animation instance. Returns: One of the following states: STATE_NONE STATE_SYNC STATE_ASYNC STATE_IN STATE_STEADY STATE_OUT

float CalAnimation::getTime (    )

Returns the time. This function returns the time of the animation instance. Returns: The time in seconds.

CalAnimation::Type CalAnimation::getType (    )

Returns the type. This function returns the type of the animation instance. Returns: One of the following types: TYPE_NONE TYPE_CYCLE TYPE_POSE TYPE_ACTION

float CalAnimation::getWeight (    )

Returns the weight. This function returns the weight of the animation instance. Returns: The weight.

void CalAnimation::setTime (  float    time )

Set the time. This function set the time of the animation instance.

---

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

• animation.h
• animation.cpp

---

Generated at Sun Oct 12 18:38:48 2003 by The Cal3D Team with 1.2.14 © 1997-2001 Dimitri van Heesch