Struct avian3d::dynamics::integrator::IntegratorPlugin

pub struct IntegratorPlugin { /* private fields */ }

Integrates Newton’s 2nd law of motion, applying forces and moving entities according to their velocities.

This acts as a prediction for the next positions and orientations of the bodies. The solver corrects these predicted positions to take constraints like contacts and joints into account.

Currently, only the semi-implicit (symplectic) Euler integration scheme is supported. It is the standard for game physics, being simple, efficient, and sufficiently accurate.

The plugin adds systems in the IntegrationSet::Velocity and IntegrationSet::Position system sets.

Implementations

impl IntegratorPlugin

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

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

The default schedule is PostUpdate.

Trait Implementations

impl Default for IntegratorPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for IntegratorPlugin

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.