Struct SpringConfig 

pub struct SpringConfig {
    pub stiffness: f32,
    pub damping: f32,
    pub mass: f32,
}

The physical parameters of a damped harmonic oscillator.

stiffness and mass must be finite and positive. damping must be finite and non-negative.

Fields

stiffness: f32

The spring stiffness, conventionally written as $k$.

damping: f32

The viscous damping coefficient, conventionally written as $c$.

mass: f32

The moving mass, conventionally written as $m$.

Implementations

impl SpringConfig

pub const fn new(stiffness: f32, damping: f32, mass: f32) -> Self

Creates a spring from its physical parameters.

pub fn canonical(&self) -> (f32, f32)

Returns the natural angular frequency and damping ratio $(\omega_0, \zeta)$.

pub fn step( &self, state: SpringState, target: f32, delta_time: f32, ) -> SpringState

Advances a spring toward a target that remains fixed for delta_time.

This analytic step is independent of frame rate and preserves velocity, allowing an interrupted spring to be retargeted without restarting it.

pub fn step_ramp( &self, state: SpringState, target: f32, target_velocity: f32, delta_time: f32, ) -> SpringState

Advances a spring toward a target moving at a constant velocity.

A first-order hold avoids the frame-rate-dependent lag introduced by treating a dragged target as stationary between frames.

pub fn propagator(&self, delta_time: f32) -> [[f32; 2]; 2]

Returns the exact state-transition matrix for a constant target.

Materializing this matrix is useful when many springs share the same configuration and frame delta. A matrix must not be reused when the frame delta changes.

pub fn is_settled(&self, state: SpringState, target: f32, epsilon: f32) -> bool

Tests both displacement and velocity against a positional tolerance.

Velocity is compared with epsilon * natural_frequency, giving it the corresponding animated-units-per-second scale.

pub fn settle_time( &self, state: SpringState, target: f32, epsilon: f32, ) -> Duration

Returns a conservative time after which the spring remains settled.

An undamped spring has no finite settling time and returns Duration::MAX.

Trait Implementations

impl Clone for SpringConfig

fn clone(&self) -> SpringConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SpringConfig

impl Debug for SpringConfig

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

Formats the value using the given formatter.

impl PartialEq for SpringConfig

fn eq(&self, other: &SpringConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SpringConfig