Struct avian3d::dynamics::sleeping::SleepingPlugin

pub struct SleepingPlugin;

Manages sleeping and waking for bodies, automatically deactivating them to save computational resources.

Bodies are marked as Sleeping when their linear and angular velocities are below the SleepingThreshold for a duration indicated by DeactivationTime.

Bodies are woken up when an active body or constraint interacts with them, or when gravity changes, or when the body’s position, rotation, velocity, or external forces are changed.

This plugin does not handle constraints waking up bodies. That is done by the solver.

The sleeping systems run in PhysicsStepSet::Sleeping.

Trait Implementations

impl Plugin for SleepingPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.