Struct avian3d::schedule::PhysicsSchedulePlugin

pub struct PhysicsSchedulePlugin { /* private fields */ }

Sets up the default scheduling, system set configuration, and time resources for physics.

Schedules and sets

This plugin initializes and configures the following schedules and system sets:

• PhysicsSet: High-level system sets for the main phases of the physics engine. You can use these to schedule your own systems before or after physics is run without having to worry about implementation details.
• PhysicsSchedule: Responsible for advancing the simulation in PhysicsSet::StepSimulation.
• PhysicsStepSet: System sets for the steps of the actual physics simulation loop, like the broad phase and the substepping loop.
• SubstepSchedule: Responsible for running the substepping loop in SolverSet::Substep.

Implementations

impl PhysicsSchedulePlugin

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

Creates a PhysicsSchedulePlugin using the given schedule for running the PhysicsSchedule.

The default schedule is PostUpdate.

Trait Implementations

impl Default for PhysicsSchedulePlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for PhysicsSchedulePlugin

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.