Struct rapier3d::dynamics::RigidBodyBuilder

#[must_use = "Builder functions return the updated builder"]
pub struct RigidBodyBuilder {
    pub position: Isometry<Real>,
    pub linvel: Vector<Real>,
    pub angvel: AngVector<Real>,
    pub gravity_scale: Real,
    pub linear_damping: Real,
    pub angular_damping: Real,
    pub mass_properties: MassProperties,
    pub can_sleep: bool,
    pub sleeping: bool,
    pub ccd_enabled: bool,
    pub dominance_group: i8,
    pub user_data: u128,
    // some fields omitted
}

A builder for rigid-bodies.

Fields

position: Isometry<Real>

The initial position of the rigid-body to be built.

linvel: Vector<Real>

The linear velocity of the rigid-body to be built.

angvel: AngVector<Real>

The angular velocity of the rigid-body to be built.

gravity_scale: Real

The scale factor applied to the gravity affecting the rigid-body to be built, 1.0 by default.

linear_damping: Real

Damping factor for gradually slowing down the translational motion of the rigid-body, 0.0 by default.

angular_damping: Real

Damping factor for gradually slowing down the angular motion of the rigid-body, 0.0 by default.

mass_properties: MassProperties

The additional mass properties of the rigid-body being built. See RigidBodyBuilder::additional_mass_properties for more information.

can_sleep: bool

Whether or not the rigid-body to be created can sleep if it reaches a dynamic equilibrium.

sleeping: bool

Whether or not the rigid-body is to be created asleep.

ccd_enabled: bool

Whether continuous collision-detection is enabled for the rigid-body to be built.

dominance_group: i8

The dominance group of the rigid-body to be built.

user_data: u128

An arbitrary user-defined 128-bit integer associated to the rigid-bodies built by this builder.

Implementations

impl RigidBodyBuilder

pub fn new(rb_type: RigidBodyType) -> Self

Initialize a new builder for a rigid body which is either static, dynamic, or kinematic.

pub fn new_static() -> Self

Initializes the builder of a new static rigid body.

pub fn new_kinematic_velocity_based() -> Self

Initializes the builder of a new kinematic rigid body.

pub fn new_kinematic_position_based() -> Self

Initializes the builder of a new kinematic rigid body.

pub fn new_dynamic() -> Self

Initializes the builder of a new dynamic rigid body.

pub fn gravity_scale(self, scale_factor: Real) -> Self

Sets the scale applied to the gravity force affecting the rigid-body to be created.

pub fn dominance_group(self, group: i8) -> Self

Sets the dominance group of this rigid-body.

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

Sets the initial translation of the rigid-body to be created.

pub fn rotation(self, angle: AngVector<Real>) -> Self

Sets the initial orientation of the rigid-body to be created.

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

Sets the initial position (translation and orientation) of the rigid-body to be created.

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

An arbitrary user-defined 128-bit integer associated to the rigid-bodies built by this builder.

pub fn additional_mass_properties(self, props: MassProperties) -> Self

Sets the additional mass properties of the rigid-body being built.

Note that “additional” means that the final mass properties of the rigid-bodies depends on the initial mass-properties of the rigid-body (set by this method) to which is added the contributions of all the colliders with non-zero density attached to this rigid-body.

Therefore, if you want your provided mass properties to be the final mass properties of your rigid-body, don’t attach colliders to it, or only attach colliders with densities equal to zero.

pub fn lock_translations(self) -> Self

Prevents this rigid-body from translating because of forces.

pub fn lock_rotations(self) -> Self

Prevents this rigid-body from rotating because of forces.

pub fn restrict_rotations(
    self,
    allow_rotations_x: bool,
    allow_rotations_y: bool,
    allow_rotations_z: bool
) -> Self

Only allow rotations of this rigid-body around specific coordinate axes.

pub fn additional_mass(self, mass: Real) -> Self

Sets the additional mass of the rigid-body being built.

This is only the “additional” mass because the total mass of the rigid-body is equal to the sum of this additional mass and the mass computed from the colliders (with non-zero densities) attached to this rigid-body.

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

👎 Deprecated:

renamed to additional_mass.

Sets the additional mass of the rigid-body being built.

This is only the “additional” mass because the total mass of the rigid-body is equal to the sum of this additional mass and the mass computed from the colliders (with non-zero densities) attached to this rigid-body.

pub fn additional_principal_angular_inertia(
    self,
    inertia: AngVector<Real>
) -> Self

Sets the additional principal angular inertia of this rigid-body.

This is only the “additional” angular inertia because the total angular inertia of the rigid-body is equal to the sum of this additional value and the angular inertia computed from the colliders (with non-zero densities) attached to this rigid-body.

pub fn principal_angular_inertia(self, inertia: AngVector<Real>) -> Self

👎 Deprecated:

renamed to additional_principal_angular_inertia.

Sets the principal angular inertia of this rigid-body.

pub fn principal_inertia(self, inertia: AngVector<Real>) -> Self

👎 Deprecated:

renamed to additional_principal_angular_inertia.

Use self.principal_angular_inertia instead.

pub fn linear_damping(self, factor: Real) -> Self

Sets the damping factor for the linear part of the rigid-body motion.

The higher the linear damping factor is, the more quickly the rigid-body will slow-down its translational movement.

pub fn angular_damping(self, factor: Real) -> Self

Sets the damping factor for the angular part of the rigid-body motion.

The higher the angular damping factor is, the more quickly the rigid-body will slow-down its rotational movement.

pub fn linvel(self, linvel: Vector<Real>) -> Self

Sets the initial linear velocity of the rigid-body to be created.

pub fn angvel(self, angvel: AngVector<Real>) -> Self

Sets the initial angular velocity of the rigid-body to be created.

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

Sets whether or not the rigid-body to be created can sleep if it reaches a dynamic equilibrium.

pub fn ccd_enabled(self, enabled: bool) -> Self

Sets whether or not continuous collision-detection is enabled for this rigid-body.

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

Sets whether or not the rigid-body is to be created asleep.

pub fn build(&self) -> RigidBody

Build a new rigid-body with the parameters configured with this builder.

Trait Implementations

impl Clone for RigidBodyBuilder

fn clone(&self) -> RigidBodyBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RigidBodyBuilder

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

Formats the value using the given formatter.

impl PartialEq<RigidBodyBuilder> for RigidBodyBuilder

fn eq(&self, other: &RigidBodyBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RigidBodyBuilder) -> bool

This method tests for !=.

impl StructuralPartialEq for RigidBodyBuilder