Struct CubicCardinalSpline 

pub struct CubicCardinalSpline<P: VectorSpace> {
    pub tension: f32,
    pub control_points: Vec<P>,
}

A spline interpolated continuously across the nearest four control points, with the position of the curve specified at every control point and the tangents computed automatically. The associated CubicCurve has one segment between each pair of adjacent control points.

Note the Catmull-Rom spline is a special case of Cardinal spline where the tension is 0.5.

Interpolation

The curve passes through every control point.

Tangency

Tangents are automatically computed based on the positions of control points.

Continuity

The curve is at minimum C1, meaning that it is continuous (it has no holes or jumps), and its tangent vector is also well-defined everywhere, without sudden jumps.

Parametrization

The first segment of the curve connects the first two control points, the second connects the second and third, and so on. This remains true when a cyclic curve is formed with to_curve_cyclic, in which case the final curve segment connects the last control point to the first.

Usage

let points = [
    vec2(-1.0, -20.0),
    vec2(3.0, 2.0),
    vec2(5.0, 3.0),
    vec2(9.0, 8.0),
];
let cardinal = CubicCardinalSpline::new(0.3, points).to_curve().unwrap();
let positions: Vec<_> = cardinal.iter_positions(100).collect();

Fields

tension: f32

Tension

control_points: Vec<P>

The control points of the Cardinal spline

Implementations

impl<P: VectorSpace> CubicCardinalSpline<P>

pub fn new(tension: f32, control_points: impl IntoIterator<Item = P>) -> Self

Build a new Cardinal spline.

pub fn new_catmull_rom(control_points: impl IntoIterator<Item = P>) -> Self

Build a new Catmull-Rom spline, the special case of a Cardinal spline where tension = 1/2.

Trait Implementations

impl<P: Clone + VectorSpace> Clone for CubicCardinalSpline<P>

fn clone(&self) -> CubicCardinalSpline<P>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: VectorSpace<Scalar = f32>> CubicGenerator<P> for CubicCardinalSpline<P>

Available on crate feature alloc only.

type Error = InsufficientDataError

An error type indicating why construction might fail.

fn to_curve(&self) -> Result<CubicCurve<P>, Self::Error>

Build a CubicCurve by computing the interpolation coefficients for each curve segment.

impl<P: VectorSpace<Scalar = f32>> CyclicCubicGenerator<P> for CubicCardinalSpline<P>

Available on crate feature alloc only.

type Error = InsufficientDataError

An error type indicating why construction might fail.

fn to_curve_cyclic(&self) -> Result<CubicCurve<P>, Self::Error>

Build a cyclic CubicCurve by computing the interpolation coefficients for each curve segment, treating the control data as cyclic so that the result is a closed curve.

impl<P: Debug + VectorSpace> Debug for CubicCardinalSpline<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.