Struct avian3d::debug_render::PhysicsDebugPlugin

pub struct PhysicsDebugPlugin { /* private fields */ }

A plugin that renders physics objects and properties for debugging purposes. It is not enabled by default and must be added manually.

Currently, the following are supported for debug rendering:

• The axes and center of mass of rigid bodies
• AABBs
• Collider wireframes
• Using different colors for sleeping bodies
• Contacts
• Joints
• RayCaster
• ShapeCaster
• Changing the visibility of entities to only show debug rendering

By default, AABBs and contacts are not debug rendered. You can configure the PhysicsGizmos retrieved from GizmoConfigStore for the global configuration and the DebugRender component for entity-level configuration.

Example

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

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            PhysicsPlugins::default(),
            // Enables debug rendering
            PhysicsDebugPlugin::default(),
        ))
        // Overwrite default debug rendering configuration (optional)
        .insert_gizmo_config(
            PhysicsGizmos {
                aabb_color: Some(Color::WHITE),
                ..default()
            },
            GizmoConfig::default(),
        )
        .run();
}

fn setup(mut commands: Commands) {
    // This rigid body and its collider and AABB will get rendered
    commands.spawn((
        RigidBody::Dynamic,
        Collider::sphere(0.5),
        // Overwrite default collider color (optional)
        DebugRender::default().with_collider_color(Color::srgb(1.0, 0.0, 0.0)),
    ));
}

Implementations

impl PhysicsDebugPlugin

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

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

The default schedule is PostUpdate.

Trait Implementations

impl Default for PhysicsDebugPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for PhysicsDebugPlugin

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.