Struct yoyo_physics::spring::Spring

pub struct Spring<T> where
    T: Float,  {
    pub from_value: T,
    pub to_value: T,
    pub stiffness: T,
    pub damping: T,
    pub mass: T,
    pub initial_velocity: T,
    pub allows_overdamping: bool,
    pub overshoot_clamping: bool,
}

This is a spring whose oscillation and velocity we can efficiently approximate.

Fields

from_value: T

Starting value of the animation.

to_value: T

Ending value of the animation.

stiffness: T

The spring stiffness coefficient.

damping: T

Defines how the spring's motion should be damped due to the forces of friction.

mass: T

The mass of the object attached to the end of the spring.

initial_velocity: T

The initial velocity (in units/ms) of the object attached to the spring.

allows_overdamping: bool

Whether or not the spring allows "overdamping" (a damping ratio > 1).

overshoot_clamping: bool

False when overshooting is allowed, true when it is not.

Trait Implementations

impl<T: Clone> Clone for Spring<T> where
    T: Float, 

pub fn clone(&self) -> Spring<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Spring<T> where
    T: Float, 

impl<T> Curve for Spring<T> where
    T: Float, 

type Value = T

This is the type that this curve operates on.

type Velocity = T

This is the type of velocity that this curve works with.

pub fn approximate(&self, time: f32) -> Approximation<T>

This function approximates a spring's oscillation and velocity at the given timestamp.

pub fn target(&self) -> T

This should return the target value of this curve.

impl<T: Debug> Debug for Spring<T> where
    T: Float, 

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

Formats the value using the given formatter.

impl<T> Default for Spring<T> where
    T: Float, 

pub fn default() -> Self

Returns the "default value" for a type.