Rebel Fork Framework
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Urho3D::Spline Class Reference

Spline class to get a point on it based off the interpolation mode. More...

#include <Urho3D/Core/Spline.h>

Public Member Functions

 Spline ()
 Default constructor.
 
 Spline (InterpolationMode mode)
 Constructor setting interpolation mode.
 
 Spline (const ea::vector< Variant > &knots, InterpolationMode mode=BEZIER_CURVE)
 Constructor setting knots and interpolation mode.
 
 Spline (const Spline &rhs)=default
 Copy constructor.
 
Spline & operator= (const Spline &rhs)=default
 Copy operator.
 
bool operator== (const Spline &rhs) const
 Equality operator.
 
bool operator!= (const Spline &rhs) const
 Inequality operator.
 
InterpolationMode GetInterpolationMode () const
 
const VariantVector & GetKnots () const
 Return the knots of the spline.
 
Variant GetKnot (unsigned index) const
 
Variant GetPoint (float f) const
 Return the T of the point of the spline at f from 0.f - 1.f.
 
void SetInterpolationMode (InterpolationMode interpolationMode)
 
void SetKnots (const ea::vector< Variant > &knots)
 Set the knots of the spline.
 
void SetKnot (const Variant &knot, unsigned index)
 Set the value of an existing knot.
 
void AddKnot (const Variant &knot)
 Add a knot to the end of the spline.
 
void AddKnot (const Variant &knot, unsigned index)
 Add a knot to the spline at a specific index.
 
void RemoveKnot ()
 Remove the last knot on the spline.
 
void RemoveKnot (unsigned index)
 Remove the knot at the specific index.
 
void Clear ()
 Clear the spline.
 

Private Member Functions

Variant BezierInterpolation (const ea::vector< Variant > &knots, float t) const
 Perform Bezier interpolation on the spline.
 
Variant CatmullRomInterpolation (const ea::vector< Variant > &knots, float t) const
 Perform Spline interpolation on the spline.
 
Variant LinearInterpolation (const ea::vector< Variant > &knots, float t) const
 Perform linear interpolation on the spline.
 
Variant LinearInterpolation (const Variant &lhs, const Variant &rhs, float t) const
 Linear interpolation between two Variants based on underlying type.
 

Private Attributes

InterpolationMode interpolationMode_
 Interpolation mode.
 
VariantVector knots_
 Knots on the spline.
 

Detailed Description

Spline class to get a point on it based off the interpolation mode.

Member Function Documentation

◆ BezierInterpolation()

Variant Urho3D::Spline::BezierInterpolation ( const ea::vector< Variant > &  knots,
float  t 
) const
private

Perform Bezier interpolation on the spline.

◆ GetInterpolationMode()

InterpolationMode Urho3D::Spline::GetInterpolationMode ( ) const
inline

Return the interpolation mode.

◆ GetKnot()

Variant Urho3D::Spline::GetKnot ( unsigned  index) const
inline

Return the knot at the specific index.

◆ GetPoint()

Variant Urho3D::Spline::GetPoint ( float  f) const

Return the T of the point of the spline at f from 0.f - 1.f.

◆ SetInterpolationMode()

void Urho3D::Spline::SetInterpolationMode ( InterpolationMode  interpolationMode)
inline

Set the interpolation mode.

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