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

A numeric animation. More...

#include <Animation.hh>

Inheritance diagram for gazebo::common::NumericAnimation:
Inheritance graph

Public Member Functions

 NumericAnimation (const std::string &_name, double _length, bool _loop)
virtual ~NumericAnimation ()
NumericKeyFrameCreateKeyFrame (double _time)
 Create a numeric keyframe at the given time.
void GetInterpolatedKeyFrame (NumericKeyFrame &_kf) const
 Get a keyframe using the animation's current time.
- Public Member Functions inherited from gazebo::common::Animation
 Animation (const std::string &_name, double _length, bool _loop)
virtual ~Animation ()
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.

Additional Inherited Members

- Protected Types inherited from gazebo::common::Animation
typedef std::vector< KeyFrame * > KeyFrame_V
 array of keyframe type alias
- Protected Member Functions inherited from gazebo::common::Animation
double GetKeyFramesAtTime (double _time, KeyFrame **_kf1, KeyFrame **_kf2, unsigned int &_firstKeyIndex) const
 Get the two key frames that bound a time value.
- Protected Attributes inherited from gazebo::common::Animation
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

A numeric animation.

Constructor & Destructor Documentation

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


[in]_nameString name of the animation. This should be unique.
[in]_lengthLength of the animation in seconds
[in]_loopTrue == loop the animation
virtual gazebo::common::NumericAnimation::~NumericAnimation ( )


Member Function Documentation

NumericKeyFrame* gazebo::common::NumericAnimation::CreateKeyFrame ( double  _time)

Create a numeric keyframe at the given time.

[in]_timeTime at which to create the keyframe
Pointer to the new keyframe
void gazebo::common::NumericAnimation::GetInterpolatedKeyFrame ( NumericKeyFrame _kf) const

Get a keyframe using the animation's current time.

[out]_kfNumericKeyFrame reference to hold the interpolated result

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