Struct SphericalJoint

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

A spherical joint, locks all relative translations between two bodies.

Fields

data: GenericJoint

The underlying joint data.

Implementations

impl SphericalJoint

pub fn new() -> Self

Creates a new spherical joint locking all relative translations between two bodies.

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 local_frame1(&self) -> &Isometry<f32>

Gets both the joint anchor and the joint’s reference orientation relative to the first rigid-body’s local-space.

pub fn set_local_frame1(&mut self, local_frame: Isometry<f32>) -> &mut Self

Sets both the joint anchor and the joint’s reference orientation relative to the first rigid-body’s local-space.

pub fn local_frame2(&self) -> &Isometry<f32>

Gets both the joint anchor and the joint’s reference orientation relative to the second rigid-body’s local-space.

pub fn set_local_frame2(&mut self, local_frame: Isometry<f32>) -> &mut Self

Sets both the joint anchor and the joint’s reference orientation relative to the second rigid-body’s local-space.

pub fn motor(&self, axis: JointAxis) -> Option<&JointMotor>

The motor affecting the joint’s rotational degree of freedom along the specified axis.

pub fn set_motor_model( &mut self, axis: JointAxis, 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, axis: JointAxis, target_vel: f32, factor: f32, ) -> &mut Self

Sets the target velocity this motor needs to reach.

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

Sets the target angle this motor needs to reach.

pub fn set_motor( &mut self, axis: JointAxis, 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, axis: JointAxis, max_force: f32, ) -> &mut Self

Sets the maximum force the motor can deliver along the specified axis.

pub fn limits(&self, axis: JointAxis) -> Option<&JointLimits<f32>>

The limit distance attached bodies can translate along the specified axis.

pub fn set_limits(&mut self, axis: JointAxis, limits: [f32; 2]) -> &mut Self

Sets the [min,max] limit angles attached bodies can translate along the joint’s principal axis.

Trait Implementations

impl Clone for SphericalJoint

fn clone(&self) -> SphericalJoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SphericalJoint

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

Formats the value using the given formatter.

impl Default for SphericalJoint

fn default() -> Self

Returns the “default value” for a type.

impl From<SphericalJoint> for GenericJoint

fn from(val: SphericalJoint) -> GenericJoint

Converts to this type from the input type.

impl PartialEq for SphericalJoint

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

impl StructuralPartialEq for SphericalJoint