NumericAnimation Class Reference

A numeric animation. More...

#include <Animation.hh>

Public Member Functions
	NumericAnimation (const std::string &_name, const double _length, const bool _loop)
	Constructor.
NumericKeyFrame *	CreateKeyFrame (const double _time)
	Create a numeric keyframe at the given time.
void	InterpolatedKeyFrame (NumericKeyFrame &_kf) const
	Get a keyframe using the animation's current time.
Public Member Functions inherited from Animation
	Animation (const std::string &_name, const double _length, const bool _loop)
	Constructor.
void	AddTime (const double _time)
	Add time to the animation.
bool	InterpolateX () const
	Return the interpolateX value.
common::KeyFrame *	KeyFrame (const unsigned int _index) const
	Get a key frame using an index value.
unsigned int	KeyFrameCount () const
	Return the number of key frames in the animation.
double	Length () const
	Return the duration of the animation.
void	Length (const double _len)
	Set the duration of the animation.
void	SetInterpolateX (const bool _interpolateX)
	Set the interpolateX value.
double	Time () const
	Return the current time position.
void	Time (const double _time)
	Set the current time position of the animation.

Additional Inherited Members
Protected Member Functions inherited from Animation
template<typename KeyFrameType >
KeyFrameType *	CreateKeyFrame (const double _time)
	Create a keyframe at the given time.
double	KeyFramesAtTime (double _time, common::KeyFrame **_kf1, common::KeyFrame **_kf2, unsigned int &_firstKeyIndex) const
	Get the two key frames that bound a time value.

Detailed Description

A numeric animation.

Constructor & Destructor Documentation

NumericAnimation()

NumericAnimation	(	const std::string &	_name,
		const double	_length,
		const 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

Member Function Documentation

CreateKeyFrame()

NumericKeyFrame * CreateKeyFrame

(

const 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

InterpolatedKeyFrame()

void InterpolatedKeyFrame

(

NumericKeyFrame &

_kf

)

const

Get a keyframe using the animation's current time.

Parameters

[out]

_kf

NumericKeyFrame reference to hold the interpolated result

---

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

• Animation.hh