Skip to main content

WheelJointDef

Struct WheelJointDef 

Source
pub struct WheelJointDef(/* private fields */);
Expand description

Wheel (suspension) joint definition (maps to b2WheelJointDef).

Constrains motion along an axis with suspension (spring + damping) and optional motor around the wheel axis. Use with World::create_wheel_joint(_id) or World::wheel(...).build().

Implementations§

Source§

impl WheelJointDef

Source

pub fn new(base: JointBase) -> Self

Source

pub fn from_raw(raw: b2WheelJointDef) -> Self

Source

pub fn base(&self) -> JointBase

Source

pub fn spring_enabled(&self) -> bool

Source

pub fn spring_hertz(&self) -> f32

Source

pub fn spring_damping_ratio(&self) -> f32

Source

pub fn limit_enabled(&self) -> bool

Source

pub fn minimum_translation(&self) -> f32

Source

pub fn maximum_translation(&self) -> f32

Source

pub fn motor_enabled(&self) -> bool

Source

pub fn maximum_motor_torque(&self) -> f32

Source

pub fn target_motor_speed(&self) -> f32

Source

pub fn into_raw(self) -> b2WheelJointDef

Source

pub fn validate(&self) -> ApiResult<()>

Source

pub fn enable_spring(self, flag: bool) -> Self

Enable/disable suspension spring.

Source

pub fn hertz(self, v: f32) -> Self

Spring stiffness in Hertz.

Source

pub fn damping_ratio(self, v: f32) -> Self

Spring damping ratio [0,1].

Source

pub fn enable_limit(self, flag: bool) -> Self

Enable/disable translation limits.

Source

pub fn lower_translation(self, v: f32) -> Self

Lower translation limit (meters).

Source

pub fn upper_translation(self, v: f32) -> Self

Upper translation limit (meters).

Source

pub fn enable_motor(self, flag: bool) -> Self

Enable/disable wheel motor.

Source

pub fn max_motor_torque(self, v: f32) -> Self

Maximum motor torque (N·m).

Source

pub fn motor_speed(self, v: f32) -> Self

Motor speed (rad/s).

Source

pub fn motor_speed_deg(self, speed_deg_per_s: f32) -> Self

Convenience: motor speed in degrees/sec.

Trait Implementations§

Source§

impl Clone for WheelJointDef

Source§

fn clone(&self) -> WheelJointDef

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WheelJointDef

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.