Struct SpringCollection 

pub struct SpringCollection<F, const N: usize> { /* private fields */ }

A fixed-size collection of springs that all share the same spring parameters. Useful for creating springs over multiple dimensions (i.e. 2D or 3D springs).

Implementations

impl<F: Float, const N: usize> SpringCollection<F, N>

pub fn from_equilibrium( params: impl Into<SpringParams<F>>, equilibrium: F, ) -> Self

Construct N springs, all starting at a specified equilibrium.

pub fn from_equilibriums( params: impl Into<SpringParams<F>>, equilibriums: [F; N], ) -> Self

Construct N springs, each with a particular equilibrium.

pub fn update(&mut self, delta: F)

Update all springs over the specified delta. Constructs a new SpringTimeStep for this usage.

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

Update all springs using the specified time_step.

Note: this time step need not be derived from SpringCollection::params. The implementation of this method uses all constants from time_step.

impl<F: Float, const N: usize> SpringCollection<F, N>

pub fn positions(&self) -> &[F; N]

The array of current spring $plural.

pub fn positions_mut(&mut self) -> &mut [F; N]

Mutable reference of current spring positions.

impl<F: Float, const N: usize> SpringCollection<F, N>

pub fn velocities(&self) -> &[F; N]

The array of current spring $plural.

pub fn velocities_mut(&mut self) -> &mut [F; N]

Mutable reference of current spring velocities.

impl<F: Float, const N: usize> SpringCollection<F, N>

pub fn equilibriums(&self) -> &[F; N]

The array of current spring $plural.

pub fn equilibriums_mut(&mut self) -> &mut [F; N]

Mutable reference of current spring equilibriums.

Trait Implementations

impl<F: Clone, const N: usize> Clone for SpringCollection<F, N>

fn clone(&self) -> SpringCollection<F, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug, const N: usize> Debug for SpringCollection<F, N>

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

Formats the value using the given formatter.

impl<F: Float, const N: usize> From<SpringCollection<F, N>> for [Spring<F>; N]

fn from(value: SpringCollection<F, N>) -> Self

Converts to this type from the input type.

impl<F: Float, const N: usize, T> From<T> for SpringCollection<F, N>

where T: Into<SpringParams<F>>,

fn from(params: T) -> Self

Converts to this type from the input type.

impl<F: PartialEq, const N: usize> PartialEq for SpringCollection<F, N>

fn eq(&self, other: &SpringCollection<F, N>) -> 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, const N: usize> StructuralPartialEq for SpringCollection<F, N>