Struct ColliderBackendPlugin

pub struct ColliderBackendPlugin<C: ScalableCollider> { /* private fields */ }

A plugin for handling generic collider backend logic.

• Initializes colliders, handles ColliderConstructor and ColliderConstructorHierarchy.
• Updates ColliderAabbs.
• Updates collider scale based on Transform scale.
• Updates ColliderMassProperties.

This plugin should typically be used together with the ColliderHierarchyPlugin.

Custom Collision Backends

By default, PhysicsPlugins adds this plugin for the Collider component. You can also create custom collider backends by implementing the AnyCollider and ScalableCollider traits for a type.

To use a custom collider backend, simply add the ColliderBackendPlugin with your collider type:

use avian3d::prelude::*;
use bevy::prelude::*;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            PhysicsPlugins::default(),
            // MyCollider must implement AnyCollider and ScalableCollider.
            ColliderBackendPlugin::<MyCollider>::default(),
            // To enable collision detection for the collider,
            // we also need to add the NarrowPhasePlugin for it.
            NarrowPhasePlugin::<MyCollider>::default(),
        ))
        // ...your other plugins, systems and resources
        .run();
}

Assuming you have implemented the required traits correctly, it should now work with the rest of the engine just like normal Colliders!

Note: Spatial queries are not supported for custom colliders yet.

Implementations

impl<C: ScalableCollider> ColliderBackendPlugin<C>

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

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

The default schedule is FixedPostUpdate.

Trait Implementations

impl<C: ScalableCollider> Default for ColliderBackendPlugin<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C: ScalableCollider> Plugin for ColliderBackendPlugin<C>

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.