Enum bevy_ui_navigation::events::NavRequest

source · [−]

pub enum NavRequest {
    Move(Direction),
    ScopeMove(ScopeDirection),
    Action,
    Cancel,
    FocusOn(Entity),
    Free,
}

Expand description

Requests to send to the navigation system to update focus.

Variants

`Move(Direction)`

Move in in provided direction according to the plugin’s navigation strategy.

Typically used by gamepads.

`ScopeMove(ScopeDirection)`

Move within the encompassing MenuSetting::scope.

`Action`

Activate the currently focused Focusable.

If a menu is reachable from

`Cancel`

Leave this submenu to enter the one it is reachable from.

`FocusOn(Entity)`

Move the focus to any arbitrary Focusable entity.

`Free`

Unlocks the navigation system.

A NavEvent::Unlocked will be emitted as a response if the navigation system was indeed locked.

Trait Implementations

source

impl Clone for NavRequest

source

fn clone(&self) -> NavRequest

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for NavRequest

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<NavRequest> for NavRequest

source

fn eq(&self, other: &NavRequest) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &NavRequest) -> bool

This method tests for !=.

source

impl Copy for NavRequest

source

impl StructuralPartialEq for NavRequest

Auto Trait Implementations

impl RefUnwindSafe for NavRequest

impl Send for NavRequest

impl Sync for NavRequest

impl Unpin for NavRequest

impl UnwindSafe for NavRequest

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for T where
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

Return the T [ShaderType] for self. When used in [AsBindGroup] derives, it is safe to assume that all images in self exist. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Enum bevy_ui_navigation::events::NavRequest

Variants

Move(Direction)

ScopeMove(ScopeDirection)

Action

Cancel

FocusOn(Entity)

Free

Trait Implementations

impl Clone for NavRequest

fn clone(&self) -> NavRequest

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

impl Debug for NavRequest

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

impl PartialEq<NavRequest> for NavRequest

fn eq(&self, other: &NavRequest) -> bool

fn ne(&self, other: &NavRequest) -> bool

impl Copy for NavRequest

impl StructuralPartialEq for NavRequest

Auto Trait Implementations

impl RefUnwindSafe for NavRequest

impl Send for NavRequest

impl Sync for NavRequest

impl Unpin for NavRequest

impl UnwindSafe for NavRequest

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T, U> AsBindGroupShaderType<U> for T where U: ShaderType, &'a T: for<'a> Into<U>,

fn as_bind_group_shader_type( &self, _images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>) -> U

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> TypeData for T where T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Event for T where T: 'static + Send + Sync,

impl<T> Resource for T where T: 'static + Send + Sync,

`Move(Direction)`

`ScopeMove(ScopeDirection)`

`Action`

`Cancel`

`FocusOn(Entity)`

`Free`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Event for T where
T: 'static + Send + Sync,

impl<T> Resource for T where
T: 'static + Send + Sync,