Struct bevy::prelude::UiRect

pub struct UiRect<T> where
    T: Reflect + PartialEq<T>, {
    pub left: T,
    pub right: T,
    pub top: T,
    pub bottom: T,
}

A type which is commonly used to define positions, margins, paddings and borders.

Examples

Position

A position is used to determine where to place a UI element.

let position = UiRect {
    left: Val::Px(100.0),
    top: Val::Px(50.0),
    ..default()
};

If you define opposite sides of the position, the size of the UI element will automatically be calculated if not explicitly specified. This means that if you have a Size that uses Val::Undefined as a width and height, the size would be determined by the window size and the values specified in the position.

let position = UiRect {
    left: Val::Px(100.0),
    right: Val::Px(200.0),
    top: Val::Px(300.0),
    bottom: Val::Px(400.0),
};

To determine the width of the UI element you have to take the width of the window and subtract it by the left and right values of the position. To determine the height of the UI element you have to take the height of the window and subtract it by the top and bottom values of the position. If we had a window with a width and height of 1000px, the UI element declared above would have a width of 700px and a height of 300px.

// Size of the window
let window_width = 1000.0;
let window_height = 1000.0;

// Values of the position
let left = 100.0;
let right = 200.0;
let top = 300.0;
let bottom = 400.0;

// Calculation to get the size of the UI element
let ui_element_width = window_width - left - right;
let ui_element_height = window_height - top - bottom;

assert_eq!(ui_element_width, 700.0);
assert_eq!(ui_element_height, 300.0);

If you define a Size and also all four sides of the position, the top and left values of the position are used to determine where to place the UI element. The size will not be calculated using the bottom and right values of the position because the size of the UI element is already explicitly specified.

let style = Style {
    position: UiRect { // Defining all four sides
        left: Val::Px(100.0),
        right: Val::Px(200.0),
        top: Val::Px(300.0),
        bottom: Val::Px(400.0),
    },
    size: Size::new(Val::Percent(100.0), Val::Percent(50.0)), // but also explicitly specifying a size
    ..default()
};

Margin

A margin is used to create space around UI elements, outside of any defined borders.

let margin = UiRect::all(Val::Auto); // Centers the UI element

Padding

A padding is used to create space around UI elements, inside of any defined borders.

let padding = UiRect {
    left: Val::Px(10.0),
    right: Val::Px(20.0),
    top: Val::Px(30.0),
    bottom: Val::Px(40.0),
};

Borders

A border is used to define the width of the border of a UI element.

let border = UiRect {
    left: Val::Px(10.0),
    right: Val::Px(20.0),
    top: Val::Px(30.0),
    bottom: Val::Px(40.0),
};

Fields

left: T

The value corresponding to the left side of the UI rect.

right: T

The value corresponding to the right side of the UI rect.

top: T

The value corresponding to the top side of the UI rect.

bottom: T

The value corresponding to the bottom side of the UI rect.

Implementations

impl<T> UiRect<T> where
    T: Reflect + PartialEq<T>, 

pub fn new(left: T, right: T, top: T, bottom: T) -> UiRect<T>

Creates a new UiRect from the values specified.

Example

let ui_rect = UiRect::new(
    Val::Px(10.0),
    Val::Px(20.0),
    Val::Px(30.0),
    Val::Px(40.0),
);

assert_eq!(ui_rect.left, Val::Px(10.0));
assert_eq!(ui_rect.right, Val::Px(20.0));
assert_eq!(ui_rect.top, Val::Px(30.0));
assert_eq!(ui_rect.bottom, Val::Px(40.0));

pub fn all(value: T) -> UiRect<T> where
    T: Clone, 

Creates a new UiRect where all sides have the same value.

Example

let ui_rect = UiRect::all(Val::Px(10.0));

assert_eq!(ui_rect.left, Val::Px(10.0));
assert_eq!(ui_rect.right, Val::Px(10.0));
assert_eq!(ui_rect.top, Val::Px(10.0));
assert_eq!(ui_rect.bottom, Val::Px(10.0));

Trait Implementations

impl<T> Clone for UiRect<T> where
    T: Clone + Reflect + PartialEq<T>, 

fn clone(&self) -> UiRect<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for UiRect<T> where
    T: Debug + Reflect + PartialEq<T>, 

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

Formats the value using the given formatter.

impl<T> Default for UiRect<T> where
    T: Default + Reflect + PartialEq<T>, 

fn default() -> UiRect<T>

Returns the “default value” for a type.

impl<T> GetTypeRegistration for UiRect<T> where
    T: Reflect + PartialEq<T>, 

fn get_type_registration() -> TypeRegistration

impl<T> PartialEq<UiRect<T>> for UiRect<T> where
    T: PartialEq<T> + Reflect, 

fn eq(&self, other: &UiRect<T>) -> bool

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

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

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

impl<T> Reflect for UiRect<T> where
    T: Reflect + PartialEq<T>, 

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

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

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

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

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

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

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_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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.

impl<T> Struct for UiRect<T> where
    T: Reflect + PartialEq<T>, 

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

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

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

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

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

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

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

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

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 struct’s fields.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl<T> Typed for UiRect<T> where
    T: Reflect + PartialEq<T>, 

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<T> Copy for UiRect<T> where
    T: Copy + Reflect + PartialEq<T>, 

impl<T> StructuralPartialEq for UiRect<T> where
    T: Reflect + PartialEq<T>,