Struct bevy_ui_navigation::Focusable

pub struct Focusable { /* private fields */ }

An Entity that can be navigated to using the ui navigation system.

It is in one of multiple FocusState, you can check its state with the Focusable::state method or any of the is_* Focusable methods.

A Focusable can be Focusable::cancel. Meaning: when you send the NavRequest::Action request while a cancel Focusable is focused, it will act as if the NavRequest::Cancel request was received.

A Focusable can also be Focusable::lock. Meaning: when you send the NavRequest::Action request while a lock Focusable is focused, it will prevent all further processing of NavRequests and emit a NavEvent::Locked.

Only by sending a NavRequest::Free will the navigation system resume processing new NavRequests. It will send a NavEvent::Unlocked just before.

Implementations

impl Focusable

pub fn state(&self) -> FocusState

The state of this Focusable

pub fn is_focused(&self) -> bool

This Focusable is the unique focused element

All navigation requests start from it.

To set an arbitrary Focusable to focused, you should send a NavRequest::FocusOn request.

pub fn is_active(&self) -> bool

This Focusable is active

Meaning it is either the focused element or one of the Focusable on the path to it. All Focusables to the path to the focused element are active.

pub fn is_dormant(&self) -> bool

This Focusable is dormant

When focus leaves a specific Focusable without being acquired by a sibling, it becomes dormant. When focus comes back to the encompassing NavMenu, the focused element will be the dormant element within the menu.

pub fn is_inert(&self) -> bool

This Focusable is neither active, focused or dormant

pub fn is_cancel(&self) -> bool

This Focusable is a cancel focusable, see Focusable::cancel

pub fn is_lock(&self) -> bool

This Focusable is a locking focusable, see Focusable::lock

pub fn cancel() -> Self

This is a “Cancel” focusable

Whenever a NavRequest::Action is sent while this Focusable is focused, act as if the request was a NavRequest::Cancel

pub fn lock() -> Self

This is a “Lock” focusable

Whenever a NavRequest::Action is sent while this Focusable is focused, the navigation system stops processing new NavRequests until it receives NavRequest::Free.

This is useful to implement widgets with complex controls you don’t want to accidentally unfocus, or suspending the navigation system while in-game.

Trait Implementations

impl Clone for Focusable

fn clone(&self) -> Focusable

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Focusable where
    Self: Send + Sync + 'static, 

type Storage = TableStorage

impl Debug for Focusable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Focusable

fn default() -> Self

Returns the “default value” for a type.