Struct RapierPhysicsPlugin

pub struct RapierPhysicsPlugin<PhysicsHooks = ()> { /* private fields */ }

A plugin responsible for setting up a full Rapier physics simulation pipeline and resources.

This will automatically setup all the resources needed to run a physics simulation with the Rapier physics engine.

Implementations

impl<PhysicsHooks> RapierPhysicsPlugin<PhysicsHooks>

where PhysicsHooks: 'static + BevyPhysicsHooks, for<'w, 's> SystemParamItem<'w, 's, PhysicsHooks>: BevyPhysicsHooks,

pub fn with_length_unit(self, length_unit: f32) -> Self

Specifies a scale ratio between the physics world and the bevy transforms.

This affects the size of every elements in the physics engine, by multiplying all the length-related quantities by the length_unit factor. This should likely always be 1.0 in 3D. In 2D, this is useful to specify a “pixels-per-meter” conversion ratio.

pub fn with_custom_initialization( self, default_world_initialization: RapierContextInitialization, ) -> Self

Specifies a default world initialization strategy.

The default is to initialize a RapierContext with a length unit of 1.

pub fn with_default_system_setup(self, default_system_setup: bool) -> Self

Specifies whether the plugin should setup each of its PhysicsSet (true), or if the user will set them up later (false).

The default value is true.

pub fn pixels_per_meter(pixels_per_meter: f32) -> Self

Specifies how many pixels on the 2D canvas equal one meter on the physics world.

This conversion unit assumes that the 2D camera uses an unscaled projection.

pub fn with_physics_sets_systems( self, enabled_physics_schedules: HashSet<PhysicsSet>, ) -> Self

Controls whether given PhysicsSets systems are injected into the scheduler.

This is useful to opt out of default plugin behaviour, for example if you need to reorganize the systems in different schedules.

If passing an empty set, the plugin will still add the Physics Sets to the plugin schedule, but no systems will be added automatically.

pub fn in_fixed_schedule(self) -> Self

Adds the physics systems to the FixedUpdate schedule rather than PostUpdate.

pub fn in_schedule(self, schedule: impl ScheduleLabel) -> Self

Adds the physics systems to the provided schedule rather than PostUpdate.

pub fn get_systems(set: PhysicsSet) -> SystemConfigs

Provided for use when staging systems outside of this plugin using with_default_system_setup(false). See PhysicsSet for a description of these systems.

Trait Implementations

impl<PhysicsHooksSystemParam> Default for RapierPhysicsPlugin<PhysicsHooksSystemParam>

fn default() -> Self

Returns the “default value” for a type.

impl<PhysicsHooks> Plugin for RapierPhysicsPlugin<PhysicsHooks>

where PhysicsHooks: 'static + BevyPhysicsHooks, for<'w, 's> SystemParamItem<'w, 's, PhysicsHooks>: BevyPhysicsHooks,

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

Configures the App to which this plugin is added.

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 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 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.