bevyengine · nicopap · Jul 19, 2022 · Jul 19, 2022 · Jul 21, 2022 · Jul 22, 2022
diff --git a/Cargo.toml b/Cargo.toml
@@ -51,6 +51,7 @@ render = [
   "bevy_internal/bevy_sprite",
   "bevy_internal/bevy_text",
   "bevy_internal/bevy_ui",
+  "bevy_internal/bevy_ui_navigation",
 ]
 
 # Optional bevy crates
@@ -1462,6 +1463,48 @@ description = "Illustrates how to scale the UI"
 category = "UI (User Interface)"
 wasm = true
 
+# UI navigation
+[[example]]
+name = "button_navigation"
+path = "examples/ui_navigation/button_navigation.rs"
+
+[package.metadata.example.button_navigation]
+name = "UI button navigation"
+description = "Illustrates simple cursor focus movement between buttons"
+category = "UI navigation"
+wasm = true
+
+[[example]]
+name = "locking"
+path = "examples/ui_navigation/locking.rs"
+
+[package.metadata.example.locking]
+name = "UI locking"
+description = "Illustrates UI locking"
+category = "UI navigation"
+wasm = true
+
+[[example]]
+name = "menu_navigation"
+path = "examples/ui_navigation/menu_navigation.rs"
+
+[package.metadata.example.menu_navigation]
+name = "menu navigation"
+description = "Illustrates movement between menus"
+category = "UI navigation"
+wasm = true
+
+[[example]]
+name = "infinite_upgrades"
+path = "examples/ui_navigation/infinite_upgrades.rs"
+
+[package.metadata.example.infinite_upgrades]
+name = "Infinite upgrades"
+description = "Shows usage of a custom navigation system in 2D space and procedural menus"
+category = "UI navigation"
+wasm = true
+
+
 # Window
 [[example]]
 name = "clear_color"

diff --git a/crates/bevy_internal/Cargo.toml b/crates/bevy_internal/Cargo.toml
@@ -94,6 +94,7 @@ bevy_scene = { path = "../bevy_scene", optional = true, version = "0.9.0-dev" }
 bevy_sprite = { path = "../bevy_sprite", optional = true, version = "0.9.0-dev" }
 bevy_text = { path = "../bevy_text", optional = true, version = "0.9.0-dev" }
 bevy_ui = { path = "../bevy_ui", optional = true, version = "0.9.0-dev" }
+bevy_ui_navigation = { path = "../bevy_ui_navigation", optional = true, version = "0.9.0-dev" }
 bevy_winit = { path = "../bevy_winit", optional = true, version = "0.9.0-dev" }
 bevy_gilrs = { path = "../bevy_gilrs", optional = true, version = "0.9.0-dev" }
 

diff --git a/crates/bevy_internal/src/lib.rs b/crates/bevy_internal/src/lib.rs
@@ -161,6 +161,12 @@ pub mod ui {
     pub use bevy_ui::*;
 }
 
+#[cfg(feature = "bevy_ui_navigation")]
+pub mod ui_navigation {
+    //! Generic cursor navigation.
+    pub use bevy_ui_navigation::*;
+}
+
 #[cfg(feature = "bevy_winit")]
 pub mod winit {
     //! Window creation, configuration, and handling

diff --git a/crates/bevy_internal/src/prelude.rs b/crates/bevy_internal/src/prelude.rs
@@ -47,6 +47,10 @@ pub use crate::text::prelude::*;
 #[cfg(feature = "bevy_ui")]
 pub use crate::ui::prelude::*;
 
+#[doc(hidden)]
+#[cfg(feature = "bevy_ui_navigation")]
+pub use crate::ui_navigation::prelude::*;
+
 #[doc(hidden)]
 #[cfg(feature = "bevy_dynamic_plugin")]
 pub use crate::dynamic_plugin::*;

diff --git a/crates/bevy_ui/Cargo.toml b/crates/bevy_ui/Cargo.toml
@@ -27,6 +27,7 @@ bevy_sprite = { path = "../bevy_sprite", version = "0.9.0-dev" }
 bevy_text = { path = "../bevy_text", version = "0.9.0-dev" }
 bevy_transform = { path = "../bevy_transform", version = "0.9.0-dev" }
 bevy_window = { path = "../bevy_window", version = "0.9.0-dev" }
+bevy_ui_navigation = { path = "../bevy_ui_navigation", version = "0.9.0-dev" }
 bevy_utils = { path = "../bevy_utils", version = "0.9.0-dev" }
 
 # other

diff --git a/crates/bevy_ui/src/entity.rs b/crates/bevy_ui/src/entity.rs
@@ -2,7 +2,7 @@
 
 use crate::{
     widget::{Button, ImageMode},
-    CalculatedSize, FocusPolicy, Interaction, Node, Style, UiColor, UiImage,
+    CalculatedSize, Hover, Node, Style, UiColor, UiImage,
 };
 use bevy_ecs::{
     bundle::Bundle,
@@ -15,6 +15,7 @@ use bevy_render::{
 };
 use bevy_text::{Text, TextAlignment, TextSection, TextStyle};
 use bevy_transform::prelude::{GlobalTransform, Transform};
+use bevy_ui_navigation::prelude::{Focusable, MenuBuilder, MenuSetting};
 
 /// The basic UI node
 #[derive(Bundle, Clone, Debug, Default)]
@@ -27,8 +28,6 @@ pub struct NodeBundle {
     pub color: UiColor,
     /// Describes the image of the node
     pub image: UiImage,
-    /// Whether this node should block interaction with lower nodes
-    pub focus_policy: FocusPolicy,
     /// The transform of the node
     pub transform: Transform,
     /// The global transform of the node
@@ -39,6 +38,18 @@ pub struct NodeBundle {
     pub computed_visibility: ComputedVisibility,
 }
 
+/// A menu. All [`Focusable`] transitive children of this entity will
+/// be part of this menu.
+#[derive(Bundle)]
+pub struct MenuBundle {
+    #[bundle]
+    pub node_bundle: NodeBundle,
+    /// From which [`Focusable`] is this menu accessible (if any).
+    pub menu: MenuBuilder,
+    /// How this menu should behave.
+    pub setting: MenuSetting,
+}
+
 /// A UI node that is an image
 #[derive(Bundle, Clone, Debug, Default)]
 pub struct ImageBundle {
@@ -54,8 +65,6 @@ pub struct ImageBundle {
     pub color: UiColor,
     /// The image of the node
     pub image: UiImage,
-    /// Whether this node should block interaction with lower nodes
-    pub focus_policy: FocusPolicy,
     /// The transform of the node
     pub transform: Transform,
     /// The global transform of the node
@@ -67,7 +76,7 @@ pub struct ImageBundle {
 }
 
 /// A UI node that is text
-#[derive(Bundle, Clone, Debug)]
+#[derive(Bundle, Clone, Debug, Default)]
 pub struct TextBundle {
     /// Describes the size of the node
     pub node: Node,
@@ -77,8 +86,6 @@ pub struct TextBundle {
     pub text: Text,
     /// The calculated size based on the given image
     pub calculated_size: CalculatedSize,
-    /// Whether this node should block interaction with lower nodes
-    pub focus_policy: FocusPolicy,
     /// The transform of the node
     pub transform: Transform,
     /// The global transform of the node
@@ -123,35 +130,17 @@ impl TextBundle {
     }
 }
 
-impl Default for TextBundle {
-    fn default() -> Self {
-        TextBundle {
-            focus_policy: FocusPolicy::Pass,
-            text: Default::default(),
-            node: Default::default(),
-            calculated_size: Default::default(),
-            style: Default::default(),
-            transform: Default::default(),
-            global_transform: Default::default(),
-            visibility: Default::default(),
-            computed_visibility: Default::default(),
-        }
-    }
-}
-
 /// A UI node that is a button
-#[derive(Bundle, Clone, Debug)]
+#[derive(Bundle, Clone, Debug, Default)]
 pub struct ButtonBundle {
     /// Describes the size of the node
     pub node: Node,
     /// Marker component that signals this node is a button
     pub button: Button,
     /// Describes the style including flexbox settings
     pub style: Style,
-    /// Describes whether and how the button has been interacted with by the input
-    pub interaction: Interaction,
-    /// Whether this node should block interaction with lower nodes
-    pub focus_policy: FocusPolicy,
+    /// How this button fits with other ones
+    pub focusable: Focusable,
     /// The color of the node
     pub color: UiColor,
     /// The image of the node
@@ -164,25 +153,10 @@ pub struct ButtonBundle {
     pub visibility: Visibility,
     /// Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering
     pub computed_visibility: ComputedVisibility,
+    /// Handle hovering state of the button
+    pub hover: Hover,
 }
 
-impl Default for ButtonBundle {
-    fn default() -> Self {
-        ButtonBundle {
-            button: Button,
-            interaction: Default::default(),
-            focus_policy: Default::default(),
-            node: Default::default(),
-            style: Default::default(),
-            color: Default::default(),
-            image: Default::default(),
-            transform: Default::default(),
-            global_transform: Default::default(),
-            visibility: Default::default(),
-            computed_visibility: Default::default(),
-        }
-    }
-}
 /// Configuration for cameras related to UI.
 ///
 /// When a [`Camera`] doesn't have the [`UiCameraConfig`] component,