Public Member Functions | List of all members
ignition::math::IntervalCubicSpline Class Reference

Cubic interpolator for splines defined between each pair of control points. More...

#include <SplinePrivate.hh>

Public Member Functions

 IntervalCubicSpline ()
 Dummy constructor. More...
 
double ArcLength () const
 Gets curve arc length. More...
 
double ArcLength (const double _t) const
 Gets curve arc length up to a given point _t. More...
 
const ControlPointEndPoint () const
 Gets the end control point. More...
 
Vector3d InterpolateMthDerivative (const unsigned int _mth, const double _t) const
 Interpolates the curve mth derivative at parameter value _t. More...
 
void SetPoints (const ControlPoint &_startPoint, const ControlPoint &_endPoint)
 Sets both control points. More...
 
const ControlPointStartPoint () const
 Gets the start control point. More...
 

Detailed Description

Cubic interpolator for splines defined between each pair of control points.

Constructor & Destructor Documentation

§ IntervalCubicSpline()

ignition::math::IntervalCubicSpline::IntervalCubicSpline ( )

Dummy constructor.

Member Function Documentation

§ ArcLength() [1/2]

double ignition::math::IntervalCubicSpline::ArcLength ( ) const
inline

Gets curve arc length.

Returns
the arc length

§ ArcLength() [2/2]

double ignition::math::IntervalCubicSpline::ArcLength ( const double  _t) const

Gets curve arc length up to a given point _t.

Parameters
[in]_tparameter value (range 0 to 1).
Returns
the arc length up to _t or INF on error.

§ EndPoint()

const ControlPoint& ignition::math::IntervalCubicSpline::EndPoint ( ) const
inline

Gets the end control point.

Returns
the end control point.

§ InterpolateMthDerivative()

Vector3d ignition::math::IntervalCubicSpline::InterpolateMthDerivative ( const unsigned int  _mth,
const double  _t 
) const

Interpolates the curve mth derivative at parameter value _t.

Parameters
[in]_mthorder of curve derivative to interpolate.
[in]_tparameter value (range 0 to 1).
Returns
the interpolated mth derivative, or [INF, INF, INF] on error. Use Vector3d::IsFinite() to check for an error.

§ SetPoints()

void ignition::math::IntervalCubicSpline::SetPoints ( const ControlPoint _startPoint,
const ControlPoint _endPoint 
)

Sets both control points.

Parameters
[in]_startPointstart control point.
[in]_endPointend control point.

§ StartPoint()

const ControlPoint& ignition::math::IntervalCubicSpline::StartPoint ( ) const
inline

Gets the start control point.

Returns
the start control point.

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