Per entity/collider debug rendering (#278)

barsoosayque · Vrixyz · web-flow · commit c2bed72eb944 · 2024-08-02T16:04:58.000+02:00
Co-authored-by: Thierry Berger &lt;contact@thierryberger.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,9 @@ during a frame which would not run a simulation step.
 - Added a `TriMeshFlags` parameter for `ComputedColliderShape`,
 its default value is `TriMeshFlags::MERGE_DUPLICATE_VERTICES`,
 which was its hardcoded behaviour.
+- Added a way to configure which colliders should be debug rendered: `global` parameter for both 
+  `RapierDebugColliderPlugin` and `DebugRenderContext`, as well as individual collider setup via
+  a `ColliderDebug` component.
 
 ## v0.27.0 (07 July 2024)
 
diff --git a/bevy_rapier2d/examples/debug_toggle2.rs b/bevy_rapier2d/examples/debug_toggle2.rs
@@ -0,0 +1,117 @@
+use std::time::Duration;
+
+pub use bevy::input::common_conditions::input_just_pressed;
+use bevy::prelude::*;
+use bevy_rapier2d::prelude::*;
+
+fn main() {
+    App::new()
+        .insert_resource(ClearColor(Color::srgb(
+            0xF9 as f32 / 255.0,
+            0xF9 as f32 / 255.0,
+            0xFF as f32 / 255.0,
+        )))
+        .add_plugins((
+            DefaultPlugins,
+            RapierPhysicsPlugin::<NoUserData>::default(),
+            RapierDebugRenderPlugin::default(),
+        ))
+        .add_systems(Startup, (setup_graphics, setup_physics))
+        .add_systems(
+            Update,
+            (
+                toggle_debug,
+                (|mut debug_render_context: ResMut<DebugRenderContext>| {
+                    debug_render_context.enabled = !debug_render_context.enabled;
+                })
+                .run_if(input_just_pressed(KeyCode::KeyV)),
+            ),
+        )
+        .run();
+}
+
+pub fn setup_graphics(mut commands: Commands) {
+    commands.spawn(Camera3dBundle {
+        transform: Transform::from_xyz(-30.0, 30.0, 100.0)
+            .looking_at(Vec3::new(0.0, 10.0, 0.0), Vec3::Y),
+        ..Default::default()
+    });
+}
+
+#[derive(Component)]
+pub struct DebugCooldown(pub Timer);
+
+pub fn setup_physics(mut commands: Commands) {
+    /*
+     * Ground
+     */
+    let ground_size = 200.1;
+    let ground_height = 0.1;
+
+    commands.spawn((
+        TransformBundle::from(Transform::from_xyz(0.0, -ground_height, 0.0)),
+        Collider::cuboid(ground_size, ground_height),
+    ));
+
+    /*
+     * Create the cubes
+     */
+    let num = 8;
+    let rad = 1.0;
+
+    let shift = rad * 2.0 + rad;
+    let centerx = shift * (num / 2) as f32;
+    let centery = shift / 2.0;
+    let centerz = shift * (num / 2) as f32;
+
+    let mut offset = -(num as f32) * (rad * 2.0 + rad) * 0.5;
+    let mut color = 0;
+    let colors = [
+        Hsla::hsl(220.0, 1.0, 0.3),
+        Hsla::hsl(180.0, 1.0, 0.3),
+        Hsla::hsl(260.0, 1.0, 0.7),
+    ];
+
+    for j in 0usize..20 {
+        for i in 0..num {
+            for k in 0usize..num {
+                let x = i as f32 * shift - centerx + offset;
+                let y = j as f32 * shift + centery + 3.0;
+                let z = k as f32 * shift - centerz + offset;
+                color += 1;
+
+                commands
+                    .spawn(TransformBundle::from(Transform::from_rotation(
+                        Quat::from_rotation_x(0.2),
+                    )))
+                    .with_children(|child| {
+                        child.spawn((
+                            TransformBundle::from(Transform::from_xyz(x, y, z)),
+                            RigidBody::Dynamic,
+                            Collider::cuboid(rad, rad),
+                            ColliderDebugColor(colors[color % 3]),
+                            ColliderDebug::AlwaysRender,
+                            DebugCooldown(Timer::new(
+                                Duration::from_secs_f32(0.4f32 + (i % 3 + (j + 1) % 3) as f32),
+                                TimerMode::Repeating,
+                            )),
+                        ));
+                    });
+            }
+        }
+
+        offset -= 0.05 * rad * (num as f32 - 1.0);
+    }
+}
+
+pub fn toggle_debug(time: Res<Time>, mut query: Query<(&mut ColliderDebug, &mut DebugCooldown)>) {
+    for (mut debug, mut cooldown) in query.iter_mut() {
+        cooldown.0.tick(time.delta());
+        if cooldown.0.just_finished() {
+            *debug = match *debug {
+                ColliderDebug::AlwaysRender => ColliderDebug::NeverRender,
+                ColliderDebug::NeverRender => ColliderDebug::AlwaysRender,
+            }
+        }
+    }
+}
diff --git a/bevy_rapier2d/examples/testbed2.rs b/bevy_rapier2d/examples/testbed2.rs
@@ -2,6 +2,7 @@
 
 mod boxes2;
 mod debug_despawn2;
+mod debug_toggle2;
 mod despawn2;
 mod events2;
 mod joints2;
@@ -21,6 +22,7 @@ pub enum Examples {
     #[default]
     None,
     Boxes2,
+    DebugToggle2,
     RopeJoint2,
     DebugDespawn2,
     Despawn2,
@@ -90,6 +92,23 @@ fn main() {
         )
         .add_systems(OnExit(Examples::Boxes2), cleanup)
         //
+        // Debug toggle
+        .add_systems(
+            OnEnter(Examples::DebugToggle2),
+            (debug_toggle2::setup_graphics, debug_toggle2::setup_physics),
+        )
+        .add_systems(
+            Update,
+            (
+                debug_toggle2::toggle_debug,
+                (|mut debug_render_context: ResMut<DebugRenderContext>| {
+                    debug_render_context.enabled = !debug_render_context.enabled;
+                })
+                .run_if(debug_toggle2::input_just_pressed(KeyCode::KeyV)),
+            )
+                .run_if(in_state(Examples::DebugToggle2)),
+        )
+        //
         // rope joint
         .add_systems(
             OnEnter(Examples::RopeJoint2),
diff --git a/bevy_rapier3d/examples/debug_toggle3.rs b/bevy_rapier3d/examples/debug_toggle3.rs
@@ -0,0 +1,117 @@
+use std::time::Duration;
+
+pub use bevy::input::common_conditions::input_just_pressed;
+use bevy::prelude::*;
+use bevy_rapier3d::prelude::*;
+
+fn main() {
+    App::new()
+        .insert_resource(ClearColor(Color::srgb(
+            0xF9 as f32 / 255.0,
+            0xF9 as f32 / 255.0,
+            0xFF as f32 / 255.0,
+        )))
+        .add_plugins((
+            DefaultPlugins,
+            RapierPhysicsPlugin::<NoUserData>::default(),
+            RapierDebugRenderPlugin::default(),
+        ))
+        .add_systems(Startup, (setup_graphics, setup_physics))
+        .add_systems(
+            Update,
+            (
+                toggle_debug,
+                (|mut debug_render_context: ResMut<DebugRenderContext>| {
+                    debug_render_context.enabled = !debug_render_context.enabled;
+                })
+                .run_if(input_just_pressed(KeyCode::KeyV)),
+            ),
+        )
+        .run();
+}
+
+pub fn setup_graphics(mut commands: Commands) {
+    commands.spawn(Camera3dBundle {
+        transform: Transform::from_xyz(-30.0, 30.0, 100.0)
+            .looking_at(Vec3::new(0.0, 10.0, 0.0), Vec3::Y),
+        ..Default::default()
+    });
+}
+
+#[derive(Component)]
+pub struct DebugCooldown(pub Timer);
+
+pub fn setup_physics(mut commands: Commands) {
+    /*
+     * Ground
+     */
+    let ground_size = 200.1;
+    let ground_height = 0.1;
+
+    commands.spawn((
+        TransformBundle::from(Transform::from_xyz(0.0, -ground_height, 0.0)),
+        Collider::cuboid(ground_size, ground_height, ground_size),
+    ));
+
+    /*
+     * Create the cubes
+     */
+    let num = 8;
+    let rad = 1.0;
+
+    let shift = rad * 2.0 + rad;
+    let centerx = shift * (num / 2) as f32;
+    let centery = shift / 2.0;
+    let centerz = shift * (num / 2) as f32;
+
+    let mut offset = -(num as f32) * (rad * 2.0 + rad) * 0.5;
+    let mut color = 0;
+    let colors = [
+        Hsla::hsl(220.0, 1.0, 0.3),
+        Hsla::hsl(180.0, 1.0, 0.3),
+        Hsla::hsl(260.0, 1.0, 0.7),
+    ];
+
+    for j in 0usize..20 {
+        for i in 0..num {
+            for k in 0usize..num {
+                let x = i as f32 * shift - centerx + offset;
+                let y = j as f32 * shift + centery + 3.0;
+                let z = k as f32 * shift - centerz + offset;
+                color += 1;
+
+                commands
+                    .spawn(TransformBundle::from(Transform::from_rotation(
+                        Quat::from_rotation_x(0.2),
+                    )))
+                    .with_children(|child| {
+                        child.spawn((
+                            TransformBundle::from(Transform::from_xyz(x, y, z)),
+                            RigidBody::Dynamic,
+                            Collider::cuboid(rad, rad, rad),
+                            ColliderDebugColor(colors[color % 3]),
+                            ColliderDebug::AlwaysRender,
+                            DebugCooldown(Timer::new(
+                                Duration::from_secs_f32(0.4f32 + (i % 3 + (j + 1) % 3) as f32),
+                                TimerMode::Repeating,
+                            )),
+                        ));
+                    });
+            }
+        }
+
+        offset -= 0.05 * rad * (num as f32 - 1.0);
+    }
+}
+
+pub fn toggle_debug(time: Res<Time>, mut query: Query<(&mut ColliderDebug, &mut DebugCooldown)>) {
+    for (mut debug, mut cooldown) in query.iter_mut() {
+        cooldown.0.tick(time.delta());
+        if cooldown.0.just_finished() {
+            *debug = match *debug {
+                ColliderDebug::AlwaysRender => ColliderDebug::NeverRender,
+                ColliderDebug::NeverRender => ColliderDebug::AlwaysRender,
+            }
+        }
+    }
+}
diff --git a/bevy_rapier3d/examples/testbed3.rs b/bevy_rapier3d/examples/testbed3.rs
@@ -1,6 +1,7 @@
 #![allow(dead_code)]
 
 mod boxes3;
+mod debug_toggle3;
 mod despawn3;
 mod events3;
 mod joints3;
@@ -20,6 +21,7 @@ pub enum Examples {
     #[default]
     None,
     Boxes3,
+    DebugToggle3,
     Despawn3,
     Events3,
     Joints3,
@@ -69,6 +71,7 @@ fn main() {
         .init_state::<Examples>()
         .insert_resource(ExampleSet(vec![
             (Examples::Boxes3, "Boxes3").into(),
+            (Examples::DebugToggle3, "DebugToggle3").into(),
             (Examples::Despawn3, "Despawn3").into(),
             (Examples::Events3, "Events3").into(),
             (Examples::Joints3, "Joints3").into(),
@@ -87,6 +90,23 @@ fn main() {
         )
         .add_systems(OnExit(Examples::Boxes3), cleanup)
         //
+        // Debug toggle
+        .add_systems(
+            OnEnter(Examples::DebugToggle3),
+            (debug_toggle3::setup_graphics, debug_toggle3::setup_physics),
+        )
+        .add_systems(
+            Update,
+            (
+                debug_toggle3::toggle_debug,
+                (|mut debug_render_context: ResMut<DebugRenderContext>| {
+                    debug_render_context.enabled = !debug_render_context.enabled;
+                })
+                .run_if(debug_toggle3::input_just_pressed(KeyCode::KeyV)),
+            )
+                .run_if(in_state(Examples::DebugToggle3)),
+        )
+        //
         // despawn
         .init_resource::<despawn3::DespawnResource>()
         .add_systems(
diff --git a/src/render/mod.rs b/src/render/mod.rs
