Struct bevy_math::cubic_splines::RationalCurve
source · pub struct RationalCurve<P: VectorSpace> {
pub segments: Vec<RationalSegment<P>>,
}
Expand description
A collection of RationalSegment
s chained into a single parametric curve.
Use any struct that implements the RationalGenerator
trait to create a new curve, such as
CubicNurbs
, or convert CubicCurve
using into/from
.
Fields§
§segments: Vec<RationalSegment<P>>
The segments in the curve
Implementations§
source§impl<P: VectorSpace> RationalCurve<P>
impl<P: VectorSpace> RationalCurve<P>
sourcepub fn position(&self, t: f32) -> P
pub fn position(&self, t: f32) -> P
Compute the position of a point on the curve at the parametric value t
.
Note that t
varies from 0..=(n_points - 3)
.
sourcepub fn velocity(&self, t: f32) -> P
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 curve at t
.
Note that t
varies from 0..=(n_points - 3)
.
sourcepub fn acceleration(&self, t: f32) -> P
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 curve at t
.
Note that t
varies from 0..=(n_points - 3)
.
sourcepub fn iter_samples<'a, 'b: 'a>(
&'b self,
subdivisions: usize,
sample_function: impl FnMut(&Self, f32) -> P + 'a
) -> impl Iterator<Item = P> + 'a
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.
sourcepub fn segments(&self) -> &[RationalSegment<P>]
pub fn segments(&self) -> &[RationalSegment<P>]
The list of segments contained in this RationalCurve
.
This spline’s global t
value is equal to how many segments it has.
All method accepting t
on RationalCurve
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()
.
sourcepub fn iter_positions(
&self,
subdivisions: usize
) -> impl Iterator<Item = P> + '_
pub fn iter_positions( &self, subdivisions: usize ) -> impl Iterator<Item = P> + '_
Iterate over the curve split into subdivisions
, sampling the position at each step.
sourcepub fn iter_velocities(
&self,
subdivisions: usize
) -> impl Iterator<Item = P> + '_
pub fn iter_velocities( &self, subdivisions: usize ) -> impl Iterator<Item = P> + '_
Iterate over the curve split into subdivisions
, sampling the velocity at each step.
sourcepub fn iter_accelerations(
&self,
subdivisions: usize
) -> impl Iterator<Item = P> + '_
pub fn iter_accelerations( &self, subdivisions: usize ) -> impl Iterator<Item = P> + '_
Iterate over the curve split into subdivisions
, sampling the acceleration at each step.
sourcepub fn push_segment(&mut self, segment: RationalSegment<P>)
pub fn push_segment(&mut self, segment: RationalSegment<P>)
Adds a segment to the curve.
Trait Implementations§
source§impl<P: Clone + VectorSpace> Clone for RationalCurve<P>
impl<P: Clone + VectorSpace> Clone for RationalCurve<P>
source§fn clone(&self) -> RationalCurve<P>
fn clone(&self) -> RationalCurve<P>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<P: Debug + VectorSpace> Debug for RationalCurve<P>
impl<P: Debug + VectorSpace> Debug for RationalCurve<P>
source§impl<P: VectorSpace> Extend<RationalSegment<P>> for RationalCurve<P>
impl<P: VectorSpace> Extend<RationalSegment<P>> for RationalCurve<P>
source§fn extend<T: IntoIterator<Item = RationalSegment<P>>>(&mut self, iter: T)
fn extend<T: IntoIterator<Item = RationalSegment<P>>>(&mut self, iter: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl<P: VectorSpace> From<CubicCurve<P>> for RationalCurve<P>
impl<P: VectorSpace> From<CubicCurve<P>> for RationalCurve<P>
source§fn from(value: CubicCurve<P>) -> Self
fn from(value: CubicCurve<P>) -> Self
source§impl<P> FromReflect for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
impl<P> FromReflect for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
source§fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl<P> GetTypeRegistration for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
impl<P> GetTypeRegistration for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl<P: VectorSpace> IntoIterator for RationalCurve<P>
impl<P: VectorSpace> IntoIterator for RationalCurve<P>
§type IntoIter = <Vec<RationalSegment<P>> as IntoIterator>::IntoIter
type IntoIter = <Vec<RationalSegment<P>> as IntoIterator>::IntoIter
§type Item = RationalSegment<P>
type Item = RationalSegment<P>
source§impl<P: PartialEq + VectorSpace> PartialEq for RationalCurve<P>
impl<P: PartialEq + VectorSpace> PartialEq for RationalCurve<P>
source§fn eq(&self, other: &RationalCurve<P>) -> bool
fn eq(&self, other: &RationalCurve<P>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<P> Reflect for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
impl<P> Reflect for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl<P> Struct for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
impl<P> Struct for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
name
as a
&mut dyn Reflect
.source§fn field_at(&self, index: usize) -> Option<&dyn Reflect>
fn field_at(&self, index: usize) -> Option<&dyn Reflect>
index
as a
&dyn Reflect
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl<P> TypePath for RationalCurve<P>
impl<P> TypePath for RationalCurve<P>
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl<P> Typed for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
impl<P> Typed for RationalCurve<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<RationalSegment<P>>: FromReflect + TypePath + RegisterForReflection,
impl<P: VectorSpace> StructuralPartialEq for RationalCurve<P>
Auto Trait Implementations§
impl<P> Freeze for RationalCurve<P>
impl<P> RefUnwindSafe for RationalCurve<P>where
P: RefUnwindSafe,
impl<P> Send for RationalCurve<P>where
P: Send,
impl<P> Sync for RationalCurve<P>where
P: Sync,
impl<P> Unpin for RationalCurve<P>where
P: Unpin,
impl<P> UnwindSafe for RationalCurve<P>where
P: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more