Struct bevy::math::cubic_splines::CubicCurve

pub struct CubicCurve<P>
where
    P: Point,
{ /* private fields */ }

A collection of CubicSegments chained into a curve.

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

Implementations

impl<P> CubicCurve<P>

where P: Point,

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>( &'b self, subdivisions: usize, sample_function: impl FnMut(&CubicCurve<P>, f32) -> P + 'a ) -> impl Iterator<Item = P> + 'a

where 'b: '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.

Trait Implementations

impl<P> Clone for CubicCurve<P>

where P: Clone + Point,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Debug for CubicCurve<P>

where P: Debug + Point,

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

Formats the value using the given formatter.

impl<P> PartialEq for CubicCurve<P>

where P: PartialEq + Point,

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P> StructuralPartialEq for CubicCurve<P>

where P: Point,