Struct CubicCurve 

pub struct CubicCurve<P: VectorSpace> { /* private fields */ }

A collection of CubicSegments chained into a single parametric curve. It is a Curve with domain [0, N], where N is its number of segments.

Use any struct that implements the CubicGenerator trait to create a new curve, such as CubicBezier.

Implementations

impl<P: VectorSpace<Scalar = f32>> CubicCurve<P>

pub fn from_segments( segments: impl IntoIterator<Item = CubicSegment<P>>, ) -> Option<Self>

Create a new curve from a collection of segments. If the collection of segments is empty, a curve cannot be built and None will be returned instead.

pub fn position(&self, t: f32) -> P

Compute the position of a point on the cubic curve at the parametric value t.

Note that t varies from 0..=(n_points - 3).

pub fn velocity(&self, t: f32) -> P

Compute the first derivative with respect to t at t. This is the instantaneous velocity of a point on the cubic curve at t.

Note that t varies from 0..=(n_points - 3).

pub fn acceleration(&self, t: f32) -> P

Compute the second derivative with respect to t at t. This is the instantaneous acceleration of a point on the cubic curve at t.

Note that t varies from 0..=(n_points - 3).

pub fn iter_samples<'a, 'b: 'a>( &'b self, subdivisions: usize, sample_function: impl FnMut(&Self, f32) -> P + 'a, ) -> impl Iterator<Item = P> + 'a

A flexible iterator used to sample curves with arbitrary functions.

This splits the curve into subdivisions of evenly spaced t values across the length of the curve from start (t = 0) to end (t = n), where n = self.segment_count(), returning an iterator evaluating the curve with the supplied sample_function at each t.

For subdivisions = 2, this will split the curve into two lines, or three points, and return an iterator with 3 items, the three points, one at the start, middle, and end.

pub fn segments(&self) -> &[CubicSegment<P>]

The list of segments contained in this CubicCurve.

This spline’s global t value is equal to how many segments it has.

All method accepting t on CubicCurve depends on the global t. When sampling over the entire curve, you should either use one of the iter_* methods or account for the segment count using curve.segments().len().

pub fn iter_positions( &self, subdivisions: usize, ) -> impl Iterator<Item = P> + '_

Iterate over the curve split into subdivisions, sampling the position at each step.

pub fn iter_velocities( &self, subdivisions: usize, ) -> impl Iterator<Item = P> + '_

Iterate over the curve split into subdivisions, sampling the velocity at each step.

pub fn iter_accelerations( &self, subdivisions: usize, ) -> impl Iterator<Item = P> + '_

Iterate over the curve split into subdivisions, sampling the acceleration at each step.

pub fn push_segment(&mut self, segment: CubicSegment<P>)

Adds a segment to the curve

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: VectorSpace<Scalar = f32>> Curve<P> for CubicCurve<P>

Available on crate feature alloc only.

fn domain(&self) -> Interval

The interval over which this curve is parametrized.

fn sample_unchecked(&self, t: f32) -> P

Sample a point on this curve at the parameter value t, extracting the associated value. This is the unchecked version of sampling, which should only be used if the sample time t is already known to lie within the curve’s domain.

fn sample(&self, t: f32) -> Option<T>

Sample a point on this curve at the parameter value t, returning None if the point is outside of the curve’s domain.

fn sample_clamped(&self, t: f32) -> T

Sample a point on this curve at the parameter value t, clamping t to lie inside the domain of the curve.

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

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

Formats the value using the given formatter.

impl<'de, P> Deserialize<'de> for CubicCurve<P>

where P: Deserialize<'de> + VectorSpace,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: VectorSpace> Extend<CubicSegment<P>> for CubicCurve<P>

Available on crate feature alloc only.

fn extend<T: IntoIterator<Item = CubicSegment<P>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<P: VectorSpace> From<CubicCurve<P>> for RationalCurve<P>

Available on crate feature alloc only.

fn from(value: CubicCurve<P>) -> Self

Converts to this type from the input type.

impl<P: VectorSpace> IntoIterator for CubicCurve<P>

Available on crate feature alloc only.

type IntoIter = <Vec<CubicSegment<P>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = CubicSegment<P>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<P: PartialEq + VectorSpace> PartialEq for CubicCurve<P>

fn eq(&self, other: &CubicCurve<P>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<P: VectorSpace<Scalar = f32>> SampleDerivative<P> for CubicCurve<P>

Available on crate feature alloc only.

fn sample_with_derivative_unchecked(&self, t: f32) -> WithDerivative<P>

Sample this curve at the parameter value t, extracting the associated value in addition to its derivative. This is the unchecked version of sampling, which should only be used if the sample time t is already known to lie within the curve’s domain.

fn sample_with_derivative(&self, t: f32) -> Option<WithDerivative<T>>

Sample this curve’s value and derivative at the parameter value t, returning None if the point is outside of the curve’s domain.

fn sample_with_derivative_clamped(&self, t: f32) -> WithDerivative<T>

Sample this curve’s value and derivative at the parameter value t, clamping t to lie inside the domain of the curve.

impl<P: VectorSpace<Scalar = f32>> SampleTwoDerivatives<P> for CubicCurve<P>

Available on crate feature alloc only.

fn sample_with_two_derivatives_unchecked(&self, t: f32) -> WithTwoDerivatives<P>

Sample this curve at the parameter value t, extracting the associated value in addition to two derivatives. This is the unchecked version of sampling, which should only be used if the sample time t is already known to lie within the curve’s domain.

fn sample_with_two_derivatives(&self, t: f32) -> Option<WithTwoDerivatives<T>>

Sample this curve’s value and two derivatives at the parameter value t, returning None if the point is outside of the curve’s domain.

fn sample_with_two_derivatives_clamped(&self, t: f32) -> WithTwoDerivatives<T>

Sample this curve’s value and two derivatives at the parameter value t, clamping t to lie inside the domain of the curve.

impl<P> Serialize for CubicCurve<P>

where P: Serialize + VectorSpace,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P: PartialEq + VectorSpace> StructuralPartialEq for CubicCurve<P>