Struct nphysics3d::object::RigidBodyDesc

pub struct RigidBodyDesc<N: RealField + Copy> { /* 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).

Implementations

impl<'a, N: RealField + Copy> RigidBodyDesc<N>

pub fn new() -> RigidBodyDesc<N>

A default rigid body builder.

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

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

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

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

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

pub fn rotation(self, axisangle: Vector<N>) -> Self

pub fn set_rotation(&mut self, axisangle: Vector<N>) -> &mut Self

pub fn kinematic_rotations(self, kinematic_rotations: Vector<bool>) -> Self

pub fn set_rotations_kinematic(
    &mut self,
    kinematic_rotations: Vector<bool>
) -> &mut Self

pub fn angular_inertia(self, angular_inertia: Matrix3<N>) -> Self

pub fn set_angular_inertia(&mut self, angular_inertia: Matrix3<N>) -> &mut Self

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn get_rotation(&self) -> Vector<N>

pub fn get_kinematic_rotations(&self) -> Vector<bool>

pub fn get_angular_inertia(&self) -> &Matrix3<N>

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

pub fn get_mass(&self) -> N

pub fn is_gravity_enabled(&self) -> bool

pub fn is_linear_motion_interpolation_enabled(&self) -> bool

pub fn get_status(&self) -> BodyStatus

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

pub fn get_linear_damping(&self) -> N

pub fn get_angular_damping(&self) -> N

pub fn get_max_linear_velocity(&self) -> N

pub fn get_max_angular_velocity(&self) -> N

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

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

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

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

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

Builds a rigid body from this description.

Trait Implementations

impl<N: Clone + RealField + Copy> Clone for RigidBodyDesc<N>

fn clone(&self) -> RigidBodyDesc<N>

Returns a copy of the value.

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

Performs copy-assignment from source.