Struct bevy_ui::node_bundles::ButtonBundle

pub struct ButtonBundle {

    pub node: Node,
    pub button: Button,
    pub style: Style,
    pub interaction: Interaction,
    pub focus_policy: FocusPolicy,
    pub border_color: BorderColor,
    pub border_radius: BorderRadius,
    pub image: UiImage,
    pub background_color: BackgroundColor,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub visibility: Visibility,
    pub inherited_visibility: InheritedVisibility,
    pub view_visibility: ViewVisibility,
    pub z_index: ZIndex,
}

A UI node that is a button

Extra behaviours

You may add one or both of the following components to enable additional behaviours:

• ImageScaleMode to enable either slicing or tiling of the texture
• TextureAtlas to draw a specific section of the texture

Fields

node: Node

Describes the logical size of the node

button: Button

Marker component that signals this node is a button

style: Style

Styles which control the layout (size and position) of the node and its children In some cases these styles also affect how the node drawn/painted.

interaction: Interaction

Describes whether and how the button has been interacted with by the input

focus_policy: FocusPolicy

Whether this node should block interaction with lower nodes

border_color: BorderColor

The color of the Node’s border

border_radius: BorderRadius

The border radius of the node

image: UiImage

The image of the node

background_color: BackgroundColor

The background color that will fill the containing node

transform: Transform

The transform of the node

This component is automatically managed by the UI layout system. To alter the position of the ButtonBundle, use the properties of the Style component.

global_transform: GlobalTransform

The global transform of the node

This component is automatically updated by the TransformPropagate systems.

visibility: Visibility

Describes the visibility properties of the node

inherited_visibility: InheritedVisibility

Inherited visibility of an entity.

view_visibility: ViewVisibility

Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering

z_index: ZIndex

Indicates the depth at which the node should appear in the UI

Trait Implementations

impl Bundle for ButtonBundle

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>) )

Gets this Bundle’s component ids. This will be None if the component has not been registered.

impl Clone for ButtonBundle

fn clone(&self) -> ButtonBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonBundle

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

Formats the value using the given formatter.

impl Default for ButtonBundle

fn default() -> Self

Returns the “default value” for a type.

impl DynamicBundle for ButtonBundle