bevy_uniform_grid_2d 0.4.2

A simple Bevy plugin for uniform grid spatial indexing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

use std::marker::PhantomData;

use bevy::{
    app::{Plugin, Update},
    ecs::component::Component,
    math::{UVec2, Vec2},
};

use crate::{
    event::{GridEvent, TransformGridEvent},
    resource::Grid,
    system::{update_debug_grid_lines, update_grid},
};

pub struct UniformGrid2dPlugin<Marker: Component, const N: usize = 4> {
    dimensions: UVec2,
    spacing: Vec2,
    anchor: Vec2,
    debug: bool,
    marker: PhantomData<Marker>,
}

impl<Marker: Component, const N: usize> UniformGrid2dPlugin<Marker, N> {
    /// Builder method to enable debug mode.
    pub fn debug(mut self, value: bool) -> Self {
        self.debug = value;
        self
    }

    /// Builder method to set the shape of the grid in cell units.
    pub fn dimensions(mut self, value: impl Into<UVec2>) -> Self {
        self.dimensions = value.into();
        self
    }

    /// Builder method to set the shape of each grid cell in world-space units.
    pub fn spacing(mut self, value: impl Into<Vec2>) -> Self {
        self.spacing = value.into();
        self
    }

    /// Builder method to set the point in world space to anchor the grid. Defaults to the origin.
    pub fn anchor(mut self, value: impl Into<Vec2>) -> Self {
        self.anchor = value.into();
        self
    }
}

impl<Marker: Component, const N: usize> Default for UniformGrid2dPlugin<Marker, N> {
    fn default() -> Self {
        Self {
            dimensions: UVec2::ONE,
            spacing: Vec2::ONE,
            anchor: Vec2::ZERO,
            debug: false,
            marker: PhantomData,
        }
    }
}

impl<Marker: Component, const N: usize> Plugin for UniformGrid2dPlugin<Marker, N> {
    fn build(&self, app: &mut bevy::app::App) {
        app.add_event::<GridEvent>()
            .add_event::<TransformGridEvent<Marker, N>>()
            .insert_resource(
                Grid::<Marker, N>::default()
                    .with_dimensions(self.dimensions)
                    .with_spacing(self.spacing)
                    .with_anchor(self.anchor),
            )
            .add_systems(Update, update_grid::<Marker, N>);
        if self.debug {
            app.add_systems(Update, update_debug_grid_lines::<Marker, N>);
        }
    }
}