Skip to main content

JointDef

box2d_rust::types

Struct JointDef

pub struct JointDef {
    pub user_data: u64,
    pub body_id_a: BodyId,
    pub body_id_b: BodyId,
    pub local_frame_a: Transform,
    pub local_frame_b: Transform,
    pub force_threshold: f32,
    pub torque_threshold: f32,
    pub constraint_hertz: f32,
    pub constraint_damping_ratio: f32,
    pub draw_scale: f32,
    pub collide_connected: bool,
}

Expand description

Base joint definition used by all joint types. The local frames are measured from the body’s origin rather than the center of mass because:

you might not know where the center of mass will be
if you add/remove shapes from a body and recompute the mass, the joints will be broken

(b2JointDef)

Fields§

§user_data: u64

User data

§body_id_a: BodyId

The first attached body

§body_id_b: BodyId

The second attached body

§local_frame_a: Transform

The first local joint frame

§local_frame_b: Transform

The second local joint frame

§force_threshold: f32

Force threshold for joint events

§torque_threshold: f32

Torque threshold for joint events

§constraint_hertz: f32

Constraint hertz (advanced feature)

§constraint_damping_ratio: f32

Constraint damping ratio (advanced feature)

§draw_scale: f32

Debug draw scale

§collide_connected: bool

Set this flag to true if the attached bodies should collide

Trait Implementations§

impl Clone for JointDef

fn clone(&self) -> JointDef

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for JointDef

impl Debug for JointDef

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

Formats the value using the given formatter. Read more

impl PartialEq for JointDef

fn eq(&self, other: &JointDef) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl StructuralPartialEq for JointDef

Auto Trait Implementations§

impl Freeze for JointDef

impl RefUnwindSafe for JointDef

impl Send for JointDef

impl Sync for JointDef

impl Unpin for JointDef

impl UnsafeUnpin for JointDef

impl UnwindSafe for JointDef

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.