bevy_debug_grid 0.9.1

A bevy plugin for creating grids, for debugging purposes
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

use bevy::asset::load_internal_asset;
use bevy::prelude::*;
use std::marker::PhantomData;

use crate::*;

/// Spawns a default floor grid, resembling the one used in [Blender](https://www.blender.org/)
pub fn spawn_floor_grid(mut commands: Commands) {
    commands.spawn((
        Grid {
            spacing: 10.0_f32,
            count: 16,
            ..default()
        },
        SubGrid::default(),
        GridAxis::new_rgb(),
        TrackedGrid::default(),
        Transform::default(),
        Visibility::default(),
    ));
}

/// The plugin which allows floor grids to work, where `T` is the component to track the floor grid to
pub struct TrackedDebugGridPlugin<T: Component> {
    spawn_floor_grid: bool,
    _phantom: PhantomData<T>,
}

impl<T: Component> TrackedDebugGridPlugin<T> {
    /// Adds the plugin along with a default floor grid
    pub const fn with_floor_grid() -> Self {
        Self {
            spawn_floor_grid: true,
            _phantom: PhantomData,
        }
    }

    /// Adds the plugin without spawning a default floor grid
    pub const fn without_floor_grid() -> Self {
        Self {
            spawn_floor_grid: false,
            _phantom: PhantomData,
        }
    }
}

impl<T: Component> Default for TrackedDebugGridPlugin<T> {
    fn default() -> Self {
        Self::with_floor_grid()
    }
}

impl<T: Component> Plugin for TrackedDebugGridPlugin<T> {
    fn build(&self, app: &mut App) {
        load_internal_asset!(
            app,
            CLIPPED_LINE_SHADER_HANDLE,
            "shaders/clipped_line.wgsl",
            Shader::from_wgsl
        );
        load_internal_asset!(
            app,
            SIMPLE_LINE_SHADER_HANDLE,
            "shaders/simple_line.wgsl",
            Shader::from_wgsl
        );

        app.add_plugins((
            MaterialPlugin::<SimpleLineMaterial>::default(),
            MaterialPlugin::<ClippedLineMaterial>::default(),
        ))
        .add_systems(
            PreUpdate,
            (
                main_grid_mesher_untracked,
                main_grid_mesher_tracked,
                sub_grid_mesher,
                grid_axis_mesher,
                tracked_grid_updater::<T>,
                custom_tracked_grid_updater,
            ),
        )
        .add_systems(
            Update,
            (
                despawn_children_upon_removal::<Grid, GridChild>,
                despawn_children_upon_removal::<Grid, SubGridChild>,
                despawn_children_upon_removal::<Grid, GridAxisChild>,
                despawn_children_upon_removal::<SubGrid, SubGridChild>,
                despawn_children_upon_removal::<GridAxis, GridAxisChild>,
            ),
        );
        if self.spawn_floor_grid {
            app.add_systems(Startup, spawn_floor_grid);
        }
    }
}

pub type DebugGridPlugin = TrackedDebugGridPlugin<Camera>;