Struct PrismaticJointBuilder

pub struct PrismaticJointBuilder(pub PrismaticJoint);

Create prismatic joints using the builder pattern.

A prismatic joint locks all relative motion except for translations along the joint’s principal axis.

Tuple Fields

0: PrismaticJoint

Implementations

impl PrismaticJointBuilder

pub fn new(axis: UnitVector<f32>) -> Self

Creates a new builder for prismatic 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 local_axis1(self, axis1: UnitVector<f32>) -> Self

Sets the principal axis of the joint, expressed in the local-space of the first rigid-body.

pub fn local_axis2(self, axis2: UnitVector<f32>) -> Self

Sets the principal axis of the joint, expressed in the local-space of the second rigid-body.

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

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

pub fn motor_velocity(self, target_vel: f32, factor: f32) -> Self

Sets the target velocity this motor needs to reach.

pub fn motor_position( self, target_pos: f32, stiffness: f32, damping: f32, ) -> Self

Sets the target angle this motor needs to reach.

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

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

pub fn motor_max_force(self, max_force: f32) -> Self

Sets the maximum force the motor can deliver.

pub fn limits(self, limits: [f32; 2]) -> Self

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

pub fn build(self) -> PrismaticJoint

Builds the prismatic joint.

Trait Implementations

impl Clone for PrismaticJointBuilder

fn clone(&self) -> PrismaticJointBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrismaticJointBuilder

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

Formats the value using the given formatter.

impl From<PrismaticJointBuilder> for GenericJoint

fn from(val: PrismaticJointBuilder) -> GenericJoint

Converts to this type from the input type.

impl PartialEq for PrismaticJointBuilder

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

impl StructuralPartialEq for PrismaticJointBuilder