multi-quadtree support

Author: kingwingfly

.github/scripts/test.sh

@@ -8,11 +8,13 @@ statements=(
     "cargo clippy --no-default-features -- -D warnings"
     "cargo clippy -F gizmos -- -D warnings"
     "cargo clippy -F sprite -- -D warnings"
-    "cargo clippy -F sprite,gizmos -- -D warnings"
+    "cargo clippy -F multi-quadtree -- -D warnings"
+    "cargo clippy --all-features -- -D warnings"
 
     "cargo test --no-default-features"
     "cargo test -F gizmos"
-    "cargo test -F sprite --doc"
+    "cargo test -F sprite"
+    "cargo test -F multi-quadtree"
     "cargo test --all-features"
 
     "cargo doc --no-deps --all-features"

CHANGELOG.md

@@ -9,6 +9,10 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com
 -->
 
 ## [Unreleased]
+## [0.15.1-alpha11] - 2025-01-23
+
+- multi-quadtree support: see `MultiQuadTreePlugin`
+
 ## [0.15.1-alpha10] - 2025-01-23
 
 - fix doc mistakes

Cargo.toml

@@ -3,7 +3,7 @@ members = ["bevy_quadtree"]
 resolver = "2"
 
 [workspace.package]
-version = "0.15.1-alpha10"
+version = "0.15.1-alpha11"
 authors = ["Louis <[email protected]>"]
 description = "A quadtree plugin for bevy"
 license = "MIT"

bevy_quadtree/Cargo.toml

@@ -32,3 +32,4 @@ rand_chacha = { version = "0.3.1", default-features = false }
 default = []
 sprite = ["dep:bevy_sprite"]
 gizmos = ["dep:bevy_gizmos", "dep:bevy_color"]
+multi-quadtree = []

bevy_quadtree/README.md

@@ -73,6 +73,7 @@ Function:
 Features:
 - `gizmos`: show gizmos of the quadtree boundaries.
 - `sprite`: enable `CollisionRect` and `CollisionRotatedRect` to track `sprite.custom_size`.
+- `multi-quadtree`: support multiple quadtree in one world.
 
 ### Caution
 
@@ -104,14 +105,14 @@ bevy_quadtree = { version = "0.15.1" }
 2. Add the plugin to your Bevy app:
 
 ```rust no_run
+# #[cfg(feature = "sprite")]
+{
 # use bevy_app::prelude::*;
 # use bevy_transform::prelude::*;
-# #[cfg(feature = "sprite")]
 # use bevy_sprite::Sprite;
 use bevy_quadtree::{QuadTreePlugin, CollisionCircle, CollisionRect};
 
 fn main() {
-    #[cfg(feature = "sprite")]
     App::new()
         .add_plugins(QuadTreePlugin::<(
                 (CollisionCircle, GlobalTransform), (CollisionRect, (GlobalTransform, Sprite)),
@@ -125,6 +126,7 @@ fn main() {
         // 20 / 10 = 2 = outlet_boundary / inlet_boundary (for loose quadtree)
         .run();
 }
+# }
 ```
 
 3. Spawn CollisionShapes as Components:

bevy_quadtree/src/lib.rs

@@ -10,6 +10,8 @@ mod system;
 pub mod tree;
 
 pub use collision::{Collision, CollisionQuery, Disassemble, UpdateCollision};
+#[cfg(feature = "multi-quadtree")]
+pub use plugin::{AsQuadTreePluginConfig, MultiQuadTreePlugin, QTConfig, QuadTreePluginConfig};
 pub use plugin::{QuadTreePlugin, TrackingPair};
 pub use shape::{CollisionCircle, CollisionRect, CollisionRotatedRect};
 pub use tree::{All, Contain, Contained, Disjoint, Overlap, QNot, QOr, QRelation, QuadTree};

bevy_quadtree/src/plugin.rs renamed to bevy_quadtree/src/plugin/mod.rs

@@ -1,4 +1,13 @@
 //! QuadTree Plugin
+//!
+
+#[cfg(feature = "multi-quadtree")]
+mod multi_plugin;
+
+#[cfg(feature = "multi-quadtree")]
+pub use multi_plugin::{
+    AsQuadTreePluginConfig, MultiQuadTreePlugin, QTConfig, QuadTreePluginConfig,
+};
 
 use crate::collision::AsDynCollision;
 use crate::system::{update_collision, update_quadtree};
@@ -9,7 +18,7 @@ use bevy_ecs::prelude::*;
 use bevy_ecs::schedule::{IntoSystemConfigs, SystemConfigs};
 #[cfg(feature = "sprite")]
 use bevy_sprite::Sprite;
-use bevy_transform::components::GlobalTransform;
+use bevy_transform::prelude::*;
 
 /// A Bevy plugin for quadtree.
 /// # Type Parameters
@@ -35,34 +44,37 @@ use bevy_transform::components::GlobalTransform;
 /// `K`: For `LooseQuadTree`, K / 10 = outlet_boundary / inlet_boundary. Set K to 10 by default and 20 is founded best.
 /// K should >= 10. Only if the object move and is **no longer completely contained** by the outlet_boundary will it be inserted again.
 ///
-/// `ID`: If you want different quadtree for different use cases with the same other parameters, set ID to different values.
-/// # Panic
-/// 1. duplicated shape in `P`.
-///
-/// e.g. `P = ((CollisionRect, GlobalTransform), (CollisionRect, Sprite))` will lead a debug_assertion failure.
-/// Try `P = (CollisionRect, (GlobalTransform, Sprite))` or `P = ((CollisionRect<0>, GlobalTransform), (CollisionRect<1>, Sprite))` in concret context.
-///
-/// 2. invalid const parameters.
-///
-/// N, D, W, H should > 0. K should >= 10.
+/// `ID`: Set a lucky number as you like for the quadtree.
+/// If you want multiple quadtrees, see [`MultiQuadTreePlugin`].
 ///
 /// # Example
 /// ```no_run
+/// # #[cfg(feature = "sprite")]
+/// # {
 /// # use bevy_app::prelude::*;
 /// # use bevy_transform::prelude::*;
-/// # #[cfg(feature = "sprite")]
 /// # use bevy_sprite::Sprite;
 /// use bevy_quadtree::{CollisionCircle, CollisionRect, CollisionRotatedRect, QuadTreePlugin};
 ///
-/// #[cfg(feature = "sprite")]
 /// App::new()
 ///    .add_plugins(QuadTreePlugin::<(
 ///             (CollisionCircle, GlobalTransform),
-///             (CollisionRotatedRect, GlobalTransform),
-///             (CollisionRect, Sprite),
+///             (CollisionRotatedRect, Sprite),
+///             (CollisionRect, (GlobalTransform, Sprite)),
 ///         ),
 ///         40, 4, 100, 100, 20>::default());
+/// # }
 /// ```
+///
+/// # Panic
+/// 1. duplicated shapes in `P`. (Debug check only)
+///
+/// e.g. `P = ((CollisionRect, GlobalTransform), (CollisionRect, Sprite))` will lead a debug_assertion failure.
+/// Try `P = (CollisionRect, (GlobalTransform, Sprite))` or `P = ((CollisionRect<0>, GlobalTransform), (CollisionRect<1>, Sprite))` in concret context.
+///
+/// 2. invalid const parameters. (Debug check only)
+///
+/// N, D, W, H should > 0. K should >= 10.
 #[derive(Debug)]
 pub struct QuadTreePlugin<
     P,
@@ -200,10 +212,9 @@ macro_rules! impl_tracking_pair_tuple {
         impl<S> TrackingPair for (S, ($($c),+,))
         where
             S: Component + AsDynCollision + $(UpdateCollision<$c>+)+ Clone,
-            $($c: Component),+,
-            $((S, $c): TrackingPair),+,
         {
             fn update_collision() -> SystemConfigs {
+                // update_collision has Mut<S>, so chain them
                 ($(update_collision::<S, $c>),+,).chain()
             }
             fn update_quadtree<const N: usize, const D: usize, const W: usize, const H: usize, const K: usize, const ID: usize>(
@@ -240,6 +251,7 @@ macro_rules! impl_tracking_pairs {
                 $([<P $i>]: TrackingPair),+
             {
                 fn update_collision() -> SystemConfigs {
+                    // no duplicate shape in `P`s, so ambiguous_with_all
                     ($([<P $i>]::update_collision()),+,).ambiguous_with_all()
                 }
                 fn update_quadtree<const N: usize, const D: usize, const W: usize, const H: usize, const K: usize, const ID: usize>(
@@ -249,7 +261,7 @@ macro_rules! impl_tracking_pairs {
                         let mut set = std::collections::HashMap::new();
                         $(
                             if let Some(dup) = set.insert([<P $i>]::shape_id(), std::any::type_name::<[<P $i>]>()) {
-                                panic!("Duplicate quadtree updating system added:\n<{}>\n<{}>\nThey have the same collision shape, merge them into one or use `ID` type parameter of shape.", dup, std::any::type_name::<[<P $i>]>());
+                                panic!("Duplicated quadtree updating system added:\n<{}>\n<{}>\nThey have the same collision shape, merge them into one or use `ID` type parameter of shape.", dup, std::any::type_name::<[<P $i>]>());
                             }
                         );+
                     }
@@ -263,15 +275,15 @@ macro_rules! impl_tracking_pairs {
                         let mut set = std::collections::HashMap::new();
                         $(
                             if let Some(dup) = set.insert([<P $i>]::shape_id(), std::any::type_name::<[<P $i>]>()) {
-                                panic!("Duplicate gizmos box updating system added:\n<{}>\n<{}>\nThey have the same collision shape, merge them into one or use `ID` type parameter of shape.", dup, std::any::type_name::<[<P $i>]>());
+                                panic!("Duplicated gizmos box updating system added:\n<{}>\n<{}>\nThey have the same collision shape, merge them into one or use `ID` type parameter of shape.", dup, std::any::type_name::<[<P $i>]>());
                             }
                         );+
                     }
                     ($([<P $i>]::show_boundary::<N, D, W, H, K, ID>()),+,).ambiguous_with_all()
                 }
                 #[cfg(debug_assertions)]
                 fn shape_id() -> std::any::TypeId {
-                    unreachable!()
+                    unreachable!("only (S, C) and ((S1, C), (S2, C), ...) are allowed")
                 }
             }
         }
@@ -295,7 +307,7 @@ mod tests {
     use crate::{CollisionCircle, CollisionRect, CollisionRotatedRect};
 
     #[test]
-    #[should_panic(expected = "Duplicate quadtree updating system added")]
+    #[should_panic(expected = "Duplicated quadtree updating system added")]
     fn duplicate_shape1() {
         App::new().add_plugins(QuadTreePlugin::<
             (
@@ -312,7 +324,7 @@ mod tests {
 
     #[cfg(feature = "sprite")]
     #[test]
-    #[should_panic(expected = "Duplicate quadtree updating system added")]
+    #[should_panic(expected = "Duplicated quadtree updating system added")]
     fn duplicate_shape2() {
         App::new().add_plugins(QuadTreePlugin::<
             ((CollisionRect, GlobalTransform), (CollisionRect, Sprite)),
@@ -326,7 +338,7 @@ mod tests {
 
     #[cfg(feature = "sprite")]
     #[test]
-    #[should_panic(expected = "Duplicate quadtree updating system added")]
+    #[should_panic(expected = "Duplicated quadtree updating system added")]
     fn duplicate_shape3() {
         App::new().add_plugins(QuadTreePlugin::<
             (
@@ -374,4 +386,20 @@ mod tests {
             20,
         >::default());
     }
+
+    #[cfg(feature = "sprite")]
+    #[test]
+    fn plugin_test_tuple() {
+        App::new().add_plugins(QuadTreePlugin::<
+            (
+                (CollisionRect<0>, (GlobalTransform, Sprite)),
+                (CollisionRect<1>, GlobalTransform),
+            ),
+            40,
+            4,
+            100,
+            100,
+            20,
+        >::default());
+    }
 }