RotationSpline Class Reference

List of all members.

Public Member Functions
void	AddPoint (const Quaternion &_p)
	Adds a control point to the end of the spline.
const Quaternion &	GetPoint (unsigned short _index) const
	Gets the detail of one of the control points of the spline.
unsigned int	GetNumPoints () const
	Gets the number of control points in the spline.
void	Clear ()
	Clears all the points in the spline.
void	UpdatePoint (unsigned short _index, const Quaternion &_value)
	Updates a single point in the spline.
Quaternion	Interpolate (double _t, bool _useShortestPath=true)
	Returns an interpolated point based on a parametric value over the whole series.
Quaternion	Interpolate (unsigned int _fromIndex, double _t, bool _useShortestPath=true)
	Interpolates a single segment of the spline given a parametric value.
void	SetAutoCalculate (bool _autoCalc)
	Tells the spline whether it should automatically calculate tangents on demand as points are added.
void	RecalcTangents ()
	Recalculates the tangents associated with this spline.
Protected Attributes
bool	autoCalc
std::vector< Quaternion >	points
std::vector< Quaternion >	tangents

---

Member Function Documentation

Quaternion 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:

t	Parametric value.
useShortestPath	Defines if rotation should take the shortest possible path

Quaternion Interpolate	(	unsigned int	_fromIndex,
		double	_t,
		bool	_useShortestPath = true
	)

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

Parameters:

fromIndex	The point index to treat as t=0. fromIndex + 1 is deemed to be t=1
t	Parametric value
useShortestPath	Defines if rotation should take the shortest possible path

void 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 SetAutoCalculate

(

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:

autoCalc

If true, tangents are calculated for you whenever a point changes. If false, you must call reclacTangents to recalculate them when it best suits.

void UpdatePoint	(	unsigned short	_index,
		const Quaternion &	_value
	)

Updates a single point in the spline.

Remarks:

This point must already exist in the spline.

---

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

• RotationSpline.hh