Struct Spring 

pub struct Spring<Value> { /* private fields */ }

A finite physical spring between arbitrary interpolatable values.

Initial velocity is in endpoint distances per second. The default mass is one, stiffness 100, damping 10 and initial velocity zero. Duration is the conservative displacement-envelope settling time at threshold 0.001, rounded up to ticks. Values at/before zero and at/after duration are exact stored endpoints.

SpringBuilder::build validates the complete configuration at once. Nonfinite or nonpositive physical parameters, an unrepresentable response or settling time, and invalid thresholds are reported as errors. Zero damping is rejected because this type promises a finite settling duration. Use a signal for undamped oscillation.

use motion_core::prelude::*;
use motion_core::{
    DisplayList, RasterLimits, ResourceStore, ValidatedDisplayList, MAX_PATH_VERBS,
    MAX_STROKE_VERBS, MAX_SVG_PATH_BYTES, sample_offsets,
};
let movement = Spring::builder(Point::ORIGIN, Point::new(100.0, 40.0))
    .damping(20.0)
    .settling_threshold(0.0001)
    .build()?;
let end = movement.settle_duration();
assert_eq!(movement.sample(end.after_origin()), Point::new(100.0, 40.0));
assert_eq!(movement.sample(Time::ZERO - 1.seconds()), Point::ORIGIN);

Implementations

impl<Value> Spring<Value>

pub fn new(from: Value, to: Value) -> Self

Creates a spring with the default physical parameters and settling threshold.

pub fn builder(from: Value, to: Value) -> SpringBuilder<Value>

Starts a builder with the default physical parameters and settling threshold.

pub fn settle_duration(&self) -> Duration

Returns the conservative time at which the spring reaches its target exactly.

Trait Implementations

impl<Value: Clone> Clone for Spring<Value>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Value: Debug> Debug for Spring<Value>

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

Formats the value using the given formatter.

impl Default for Spring<f64>

fn default() -> Self

Returns the “default value” for a type.

impl<Value: Interpolate + Send + Sync> Signal<Value> for Spring<Value>

fn sample(&self, time: Time) -> Value

Samples without advancing a clock or changing playback state.

fn sample_at(&self, elapsed: Duration) -> Value

Samples elapsed after the time origin, shorthand for sample(elapsed.after_origin()).

fn map<Output, Function>(self, function: Function) -> Map<Self, Function, Value>

where Self: Sized, Function: Fn(Value) -> Output + Send + Sync,

Transforms values without changing timing.

fn zip<OtherValue, Other>(self, other: Other) -> Zip<Self, Other>

where Self: Sized, Other: Signal<OtherValue>,

Samples in parallel; the result is finite only if both inputs are finite.

fn boxed(self) -> Arc<dyn Signal<Value>>

where Self: Sized + 'static,

Shares a type-erased signal.