Struct SpringJoint 

#[repr(transparent)]
pub struct SpringJoint {
    pub data: GenericJoint,
}

A spring joint that pulls/pushes two bodies toward a target distance (like a spring or shock absorber).

Springs apply force based on:

• Stiffness: How strong the spring force is (higher = stiffer spring)
• Damping: Resistance to motion (higher = less bouncy, settles faster)
• Rest length: The distance the spring “wants” to be

Use for:

• Suspension systems (vehicles, furniture)
• Bouncy connections
• Soft constraints between objects
• Procedural animation (following targets softly)

Technical note: Springs use implicit integration which adds some numerical damping. This means even zero-damping springs will eventually settle (more iterations = less damping).

Fields

data: GenericJoint

The underlying joint data.

Implementations

impl SpringJoint

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

Creates a new spring joint limiting the max distance between two bodies.

The max_dist must be strictly greater than 0.0.

pub fn data(&self) -> &GenericJoint

The underlying generic joint.

pub fn contacts_enabled(&self) -> bool

Are contacts between the attached rigid-bodies enabled?

pub fn set_contacts_enabled(&mut self, enabled: bool) -> &mut Self

Sets whether contacts between the attached rigid-bodies are enabled.

pub fn local_anchor1(&self) -> Point<f32>

The joint’s anchor, expressed in the local-space of the first rigid-body.

pub fn set_local_anchor1(&mut self, anchor1: Point<f32>) -> &mut Self

Sets the joint’s anchor, expressed in the local-space of the first rigid-body.

pub fn local_anchor2(&self) -> Point<f32>

The joint’s anchor, expressed in the local-space of the second rigid-body.

pub fn set_local_anchor2(&mut self, anchor2: Point<f32>) -> &mut Self

Sets the joint’s anchor, expressed in the local-space of the second rigid-body.

pub fn set_spring_model(&mut self, model: MotorModel) -> &mut Self

Sets whether spring constants are mass-dependent or mass-independent.

• MotorModel::ForceBased (default): Stiffness/damping are absolute values. Heavier objects will respond differently to the same spring constants.
• MotorModel::AccelerationBased: Spring constants auto-scale with mass. Objects of different masses behave more similarly.

Most users can ignore this and use the default.

Trait Implementations

impl Clone for SpringJoint

fn clone(&self) -> SpringJoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpringJoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpringJoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SpringJoint> for GenericJoint

fn from(val: SpringJoint) -> GenericJoint

Converts to this type from the input type.

impl PartialEq for SpringJoint

fn eq(&self, other: &SpringJoint) -> 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 Serialize for SpringJoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SpringJoint

impl StructuralPartialEq for SpringJoint