[][src]Struct nphysics2d::object::RigidBodyDesc

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

The description of a rigid body, used to build a new RigidBody.

This is the structure to use in order to create and add a rigid body (as well as some attached colliders) to the World. It follows the builder pattern and defines three kinds of methods:

  • Methods with the .with_ prefix: sets a property of self and returns Self itself.
  • Methods with the .set_prefix: sets a property of &mut self and retuns the &mut self pointer.
  • The build method: actually build the rigid body into the given World and returns a mutable reference to the newly created rigid body. The build methods takes self by-ref so the same RigidBodyDesc can be re-used (possibly modified) to build other rigid bodies.

The .with_ methods as well as the .set_ method are designed to support chaining. Because the .with_ methods takes self by-move, it is useful to use when initializing the RigidBodyDesc for the first time. The .set_ methods are useful when modifying it after this initialization (including after calls to .build).

Methods

impl<'a, N: RealField> RigidBodyDesc<N>[src]

pub fn new() -> RigidBodyDesc<N>[src]

A default rigid body builder.

pub fn user_data(self, data: impl UserData) -> Self[src]

Sets a user-data to be attached to the object being built.

pub fn set_user_data(&mut self, data: Option<impl UserData>) -> &mut Self[src]

Sets the user-data to be attached to the object being built.

pub fn get_user_data(&self) -> Option<&(dyn Any + Send + Sync)>[src]

Reference to the user-data to be attached to the object being built.

pub fn rotation(self, angle: N) -> Self[src]

pub fn set_rotation(&mut self, angle: N) -> &mut Self[src]

pub fn kinematic_rotations(self, is_kinematic: bool) -> Self[src]

pub fn set_rotations_kinematic(&mut self, is_kinematic: bool) -> &mut Self[src]

pub fn angular_inertia(self, angular_inertia: N) -> Self[src]

pub fn set_angular_inertia(&mut self, angular_inertia: N) -> &mut Self[src]

pub fn translation(self, vector: Vector<N>) -> Self[src]

pub fn set_translation(&mut self, vector: Vector<N>) -> &mut Self[src]

pub fn mass(self, mass: N) -> Self[src]

pub fn set_mass(&mut self, mass: N) -> &mut Self[src]

pub fn gravity_enabled(self, gravity_enabled: bool) -> Self[src]

pub fn enable_gravity(&mut self, gravity_enabled: bool) -> &mut Self[src]

pub fn linear_motion_interpolation_enabled(
    self,
    linear_motion_interpolation_enabled: bool
) -> Self
[src]

pub fn enable_linear_motion_interpolation(
    &mut self,
    linear_motion_interpolation_enabled: bool
) -> &mut Self
[src]

pub fn status(self, status: BodyStatus) -> Self[src]

pub fn set_status(&mut self, status: BodyStatus) -> &mut Self[src]

pub fn position(self, position: Isometry<N>) -> Self[src]

pub fn set_position(&mut self, position: Isometry<N>) -> &mut Self[src]

pub fn velocity(self, velocity: Velocity<N>) -> Self[src]

pub fn set_velocity(&mut self, velocity: Velocity<N>) -> &mut Self[src]

pub fn linear_damping(self, linear_damping: N) -> Self[src]

pub fn set_linear_damping(&mut self, linear_damping: N) -> &mut Self[src]

pub fn angular_damping(self, angular_damping: N) -> Self[src]

pub fn set_angular_damping(&mut self, angular_damping: N) -> &mut Self[src]

pub fn max_linear_velocity(self, max_linear_velocity: N) -> Self[src]

pub fn set_max_linear_velocity(&mut self, max_linear_velocity: N) -> &mut Self[src]

pub fn max_angular_velocity(self, max_angular_velocity: N) -> Self[src]

pub fn set_max_angular_velocity(&mut self, max_angular_velocity: N) -> &mut Self[src]

pub fn local_inertia(self, local_inertia: Inertia<N>) -> Self[src]

pub fn set_local_inertia(&mut self, local_inertia: Inertia<N>) -> &mut Self[src]

pub fn local_center_of_mass(self, local_center_of_mass: Point<N>) -> Self[src]

pub fn set_local_center_of_mass(
    &mut self,
    local_center_of_mass: Point<N>
) -> &mut Self
[src]

pub fn sleep_threshold(self, sleep_threshold: Option<N>) -> Self[src]

pub fn set_sleep_threshold(&mut self, sleep_threshold: Option<N>) -> &mut Self[src]

pub fn kinematic_translations(
    self,
    kinematic_translations: Vector<bool>
) -> Self
[src]

pub fn set_translations_kinematic(
    &mut self,
    kinematic_translations: Vector<bool>
) -> &mut Self
[src]

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

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

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

pub fn get_translation(&self) -> &Vector<N>[src]

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

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

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

pub fn get_status(&self) -> BodyStatus[src]

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

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

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

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

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

pub fn get_position(&self) -> &Isometry<N>[src]

pub fn get_velocity(&self) -> &Velocity<N>[src]

pub fn get_local_inertia(&self) -> &Inertia<N>[src]

pub fn get_local_center_of_mass(&self) -> &Point<N>[src]

pub fn build(&self) -> RigidBody<N>[src]

Builds a rigid body from this description.

Trait Implementations

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

Auto Trait Implementations

impl<N> !RefUnwindSafe for RigidBodyDesc<N>

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

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

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

impl<N> !UnwindSafe for RigidBodyDesc<N>

Blanket Implementations

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

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

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

impl<T> Downcast for T where
    T: Any

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

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

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

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> 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<V, T> VZip<V> for T where
    V: MultiLane<T>,