Public Member Functions | Protected Attributes | List of all members
gazebo::common::PoseKeyFrame Class Reference

A keyframe for a PoseAnimation. More...

#include <KeyFrame.hh>

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

Public Member Functions

 PoseKeyFrame (double _time)
 Constructor. More...
 
virtual ~PoseKeyFrame ()
 Destructor. More...
 
math::Quaternion GetRotation () const GAZEBO_DEPRECATED(6.0)
 Get the rotation of the keyframe. More...
 
math::Vector3 GetTranslation () const GAZEBO_DEPRECATED(6.0)
 Get the translation of the keyframe. More...
 
void Rotation (const ignition::math::Quaterniond &_rot)
 Set the rotation for the keyframe. More...
 
ignition::math::Quaterniond Rotation () const
 Get the rotation of the keyframe. More...
 
void SetRotation (const math::Quaternion &_rot) GAZEBO_DEPRECATED(6.0)
 Set the rotation for the keyframe. More...
 
void SetTranslation (const math::Vector3 &_trans) GAZEBO_DEPRECATED(6.0)
 Set the translation for the keyframe. More...
 
void Translation (const ignition::math::Vector3d &_trans)
 Set the translation for the keyframe. More...
 
ignition::math::Vector3d Translation () const
 Get the translation of the keyframe. More...
 
- Public Member Functions inherited from gazebo::common::KeyFrame
 KeyFrame (double _time)
 Constructor. More...
 
virtual ~KeyFrame ()
 Destructor. More...
 
double GetTime () const
 Get the time of the keyframe. More...
 

Protected Attributes

ignition::math::Quaterniond rotate
 the rotation quaternion More...
 
ignition::math::Vector3d translate
 the translation vector More...
 
- Protected Attributes inherited from gazebo::common::KeyFrame
double time
 time of key frame More...
 

Detailed Description

A keyframe for a PoseAnimation.

Constructor & Destructor Documentation

gazebo::common::PoseKeyFrame::PoseKeyFrame ( double  _time)

Constructor.

Parameters
[in]_timeof the keyframe
virtual gazebo::common::PoseKeyFrame::~PoseKeyFrame ( )
virtual

Destructor.

Member Function Documentation

math::Quaternion gazebo::common::PoseKeyFrame::GetRotation ( ) const

Get the rotation of the keyframe.

Returns
The rotation amount
Deprecated:
See Rotation function that returns ignition::math
math::Vector3 gazebo::common::PoseKeyFrame::GetTranslation ( ) const

Get the translation of the keyframe.

Returns
The translation amount
Deprecated:
See Translation function that returns igntion::math
void gazebo::common::PoseKeyFrame::Rotation ( const ignition::math::Quaterniond &  _rot)

Set the rotation for the keyframe.

Parameters
[in]_rotRotation amount
ignition::math::Quaterniond gazebo::common::PoseKeyFrame::Rotation ( ) const

Get the rotation of the keyframe.

Returns
The rotation amount
void gazebo::common::PoseKeyFrame::SetRotation ( const math::Quaternion _rot)

Set the rotation for the keyframe.

Parameters
[in]_rotRotation amount
Deprecated:
See Rotation function that accepts ignition::math
void gazebo::common::PoseKeyFrame::SetTranslation ( const math::Vector3 _trans)

Set the translation for the keyframe.

Parameters
[in]_transTranslation amount
Deprecated:
See Translation function that accepts ignition::math
void gazebo::common::PoseKeyFrame::Translation ( const ignition::math::Vector3d &  _trans)

Set the translation for the keyframe.

Parameters
[in]_transTranslation amount
ignition::math::Vector3d gazebo::common::PoseKeyFrame::Translation ( ) const

Get the translation of the keyframe.

Returns
The translation amount

Member Data Documentation

ignition::math::Quaterniond gazebo::common::PoseKeyFrame::rotate
protected

the rotation quaternion

ignition::math::Vector3d gazebo::common::PoseKeyFrame::translate
protected

the translation vector


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