Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

Ogre::SimpleSpline Class Reference

A very simple spline class which implements the Catmull-Rom class of splines. More...

#include <OgreSimpleSpline.h>

Collaboration diagram for Ogre::SimpleSpline:

[legend]List of all members.

Public Methods
	SimpleSpline ()
	~SimpleSpline ()
void	addPoint (const Vector3 &p)
	Adds a control point to the end of the spline.
const Vector3 &	getPoint (unsigned short index) const
	Gets the detail of one of the control points of the spline.
unsigned short	getNumPoints (void) const
	Gets the number of control points in the spline.
void	clear (void)
	Clears all the points in the spline.
void	updatePoint (unsigned short index, const Vector3 &value)
	Updates a single point in the spline.
Vector3	interpolate (Real t)
	Returns an interpolated point based on a parametric value over the whole series.
Vector3	interpolate (unsigned int fromIndex, Real t)
	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 (void)
	Recalculates the tangents associated with this spline.
Protected Attributes
bool	mAutoCalc
std::vector< Vector3 >	mPoints
std::vector< Vector3 >	mTangents
Matrix4	mCoeffs
	Matrix of coefficients.

Detailed Description

A very simple spline class which implements the Catmull-Rom class of splines.

Remarks:: Splines are bendy lines. You define a series of points, and the spline forms a smoother line between the points to eliminate the sharp angles.
Catmull-Rom splines are a specialisation of the general Hermite spline. With a Hermite spline, you define the start and end point of the line, and 2 tangents, one at the start of the line and one at the end. The Catmull-Rom spline simplifies this by just asking you to define a series of points, and the tangents are created for you.

Definition at line 47 of file OgreSimpleSpline.h.

Constructor & Destructor Documentation

Ogre::SimpleSpline::SimpleSpline ( )

Definition at line 35 of file OgreSimpleSpline.cpp.
References mAutoCalc, and mCoeffs.

Ogre::SimpleSpline::~SimpleSpline ( )

Definition at line 59 of file OgreSimpleSpline.cpp.

Member Function Documentation

void Ogre::SimpleSpline::addPoint ( const Vector3 & p )

Adds a control point to the end of the spline.

Definition at line 63 of file OgreSimpleSpline.cpp.
References mPoints, and recalcTangents().
Referenced by Ogre::AnimationTrack::buildInterpolationSplines().

void Ogre::SimpleSpline::clear ( void )

Clears all the points in the spline.

Definition at line 238 of file OgreSimpleSpline.cpp.
References mPoints, and mTangents.
Referenced by Ogre::AnimationTrack::buildInterpolationSplines().

unsigned short Ogre::SimpleSpline::getNumPoints ( void ) const

Gets the number of control points in the spline.

Definition at line 233 of file OgreSimpleSpline.cpp.
References mPoints.

const Vector3 & Ogre::SimpleSpline::getPoint ( unsigned short index ) const

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

Definition at line 226 of file OgreSimpleSpline.cpp.
References mPoints.

Vector3 Ogre::SimpleSpline::interpolate ( unsigned int fromIndex,

Real t

)

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

Definition at line 89 of file OgreSimpleSpline.cpp.
References mCoeffs, mPoints, mTangents, Ogre::Real, Ogre::Vector4::x, Ogre::Vector3::x, Ogre::Vector4::y, Ogre::Vector3::y, Ogre::Vector4::z, and Ogre::Vector3::z.

Vector3 Ogre::SimpleSpline::interpolate ( Real t )

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.

Definition at line 72 of file OgreSimpleSpline.cpp.
References mPoints, and Ogre::Real.
Referenced by Ogre::AnimationTrack::getInterpolatedKeyFrame().

void Ogre::SimpleSpline::recalcTangents ( void )

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.

Definition at line 155 of file OgreSimpleSpline.cpp.
References mPoints, and mTangents.
Referenced by addPoint(), Ogre::AnimationTrack::buildInterpolationSplines(), and updatePoint().

void Ogre::SimpleSpline::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.

Definition at line 255 of file OgreSimpleSpline.cpp.
References mAutoCalc.
Referenced by Ogre::AnimationTrack::buildInterpolationSplines().

void Ogre::SimpleSpline::updatePoint ( unsigned short index,

const Vector3 & value

)

Updates a single point in the spline.

Remarks:
This point must already exist in the spline.

Definition at line 244 of file OgreSimpleSpline.cpp.
References mPoints, and recalcTangents().

Member Data Documentation

bool Ogre::SimpleSpline::mAutoCalc [protected]

Definition at line 109 of file OgreSimpleSpline.h.
Referenced by setAutoCalculate(), and SimpleSpline().

Matrix4 Ogre::SimpleSpline::mCoeffs [protected]

Matrix of coefficients.

Definition at line 115 of file OgreSimpleSpline.h.
Referenced by interpolate(), and SimpleSpline().

std::vector<Vector3> Ogre::SimpleSpline::mPoints [protected]

Definition at line 111 of file OgreSimpleSpline.h.
Referenced by addPoint(), clear(), getNumPoints(), getPoint(), interpolate(), recalcTangents(), and updatePoint().

std::vector<Vector3> Ogre::SimpleSpline::mTangents [protected]

Definition at line 112 of file OgreSimpleSpline.h.
Referenced by clear(), interpolate(), and recalcTangents().

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

Ogre::SimpleSpline Class Reference

Public Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation