Struct SpringCoefficients 

pub struct SpringCoefficients<N> {
    pub natural_frequency: N,
    pub damping_ratio: N,
}

Coefficients for a spring, typically used for configuring constraint softness for contacts and joints.

Fields

natural_frequency: N

Sets the natural frequency (Hz) of the spring-like constraint.

Higher values make the constraint stiffer and resolve constraint violations more quickly.

damping_ratio: N

Sets the damping ratio for the spring-like constraint.

Larger values make the joint more compliant (allowing more drift before stabilization).

Implementations

impl<N: SimdRealField<Element = f32> + Copy> SpringCoefficients<N>

pub fn new(natural_frequency: N, damping_ratio: N) -> Self

Initializes spring coefficients from the spring natural frequency and damping ratio.

pub fn contact_defaults() -> Self

Default softness coefficients for contacts.

pub fn joint_defaults() -> Self

Default softness coefficients for joints.

pub fn angular_frequency(&self) -> N

The contact’s spring angular frequency for constraints regularization.

pub fn erp_inv_dt(&self, dt: N) -> N

The Self::erp coefficient, multiplied by the inverse timestep length.

pub fn erp(&self, dt: N) -> N

The effective Error Reduction Parameter applied for calculating regularization forces.

This parameter is computed automatically from Self::natural_frequency, Self::damping_ratio and the substep length.

pub fn cfm_coeff(&self, dt: N) -> N

Compute CFM assuming a critically damped spring multiplied by the damping ratio.

This coefficient softens the impulse applied at each solver iteration.

pub fn cfm_factor(&self, dt: N) -> N

The CFM factor to be used in the constraint resolution.

This parameter is computed automatically from Self::natural_frequency, Self::damping_ratio and the substep length.

Trait Implementations

impl<N: Clone> Clone for SpringCoefficients<N>

fn clone(&self) -> SpringCoefficients<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for SpringCoefficients<N>

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

Formats the value using the given formatter.

impl<N: PartialEq> PartialEq for SpringCoefficients<N>

fn eq(&self, other: &SpringCoefficients<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<N: Copy> Copy for SpringCoefficients<N>

impl<N> StructuralPartialEq for SpringCoefficients<N>