Clean up diagnostics

Author: Jondolf

src/collider_tree/diagnostics.rs

@@ -0,0 +1,31 @@
+use bevy::{
+    diagnostic::DiagnosticPath,
+    prelude::{ReflectResource, Resource},
+    reflect::Reflect,
+};
+use core::time::Duration;
+
+use crate::diagnostics::{PhysicsDiagnostics, impl_diagnostic_paths};
+
+/// Diagnostics for [collider trees](crate::collider_tree).
+#[derive(Resource, Debug, Default, Reflect)]
+#[reflect(Resource, Debug)]
+pub struct ColliderTreeDiagnostics {
+    /// Time spent optimizing [collider trees](crate::collider_tree).
+    pub optimize: Duration,
+    /// Time spent updating AABBs and BVH nodes.
+    pub update: Duration,
+}
+
+impl PhysicsDiagnostics for ColliderTreeDiagnostics {
+    fn timer_paths(&self) -> Vec<(&'static DiagnosticPath, Duration)> {
+        vec![(Self::OPTIMIZE, self.optimize), (Self::UPDATE, self.update)]
+    }
+}
+
+impl_diagnostic_paths! {
+    impl ColliderTreeDiagnostics {
+        OPTIMIZE: "avian/collider_tree/optimize",
+        UPDATE: "avian/collider_tree/update",
+    }
+}

src/collider_tree/mod.rs

@@ -21,11 +21,13 @@
 //! [`SpatialQuery`]: crate::spatial_query::SpatialQuery
 //! [`BvhBroadPhasePlugin`]: crate::collision::broad_phase::bvh::BvhBroadPhasePlugin
 
+mod diagnostics;
 mod optimization;
 mod proxy_key;
 mod tree;
 mod update;
 
+pub use diagnostics::ColliderTreeDiagnostics;
 pub use optimization::{ColliderTreeOptimization, TreeOptimizationMode};
 pub use proxy_key::{ColliderTreeProxyKey, ColliderTreeType, ProxyId};
 pub use tree::{ColliderTree, ColliderTreeProxy, ColliderTreeProxyFlags, ColliderTreeWorkspace};
@@ -85,6 +87,11 @@ impl<C: AnyCollider> Plugin for ColliderTreePlugin<C> {
             ColliderTreeSystems::EndOptimize.in_set(PhysicsStepSystems::Finalize),
         );
     }
+
+    fn finish(&self, app: &mut App) {
+        // Register timer diagnostics for collider trees.
+        app.register_physics_diagnostics::<ColliderTreeDiagnostics>();
+    }
 }
 
 /// System sets for managing [`ColliderTrees`].

src/collider_tree/optimization.rs

@@ -1,6 +1,7 @@
 use crate::{
-    collider_tree::{ColliderTree, ColliderTreeSystems, ColliderTrees, MovedProxies},
-    collision::broad_phase::BroadPhaseDiagnostics,
+    collider_tree::{
+        ColliderTree, ColliderTreeDiagnostics, ColliderTreeSystems, ColliderTrees, MovedProxies,
+    },
     prelude::*,
 };
 use bevy::{
@@ -158,7 +159,7 @@ fn optimize_trees(
     mut optimization: ResMut<OptimizationTask>,
     optimization_settings: Res<ColliderTreeOptimization>,
     moved_proxies: ResMut<MovedProxies>,
-    mut diagnostics: ResMut<BroadPhaseDiagnostics>,
+    mut diagnostics: ResMut<ColliderTreeDiagnostics>,
 ) {
     let start = crate::utils::Instant::now();
 
@@ -244,7 +245,7 @@ fn block_on_optimize_trees(
     mut commands: Commands,
     mut collider_trees: ResMut<ColliderTrees>,
     mut optimization: ResMut<OptimizationTask>,
-    mut diagnostics: ResMut<BroadPhaseDiagnostics>,
+    mut diagnostics: ResMut<ColliderTreeDiagnostics>,
 ) {
     let start = crate::utils::Instant::now();
 

src/collider_tree/update.rs

@@ -4,10 +4,10 @@ use core::marker::PhantomData;
 
 use crate::{
     collider_tree::{
-        ColliderTreeProxy, ColliderTreeProxyKey, ColliderTreeSystems, ColliderTreeType,
-        ColliderTrees, ProxyId, tree::ColliderTreeProxyFlags,
+        ColliderTreeDiagnostics, ColliderTreeProxy, ColliderTreeProxyKey, ColliderTreeSystems,
+        ColliderTreeType, ColliderTrees, ProxyId, tree::ColliderTreeProxyFlags,
     },
-    collision::{broad_phase::BroadPhaseDiagnostics, collider::EnlargedAabb},
+    collision::collider::EnlargedAabb,
     data_structures::bit_vec::BitVec,
     dynamics::solver::solver_body::SolverBody,
     prelude::*,
@@ -602,7 +602,7 @@ fn update_dynamic_kinematic_aabbs<C: AnyCollider>(
     mut enlarged_proxies: ResMut<EnlargedProxies>,
     time: Res<Time>,
     collider_context: StaticSystemParam<C::Context>,
-    mut diagnostics: ResMut<BroadPhaseDiagnostics>,
+    mut diagnostics: ResMut<ColliderTreeDiagnostics>,
     mut last_tick: ResMut<LastDynamicKinematicAabbUpdate>,
     system_tick: SystemChangeTick,
 ) {
@@ -827,7 +827,7 @@ fn update_static_aabbs<C: AnyCollider>(
     narrow_phase_config: Res<NarrowPhaseConfig>,
     length_unit: Res<PhysicsLengthUnit>,
     mut collider_trees: ResMut<ColliderTrees>,
-    mut diagnostics: ResMut<BroadPhaseDiagnostics>,
+    mut diagnostics: ResMut<ColliderTreeDiagnostics>,
     collider_context: StaticSystemParam<C::Context>,
 ) {
     let start = crate::utils::Instant::now();
@@ -892,7 +892,7 @@ fn update_standalone_aabbs<C: AnyCollider>(
     narrow_phase_config: Res<NarrowPhaseConfig>,
     length_unit: Res<PhysicsLengthUnit>,
     mut collider_trees: ResMut<ColliderTrees>,
-    mut diagnostics: ResMut<BroadPhaseDiagnostics>,
+    mut diagnostics: ResMut<ColliderTreeDiagnostics>,
     collider_context: StaticSystemParam<C::Context>,
 ) {
     let start = crate::utils::Instant::now();

src/collision/broad_phase/bvh_broad_phase.rs

@@ -5,7 +5,7 @@ use crate::{
         ColliderTree, ColliderTreeProxy, ColliderTreeProxyFlags, ColliderTreeProxyKey,
         ColliderTreeType, ColliderTrees, MovedProxies, ProxyId,
     },
-    collision::broad_phase::BroadPhaseDiagnostics,
+    collision::CollisionDiagnostics,
     data_structures::pair_key::PairKey,
     dynamics::solver::joint_graph::JointGraph,
     prelude::*,
@@ -55,7 +55,7 @@ fn collect_collision_pairs<H: CollisionHooks>(
     par_commands: ParallelCommands,
     mut contact_graph: ResMut<ContactGraph>,
     joint_graph: Res<JointGraph>,
-    mut diagnostics: ResMut<BroadPhaseDiagnostics>,
+    mut diagnostics: ResMut<CollisionDiagnostics>,
 ) where
     for<'w, 's> SystemParamItem<'w, 's, H>: CollisionHooks,
 {
@@ -181,7 +181,7 @@ fn collect_collision_pairs<H: CollisionHooks>(
         });
     }
 
-    diagnostics.find_pairs += start.elapsed();
+    diagnostics.broad_phase += start.elapsed();
 }
 
 #[inline]

src/collision/broad_phase/diagnostics.rs

@@ -148,13 +148,12 @@
 //! # }
 //! ```
 
-mod diagnostics;
-pub use diagnostics::BroadPhaseDiagnostics;
-
 mod bvh_broad_phase;
 pub use bvh_broad_phase::BvhBroadPhasePlugin;
 
-use crate::{dynamics::solver::joint_graph::JointGraph, prelude::*};
+use crate::{
+    collision::CollisionDiagnostics, dynamics::solver::joint_graph::JointGraph, prelude::*,
+};
 use bevy::prelude::*;
 
 /// The core [broad phase](crate::collision::broad_phase) plugin that sets up the
@@ -187,8 +186,8 @@ impl Plugin for BroadPhaseCorePlugin {
     }
 
     fn finish(&self, app: &mut App) {
-        // Register timer diagnostics for the broad phase.
-        app.register_physics_diagnostics::<BroadPhaseDiagnostics>();
+        // Register timer diagnostics for collision detection.
+        app.register_physics_diagnostics::<CollisionDiagnostics>();
     }
 }
 

src/collision/broad_phase/mod.rs

@@ -11,15 +11,20 @@ use crate::diagnostics::{PhysicsDiagnostics, impl_diagnostic_paths};
 #[derive(Resource, Debug, Default, Reflect)]
 #[reflect(Resource, Debug)]
 pub struct CollisionDiagnostics {
-    /// Time spent updating contacts in the narrow phase.
+    /// Time spent finding potential collision pairs in the [broad phase](crate::collision::broad_phase).
+    pub broad_phase: Duration,
+    /// Time spent updating contacts in the [narrow phase](crate::collision::narrow_phase).
     pub narrow_phase: Duration,
     /// The number of contacts.
     pub contact_count: u32,
 }
 
 impl PhysicsDiagnostics for CollisionDiagnostics {
     fn timer_paths(&self) -> Vec<(&'static DiagnosticPath, Duration)> {
-        vec![(Self::NARROW_PHASE, self.narrow_phase)]
+        vec![
+            (Self::BROAD_PHASE, self.broad_phase),
+            (Self::NARROW_PHASE, self.narrow_phase),
+        ]
     }
 
     fn counter_paths(&self) -> Vec<(&'static DiagnosticPath, u32)> {
@@ -29,6 +34,7 @@ impl PhysicsDiagnostics for CollisionDiagnostics {
 
 impl_diagnostic_paths! {
     impl CollisionDiagnostics {
+        BROAD_PHASE: "avian/collision/broad_phase",
         NARROW_PHASE: "avian/collision/update_contacts",
         CONTACT_COUNT: "avian/collision/contact_count",
     }

src/collision/diagnostics.rs

@@ -3,11 +3,9 @@
 //!
 //! See [`PhysicsDiagnosticsPlugin`] for more information.
 
+use crate::collider_tree::ColliderTreeDiagnostics;
 use crate::dynamics::solver::constraint_graph::ConstraintGraph;
-use crate::{
-    collision::{CollisionDiagnostics, broad_phase::BroadPhaseDiagnostics},
-    dynamics::solver::SolverDiagnostics,
-};
+use crate::{collision::CollisionDiagnostics, dynamics::solver::SolverDiagnostics};
 use crate::{diagnostics::*, prelude::*};
 use bevy::color::palettes::tailwind::{GREEN_400, RED_400};
 use bevy::diagnostic::{DiagnosticPath, DiagnosticsStore, FrameTimeDiagnosticsPlugin};
@@ -239,12 +237,11 @@ fn build_diagnostic_texts(cmd: &mut RelatedSpawnerCommands<ChildOf>) {
     });
 
     // Collision detection and solver timers
+    type Collision = CollisionDiagnostics;
     type Solver = SolverDiagnostics;
     let collision_timers = vec![
-        ("Find Pairs", BroadPhaseDiagnostics::FIND_PAIRS),
-        ("Update AABBs", BroadPhaseDiagnostics::UPDATE),
-        ("Rebuild BVH", BroadPhaseDiagnostics::OPTIMIZE),
-        ("Narrow Phase", CollisionDiagnostics::NARROW_PHASE),
+        ("Broad Phase", Collision::BROAD_PHASE),
+        ("Narrow Phase", Collision::NARROW_PHASE),
     ];
     let solver_timers = vec![
         ("Prepare Constraints", Solver::PREPARE_CONSTRAINTS),
@@ -282,6 +279,15 @@ fn build_diagnostic_texts(cmd: &mut RelatedSpawnerCommands<ChildOf>) {
             cmd.timer_texts(spatial_query_timers, AdaptiveTextSettings::new(0.0, 4.0));
         });
 
+    // Collider tree timers
+    let collider_tree_timers = vec![
+        ("Update AABBs", ColliderTreeDiagnostics::UPDATE),
+        ("Optimize Trees", ColliderTreeDiagnostics::OPTIMIZE),
+    ];
+    cmd.diagnostic_group("Collider Trees").with_children(|cmd| {
+        cmd.timer_texts(collider_tree_timers, AdaptiveTextSettings::new(0.0, 4.0));
+    });
+
     cmd.diagnostic_group("Other").with_children(|cmd| {
         cmd.timer_text(
             "Other",