Struct Spring 

pub struct Spring {
    pub config: SpringConfig,
    /* private fields */
}

A 1D damped harmonic oscillator spring.

Stack-allocated and no_std-compatible. Use SpringN<T> for multi-dimensional animation.

Example

use animato_spring::{Spring, SpringConfig};
use animato_core::Update;

let mut s = Spring::new(SpringConfig::stiff());
s.set_target(100.0);
for _ in 0..300 {
    s.update(1.0 / 60.0);
}
assert!((s.position() - 100.0).abs() < 0.01);

Fields

config: SpringConfig

The spring configuration (stiffness, damping, mass, epsilon).

Implementations

impl Spring

pub fn new(config: SpringConfig) -> Self

Create a new spring at position 0.0 with target 0.0.

pub fn from_velocity( initial: f32, velocity: f32, target: f32, config: SpringConfig, ) -> Self

Create a spring at initial, moving with velocity, toward target.

This is useful for fling-to-snap gestures where the release velocity should carry into the settling animation.

pub fn set_target(&mut self, target: f32)

Set the target position the spring moves toward.

pub fn position(&self) -> f32

Current position of the spring.

pub fn velocity(&self) -> f32

Current velocity of the spring.

pub fn is_settled(&self) -> bool

true when the spring has come to rest within epsilon of the target.

pub fn energy(&self) -> f32

Current kinetic plus potential energy.

This is useful for diagnostics and settle visualization. The units are simulation-relative rather than renderer-specific.

pub fn overshoot_count(&self) -> u32

Number of times the spring has crossed its target since the last target change.

pub fn snap_to(&mut self, pos: f32)

Teleport to pos instantly — no animation, velocity zeroed.

pub fn use_rk4(self, yes: bool) -> Self

Switch to RK4 integration (more accurate for high-stiffness springs).

Trait Implementations

impl Clone for Spring

fn clone(&self) -> Spring

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spring

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

Formats the value using the given formatter.

impl Inspectable for Spring

fn introspect(&self) -> AnimationIntrospection

Return a compact, allocation-free snapshot of the current animation state.

impl Update for Spring

fn update(&mut self, dt: f32) -> bool

Advance the spring by dt seconds.

Returns false when settled, true while still moving. Negative dt is treated as 0.0.