Struct UiStack 

pub struct UiStack {
    pub direction: StackDirection,
    pub flipped: bool,
    pub inverted: bool,
    pub gap: UiValue<Vec2>,
    pub margin: StackMargin,
}

Ui stack - A type used to define how should subnodes be placed within this node.

🛠️ Example

let stack: UiStack = UiStack::new().flipped(true);

Fields

direction: StackDirection

Populating direction

flipped: bool

Populating direction (flip around y axis) - top-to-bottom vs bottom-to-top.

inverted: bool

Populating direction (flip around x axis) - left-to-right vs right-to-left.

gap: UiValue<Vec2>

Minimal gap between subnodes.

margin: StackMargin

The margin that subnodes should inherit.

Implementations

impl UiStack

pub fn new() -> Self

Creates new empty Stack.

pub fn direction(self, direction: StackDirection) -> Self

Replaces the direction with a new value.

pub fn flipped(self, value: bool) -> Self

Replaces the flipped value with a new value.

pub fn inverted(self, value: bool) -> Self

Replaces the inversion value with a new value.

pub fn gap(self, gap: impl Into<UiValue<Vec2>>) -> Self

Replaces the gap with a new value.

pub fn gap_x(self, gap: impl Into<UiValue<f32>>) -> Self

Replaces the horizontal gap with a new value.

pub fn gap_y(self, gap: impl Into<UiValue<f32>>) -> Self

Replaces the vertical gap with a new value.

pub fn margin(self, margin: StackMargin) -> Self

Replaces the margin with a new value.

pub fn set_direction(&mut self, direction: StackDirection)

Sets the direction to a new value.

pub fn set_flipped(&mut self, value: bool)

Sets the flipped value to a new value.

pub fn set_inverted(&mut self, value: bool)

Sets the inversion value with a new value.

pub fn set_gap(&mut self, gap: impl Into<UiValue<Vec2>>)

Sets the gap to a new value.

pub fn set_gap_x(&mut self, gap: impl Into<UiValue<f32>>)

Sets the horizontal gap to a new value.

pub fn set_gap_y(&mut self, gap: impl Into<UiValue<f32>>)

Sets the vertical gap to a new value.

pub fn set_margin(&mut self, margin: StackMargin)

Sets the margin to a new value.

Trait Implementations

impl Clone for UiStack

fn clone(&self) -> UiStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for UiStack

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for UiStack

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

Formats the value using the given formatter.

impl Default for UiStack

fn default() -> UiStack

Returns the “default value” for a type.

impl PartialEq for UiStack

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UiStack