Struct CubicCurve

pub struct CubicCurve<P>
where
    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> CubicCurve<P>

where P: VectorSpace<Scalar = f32>,

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

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>( &'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.

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

Adds a segment to the curve

Trait Implementations

impl<P> Clone for CubicCurve<P>

where P: Clone + VectorSpace,

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> Debug for CubicCurve<P>

where P: Debug + VectorSpace,

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

Formats the value using the given formatter.

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

where P: VectorSpace,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = CubicSegment<P>>,

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> From<CubicCurve<P>> for RationalCurve<P>

where P: VectorSpace,

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

Converts to this type from the input type.

impl<P> FromReflect for CubicCurve<P>

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

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<CubicCurve<P>>

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 CubicCurve<P>

where P: VectorSpace + TypePath, CubicCurve<P>: Any + Send + Sync, Vec<CubicSegment<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> IntoIterator for CubicCurve<P>

where P: VectorSpace,

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) -> <CubicCurve<P> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<P> PartialEq for CubicCurve<P>

where P: PartialEq + VectorSpace,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<P> PartialReflect for CubicCurve<P>

where P: VectorSpace + TypePath, CubicCurve<P>: Any + Send + Sync, Vec<CubicSegment<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 try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> 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<CubicCurve<P>>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<CubicCurve<P>>, ) -> 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 + 'static)>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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

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

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<P> Reflect for CubicCurve<P>

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

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

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 CubicCurve<P>

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

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

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 + 'static)>

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 + 'static)>

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 + 'static)>

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 to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

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

Will return None if TypeInfo is not available.

impl<P> TypePath for CubicCurve<P>

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

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 CubicCurve<P>

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<P> StructuralPartialEq for CubicCurve<P>

where P: VectorSpace,