Struct MultiQuadTreePlugin

pub struct MultiQuadTreePlugin<C>
where
    C: AsQuadTreePluginConfig,
{ /* private fields */ }

Available on crate feature multi-quadtree only.

A Bevy plugin for multiple quadtrees.

Example

App::new()
    .add_plugins(MultiQuadTreePlugin::<(
        QTConfig::<(
                // CollisionRect with ID 0, follows GlobalTransform and Sprite
                (CollisionRect<0>, (GlobalTransform, Sprite)),
                // CollisionRect with ID 1, follows GlobalTransform only
                (CollisionRect<1>, GlobalTransform),
                // CollisionCircle with default ID 0, follows GlobalTransform
                (CollisionCircle, GlobalTransform),
            ),
            // the ID of this quadtree is 0.
            // at most 40 objects in each node, 4 levels, 100x100 boundary, center at (0, 0)
            // 2.0 = outlet_boundary / inlet_boundary for LooseQuadTree,
            // query by `Res<QuadTree<0>>`
            0, 40, 4, 100, 100, 0, 0, 20>,
        QTConfig::<(
                // CollisionRect with ID 1, follows GlobalTransform and Sprite
                (CollisionRect<1>, (GlobalTransform, Sprite)),
                // CollisionCircle with ID 1, follows GlobalTransform only
                (CollisionCircle<1>, GlobalTransform),
            ),
            // The same attribute as the previous one, but the ID is 1.
            // query by `Res<QuadTree<1>>`
            1, 40, 4, 100, 100, 0, 0, 20>,
        )>::default());

Panic

1. duplicated quadtree added. (Debug check only)

e.g. (QTConfig<…, 0, 40, 4, 100, 100, 0, 0, 20>, QTConfig<…, 0, 40, 4, 100, 100, 0, 0, 20>) they both insert QuadTrees with the same ID 0 into the world.

2. duplicated shapes in the same quadtree. (Debug check only)

See QuadTreePlugin for more information.

3. invalid const parameters. (Debug check only)

N, D, W, H should > 0. K should >= 10.

Trait Implementations

impl<C> Debug for MultiQuadTreePlugin<C>

where C: AsQuadTreePluginConfig + Debug,

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

Formats the value using the given formatter.

impl<C> Default for MultiQuadTreePlugin<C>

where C: AsQuadTreePluginConfig,

fn default() -> Self

Returns the “default value” for a type.

impl<C> Plugin for MultiQuadTreePlugin<C>

where C: AsQuadTreePluginConfig,

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.