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,
    /* private fields */
}

Controls when a body goes to sleep (becomes inactive to save CPU).

Sleeping System

Bodies automatically sleep when they’re at rest, dramatically improving performance in scenes with many inactive objects. Sleeping bodies are:

• Excluded from simulation (no collision detection, no velocity integration)
• Automatically woken when disturbed (hit by moving object, connected via joint)
• Woken manually with body.wake_up() or islands.wake_up()

When to disable sleeping

Most bodies should sleep! Only disable if the body needs to stay active despite being still:

• Bodies you frequently query for raycasts/contacts
• Bodies with time-based behaviors while stationary

Use RigidBodyBuilder::can_sleep(false) or RigidBodyActivation::cannot_sleep().

Fields

normalized_linear_threshold: f32

Velocity threshold for sleeping (scaled by length_unit).

Compared against the body’s farthest-point speed (|linvel| + |angvel| * max_extent) and against its farthest-point displacement rate (so solver position corrections count as motion too). If negative, body never sleeps. Default: 0.05 units/second.

angular_threshold: f32

Angular velocity threshold for sleeping (radians/second).

For bodies with colliders, angular motion is folded into the point-velocity check of normalized_linear_threshold; this raw threshold only applies to collider-less bodies. If negative, body never sleeps. Default: 0.5 rad/s.

time_until_sleep: f32

How long the body must stay below the velocity threshold before sleeping (seconds).

Default: 0.5 seconds.

time_since_can_sleep: f32

Internal timer tracking how long body has been still.

sleeping: bool

Is this body currently sleeping?

Implementations

impl RigidBodyActivation

pub fn default_normalized_linear_threshold() -> f32

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

Default: 0.05 length units per second.

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.

Default: half a second.

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.

pub fn is_eligible_for_sleep(&self) -> bool

Does this body have a sufficiently low kinetic energy for a long enough duration to be eligible for sleeping?

Trait Implementations

impl Clone for RigidBodyActivation

fn clone(&self) -> RigidBodyActivation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RigidBodyActivation

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 StructuralPartialEq for RigidBodyActivation