Struct bevy_rapier2d::prelude::PrismaticJoint[−][src]

pub struct PrismaticJoint {Show fields
    pub local_anchor1: Point<f32, 2_usize>,
    pub local_anchor2: Point<f32, 2_usize>,
    pub impulse: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>,
    pub limits_enabled: bool,
    pub limits: [f32; 2],
    pub limits_impulse: f32,
    pub motor_target_vel: f32,
    pub motor_target_pos: f32,
    pub motor_stiffness: f32,
    pub motor_damping: f32,
    pub motor_max_impulse: f32,
    pub motor_impulse: f32,
    pub motor_model: SpringModel,
    // some fields omitted
}

Expand description

A joint that removes all relative motion between two bodies, except for the translations along one axis.

Fields

local_anchor1: Point<f32, 2_usize>

Where the prismatic joint is attached on the first body, expressed in the local space of the first attached body.

local_anchor2: Point<f32, 2_usize>

Where the prismatic joint is attached on the second body, expressed in the local space of the second attached body.

impulse: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>

The impulse applied by this joint on the first body.

The impulse applied to the second body is given by -impulse.

limits_enabled: bool

Whether or not this joint should enforce translational limits along its axis.

limits: [f32; 2]

The min an max relative position of the attached bodies along this joint’s axis.

limits_impulse: f32

The impulse applied by this joint on the first body to enforce the position limit along this joint’s axis.

The impulse applied to the second body is given by -impulse.

motor_target_vel: f32

The target relative angular velocity the motor will attempt to reach.

motor_target_pos: f32

The target relative angle along the joint axis the motor will attempt to reach.

motor_stiffness: f32

The motor’s stiffness. See the documentation of SpringModel for more information on this parameter.

motor_damping: f32

The motor’s damping. See the documentation of SpringModel for more information on this parameter.

motor_max_impulse: f32

The maximal impulse the motor is able to deliver.

motor_impulse: f32

The angular impulse applied by the motor.

motor_model: SpringModel

The spring-like model used by the motor to reach the target velocity and .

Implementations

impl PrismaticJoint[src]

pub fn new(
    local_anchor1: Point<f32, 2_usize>, 
    local_axis1: Unit<Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>>, 
    local_anchor2: Point<f32, 2_usize>, 
    local_axis2: Unit<Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>>
) -> PrismaticJoint

[src]

Creates a new prismatic joint with the given point of applications and axis, all expressed in the local-space of the affected bodies.

pub fn local_axis1(
    &self
) -> Unit<Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>>

[src]

The local axis of this joint, expressed in the local-space of the first attached body.

pub fn local_axis2(
    &self
) -> Unit<Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>>

[src]

The local axis of this joint, expressed in the local-space of the second attached body.

pub fn supports_simd_constraints(&self) -> bool[src]

Can a SIMD constraint be used for resolving this joint?

pub fn configure_motor_model(&mut self, model: SpringModel)[src]

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

pub fn configure_motor_velocity(&mut self, target_vel: f32, factor: f32)[src]

Sets the target velocity this motor needs to reach.

pub fn configure_motor_position(
    &mut self, 
    target_pos: f32, 
    stiffness: f32, 
    damping: f32
)

[src]

Sets the target position this motor needs to reach.

pub fn configure_motor(
    &mut self, 
    target_pos: f32, 
    target_vel: f32, 
    stiffness: f32, 
    damping: f32
)

[src]

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

Trait Implementations

impl Clone for PrismaticJoint[src]

pub fn clone(&self) -> PrismaticJoint[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl From<PrismaticJoint> for JointParams[src]

pub fn from(j: PrismaticJoint) -> JointParams[src]

Performs the conversion.

impl Copy for PrismaticJoint[src]

Auto Trait Implementations

impl RefUnwindSafe for PrismaticJoint

impl Send for PrismaticJoint

impl Sync for PrismaticJoint

impl Unpin for PrismaticJoint

impl UnwindSafe for PrismaticJoint

Blanket Implementations

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

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
    T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

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

[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> TypeData for T where
    T: 'static + Send + Sync + Clone,

pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> Component for T where
    T: 'static + Send + Sync,