All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
ignition::math::RotationSpline Class Reference

Spline for rotations. More...

#include <ignition/math/RotationSpline.hh>

Public Member Functions

 RotationSpline ()
 Constructor. Sets the autoCalc to true. More...
 
 ~RotationSpline ()
 Destructor. Nothing is done. More...
 
void AddPoint (const Quaterniond &_p)
 Adds a control point to the end of the spline. More...
 
void AutoCalculate (bool _autoCalc)
 Tells the spline whether it should automatically calculate tangents on demand as points are added. More...
 
void Clear ()
 Clears all the points in the spline. More...
 
Quaterniond Interpolate (double _t, bool _useShortestPath=true)
 Returns an interpolated point based on a parametric value over the whole series. More...
 
Quaterniond Interpolate (unsigned int _fromIndex, double _t, bool _useShortestPath=true)
 Interpolates a single segment of the spline given a parametric value. More...
 
const QuaterniondPoint (unsigned int _index) const
 Gets the detail of one of the control points of the spline. More...
 
unsigned int PointCount () const
 Gets the number of control points in the spline. More...
 
void RecalcTangents ()
 Recalculates the tangents associated with this spline. More...
 
void UpdatePoint (unsigned int _index, const Quaterniond &_value)
 Updates a single point in the spline. More...
 

Protected Attributes

bool autoCalc
 Automatic recalcultation of tangeants when control points are updated. More...
 
std::vector< Quaterniondpoints
 the control points More...
 
std::vector< Quaterniondtangents
 the tangents More...
 

Detailed Description

Spline for rotations.

Constructor & Destructor Documentation

ignition::math::RotationSpline::RotationSpline ( )

Constructor. Sets the autoCalc to true.

ignition::math::RotationSpline::~RotationSpline ( )

Destructor. Nothing is done.

Member Function Documentation

void ignition::math::RotationSpline::AddPoint ( const Quaterniond _p)

Adds a control point to the end of the spline.

Parameters
[in]_pcontrol point
void ignition::math::RotationSpline::AutoCalculate ( bool  _autoCalc)

Tells the spline whether it should automatically calculate tangents on demand as points are added.

Remarks
The spline calculates tangents at each point automatically based on the input points. Normally it does this every time a point changes. However, if you have a lot of points to add in one go, you probably don't want to incur this overhead and would prefer to defer the calculation until you are finished setting all the points. You can do this by calling this method with a parameter of 'false'. Just remember to manually call the recalcTangents method when you are done.
Parameters
[in]_autoCalcIf true, tangents are calculated for you whenever a point changes. If false, you must call reclacTangents to recalculate them when it best suits.
void ignition::math::RotationSpline::Clear ( )

Clears all the points in the spline.

Quaterniond ignition::math::RotationSpline::Interpolate ( double  _t,
bool  _useShortestPath = true 
)

Returns an interpolated point based on a parametric value over the whole series.

Remarks
Given a t value between 0 and 1 representing the parametric distance along the whole length of the spline, this method returns an interpolated point.
Parameters
[in]_tParametric value.
[in]_useShortestPathDefines if rotation should take the shortest possible path
Returns
the rotation
Quaterniond ignition::math::RotationSpline::Interpolate ( unsigned int  _fromIndex,
double  _t,
bool  _useShortestPath = true 
)

Interpolates a single segment of the spline given a parametric value.

Parameters
[in]_fromIndexThe point index to treat as t = 0. _fromIndex + 1 is deemed to be t = 1
[in]_tParametric value
[in]_useShortestPathDefines if rotation should take the shortest possible path
Exceptions
IndexExceptionif _fromIndex >= PointCount()
Returns
the rotation
const Quaterniond& ignition::math::RotationSpline::Point ( unsigned int  _index) const

Gets the detail of one of the control points of the spline.

Parameters
[in]_indexthe index of the control point.
Remarks
This point must already exist in the spline.
Exceptions
IndexExceptionif _index >= PointCount()
Returns
a quaternion (out of bound index result in assertion)
unsigned int ignition::math::RotationSpline::PointCount ( ) const

Gets the number of control points in the spline.

Returns
the count
void ignition::math::RotationSpline::RecalcTangents ( )

Recalculates the tangents associated with this spline.

Remarks
If you tell the spline not to update on demand by calling setAutoCalculate(false) then you must call this after completing your updates to the spline points.
void ignition::math::RotationSpline::UpdatePoint ( unsigned int  _index,
const Quaterniond _value 
)

Updates a single point in the spline.

Remarks
This point must already exist in the spline.
Parameters
[in]_indexindex
[in]_valuethe new control point value
Exceptions
IndexExceptionif _index >= PointCount()

Member Data Documentation

bool ignition::math::RotationSpline::autoCalc
protected

Automatic recalcultation of tangeants when control points are updated.

std::vector<Quaterniond> ignition::math::RotationSpline::points
protected

the control points

std::vector<Quaterniond> ignition::math::RotationSpline::tangents
protected

the tangents


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