All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
gazebo::common::Animation Class Reference

Manages an animation, which is a collection of keyframes and the ability to interpolate between the keyframes. More...

#include <common/common.hh>

Inheritance diagram for gazebo::common::Animation:
Inheritance graph
[legend]

Public Member Functions

 Animation (const std::string &_name, double _length, bool _loop)
 Constructor.
 
virtual ~Animation ()
 Destructor.
 
void AddTime (double _time)
 Add time to the animation.
 
KeyFrameGetKeyFrame (unsigned int _index) const
 Get a key frame using an index value.
 
unsigned int GetKeyFrameCount () const
 Return the number of key frames in the animation.
 
double GetLength () const
 Return the duration of the animation.
 
double GetTime () const
 Return the current time position.
 
void SetLength (double _len)
 Set the duration of the animation.
 
void SetTime (double _time)
 Set the current time position of the animation.
 

Protected Types

typedef std::vector< KeyFrame * > KeyFrame_V
 array of keyframe type alias
 

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.
 

Protected Attributes

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

Detailed Description

Manages an animation, which is a collection of keyframes and the ability to interpolate between the keyframes.

Member Typedef Documentation

typedef std::vector<KeyFrame*> gazebo::common::Animation::KeyFrame_V
protected

array of keyframe type alias

Constructor & Destructor Documentation

gazebo::common::Animation::Animation ( const std::string &  _name,
double  _length,
bool  _loop 
)

Constructor.

Parameters
[in]_nameName of the animation, should be unique
[in]_lengthDuration of the animation in seconds
[in]_loopSet to true if the animation should repeat
virtual gazebo::common::Animation::~Animation ( )
virtual

Destructor.

Member Function Documentation

void gazebo::common::Animation::AddTime ( double  _time)

Add time to the animation.

Parameters
[in]_timeThe amount of time to add in seconds
KeyFrame* gazebo::common::Animation::GetKeyFrame ( unsigned int  _index) const

Get a key frame using an index value.

Parameters
[in]_indexThe index of the key frame
Returns
A pointer the keyframe, NULL if the _index is invalid
unsigned int gazebo::common::Animation::GetKeyFrameCount ( ) const

Return the number of key frames in the animation.

Returns
The number of keyframes
double gazebo::common::Animation::GetKeyFramesAtTime ( double  _time,
KeyFrame **  _kf1,
KeyFrame **  _kf2,
unsigned int &  _firstKeyIndex 
) const
protected

Get the two key frames that bound a time value.

Parameters
[in]_timeThe time in seconds
[out]_kf1Lower bound keyframe that is returned
[out]_kf2Upper bound keyframe that is returned
[out]_firstKeyIndexIndex of the lower bound key frame
Returns
The time between the two keyframe
double gazebo::common::Animation::GetLength ( ) const

Return the duration of the animation.

Returns
Duration of the animation in seconds
double gazebo::common::Animation::GetTime ( ) const

Return the current time position.

Returns
The time position in seconds
void gazebo::common::Animation::SetLength ( double  _len)

Set the duration of the animation.

Parameters
[in]_lenThe length of the animation in seconds
void gazebo::common::Animation::SetTime ( double  _time)

Set the current time position of the animation.

Parameters
[in]_timeThe time position in seconds

Member Data Documentation

bool gazebo::common::Animation::build
mutableprotected

determines if the interpolation splines need building

KeyFrame_V gazebo::common::Animation::keyFrames
protected

array of key frames

double gazebo::common::Animation::length
protected

animation duration

bool gazebo::common::Animation::loop
protected

true if animation repeats

std::string gazebo::common::Animation::name
protected

animation name

double gazebo::common::Animation::timePos
protected

current time position


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