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 Into<Vec<P>>) -> Self

Build a new Cardinal spline.

pub fn new_catmull_rom(control_points: impl Into<Vec<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 copy of the value.

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

Performs copy-assignment from source.

impl<P: VectorSpace> CubicGenerator<P> for CubicCardinalSpline<P>

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> CyclicCubicGenerator<P> for CubicCardinalSpline<P>

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.

impl<P> FromReflect for CubicCardinalSpline<P>

where CubicCardinalSpline<P>: Any + Send + Sync, P: TypePath + VectorSpace, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<P>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<P> GetTypeRegistration for CubicCardinalSpline<P>

where CubicCardinalSpline<P>: Any + Send + Sync, P: TypePath + VectorSpace, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<P>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<P> PartialReflect for CubicCardinalSpline<P>

where CubicCardinalSpline<P>: Any + Send + Sync, P: TypePath + VectorSpace, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<P>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<P> Reflect for CubicCardinalSpline<P>

where CubicCardinalSpline<P>: Any + Send + Sync, P: TypePath + VectorSpace, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<P>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl<P> Struct for CubicCardinalSpline<P>

where CubicCardinalSpline<P>: Any + Send + Sync, P: TypePath + VectorSpace, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<P>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl<P> TypePath for CubicCardinalSpline<P>

where CubicCardinalSpline<P>: Any + Send + Sync, P: TypePath + VectorSpace,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<P> Typed for CubicCardinalSpline<P>

where CubicCardinalSpline<P>: Any + Send + Sync, P: TypePath + VectorSpace, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<P>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.