- remove unrelated type params of QuadTree

- support center setting

Author: kingwingfly

CHANGELOG.md

@@ -9,6 +9,11 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com
 -->
 
 ## [Unreleased]
+## [0.15.1-beta.3] - 2025-01-23
+
+- remove unrelated type params of `QuadTree`
+- support center setting
+
 ## [0.15.1-beta.2] - 2025-01-23
 
 - improved the organization of public exports (`pub use`) to enhance usability and clarity.

Cargo.toml

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

bevy_quadtree/README.md

@@ -68,12 +68,11 @@ A quadtree plugin for bevy.
 Function:
 - Auto update following `Changed<GlobalTransform>`, all users need to do is querying.
 - LooseQuadTree supported.
-- Compile time optimized with const type parameters.
 
 Features:
 - `gizmos`: show gizmos of the quadtree boundaries.
 - `sprite`: enable `CollisionRect` and `CollisionRotatedRect` to track `sprite.custom_size`.
-- `multi-quadtree`: support multiple quadtrees in one world.
+- `multi-quadtree`: support multiple quadtrees in one world, see [`MultiQuadTreePlugin`].
 
 Version:
 
@@ -85,6 +84,9 @@ And upgrade will be like `bevy_version.beta.x`
 For those who upgrade from version <= 0.15.1-alpha7, pay attention to the new type paramter `D` in `QuadTreePlugin`.
 And shapes now have `ID` as well. Moreover, the tree memory is pre-allocated, no longer dynamically allocating.
 
+For those who upgrade from version <= 0.15.1-beta.2, `X` `Y` type params added to Plugins to set the origin of boundary.
+The QuadTree's type params is simplified to only `ID` as well.
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 
@@ -122,13 +124,14 @@ fn main() {
         .add_plugins(QuadTreePlugin::<(
                 (CollisionCircle, GlobalTransform), (CollisionRect, (GlobalTransform, Sprite)),
             ),
-            40, 8, 100, 100, 20>::default()
+            40, 8, 100, 100, 0, 0, 20, 114514>::default()
         )
         // CollisionCircle follows GlobalTransform, CollisionRect follows Sprite and GlobalTransform
         // at most 40 entities in a node
         // at most 8 levels
-        // 100 x 100 world size
-        // 20 / 10 = 2 = outlet_boundary / inlet_boundary (for loose quadtree)
+        // 100 x 100 world size, center at (0, 0)
+        // 20 / 10 = 2.0 = outlet_boundary / inlet_boundary (for loose quadtree)
+        // quadtree id 114514
         .run();
 }
 # }
@@ -154,7 +157,8 @@ cmds.spawn((
 4. Query the quadtree like bevy's `Or, Not`:
 
 ```rust ignore
-type MyQuadTree = QuadTree<40, 8, 100, 100, 20>;
+// default id 0
+type MyQuadTree = QuadTree<114514>;
 
 fn pick(
     mut gizmos: Gizmos,

bevy_quadtree/src/plugin/mod.rs

@@ -38,9 +38,9 @@ use bevy_transform::prelude::*;
 ///
 /// `W`: The width of the root node boundary.
 /// `H`: The height of the root node boundary.
-/// The boundary's center is (0, 0).
+/// The boundary's center is (`X`, `Y`).
 ///
-/// `K`: For `LooseQuadTree`, K / 10 = outlet_boundary / inlet_boundary. Set K to 10 by default and 20 is founded best.
+/// `K`: For `LooseQuadTree`, K / 10 = outlet_boundary / inlet_boundary. K is set to 20 by default.
 /// K should >= 10. Only if the object move and is **no longer completely contained** by the outlet_boundary will it be inserted again.
 ///
 /// `ID`: Set a lucky number as you like for the quadtree.
@@ -61,7 +61,7 @@ use bevy_transform::prelude::*;
 ///             (CollisionRotatedRect, Sprite),
 ///             (CollisionRect, (GlobalTransform, Sprite)),
 ///         ),
-///         40, 4, 100, 100, 20>::default());
+///         40, 4, 100, 100, 0, 0, 20>::default());
 /// # }
 /// ```
 ///
@@ -81,7 +81,9 @@ pub struct QuadTreePlugin<
     const D: usize,
     const W: usize,
     const H: usize,
-    const K: usize = 10,
+    const X: usize = 0,
+    const Y: usize = 0,
+    const K: usize = 20,
     const ID: usize = 0,
 > where
     P: TrackingPair,
@@ -95,9 +97,11 @@ impl<
         const N: usize,
         const W: usize,
         const H: usize,
+        const X: usize,
+        const Y: usize,
         const K: usize,
         const ID: usize,
-    > Default for QuadTreePlugin<P, N, D, W, H, K, ID>
+    > Default for QuadTreePlugin<P, N, D, W, H, X, Y, K, ID>
 where
     P: TrackingPair,
 {
@@ -114,9 +118,11 @@ impl<
         const D: usize,
         const W: usize,
         const H: usize,
+        const X: usize,
+        const Y: usize,
         const K: usize,
         const ID: usize,
-    > Plugin for QuadTreePlugin<P, N, D, W, H, K, ID>
+    > Plugin for QuadTreePlugin<P, N, D, W, H, X, Y, K, ID>
 where
     P: TrackingPair,
 {
@@ -126,11 +132,11 @@ where
         assert!(W > 0, "W should > 0");
         assert!(H > 0, "H should > 0");
         assert!(K >= 10, "K should >= 10");
-        app.init_resource::<QuadTree<N, D, W, H, K, ID>>()
+        app.insert_resource(QuadTree::<ID>::new(N, D, W, H, X, Y, K))
             .add_systems(PreUpdate, P::update_collision())
-            .add_systems(Update, P::update_quadtree::<N, D, W, H, K, ID>());
+            .add_systems(Update, P::update_quadtree::<ID>());
         #[cfg(feature = "gizmos")]
-        app.add_systems(PostUpdate, P::show_boundary::<N, D, W, H, K, ID>());
+        app.add_systems(PostUpdate, P::show_boundary::<ID>());
     }
 }
 
@@ -140,24 +146,10 @@ pub trait TrackingPair: Send + Sync + 'static {
     /// return the system to update collision
     fn update_collision() -> SystemConfigs;
     /// return the system to update quadtree
-    fn update_quadtree<
-        const N: usize,
-        const D: usize,
-        const W: usize,
-        const H: usize,
-        const K: usize,
-        const ID: usize,
-    >() -> SystemConfigs;
+    fn update_quadtree<const ID: usize>() -> SystemConfigs;
     /// return the system to show box
     #[cfg(feature = "gizmos")]
-    fn show_boundary<
-        const N: usize,
-        const D: usize,
-        const W: usize,
-        const H: usize,
-        const K: usize,
-        const ID: usize,
-    >() -> SystemConfigs;
+    fn show_boundary<const ID: usize>() -> SystemConfigs;
     /// return the shape id, to ensure no duplicate shape updating system added
     #[cfg(debug_assertions)]
     fn shape_id() -> std::any::TypeId;
@@ -172,27 +164,13 @@ macro_rules! impl_tracking_pair {
             fn update_collision() -> SystemConfigs {
                 update_collision::<S, $c>.ambiguous_with_all()
             }
-            fn update_quadtree<
-                const N: usize,
-                const D: usize,
-                const W: usize,
-                const H: usize,
-                const K: usize,
-                const ID: usize,
-            >() -> SystemConfigs {
-                update_quadtree::<S, N, D, W, H, K, ID>.ambiguous_with_all()
+            fn update_quadtree<const ID: usize>() -> SystemConfigs {
+                update_quadtree::<S, ID>.ambiguous_with_all()
             }
             #[cfg(feature = "gizmos")]
-            fn show_boundary<
-                const N: usize,
-                const D: usize,
-                const W: usize,
-                const H: usize,
-                const K: usize,
-                const ID: usize,
-            >() -> SystemConfigs {
+            fn show_boundary<const ID: usize>() -> SystemConfigs {
                 use crate::system::show_boundary;
-                show_boundary::<S, N, D, W, H, K, ID>.ambiguous_with_all()
+                show_boundary::<S, ID>.ambiguous_with_all()
             }
             #[cfg(debug_assertions)]
             fn shape_id() -> std::any::TypeId {
@@ -216,15 +194,15 @@ macro_rules! impl_tracking_pair_tuple {
                 // 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>(
+            fn update_quadtree<const ID: usize>(
             ) -> SystemConfigs {
-                update_quadtree::<S, N, D, W, H, K, ID>.ambiguous_with_all()
+                update_quadtree::<S, ID>.ambiguous_with_all()
             }
             #[cfg(feature = "gizmos")]
-            fn show_boundary<const N: usize, const D: usize, const W: usize, const H: usize, const K: usize, const ID: usize>(
+            fn show_boundary<const ID: usize>(
             ) -> SystemConfigs {
                 use crate::system::show_boundary;
-                show_boundary::<S, N, D, W, H, K, ID>.ambiguous_with_all()
+                show_boundary::<S, ID>.ambiguous_with_all()
             }
             #[cfg(debug_assertions)]
             fn shape_id() -> std::any::TypeId {
@@ -253,7 +231,7 @@ macro_rules! impl_tracking_pairs {
                     // 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>(
+                fn update_quadtree<const ID: usize>(
                 ) -> SystemConfigs {
                     #[cfg(debug_assertions)]
                     {
@@ -264,10 +242,10 @@ macro_rules! impl_tracking_pairs {
                             }
                         );+
                     }
-                    ($([<P $i>]::update_quadtree::<N, D, W, H, K, ID>()),+,).ambiguous_with_all()
+                    ($([<P $i>]::update_quadtree::<ID>()),+,).ambiguous_with_all()
                 }
                 #[cfg(feature = "gizmos")]
-                fn show_boundary<const N: usize, const D: usize, const W: usize, const H: usize, const K: usize, const ID: usize>(
+                fn show_boundary<const ID: usize>(
                 ) -> SystemConfigs {
                     #[cfg(debug_assertions)]
                     {
@@ -278,7 +256,7 @@ macro_rules! impl_tracking_pairs {
                             }
                         );+
                     }
-                    ($([<P $i>]::show_boundary::<N, D, W, H, K, ID>()),+,).ambiguous_with_all()
+                    ($([<P $i>]::show_boundary::<ID>()),+,).ambiguous_with_all()
                 }
                 #[cfg(debug_assertions)]
                 fn shape_id() -> std::any::TypeId {
@@ -317,6 +295,8 @@ mod tests {
             4,
             100,
             100,
+            0,
+            0,
             20,
         >::default());
     }
@@ -331,6 +311,8 @@ mod tests {
             4,
             100,
             100,
+            0,
+            0,
             20,
         >::default());
     }
@@ -350,6 +332,8 @@ mod tests {
             4,
             100,
             100,
+            0,
+            0,
             20,
         >::default());
     }
@@ -367,6 +351,8 @@ mod tests {
             4,
             100,
             100,
+            0,
+            0,
             20,
         >::default());
     }
@@ -382,6 +368,8 @@ mod tests {
             4,
             100,
             100,
+            0,
+            0,
             20,
         >::default());
     }
@@ -398,6 +386,8 @@ mod tests {
             4,
             100,
             100,
+            0,
+            0,
             20,
         >::default());
     }