Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::LinearInterpolator< T > Class Template Reference

The LinearInterpolator class is a template class that implements linear interpolation. More...

#include <LinearInterpolator.hpp>

+ Inheritance diagram for vl::LinearInterpolator< T >:

Public Member Functions

 LinearInterpolator ()
 
 LinearInterpolator (const std::vector< T > &path)
 
computePoint (float t) const
 Samples the path 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...
 
Objectoperator= (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...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () 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 > mLinearSpline
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

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

The LinearInterpolator class is a template class that implements linear interpolation.

See also
CatmullRomInterpolator, Interpolator and the Interpolators Tutorial page.

Definition at line 44 of file LinearInterpolator.hpp.

Constructor & Destructor Documentation

◆ LinearInterpolator() [1/2]

template<typename T >
vl::LinearInterpolator< T >::LinearInterpolator ( )
inline

Definition at line 49 of file LinearInterpolator.hpp.

◆ LinearInterpolator() [2/2]

template<typename T >
vl::LinearInterpolator< T >::LinearInterpolator ( const std::vector< T > &  path)
inline

Definition at line 54 of file LinearInterpolator.hpp.

Member Function Documentation

◆ computePoint()

template<typename T >
T vl::LinearInterpolator< T >::computePoint ( float  t) const
inline

Samples the path at the given point. The t parameter must be in the range 0.0 ... 1.0 included.

Definition at line 57 of file LinearInterpolator.hpp.

References vl::clamp(), and vl::LinearInterpolator< T >::mPath.

◆ path() [1/2]

template<typename T >
const std::vector<T>& vl::LinearInterpolator< T >::path ( ) const
inline

The control points defining the Catmull-Rom spline.

Definition at line 77 of file LinearInterpolator.hpp.

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

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

◆ path() [2/2]

template<typename T >
std::vector<T>& vl::LinearInterpolator< T >::path ( )
inline

The control points defining the Catmull-Rom spline.

Definition at line 79 of file LinearInterpolator.hpp.

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

◆ setPath()

template<typename T >
void vl::LinearInterpolator< 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.

Definition at line 75 of file LinearInterpolator.hpp.

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

Member Data Documentation

◆ mLinearSpline

template<typename T >
std::vector<T> vl::LinearInterpolator< T >::mLinearSpline
protected

Definition at line 83 of file LinearInterpolator.hpp.

◆ mPath

template<typename T >
std::vector<T> vl::LinearInterpolator< T >::mPath
protected

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