Struct RopeJoint

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

A rope joint, limits the maximum distance between two bodies

Fields

data: GenericJoint

The underlying joint data.

Implementations

impl RopeJoint

pub fn new(max_dist: f32) -> Self

Creates a new rope 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 motor(&self, axis: JointAxis) -> Option<&JointMotor>

The motor affecting the joint’s translational degree of freedom.

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

Set the spring-like model used by the motor to reach the desired target velocity and position.

pub fn set_motor_velocity(&mut self, target_vel: f32, factor: f32) -> &mut Self

Sets the target velocity this motor needs to reach.

pub fn set_motor_position( &mut self, target_pos: f32, stiffness: f32, damping: f32, ) -> &mut Self

Sets the target angle this motor needs to reach.

pub fn set_motor( &mut self, target_pos: f32, target_vel: f32, stiffness: f32, damping: f32, ) -> &mut Self

Configure both the target angle and target velocity of the motor.

pub fn set_motor_max_force(&mut self, max_force: f32) -> &mut Self

Sets the maximum force the motor can deliver.

pub fn max_distance(&self) -> f32

The maximum distance allowed between the attached objects.

pub fn set_max_distance(&mut self, max_dist: f32) -> &mut Self

Sets the maximum allowed distance between the attached objects.

The max_dist must be strictly greater than 0.0.

Trait Implementations

impl Clone for RopeJoint

fn clone(&self) -> RopeJoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RopeJoint

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

Formats the value using the given formatter.

impl From<RopeJoint> for GenericJoint

fn from(val: RopeJoint) -> GenericJoint

Converts to this type from the input type.

impl PartialEq for RopeJoint

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

impl StructuralPartialEq for RopeJoint