Struct Ui

pub struct Ui {

    pub display: Display,
    pub box_sizing: BoxSizing,
    pub overflow_x: Overflow,
    pub overflow_y: Overflow,
    pub scrollbar_width: f32,
    pub position: Position,
    pub inset: UiBorder,
    pub size: UiSize,
    pub min_size: UiSize,
    pub max_size: UiSize,
    pub aspect_ratio: Option<f32>,
    pub margin: UiBorder,
    pub padding: UiBorder,
    pub border: UiBorder,
    pub flex_direction: FlexDirection,
    pub flex_wrap: FlexWrap,
    pub gap: UiSize,
    pub align_content: AlignContent,
    pub align_items: AlignItems,
    pub justify_content: JustifyContent,
    pub flex_basis: Val,
    pub flex_grow: f32,
    pub flex_shrink: f32,
    pub align_self: AlignSelf,
}

A Ui node, complete with its styling information.

Fields

display: Display

Layout strategy to be used when laying out this node.

box_sizing: BoxSizing

Defines whether size styles apply to the content box or the border box of the node.

overflow_x: Overflow

How children overflowing their container should affect layout in the X axis.

overflow_y: Overflow

How children overflowing their container should affect layout in the Y axis.

scrollbar_width: f32

How much space (in pixels) should be reserved for the scrollbars of Overflow::Scroll.

position: Position

Determines what the inset value use as a base offset.

inset: UiBorder

Determines how the position of this element should be tweaked relative to the layout defined.

size: UiSize

Sets the initial size of the node.

min_size: UiSize

Controls the minimum size of the node.

max_size: UiSize

Controls the maximum size of the node.

aspect_ratio: Option<f32>

Sets the preferred aspect ratio for the node, calculated as width divided by height.

margin: UiBorder

How large the margin should be on each side.

padding: UiBorder

How large the padding should be on each side.

border: UiBorder

How large the border should be on each side.

flex_direction: FlexDirection

Defines which direction the main axis flows in.

flex_wrap: FlexWrap

Defines wrapping behavior for when children nodes exhaust their available space.

gap: UiSize

Determines ow large the gaps between nodes. in the container should be.

align_content: AlignContent

Determines how content contained within this node should be aligned in the cross/block axis.

align_items: AlignItems

Determines how this node’s children should be aligned in the cross/block axis.

justify_content: JustifyContent

Determines how content contained within this node should be aligned in the main/inline axis.

flex_basis: Val

Sets the initial main axis size of the node.

flex_grow: f32

The relative rate at which this node grows when it is expanding to fill space.

flex_shrink: f32

The relative rate at which this node shrinks when it is contracting to fit into space.

align_self: AlignSelf

Determines how this node should be aligned in the cross/block axis, falling back to the parent’s AlignItems if not set.

Implementations

impl Ui

pub const DEFAULT: Self

The default value.

Trait Implementations

impl Clone for Ui

fn clone(&self) -> Ui

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Ui

where Self: Send + Sync + 'static,

Required Components: Transform, ComputedUi.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

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

impl Default for Ui

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for Ui

where Ui: Any + Send + Sync, Display: FromReflect + TypePath + MaybeTyped + RegisterForReflection, BoxSizing: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Overflow: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Position: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiBorder: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiSize: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<f32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexWrap: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignItems: FromReflect + TypePath + MaybeTyped + RegisterForReflection, JustifyContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Val: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignSelf: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for Ui

where Ui: Any + Send + Sync, Display: FromReflect + TypePath + MaybeTyped + RegisterForReflection, BoxSizing: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Overflow: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Position: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiBorder: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiSize: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<f32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexWrap: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignItems: FromReflect + TypePath + MaybeTyped + RegisterForReflection, JustifyContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Val: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignSelf: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialReflect for Ui

where Ui: Any + Send + Sync, Display: FromReflect + TypePath + MaybeTyped + RegisterForReflection, BoxSizing: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Overflow: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Position: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiBorder: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiSize: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<f32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexWrap: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignItems: FromReflect + TypePath + MaybeTyped + RegisterForReflection, JustifyContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Val: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignSelf: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

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

Returns a hash of the value (which includes the 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 Reflect for Ui

where Ui: Any + Send + Sync, Display: FromReflect + TypePath + MaybeTyped + RegisterForReflection, BoxSizing: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Overflow: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Position: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiBorder: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiSize: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<f32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexWrap: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignItems: FromReflect + TypePath + MaybeTyped + RegisterForReflection, JustifyContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Val: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignSelf: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Struct for Ui

where Ui: Any + Send + Sync, Display: FromReflect + TypePath + MaybeTyped + RegisterForReflection, BoxSizing: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Overflow: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Position: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiBorder: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiSize: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<f32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexWrap: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignItems: FromReflect + TypePath + MaybeTyped + RegisterForReflection, JustifyContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Val: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignSelf: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for Ui

where Ui: Any + Send + Sync,

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 Ui

where Ui: Any + Send + Sync, Display: FromReflect + TypePath + MaybeTyped + RegisterForReflection, BoxSizing: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Overflow: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Position: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiBorder: FromReflect + TypePath + MaybeTyped + RegisterForReflection, UiSize: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<f32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FlexWrap: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignItems: FromReflect + TypePath + MaybeTyped + RegisterForReflection, JustifyContent: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Val: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AlignSelf: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.