From 683fb12534da519834b650e7523e87d206fba375 Mon Sep 17 00:00:00 2001
From: andriyDev <andriydzikh@gmail.com>
Date: Sun, 30 Jun 2024 00:06:31 -0700
Subject: [PATCH] Move the debugging code in the example to be part of
 `bevy_landmass::debug`.

Previously, all this debug drawing code was bespoke - every user needed to write their own version. Now it's part of bevy_landmass so every user can just toss it in immediately! Note we still provide `draw_archipelago_debug` as a low-level API in case users don't like my debug visualizations.
---
 crates/bevy_landmass/Cargo.toml       |   1 +
 crates/bevy_landmass/example/debug.rs |  73 -----------------
 crates/bevy_landmass/example/main.rs  |  23 ++++--
 crates/bevy_landmass/src/debug.rs     | 112 +++++++++++++++++++++++++-
 4 files changed, 130 insertions(+), 79 deletions(-)
 delete mode 100644 crates/bevy_landmass/example/debug.rs

diff --git a/crates/bevy_landmass/Cargo.toml b/crates/bevy_landmass/Cargo.toml
index b0d0c4a..d6db682 100644
--- a/crates/bevy_landmass/Cargo.toml
+++ b/crates/bevy_landmass/Cargo.toml
@@ -19,6 +19,7 @@ type_complexity = "allow"
 [dependencies]
 bevy = { version = "0.13.0", default-features = false, features = [
   "bevy_asset",
+  "bevy_gizmos",
 ] }
 landmass = { path = "../landmass", version = "0.4.0" }
 
diff --git a/crates/bevy_landmass/example/debug.rs b/crates/bevy_landmass/example/debug.rs
deleted file mode 100644
index f306813..0000000
--- a/crates/bevy_landmass/example/debug.rs
+++ /dev/null
@@ -1,73 +0,0 @@
-use bevy::{input::common_conditions::input_toggle_active, prelude::*};
-use bevy_landmass::{debug::*, LandmassSystemSet};
-
-pub struct DebugPlugin;
-
-impl Plugin for DebugPlugin {
-  fn build(&self, app: &mut bevy::prelude::App) {
-    app
-      .add_systems(
-        Update,
-        draw_archipelagos
-          .in_set(LandmassSystemSet::Output)
-          .run_if(input_toggle_active(false, KeyCode::F12)),
-      )
-      .insert_gizmo_group(
-        DefaultGizmoConfigGroup,
-        GizmoConfig { depth_bias: -1.0, ..Default::default() },
-      );
-  }
-}
-
-struct LyonDrawer<'w, 's, 'a>(&'a mut Gizmos<'w, 's>);
-
-impl<'w, 's, 'a> DebugDrawer for LyonDrawer<'w, 's, 'a> {
-  fn add_point(&mut self, point_type: PointType, point: Vec3) {
-    self.0.sphere(
-      point,
-      Quat::IDENTITY,
-      0.2,
-      match point_type {
-        PointType::AgentPosition(_) => Color::rgba(0.0, 1.0, 0.0, 0.6),
-        PointType::TargetPosition(_) => Color::rgba(1.0, 1.0, 0.0, 0.6),
-        PointType::Waypoint(_) => Color::rgba(0.6, 0.6, 0.6, 0.6),
-      },
-    );
-  }
-
-  fn add_line(&mut self, line_type: LineType, line: [Vec3; 2]) {
-    self.0.line(
-      line[0],
-      line[1],
-      match line_type {
-        LineType::BoundaryEdge => Color::rgba(0.0, 0.0, 1.0, 0.6),
-        LineType::ConnectivityEdge => Color::rgba(0.5, 0.5, 1.0, 0.6),
-        LineType::AgentCorridor(_) => Color::rgba(0.6, 0.0, 0.6, 0.6),
-        LineType::Target(_) => Color::rgba(1.0, 1.0, 0.0, 0.6),
-        LineType::Waypoint(_) => Color::rgba(0.6, 0.6, 0.6, 0.6),
-      },
-    );
-  }
-
-  fn add_triangle(
-    &mut self,
-    _triangle_type: TriangleType,
-    _triangle: [Vec3; 3],
-  ) {
-    // Bevy doesn't have a way to draw triangles :'(
-  }
-}
-
-fn draw_archipelagos(
-  time: Res<Time>,
-  archipelagos: Query<&bevy_landmass::Archipelago>,
-  mut gizmos: Gizmos,
-) {
-  if time.delta_seconds() == 0.0 {
-    return;
-  }
-  let mut drawer = LyonDrawer(&mut gizmos);
-  for archipelago in archipelagos.iter() {
-    draw_archipelago_debug(archipelago, &mut drawer);
-  }
-}
diff --git a/crates/bevy_landmass/example/main.rs b/crates/bevy_landmass/example/main.rs
index 78ff8f1..25027c8 100644
--- a/crates/bevy_landmass/example/main.rs
+++ b/crates/bevy_landmass/example/main.rs
@@ -1,17 +1,23 @@
 use std::sync::Arc;
 
-use bevy::{prelude::*, render::mesh::CylinderMeshBuilder};
-use bevy_landmass::{nav_mesh::bevy_mesh_to_landmass_nav_mesh, prelude::*};
-
-mod debug;
+use bevy::{
+  input::common_conditions::input_just_pressed, prelude::*,
+  render::mesh::CylinderMeshBuilder,
+};
+use bevy_landmass::{
+  debug::{EnableLandmassDebug, LandmassDebugPlugin},
+  nav_mesh::bevy_mesh_to_landmass_nav_mesh,
+  prelude::*,
+};
 
 fn main() {
   App::new()
     .add_plugins(DefaultPlugins)
     .add_plugins(LandmassPlugin)
-    .add_plugins(debug::DebugPlugin)
+    .add_plugins(LandmassDebugPlugin::default())
     .add_systems(Startup, setup)
     .add_systems(Update, (convert_mesh, handle_clicks))
+    .add_systems(Update, toggle_debug.run_if(input_just_pressed(KeyCode::F12)))
     .add_systems(
       Update,
       (update_agent_velocity, move_agent_by_velocity).chain(),
@@ -199,9 +205,11 @@ fn move_agent_by_velocity(
   }
 }
 
+/// Marker component for the target entity.
 #[derive(Component)]
 struct Target;
 
+/// Handles clicks by spawning agents with LMB and moving the target with RMB.
 fn handle_clicks(
   buttons: Res<ButtonInput<MouseButton>>,
   window_query: Query<&Window>,
@@ -240,3 +248,8 @@ fn handle_clicks(
       .insert(Transform::from_translation(world_position));
   }
 }
+
+/// System for toggling the `EnableLandmassDebug` resource.
+fn toggle_debug(mut debug: ResMut<EnableLandmassDebug>) {
+  **debug = !**debug;
+}
diff --git a/crates/bevy_landmass/src/debug.rs b/crates/bevy_landmass/src/debug.rs
index 22bd35f..8a303ef 100644
--- a/crates/bevy_landmass/src/debug.rs
+++ b/crates/bevy_landmass/src/debug.rs
@@ -1,6 +1,22 @@
+use crate::{util::landmass_vec3_to_bevy_vec3, Archipelago, LandmassSystemSet};
+use bevy::{
+  app::Update,
+  gizmos::AppGizmoBuilder,
+  math::Quat,
+  prelude::{
+    Deref, DerefMut, GizmoConfig, GizmoConfigGroup, Gizmos, IntoSystemConfigs,
+    Plugin, Query, Res, Resource,
+  },
+  reflect::Reflect,
+  render::color::Color,
+  time::Time,
+};
+
 pub use landmass::debug::*;
 
-/// Draws all parts of `archipelago` to `debug_drawer`.
+/// Draws all parts of `archipelago` to `debug_drawer`. This is a lower level
+/// API to allow custom debug drawing. For a pre-made implementation, use
+/// [`LandmassDebugPlugin`].
 pub fn draw_archipelago_debug(
   archipelago: &crate::Archipelago,
   debug_drawer: &mut impl DebugDrawer,
@@ -10,3 +26,97 @@ pub fn draw_archipelago_debug(
     debug_drawer,
   )
 }
+
+/// A plugin to draw landmass debug data with Bevy gizmos.
+pub struct LandmassDebugPlugin {
+  /// Whether to begin drawing on startup.
+  pub draw_on_start: bool,
+}
+
+impl Default for LandmassDebugPlugin {
+  fn default() -> Self {
+    Self { draw_on_start: true }
+  }
+}
+
+impl Plugin for LandmassDebugPlugin {
+  fn build(&self, app: &mut bevy::prelude::App) {
+    app
+      .insert_resource(EnableLandmassDebug(self.draw_on_start))
+      .add_systems(
+        Update,
+        draw_archipelagos_default
+          .in_set(LandmassSystemSet::Output)
+          .run_if(|enable: Res<EnableLandmassDebug>| enable.0),
+      )
+      .insert_gizmo_group(
+        LandmassGizmoConfigGroup,
+        GizmoConfig { depth_bias: -1.0, ..Default::default() },
+      );
+  }
+}
+
+/// A resource controlling whether debug data is drawn.
+#[derive(Resource, Default, Deref, DerefMut)]
+pub struct EnableLandmassDebug(pub bool);
+
+/// A config group for landmass debug gizmos.
+#[derive(Default, Reflect, GizmoConfigGroup)]
+pub struct LandmassGizmoConfigGroup;
+
+/// A gizmo debug drawer.
+struct GizmoDrawer<'w, 's, 'a>(
+  &'a mut Gizmos<'w, 's, LandmassGizmoConfigGroup>,
+);
+
+impl<'w, 's, 'a> DebugDrawer for GizmoDrawer<'w, 's, 'a> {
+  fn add_point(&mut self, point_type: PointType, point: landmass::Vec3) {
+    self.0.sphere(
+      landmass_vec3_to_bevy_vec3(point),
+      Quat::IDENTITY,
+      0.2,
+      match point_type {
+        PointType::AgentPosition(_) => Color::rgba(0.0, 1.0, 0.0, 0.6),
+        PointType::TargetPosition(_) => Color::rgba(1.0, 1.0, 0.0, 0.6),
+        PointType::Waypoint(_) => Color::rgba(0.6, 0.6, 0.6, 0.6),
+      },
+    );
+  }
+
+  fn add_line(&mut self, line_type: LineType, line: [landmass::Vec3; 2]) {
+    self.0.line(
+      landmass_vec3_to_bevy_vec3(line[0]),
+      landmass_vec3_to_bevy_vec3(line[1]),
+      match line_type {
+        LineType::BoundaryEdge => Color::rgba(0.0, 0.0, 1.0, 0.6),
+        LineType::ConnectivityEdge => Color::rgba(0.5, 0.5, 1.0, 0.6),
+        LineType::AgentCorridor(_) => Color::rgba(0.6, 0.0, 0.6, 0.6),
+        LineType::Target(_) => Color::rgba(1.0, 1.0, 0.0, 0.6),
+        LineType::Waypoint(_) => Color::rgba(0.6, 0.6, 0.6, 0.6),
+      },
+    );
+  }
+
+  fn add_triangle(
+    &mut self,
+    _triangle_type: TriangleType,
+    _triangle: [landmass::Vec3; 3],
+  ) {
+    // Bevy doesn't have a way to draw triangles :'(
+  }
+}
+
+/// A system for drawing debug data.
+fn draw_archipelagos_default(
+  time: Res<Time>,
+  archipelagos: Query<&Archipelago>,
+  mut gizmos: Gizmos<'_, '_, LandmassGizmoConfigGroup>,
+) {
+  if time.delta_seconds() == 0.0 {
+    return;
+  }
+  let mut drawer = GizmoDrawer(&mut gizmos);
+  for archipelago in archipelagos.iter() {
+    draw_archipelago_debug(archipelago, &mut drawer);
+  }
+}