[][src]Struct nphysics2d::joint::PrismaticJoint

pub struct PrismaticJoint<N: RealField> { /* fields omitted */ }

A unit joint that allows only one translational degree on freedom.

Methods

impl<N: RealField> PrismaticJoint<N>[src]

pub fn new(axis: Unit<Vector<N>>, offset: N) -> Self[src]

Create a new prismatic joint where the allowed traslation is defined along the provided axis.

The axis is expressed in the local coordinate system of the two multibody links attached to this joint.

pub fn offset(&self) -> N[src]

The relative displacement of the attached multibody links along the joint axis.

pub fn translation(&self) -> Translation<N>[src]

The relative translation of the attached multibody links along the joint axis.

pub fn min_offset(&self) -> Option<N>[src]

The lower limit of the relative displacement of the attached multibody links along the joint axis.

pub fn max_offset(&self) -> Option<N>[src]

The upper limit of the relative displacement of the attached multibody links along the joint axis.

pub fn disable_min_offset(&mut self)[src]

Disable the lower limit of the relative displacement of the attached multibody links along the joint axis.

pub fn disable_max_offset(&mut self)[src]

Disable the upper limit of the relative displacement of the attached multibody links along the joint axis.

pub fn enable_min_offset(&mut self, limit: N)[src]

Set the lower limit of the relative displacement of the attached multibody links along the joint axis.

pub fn enable_max_offset(&mut self, limit: N)[src]

Set the upper limit of the relative displacement of the attached multibody links along the joint axis.

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

Returns true if the joint motor is enabled.

pub fn enable_linear_motor(&mut self)[src]

Enable the joint motor.

pub fn disable_linear_motor(&mut self)[src]

Disable the joint motor.

pub fn desired_linear_motor_velocity(&self) -> N[src]

The desired relative velocity to be enforced by the joint motor.

pub fn set_desired_linear_motor_velocity(&mut self, vel: N)[src]

Set the desired relative velocity to be enforced by the joint motor.

pub fn max_linear_motor_force(&self) -> N[src]

The maximum force that can be output by the joint motor.

pub fn set_max_linear_motor_force(&mut self, force: N)[src]

Set the maximum force that can be output by the joint motor.

Trait Implementations

impl<N: RealField> Joint<N> for PrismaticJoint<N>[src]

fn nimpulses(&self) -> usize[src]

The maximum number of impulses needed by this joints for its constraints. Read more

impl<N: RealField> UnitJoint<N> for PrismaticJoint<N>[src]

impl<N: Clone + RealField> Clone for PrismaticJoint<N>[src]

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

Performs copy-assignment from source. Read more

impl<N: Copy + RealField> Copy for PrismaticJoint<N>[src]

impl<N: Debug + RealField> Debug for PrismaticJoint<N>[src]

Auto Trait Implementations

impl<N> Send for PrismaticJoint<N> where
    N: Scalar

impl<N> Unpin for PrismaticJoint<N> where
    N: Scalar + Unpin

impl<N> Sync for PrismaticJoint<N> where
    N: Scalar

impl<N> RefUnwindSafe for PrismaticJoint<N> where
    N: RefUnwindSafe + Scalar

impl<N> UnwindSafe for PrismaticJoint<N> where
    N: Scalar + UnwindSafe

Blanket Implementations

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

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.

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.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Downcast for T where
    T: Any

impl<T> Same<T> for T

type Output = T

Should always be Self

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

impl<T> Slottable for T where
    T: Copy
[src]