Struct Spring 

pub struct Spring<F> {
    pub position: F,
    pub velocity: F,
    pub equilibrium: F,
}

An instance of a spring and its current physical properties, like its position, velocity, and target equilibrium.

Fields

position: F

velocity: F

equilibrium: F

Implementations

impl<F: Float> Spring<F>

pub fn new() -> Self

Create a new stable spring at position 0.

pub fn from_equilibrium(equilibrium: F) -> Self

Create a new spring from a start equilibrium.

pub fn with_position(self, position: F) -> Self

Builder function to set the spring’s position.

pub fn with_velocity(self, velocity: F) -> Self

Builder function to set the spring’s velocity.

pub fn with_equilibrium(self, equilibrium: F) -> Self

Builder function to set the spring’s equilibrium.

pub fn update(&mut self, time_step: SpringTimeStep<F>)

Update this spring using a pre-computed SpringTimeStep.

pub fn update_single(&mut self, state: SpringParams<F>, delta: F)

Update this spring (and this spring only) using a SpringParams and a delta time. Will internally create a SpringTimeStep for this call.

If you are updating multiple springs with the same properties, consider using SpringTimeStep::new and SpringTimeStep::update_many or create a SpringCollection.

Trait Implementations

impl<F: Clone> Clone for Spring<F>

fn clone(&self) -> Spring<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for Spring<F>

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

Formats the value using the given formatter.

impl<F: Float> Default for Spring<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: PartialEq> PartialEq for Spring<F>

fn eq(&self, other: &Spring<F>) -> 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<F: Copy> Copy for Spring<F>

impl<F> StructuralPartialEq for Spring<F>