Struct QuadTreePlugin

pub struct QuadTreePlugin<P, const N: usize, const W: usize, const H: usize, const K: usize = 10, const ID: usize = 0>
where
    P: TrackingPair,
{ /* private fields */ }

A Bevy plugin for quadtree.

Type Parameters

P: (S, C) pair (or tuple of (S, C)s) where S (collision shape) can updated by C (component).

S: Component + DynCollision + UpdateCollision<C> + Clone, such as CollisionCircle, CollisionRect, CollisionRotatedRect. are used to perform Collision Detection, storing the shape and position info, also serving as a marker component in ECS queries. Add the shapes which you wanna include into QuadTree and auto-upgrade. (Do not need to include those only used in the QuadTree::query)

C: Component, such as GlobalTransform.

N: The max number of objects each node.

W: The width of the root node boundary. H: The height of the root node boundary. The boundary’s center is (0, 0).

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.

Example

use bevy::prelude::*;
use bevy_quadtree::{CollisionCircle, CollisionRect, CollisionRotatedRect, QuadTreePlugin};

#[cfg(feature = "sprite")]
App::new()
   .add_plugins(QuadTreePlugin::<(
            (CollisionCircle, GlobalTransform),
            (CollisionRotatedRect, GlobalTransform),
            (CollisionRect, Sprite),
        ),
        40, 100, 100, 20>::default());

Trait Implementations

impl<P, const N: usize, const W: usize, const H: usize, const K: usize, const ID: usize> Debug for QuadTreePlugin<P, N, W, H, K, ID>

where P: TrackingPair + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P, const N: usize, const W: usize, const H: usize, const K: usize, const ID: usize> Default for QuadTreePlugin<P, N, W, H, K, ID>

where P: TrackingPair,

fn default() -> Self

Returns the “default value” for a type.

impl<P, const N: usize, const W: usize, const H: usize, const K: usize, const ID: usize> Plugin for QuadTreePlugin<P, N, W, H, K, ID>

where P: TrackingPair,

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.