Enum MenuBuilder

pub enum MenuBuilder {
    NamedParent(Name),
    EntityParent(Entity),
    Root,
}

Tell the navigation system to turn this UI node into a menu.

Note that MenuBuilder is replaced by a private component when encoutered.

Variants

NamedParent(Name)

Create a menu as reachable from a Focusable with a Name component.

This is useful if, for example, you just want to spawn your UI without keeping track of entity ids of buttons that leads to submenus.

See MenuBuilder::from_named for an easier to use method if you don’t have a Name ready to use.

Important

You must ensure this doesn’t create a cycle. Eg: you shouldn’t be able to reach MenuSetting X from Focusable Y if there is a path from MenuSetting X to Focusable Y.

Performance and edge cases

bevy-ui-navigation tries to convert each frame every MenuBuilder::NamedParent into a MenuBuilder::EntityParent.

It iterates every Focusable with a Name component until it finds a match. And repeat the operation next frame if no match is found.

This incurs a significant performance cost per unmatched NamedParent! bevy-ui-navigation emits a WARN per second if it encounters unmatched NamedParents. Pay attention to this message if you don’t want to waste preciously CPU cycles.

EntityParent(Entity)

Create a menu as reachable from a given Focusable.

When requesting NavRequest::Action when Entity is focused, the focus will be changed to a focusable within this menu.

Important

You must ensure this doesn’t create a cycle. Eg: you shouldn’t be able to reach MenuSetting X from Focusable Y if there is a path from MenuSetting X to Focusable Y.

Root

Create a menu with no parents.

No Focusable will “lead to” this menu. You either need to programmatically give focus to this menu tree with NavRequest::FocusOn or have only one root menu.

Implementations

impl MenuBuilder

pub fn from_named(parent: impl Into<Cow<'static, str>>) -> Self

Create a MenuBuilder::NamedParent directly from String or &str.

See MenuBuilder::NamedParent for caveats and quirks.

Trait Implementations

impl Clone for MenuBuilder

fn clone(&self) -> MenuBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for MenuBuilder

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Debug for MenuBuilder

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

Formats the value using the given formatter.

impl Enum for MenuBuilder

where Name: FromReflect + TypePath, Entity: FromReflect + TypePath,

fn field(&self, __name_param: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl From<Option<Entity>> for MenuBuilder

fn from(parent: Option<Entity>) -> Self

Converts to this type from the input type.

impl FromReflect for MenuBuilder

where Name: FromReflect + TypePath, Entity: FromReflect + TypePath,

fn from_reflect(__param0: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect>, ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl FromWorld for MenuBuilder

fn from_world(_: &mut World) -> Self

This shouldn’t be considered a good “default”, this only exists to make possible ReflectComponent derive.

impl GetTypeRegistration for MenuBuilder

where Name: FromReflect + TypePath, Entity: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for MenuBuilder

where Name: FromReflect + TypePath, Entity: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect>, ) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn type_name(&self) -> &str

👎Deprecated since 0.12.0: view the method documentation to find alternatives to this method.

Returns the type path of the underlying type.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TryFrom<&MenuBuilder> for Option<Entity>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &MenuBuilder) -> Result<Self, Self::Error>

Performs the conversion.

impl TypePath for MenuBuilder

where Name: FromReflect + TypePath, Entity: FromReflect + TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for MenuBuilder

where Name: FromReflect + TypePath, Entity: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.