Struct MotorJointDef 

pub struct MotorJointDef { /* private fields */ }

Builder for a Box3D motor joint.

A motor joint drives relative linear and angular velocity between two bodies, with optional spring controls for position-style correction.

Implementations

impl MotorJointDef

pub fn raw(&self) -> &b3MotorJointDef

Returns the raw Box3D definition backing this builder.

pub fn body_ids(self, body_a: BodyId, body_b: BodyId) -> Self

Sets the two bodies connected by the joint.

pub fn local_frame_a(self, frame: Transform) -> Self

Sets the local constraint frame on body A.

Box3D measures joint local frames from each body’s origin, not from its center of mass. This keeps the joint stable when body shapes are later added, removed, or have mass recomputed.

pub fn local_frame_b(self, frame: Transform) -> Self

Sets the local constraint frame on body B.

Box3D measures joint local frames from each body’s origin, not from its center of mass.

pub fn collide_connected(self, collide_connected: bool) -> Self

Controls whether the connected bodies may collide with each other.

pub fn force_threshold(self, threshold: f32) -> Self

Sets the force threshold, in newtons, used to emit joint events.

pub fn torque_threshold(self, threshold: f32) -> Self

Sets the torque threshold, in newton-meters, used to emit joint events.

pub fn constraint_tuning(self, tuning: JointTuning) -> Self

Sets the common constraint frequency and damping ratio.

The frequency is in hertz and the damping ratio is dimensionless.

pub fn draw_scale(self, draw_scale: f32) -> Self

Sets the scale used by native debug drawing for this joint.

pub unsafe fn raw_user_data(self, user_data: *mut c_void) -> Self

Sets the raw Box3D userData pointer on this joint definition.

Safety

The caller must ensure the pointer remains valid for every native Box3D use and must not rely on boxddd to manage, alias-check, or drop the pointed-to value.

impl MotorJointDef

pub fn new(body_a: BodyId, body_b: BodyId) -> Self

Creates a motor joint definition for two bodies.

pub fn linear_velocity(self, velocity: impl Into<Vec3>) -> Self

Sets the desired relative linear velocity.

pub fn angular_velocity(self, velocity: impl Into<Vec3>) -> Self

Sets the desired relative angular velocity.

pub fn max_velocity_force(self, force: f32) -> Self

Sets the maximum force, in newtons, applied to reach the target linear velocity.

pub fn max_velocity_torque(self, torque: f32) -> Self

Sets the maximum torque, in newton-meters, applied to reach the target angular velocity.

Trait Implementations

impl Clone for MotorJointDef

fn clone(&self) -> MotorJointDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MotorJointDef

impl Debug for MotorJointDef

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

Formats the value using the given formatter.

impl Default for MotorJointDef

fn default() -> Self

Returns the “default value” for a type.