bevy_ui_extras 0.20.0

A crate containing a collection of utilities to make working with ui in bevy easier.
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

use std::marker::PhantomData;
use std::ops::DerefMut;

use bevy_diagnostic::{FrameTimeDiagnosticsPlugin, SystemInformationDiagnosticsPlugin};
use bevy_inspector_egui::bevy_egui::EguiPlugin;
use bevy_inspector_egui::egui::Align2;
// use bevy_inspector_egui::quick::AssetInspectorPlugin;
use bevy_inspector_egui::DefaultInspectorConfigPlugin;
// use bevy_pbr::StandardMaterial;
use bevy_state::prelude::*;
// use bevy_pbr::StandardMaterial;
use bevy_app::{Plugin, Update};
use bevy_ecs::prelude::*;

use crate::{
    ComponentFilterMode, DebugMenuToggle, DebugModeFlagToggle, DebugWidgetView, FilterKind,
    FocusOnDebugFilter, Opacity, ShowAppStatus, UiAlignment, UiStyle,
    display_debug_menu_explanation, manage_debug_menu_state, set_entry_to_off, set_entry_to_on,
};
use crate::{FilterResponse, KeyBinds, debug_menu, states::DebugMenuState};

/// plugin for general debug menu. See [`KeyBinds`] for keybinds.
pub struct UiExtrasDebug {
    pub ui_style: UiStyle,
    pub alignment: Option<Align2>,
    pub default_filters: Vec<FilterKind>,
    pub keybinds_override: Option<KeyBinds>,
    pub menu_mode: DebugMenuState,
}

impl Default for UiExtrasDebug {
    fn default() -> Self {
        Self {
            ui_style: UiStyle::BLACK_GLASS,
            alignment: None,
            keybinds_override: None,
            default_filters: vec![],
            menu_mode: DebugMenuState::Closed,
        }
    }
}

impl Plugin for UiExtrasDebug {
    fn build(&self, app: &mut bevy_app::App) {
        // let window_style = match self.ui_style {
        //     UiStyle::Black_Glass => UiStyle::default(),
        //     UiStyle::Default => UiStyle(None),
        //     UiStyle::Custom(frame) => UiStyle(Some(frame)),
        // };

        if !app.is_plugin_added::<DefaultInspectorConfigPlugin>() {
            app.add_plugins(DefaultInspectorConfigPlugin);
        }
        if !app.is_plugin_added::<EguiPlugin>() {
            app.add_plugins(EguiPlugin {
                //(TODO): Setting this to false because it causes a panic
                //once this is fixed, set this to true.
                enable_multipass_for_primary_context: false,
            });
        }
        // if !app.is_plugin_added::<AssetInspectorPlugin::<StandardMaterial>>() {
        //     app.add_plugins(AssetInspectorPlugin::<StandardMaterial>::default());
        // }

        // if !app.is_plugin_added::<InspectSchedulePlugin>() {
        //     app.add_plugins(InspectSchedulePlugin);
        // }

        let opacity = match self.ui_style.0 {
            Some(style) => style.fill.a(),
            None => u8::MAX,
        };
        app.init_resource::<DebugMenuToggle>()
            .insert_state(self.menu_mode.clone())
            .insert_state(DebugModeFlagToggle::Off)
            .insert_resource(self.keybinds_override.clone().unwrap_or_default())
            .register_type::<KeyBinds>()
            .insert_resource(Opacity(opacity))
            .insert_resource(self.ui_style.clone())
            .insert_resource(UiAlignment(self.alignment.clone()))
            .init_resource::<DebugWidgetView>()
            .init_resource::<FilterResponse>()
            .init_resource::<ShowAppStatus>()
            .init_resource::<FocusOnDebugFilter>()
            .init_resource::<ComponentFilterMode>()
            //.init_resource::<SelectedEntities>()
            .register_type::<FilterResponse>()
            //.register_asset_reflect::<StandardMaterial>()
            .add_systems(Update, debug_menu.run_if(in_state(DebugMenuState::Open)))
            .add_systems(Update, manage_debug_menu_state)
            .add_systems(
                Update,
                display_debug_menu_explanation.run_if(in_state(DebugMenuState::Explain)),
            )
            .add_plugins(FrameTimeDiagnosticsPlugin::default())
            .add_plugins(SystemInformationDiagnosticsPlugin);
    }
}

/// Plugin for registering debug mode flags. If your resource is a bool newtype. implement deref into bool for it and, register it with
/// ```rust
/// app.add_plugins(DebugModeFlagRegistry::<T>::default())
/// ```
/// and then you can enable it through the debug menu.
#[derive(Default)]
pub struct DebugModeFlagRegister<T: DerefMut<Target = bool> + Resource>(pub PhantomData<T>);

impl<T: DerefMut<Target = bool> + Resource> Plugin for DebugModeFlagRegister<T> {
    fn build(&self, app: &mut bevy_app::App) {
        app.add_systems(OnEnter(DebugModeFlagToggle::On), set_entry_to_on::<T>)
            .add_systems(OnEnter(DebugModeFlagToggle::Off), set_entry_to_off::<T>);
    }
}