nightshade 0.53.0

A cross-platform data-oriented game engine.
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

//! The retained UI composition: the ordered UI pipeline, the sub-schedule
//! runner, and [`UiPlugin`]. The UI subsystem itself lives in
//! [`crate::ecs::ui`] because it is core, not feature-gated; this plugin
//! is what activates it.

use crate::app::{App, Plugin, Stage};
use crate::ecs::world::World;
use crate::schedule::{FramePhase, SystemFn, schedule_push};

/// The UI pipeline in run order. Gamepad navigation has to run after
/// picking: picking resets every entity's `interaction.clicked` flag at
/// the top of the frame, so running navigation after it lets the
/// gamepad's South-press flag survive into widget interaction and click
/// event emission.
pub fn build_default_retained_ui_schedule() -> Vec<SystemFn> {
    vec![
        crate::ecs::ui::widget_systems::ui_retained_input_sync_system,
        crate::ecs::ui::picking::ui_layout_picking_system,
        #[cfg(feature = "gamepad")]
        crate::ecs::ui::gamepad_navigation::ui_gamepad_navigation_system,
        crate::ecs::ui::widget_systems::ui_widget_interaction_system,
        crate::ecs::ui::widget_systems::ui_event_bubble_system,
        crate::ecs::ui::widget_systems::ui_emit_click_events_system,
        crate::ecs::ui::systems::ui_layout_state_update_system,
        crate::ecs::ui::systems::ui_docked_panel_layout_system,
        crate::ecs::ui::systems::ui_responsive_apply_system,
        crate::ecs::ui::systems::ui_layout_compute_system,
        crate::ecs::ui::systems::ui_theme_transition_tick_system,
        crate::ecs::ui::systems::ui_theme_apply_system,
        crate::ecs::ui::systems::ui_layout_color_blend_system,
        crate::ecs::ui::systems::ui_layout_transform_blend_system,
        crate::ecs::ui::render_sync::ui_layout_render_sync_system,
    ]
}

pub fn run_retained_ui_schedule(world: &mut World) {
    let systems = std::mem::take(&mut world.resources.schedules.retained_ui);
    for system in &systems {
        system(world);
    }
    world.resources.schedules.retained_ui = systems;
}

/// Builds the UI sub-schedule and registers the frame-schedule entry that
/// runs it, after the transform propagation the layout depends on, with
/// the tree shown.
pub fn install(world: &mut World) {
    world.resources.retained_ui.visible = true;
    world.resources.schedules.retained_ui = build_default_retained_ui_schedule();
    schedule_push(
        &mut world.resources.schedules.frame,
        FramePhase::PostUpdate,
        run_retained_ui_schedule,
    );
}

/// Installs the retained UI through [`install`]. Hide and show the whole
/// tree at runtime through `world.resources.retained_ui.visible`.
pub struct UiPlugin;

impl Plugin for UiPlugin {
    fn build(&self, app: &mut App) {
        app.add_system(Stage::Startup, install);
    }
}