The LinearInterpolator class is a template class that implements Catmull-Rom spline interpolation. More...

#include <CatmullRomInterpolator.hpp>

Inheritance diagram for vl::CatmullRomInterpolator< T >:

Public Member Functions
	CatmullRomInterpolator ()

	CatmullRomInterpolator (const std::vector< T > &path)

void	setupEndPoints (bool is_loop)
	Call this function after having specified the control points if you want to automatically generate the start/end control points. More...

T	computePoint (float t) const
	Samples the Catmull-Rom spline at the given point. The `t` parameter must be in the range 0.0 ... 1.0 included. More...

void	setPath (const std::vector< T > &path)
	The control points defining the Catmull-Rom spline. More...

const std::vector< T > &	path () const
	The control points defining the Catmull-Rom spline. More...

std::vector< T > &	path ()
	The control points defining the Catmull-Rom spline. More...

Public Member Functions inherited from vl::Object
	Object ()
	Constructor. More...

	Object (const Object &other)
	Copy constructor: copies the name, ref count mutex and user data. More...

Object &	operator= (const Object &other)
	Copy operator: copies the object's name, ref count mutex and user data. More...

const std::string &	objectName () const
	The name of the object, by default set to the object's class name. More...

void	setObjectName (const char *name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setObjectName (const std::string &name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setRefCountMutex (IMutex *mutex)
	The mutex used to protect the reference counting of an Object across multiple threads. More...

IMutex *	refCountMutex ()
	The mutex used to protect the reference counting of an Object across multiple threads. More...

const IMutex *	refCountMutex () const
	The mutex used to protect the reference counting of an Object across multiple threads. More...

int	referenceCount () const
	Returns the number of references of an object. More...

void	incReference () const
	Increments the reference count of an object. More...

void	decReference ()
	Decrements the reference count of an object and deletes it if both automaticDelete() is `true` the count reaches 0. More...

void	setAutomaticDelete (bool autodel_on)
	If set to true the Object is deleted when its reference count reaches 0. More...

bool	automaticDelete () const
	If set to true the Object is deleted when its reference count reaches 0. More...

template<class T >
T *	as ()
	Casts an Object to the specified class. More...

template<class T >
const T *	as () const
	Casts an Object to the specified class. More...

Protected Attributes
std::vector< T >	mPath

std::vector< T >	mCatmullRomSpline

Protected Attributes inherited from vl::Object
std::string	mObjectName

IMutex *	mRefCountMutex

int	mReferenceCount

bool	mAutomaticDelete

Additional Inherited Members
Protected Member Functions inherited from vl::Object
virtual	~Object ()

Detailed Description

template<typename T>
class vl::CatmullRomInterpolator< T >

The LinearInterpolator class is a template class that implements Catmull-Rom spline interpolation.

Catmull-Rom spline interpolation allows smoother interpolations than simple linear interpolation, is thus indicated for example when you want to smoothly interpolate from one position to another or from one color to another.

See also: LinearInterpolator, Interpolator and the Interpolators Tutorial page.

Definition at line 46 of file CatmullRomInterpolator.hpp.

Constructor & Destructor Documentation

◆ CatmullRomInterpolator() [1/2]

template<typename T >

vl::CatmullRomInterpolator< T >::CatmullRomInterpolator ( )

inline

Definition at line 51 of file CatmullRomInterpolator.hpp.

◆ CatmullRomInterpolator() [2/2]

template<typename T >

vl::CatmullRomInterpolator< T >::CatmullRomInterpolator ( const std::vector< T > & path )

inline

Definition at line 56 of file CatmullRomInterpolator.hpp.

Member Function Documentation

◆ computePoint()

template<typename T >

T vl::CatmullRomInterpolator< T >::computePoint ( float t ) const

inline

Samples the Catmull-Rom spline at the given point. The t parameter must be in the range 0.0 ... 1.0 included.

Definition at line 96 of file CatmullRomInterpolator.hpp.

References vl::clamp(), vl::CatmullRomInterpolator< T >::mCatmullRomSpline, and VL_CHECK.

◆ path() [1/2]

template<typename T >

const std::vector<T>& vl::CatmullRomInterpolator< T >::path ( ) const

inline

The control points defining the Catmull-Rom spline.

Definition at line 133 of file CatmullRomInterpolator.hpp.

References vl::CatmullRomInterpolator< T >::mPath.

Referenced by vl::CatmullRomInterpolator< T >::setPath().

◆ path() [2/2]

template<typename T >

std::vector<T>& vl::CatmullRomInterpolator< T >::path ( )

inline

The control points defining the Catmull-Rom spline.

Definition at line 136 of file CatmullRomInterpolator.hpp.

References vl::CatmullRomInterpolator< T >::mPath.

◆ setPath()

template<typename T >

void vl::CatmullRomInterpolator< T >::setPath ( const std::vector< T > & path )

inline

The control points defining the Catmull-Rom spline.

Because of the Catmull-Rom formula the interpolated path must start and end with an extra control point (one on each side) and cannot have less than 4 control points. You can also automatically generate such extra control points by calling the setupEndPoints() method.

Definition at line 130 of file CatmullRomInterpolator.hpp.

References vl::CatmullRomInterpolator< T >::mPath, and vl::CatmullRomInterpolator< T >::path().