Struct avian3d::prepare::PreparePlugin

pub struct PreparePlugin { /* private fields */ }

Runs systems at the start of each physics frame. Initializes rigid bodies and updates components.

• Adds missing rigid body components for entities with a RigidBody component
• Adds missing mass properties for entities with a RigidBody component
• Updates mass properties
• Clamps restitution coefficients between 0 and 1

The Transform component will be initialized based on Position or Rotation and vice versa. You can configure this synchronization using the PrepareConfig resource.

The plugin takes a collider type. This should be Collider for the vast majority of applications, but for custom collisión backends you may use any collider that implements the AnyCollider trait.

The systems run in PhysicsSet::Prepare.

Implementations

impl PreparePlugin

pub fn new(schedule: impl ScheduleLabel) -> Self

Creates a PreparePlugin with the schedule that is used for running the PhysicsSchedule.

The default schedule is PostUpdate.

Trait Implementations

impl Default for PreparePlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for PreparePlugin

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.