Struct SpringConfig 

pub struct SpringConfig<F> { /* private fields */ }

Configuration options for a spring. Composed of its angular_freq and damping_ratio.

Implementations

impl<F: Float> SpringConfig<F>

pub fn new(angular_freq: F, damping_ratio: F) -> Self

Construct a new spring configuration. Constrains spring parameters to non-negative values.

pub fn angular_freq(&self) -> F

Returns the angular frequency of this spring config. Guaranteed to be at least zero.

pub fn damping_ratio(&self) -> F

Returns the damping ratio of this spring config. Guaranteed to be at least zero.

Trait Implementations

impl<F: Clone> Clone for SpringConfig<F>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for SpringConfig<F>

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

Formats the value using the given formatter.

impl<F: Float> From<SpringConfig<F>> for SpringParams<F>

fn from(_: SpringConfig<F>) -> Self

Converts to this type from the input type.

impl<F: PartialEq> PartialEq for SpringConfig<F>

fn eq(&self, other: &SpringConfig<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 SpringConfig<F>

impl<F> StructuralPartialEq for SpringConfig<F>