ParaEngine::IAnimated Class Reference

base class for AnimatedVariable. More...

#include <IAnimated.h>

Inheritance diagram for ParaEngine::IAnimated:

Public Member Functions
virtual int	GetNumKeys ()
	get total number of animated keys. More...
virtual void	SetNumKeys (int nKeyCount)
	get set the total number of animated keys. More...
virtual int	GetNextKeyIndex (int nTime)
	return the index of the first key whose time is larger than or equal to time. More...
virtual int	AddKey (int time, bool *isKeyExist=NULL)
	add a given key with default value at specified time if there is already a key at the index, we will return the old index. More...
virtual void	SetTime (int nIndex, int nTime)
	only applied to Animated attribute More...
virtual int	GetTime (int nIndex)
virtual void	SetValue (int nIndex, const Quaternion &val)
virtual bool	GetValue (int nIndex, Quaternion &val)
virtual bool	GetValueByTime (int nTime, Quaternion &val)
virtual void	SetValue (int nIndex, const Vector2 &val)
virtual bool	GetValue (int nIndex, Vector2 &val)
virtual bool	GetValueByTime (int nTime, Vector2 &val)
virtual void	SetValue (int nIndex, const Vector3 &val)
virtual bool	GetValue (int nIndex, Vector3 &val)
virtual bool	GetValueByTime (int nTime, Vector3 &val)
virtual void	SetValue (int nIndex, const double &val)
virtual bool	GetValue (int nIndex, double &val)
virtual bool	GetValueByTime (int nTime, double &val)
virtual void	SetValue (int nIndex, const float &val)
virtual bool	GetValue (int nIndex, float &val)
virtual bool	GetValueByTime (int nTime, float &val)
virtual void	SetValue (int nIndex, const int &val)
virtual bool	GetValue (int nIndex, int &val)
virtual bool	GetValueByTime (int nTime, int &val)
virtual void	SetValue (int nIndex, const std::string &val)
virtual bool	GetValue (int nIndex, std::string &val)
virtual bool	GetValueByTime (int nTime, std::string &val)

Detailed Description

base class for AnimatedVariable.

Member Function Documentation

AddKey()

int ParaEngine::IAnimated::AddKey ( int  time, bool *  isKeyExist = NULL  )

virtual

add a given key with default value at specified time if there is already a key at the index, we will return the old index.

return the key index.

Parameters

isKeyExist

if not NULL, it will return whether the given key already exist at the index.

Reimplemented in ParaEngine::AnimatedVariable< T, Conv >.

GetNextKeyIndex()

int ParaEngine::IAnimated::GetNextKeyIndex ( int  nTime )

virtual

return the index of the first key whose time is larger than or equal to time.

return -1 if no suitable index is found.

Reimplemented in ParaEngine::AnimatedVariable< T, Conv >.

GetNumKeys()

int ParaEngine::IAnimated::GetNumKeys ( )

virtual

get total number of animated keys.

For non-animated attribute, this will return 1.

Reimplemented in ParaEngine::Animated< T, D, Conv >, ParaEngine::Animated< ParaEngine::Vector3 >, ParaEngine::Animated< float >, ParaEngine::Animated< ParaEngine::Quaternion >, ParaEngine::Animated< float, DWORD, ShortToFloat >, and ParaEngine::AnimatedVariable< T, Conv >.

SetNumKeys()

void ParaEngine::IAnimated::SetNumKeys ( int  nKeyCount )

virtual

get set the total number of animated keys.

Reimplemented in ParaEngine::Animated< T, D, Conv >, ParaEngine::Animated< ParaEngine::Vector3 >, ParaEngine::Animated< float >, ParaEngine::Animated< ParaEngine::Quaternion >, ParaEngine::Animated< float, DWORD, ShortToFloat >, and ParaEngine::AnimatedVariable< T, Conv >.

SetTime()

void ParaEngine::IAnimated::SetTime ( int  nIndex, int  nTime  )

virtual

only applied to Animated attribute

Parameters

nIndex	key index.
nTime	in milliseconds

Reimplemented in ParaEngine::Animated< T, D, Conv >, ParaEngine::Animated< ParaEngine::Vector3 >, ParaEngine::Animated< float >, ParaEngine::Animated< ParaEngine::Quaternion >, ParaEngine::Animated< float, DWORD, ShortToFloat >, and ParaEngine::AnimatedVariable< T, Conv >.

---

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

• Client/trunk/ParaEngineClient/Core/IAnimated.h
• Client/trunk/ParaEngineClient/Core/IAnimated.cpp