Struct bevy_math::cubic_splines::CubicNurbs
source · pub struct CubicNurbs<P: VectorSpace> {
pub control_points: Vec<P>,
pub weights: Vec<f32>,
pub knots: Vec<f32>,
}
Expand description
Non-uniform Rational B-Splines (NURBS) are a powerful generalization of the CubicBSpline
which can
represent a much more diverse class of curves (like perfect circles and ellipses).
§Non-uniformity
The ‘NU’ part of NURBS stands for “Non-Uniform”. This has to do with a parameter called ‘knots’. The knots are a non-decreasing sequence of floating point numbers. The first and last three pairs of knots control the behavior of the curve as it approaches its endpoints. The intermediate pairs each control the length of one segment of the curve. Multiple repeated knot values are called “knot multiplicity”. Knot multiplicity in the intermediate knots causes a “zero-length” segment, and can create sharp corners.
§Rationality
The ‘R’ part of NURBS stands for “Rational”. This has to do with NURBS allowing each control point to be assigned a weighting, which controls how much it affects the curve compared to the other points.
§Interpolation
The curve will not pass through the control points except where a knot has multiplicity four.
§Tangency
Tangents are automatically computed based on the position of control points.
§Continuity
When there is no knot multiplicity, the curve is C2 continuous, meaning it has no holes or jumps and the
tangent vector changes smoothly along the entire curve length. Like the CubicBSpline
, the acceleration
continuity makes it useful for camera paths. Knot multiplicity of 2 in intermediate knots reduces the
continuity to C2, and knot multiplicity of 3 reduces the continuity to C0. The curve is always at least
C0, meaning it has no jumps or holes.
§Usage
let points = [
vec2(-1.0, -20.0),
vec2(3.0, 2.0),
vec2(5.0, 3.0),
vec2(9.0, 8.0),
];
let weights = [1.0, 1.0, 2.0, 1.0];
let knots = [0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 5.0];
let nurbs = CubicNurbs::new(points, Some(weights), Some(knots))
.expect("NURBS construction failed!")
.to_curve();
let positions: Vec<_> = nurbs.iter_positions(100).collect();
Fields§
§control_points: Vec<P>
The control points of the NURBS
weights: Vec<f32>
Weights
knots: Vec<f32>
Knots
Implementations§
source§impl<P: VectorSpace> CubicNurbs<P>
impl<P: VectorSpace> CubicNurbs<P>
sourcepub fn new(
control_points: impl Into<Vec<P>>,
weights: Option<impl Into<Vec<f32>>>,
knots: Option<impl Into<Vec<f32>>>
) -> Result<Self, CubicNurbsError>
pub fn new( control_points: impl Into<Vec<P>>, weights: Option<impl Into<Vec<f32>>>, knots: Option<impl Into<Vec<f32>>> ) -> Result<Self, CubicNurbsError>
Build a Non-Uniform Rational B-Spline.
If provided, weights must be the same length as the control points. Defaults to equal weights.
If provided, the number of knots must be n + 4 elements, where n is the amount of control
points. Defaults to open uniform knots: Self::open_uniform_knots
. Knots cannot
all be equal.
At least 4 points must be provided, otherwise an error will be returned.
sourcepub fn uniform_knots(control_points: usize) -> Option<Vec<f32>>
pub fn uniform_knots(control_points: usize) -> Option<Vec<f32>>
Generates uniform knots that will generate the same curve as CubicBSpline
.
“Uniform” means that the difference between two subsequent knots is the same.
Will return None
if there are less than 4 control points.
sourcepub fn open_uniform_knots(control_points: usize) -> Option<Vec<f32>>
pub fn open_uniform_knots(control_points: usize) -> Option<Vec<f32>>
Generates open uniform knots, which makes the ends of the curve pass through the start and end points.
The start and end knots have multiplicity 4, and intermediate knots have multiplicity 0 and difference of 1.
Will return None
if there are less than 4 control points.
Trait Implementations§
source§impl<P: Clone + VectorSpace> Clone for CubicNurbs<P>
impl<P: Clone + VectorSpace> Clone for CubicNurbs<P>
source§fn clone(&self) -> CubicNurbs<P>
fn clone(&self) -> CubicNurbs<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 CubicNurbs<P>
impl<P: Debug + VectorSpace> Debug for CubicNurbs<P>
source§impl<P> FromReflect for CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: FromReflect + TypePath + RegisterForReflection,
impl<P> FromReflect for CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: 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 CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: FromReflect + TypePath + RegisterForReflection,
impl<P> GetTypeRegistration for CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: 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> RationalGenerator<P> for CubicNurbs<P>
impl<P: VectorSpace> RationalGenerator<P> for CubicNurbs<P>
source§fn to_curve(&self) -> RationalCurve<P>
fn to_curve(&self) -> RationalCurve<P>
RationalCurve
by computing the interpolation coefficients for each curve segment.source§impl<P> Reflect for CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: FromReflect + TypePath + RegisterForReflection,
impl<P> Reflect for CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: 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 CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: FromReflect + TypePath + RegisterForReflection,
impl<P> Struct for CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: 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 CubicNurbs<P>
impl<P> TypePath for CubicNurbs<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 CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: FromReflect + TypePath + RegisterForReflection,
impl<P> Typed for CubicNurbs<P>where
Self: Any + Send + Sync,
P: TypePath + VectorSpace,
Vec<P>: FromReflect + TypePath + RegisterForReflection,
Vec<f32>: FromReflect + TypePath + RegisterForReflection,
Auto Trait Implementations§
impl<P> Freeze for CubicNurbs<P>
impl<P> RefUnwindSafe for CubicNurbs<P>where
P: RefUnwindSafe,
impl<P> Send for CubicNurbs<P>where
P: Send,
impl<P> Sync for CubicNurbs<P>where
P: Sync,
impl<P> Unpin for CubicNurbs<P>where
P: Unpin,
impl<P> UnwindSafe for CubicNurbs<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