NumericAnimation Class Reference

A numeric animation. More...

#include <Animation.hh>

Inherits Animation.

Public Member Functions
	NumericAnimation (const std::string &_name, double _length, bool _loop)
	Constructor. More...
virtual	~NumericAnimation ()
	Destructor. More...
void	AddTime (double _time)
	Add time to the animation. More...
NumericKeyFrame *	CreateKeyFrame (double _time)
	Create a numeric keyframe at the given time. More...
void	GetInterpolatedKeyFrame (NumericKeyFrame &_kf) const
	Get a keyframe using the animation's current time. More...
KeyFrame *	GetKeyFrame (unsigned int _index) const
	Get a key frame using an index value. More...
unsigned int	GetKeyFrameCount () const
	Return the number of key frames in the animation. More...
double	GetLength () const
	Return the duration of the animation. More...
double	GetTime () const
	Return the current time position. More...
void	SetLength (double _len)
	Set the duration of the animation. More...
void	SetTime (double _time)
	Set the current time position of the animation. More...

Protected Types
typedef std::vector< KeyFrame * >	KeyFrame_V
	array of keyframe type alias More...

Protected Member Functions
double	GetKeyFramesAtTime (double _time, KeyFrame **_kf1, KeyFrame **_kf2, unsigned int &_firstKeyIndex) const
	Get the two key frames that bound a time value. More...

Protected Attributes
bool	build
	determines if the interpolation splines need building More...
KeyFrame_V	keyFrames
	array of key frames More...
double	length
	animation duration More...
bool	loop
	true if animation repeats More...
std::string	name
	animation name More...
double	timePos
	current time position More...

Detailed Description

A numeric animation.

Member Typedef Documentation

KeyFrame_V

typedef std::vector<KeyFrame*> KeyFrame_V

protectedinherited

array of keyframe type alias

Constructor & Destructor Documentation

NumericAnimation()

NumericAnimation	(	const std::string &	_name,
		double	_length,
		bool	_loop
	)

Constructor.

Parameters

[in]	_name	String name of the animation. This should be unique.
[in]	_length	Length of the animation in seconds
[in]	_loop	True == loop the animation

~NumericAnimation()

virtual ~NumericAnimation ( )

virtual

Destructor.

Member Function Documentation

AddTime()

void AddTime ( double  _time )

inherited

Add time to the animation.

Parameters

[in]

_time

The amount of time to add in seconds

CreateKeyFrame()

NumericKeyFrame* CreateKeyFrame

(

double

_time

)

Create a numeric keyframe at the given time.

Parameters

[in]

_time

Time at which to create the keyframe

Returns

Pointer to the new keyframe

GetInterpolatedKeyFrame()

void GetInterpolatedKeyFrame

(

NumericKeyFrame &

_kf

)

const

Get a keyframe using the animation's current time.

Parameters

[out]

_kf

NumericKeyFrame reference to hold the interpolated result

GetKeyFrame()

KeyFrame* GetKeyFrame ( unsigned int  _index ) const

inherited

Get a key frame using an index value.

Parameters

[in]

_index

The index of the key frame

Returns

A pointer the keyframe, nullptr if the _index is invalid

GetKeyFrameCount()

unsigned int GetKeyFrameCount ( ) const

inherited

Return the number of key frames in the animation.

Returns

The number of keyframes

GetKeyFramesAtTime()

double GetKeyFramesAtTime ( double  _time, KeyFrame **  _kf1, KeyFrame **  _kf2, unsigned int &  _firstKeyIndex  ) const

protectedinherited

Get the two key frames that bound a time value.

Parameters

[in]	_time	The time in seconds
[out]	_kf1	Lower bound keyframe that is returned
[out]	_kf2	Upper bound keyframe that is returned
[out]	_firstKeyIndex	Index of the lower bound key frame

Returns

The time between the two keyframe

GetLength()

double GetLength ( ) const

inherited

Return the duration of the animation.

Returns

Duration of the animation in seconds

GetTime()

double GetTime ( ) const

inherited

Return the current time position.

Returns

The time position in seconds

SetLength()

void SetLength ( double  _len )

inherited

Set the duration of the animation.

Parameters

[in]

_len

The length of the animation in seconds

SetTime()

void SetTime ( double  _time )

inherited

Set the current time position of the animation.

Parameters

[in]

_time

The time position in seconds

Member Data Documentation

build

bool build

mutableprotectedinherited

determines if the interpolation splines need building

keyFrames

KeyFrame_V keyFrames

protectedinherited

array of key frames

length

double length

protectedinherited

animation duration

loop

bool loop

protectedinherited

true if animation repeats

name

std::string name

protectedinherited

animation name

timePos

double timePos

protectedinherited

current time position

---

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

• Animation.hh