Struct bevy_math::cubic_splines::CubicBezier

pub struct CubicBezier<P: VectorSpace> {
    pub control_points: Vec<[P; 4]>,
}

A spline composed of a single cubic Bezier curve.

Useful for user-drawn curves with local control, or animation easing. See CubicSegment::new_bezier for use in easing.

Interpolation

The curve only passes through the first and last control point in each set of four points. The curve is divided into “segments” by every fourth control point.

Tangency

Tangents are manually defined by the two intermediate control points within each set of four points. You can think of the control points the curve passes through as “anchors”, and as the intermediate control points as the anchors displaced along their tangent vectors

Continuity

A Bezier curve is at minimum C0 continuous, meaning it has no holes or jumps. Each curve segment is C2, meaning the tangent vector changes smoothly between each set of four control points, but this doesn’t hold at the control points between segments. Making the whole curve C1 or C2 requires moving the intermediate control points to align the tangent vectors between segments, and can result in a loss of local control.

Usage

let points = [[
    vec2(-1.0, -20.0),
    vec2(3.0, 2.0),
    vec2(5.0, 3.0),
    vec2(9.0, 8.0),
]];
let bezier = CubicBezier::new(points).to_curve();
let positions: Vec<_> = bezier.iter_positions(100).collect();

Fields

control_points: Vec<[P; 4]>

The control points of the Bezier curve

Implementations

impl<P: VectorSpace> CubicBezier<P>

pub fn new(control_points: impl Into<Vec<[P; 4]>>) -> Self

Create a new cubic Bezier curve from sets of control points.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: VectorSpace> CubicGenerator<P> for CubicBezier<P>

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

Build a CubicCurve by computing the interpolation coefficients for each curve segment.

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

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

Formats the value using the given formatter.

impl<P> FromReflect for CubicBezier<P>

where Self: Any + Send + Sync, P: TypePath + VectorSpace, Vec<[P; 4]>: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<P> GetTypeRegistration for CubicBezier<P>

where Self: Any + Send + Sync, P: TypePath + VectorSpace, Vec<[P; 4]>: FromReflect + TypePath + 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> Reflect for CubicBezier<P>

where Self: Any + Send + Sync, P: TypePath + VectorSpace, Vec<[P; 4]>: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> 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<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

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

Applies a reflected value to this value.

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

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

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<P> Struct for CubicBezier<P>

where Self: Any + Send + Sync, P: TypePath + VectorSpace, Vec<[P; 4]>: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

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

Clones the struct into a DynamicStruct.

impl<P> TypePath for CubicBezier<P>

where Self: Any + Send + Sync, P: TypePath + VectorSpace,

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

where Self: Any + Send + Sync, P: TypePath + VectorSpace, Vec<[P; 4]>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.