Struct SpringJointBuilder

pub struct SpringJointBuilder(pub SpringJoint);

A SpringJoint joint using the builder pattern.

This builds a spring-damper joint which applies a force proportional to the distance between two objects. See the documentation of SpringJoint for more information on its behavior.

Tuple Fields

0: SpringJoint

Implementations

impl SpringJointBuilder

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

Creates a new builder for spring joints.

This axis is expressed in the local-space of both rigid-bodies.

pub fn contacts_enabled(self, enabled: bool) -> Self

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

pub fn local_anchor1(self, anchor1: Point<f32>) -> Self

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

pub fn local_anchor2(self, anchor2: Point<f32>) -> Self

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

pub fn spring_model(self, model: MotorModel) -> Self

Set the spring used by this joint to reach the desired target velocity and position.

Setting this to MotorModel::ForceBased (which is the default value for this joint) makes the spring constants (stiffness and damping) parameter understood as in the regular spring-mass-damper system. With MotorModel::AccelerationBased, the spring constants will be automatically scaled by the attached masses, making the spring more mass-independent.

pub fn build(self) -> SpringJoint

Builds the spring joint.

Trait Implementations

impl Clone for SpringJointBuilder

fn clone(&self) -> SpringJointBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpringJointBuilder

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

Formats the value using the given formatter.

impl From<SpringJointBuilder> for GenericJoint

fn from(val: SpringJointBuilder) -> GenericJoint

Converts to this type from the input type.

impl PartialEq for SpringJointBuilder

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

impl StructuralPartialEq for SpringJointBuilder