Struct RigidBodyActivation

pub struct RigidBodyActivation {
    pub normalized_linear_threshold: f32,
    pub angular_threshold: f32,
    pub time_until_sleep: f32,
    pub time_since_can_sleep: f32,
    pub sleeping: bool,
}

The rb_activation status of a body.

This controls whether a body is sleeping or not. If the threshold is negative, the body never sleeps.

Fields

normalized_linear_threshold: f32

The threshold linear velocity below which the body can fall asleep.

The value is “normalized”, i.e., the actual threshold applied by the physics engine is equal to this value multiplied by IntegrationParameters::length_unit.

angular_threshold: f32

The angular linear velocity below which the body can fall asleep.

time_until_sleep: f32

The amount of time the rigid-body must remain below the thresholds to be put to sleep.

time_since_can_sleep: f32

Since how much time can this body sleep?

sleeping: bool

Is this body sleeping?

Implementations

impl RigidBodyActivation

pub fn default_normalized_linear_threshold() -> f32

The default linear velocity below which a body can be put to sleep.

pub fn default_angular_threshold() -> f32

The default angular velocity below which a body can be put to sleep.

pub fn default_time_until_sleep() -> f32

The amount of time the rigid-body must remain below it’s linear and angular velocity threshold before falling to sleep.

pub fn active() -> Self

Create a new rb_activation status initialised with the default rb_activation threshold and is active.

pub fn inactive() -> Self

Create a new rb_activation status initialised with the default rb_activation threshold and is inactive.

pub fn cannot_sleep() -> Self

Create a new activation status that prevents the rigid-body from sleeping.

pub fn is_active(&self) -> bool

Returns true if the body is not asleep.

pub fn wake_up(&mut self, strong: bool)

Wakes up this rigid-body.

pub fn sleep(&mut self)

Put this rigid-body to sleep.

Trait Implementations

impl Clone for RigidBodyActivation

fn clone(&self) -> RigidBodyActivation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RigidBodyActivation

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

Formats the value using the given formatter.

impl Default for RigidBodyActivation

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RigidBodyActivation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RigidBodyActivation

impl StructuralPartialEq for RigidBodyActivation