bevy_ghx_grid 0.6.0

Bevy plugins for 2D & 3D grids
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use bevy::{
    color::Color,
    ecs::{component::Component, query::With, system::Query},
    gizmos::{config::GizmoConfigGroup, gizmos::Gizmos},
    math::{Vec2, Vec3, Vec3Swizzles},
    reflect::Reflect,
    transform::components::Transform,
};
use ghx_grid::cartesian::{coordinates::CartesianCoordinates, grid::CartesianGrid};

/// 3d-specific (`Camera3d`) component-marker of a grid debug view
#[derive(Component, Default)]
#[require(DebugGridView)]
pub struct DebugGridView3d;

/// 2d-specific (`Camera2d`) component-marker of a grid debug view
#[derive(Component, Default)]
#[require(DebugGridView)]
pub struct DebugGridView2d;

#[derive(Default, Reflect, GizmoConfigGroup)]
/// The Gizmo configuration for grid views
pub struct GridViewGizmoGroup;

/// Component used on all debug grid to store configuration.
///
/// Updating the component members will update the grid debug view directly
#[derive(Component)]
pub struct DebugGridView {
    /// Whether or not to display the grid
    pub display_grid: bool,
    /// Whether or not to display the grid markers
    pub display_markers: bool,
    /// Color of the displayed grid.
    pub color: Color,
    /// Size of a grid node in world units on all 3 axis. Defaults to [`Vec3::ONE`]
    pub node_size: Vec3,
}
impl Default for DebugGridView {
    fn default() -> Self {
        Self {
            display_grid: true,
            display_markers: true,
            color: Default::default(),
            node_size: Vec3::ONE,
        }
    }
}
impl DebugGridView {
    /// Creates a new [`DebugGridView`]
    pub fn new(display_grid: bool, display_markers: bool, color: Color, node_size: Vec3) -> Self {
        Self {
            display_grid,
            display_markers,
            color,
            node_size,
        }
    }
}

/// System that uses [`Gizmos`] to render the debug grid every frame.
///
/// To be used with a `Camera3d`
pub fn draw_debug_grids_3d<T: CartesianCoordinates>(
    mut gizmos: Gizmos,
    debug_grids: Query<(&Transform, &CartesianGrid<T>, &DebugGridView), With<DebugGridView3d>>,
) {
    for (transform, grid, view) in debug_grids.iter() {
        if !view.display_grid {
            continue;
        }
        let end = Vec3 {
            x: (grid.size_x() as f32) * view.node_size.x,
            y: (grid.size_y() as f32) * view.node_size.y,
            z: (grid.size_z() as f32) * view.node_size.z,
        };
        for x in 0..=grid.size_x() {
            let current_x = x as f32 * view.node_size.x;
            let points = vec![
                transform.transform_point(Vec3::new(current_x, 0., 0.)),
                transform.transform_point(Vec3::new(current_x, end.y, 0.)),
                transform.transform_point(Vec3::new(current_x, end.y, end.z)),
                transform.transform_point(Vec3::new(current_x, 0., end.z)),
                transform.transform_point(Vec3::new(current_x, 0., 0.)),
            ];
            gizmos.linestrip(points, view.color);
        }
        for y in 0..=grid.size_y() {
            let current_y = y as f32 * view.node_size.y;
            let points = vec![
                transform.transform_point(Vec3::new(0., current_y, 0.)),
                transform.transform_point(Vec3::new(end.x, current_y, 0.)),
                transform.transform_point(Vec3::new(end.x, current_y, end.z)),
                transform.transform_point(Vec3::new(0., current_y, end.z)),
                transform.transform_point(Vec3::new(0., current_y, 0.)),
            ];
            gizmos.linestrip(points, view.color);
        }
        for z in 0..=grid.size_z() {
            let current_z = z as f32 * view.node_size.z;
            let points = vec![
                transform.transform_point(Vec3::new(0., 0., current_z)),
                transform.transform_point(Vec3::new(end.x, 0., current_z)),
                transform.transform_point(Vec3::new(end.x, end.y, current_z)),
                transform.transform_point(Vec3::new(0., end.y, current_z)),
                transform.transform_point(Vec3::new(0., 0., current_z)),
            ];
            gizmos.linestrip(points, view.color);
        }
    }
}

/// System that uses [`Gizmos`] to render the debug grid every frame.
///
/// To be used with a `Camera2d`
pub fn draw_debug_grids_2d<T: CartesianCoordinates>(
    mut gizmos: Gizmos,
    debug_grids: Query<(&Transform, &CartesianGrid<T>, &DebugGridView), With<DebugGridView2d>>,
) {
    for (transform, grid, view) in debug_grids.iter() {
        if !view.display_grid {
            continue;
        }
        let end = Vec2 {
            x: (grid.size_x() as f32) * view.node_size.x,
            y: (grid.size_y() as f32) * view.node_size.y,
        };
        for y in 0..=grid.size_y() {
            let current_y = y as f32 * view.node_size.y;
            let from = transform.transform_point(Vec3::new(0., current_y, 0.));
            let to = transform.transform_point(Vec3::new(end.x, current_y, 0.));
            gizmos.line_2d(from.xy(), to.xy(), view.color);
        }
        for x in 0..=grid.size_x() {
            let current_x = x as f32 * view.node_size.x;
            let from = transform.transform_point(Vec3::new(current_x, 0., 0.));
            let to = transform.transform_point(Vec3::new(current_x, end.y, 0.));
            gizmos.line_2d(from.xy(), to.xy(), view.color);
        }
    }
}