Struct amethyst_ui::UiTransformData

pub struct UiTransformData<G> {
    pub id: String,
    pub x: f32,
    pub y: f32,
    pub z: f32,
    pub width: f32,
    pub height: f32,
    pub opaque: bool,
    pub percent: bool,
    pub stretch: Option<Stretch>,
    pub anchor: Anchor,
    pub pivot: Anchor,
    pub mouse_reactive: bool,
    pub hidden: bool,
    pub selectable: Option<u32>,
    // some fields omitted
}

Loadable UiTransform data. By default z is equal to one.

Fields

id: String

An identifier. Serves no purpose other than to help you distinguish between UI elements.

x: f32

X coordinate

y: f32

Y coordinate

z: f32

Z coordinate, defaults to one.

width: f32

The width of this UI element.

height: f32

The height of this UI element.

opaque: bool

Indicates if actions on the ui can go through this element. If set to false, the element will behaves as if it was transparent and will let events go to the next element (for example, the text on a button).

percent: bool

Renders this UI element by evaluating transform as a percentage of the parent size, rather than rendering it with pixel units.

stretch: Option<Stretch>

If a child ui element needs to fill its parent this can be used to stretch it to the appropriate size.

anchor: Anchor

Indicates where the element sits, relative to the parent (or to the screen, if there is no parent)

pivot: Anchor

Indicates where the element sits, relative to itself

mouse_reactive: bool

Allow mouse events on this UI element.

hidden: bool

Hides an entity by adding a HiddenPropagate component

selectable: Option<u32>

Makes the UiTransform selectable through keyboard inputs, mouse inputs and other means.

Ordering

The UI element tab order. When the player presses tab the UI focus will shift to the UI element with the next highest tab order, or if another element with the same tab_order as this one exists they are ordered according to Entity creation order. Shift-tab walks this ordering backwards.

Methods

impl<G> UiTransformData<G>

pub fn with_id<S>(self, id: S) -> Self where
    S: ToString, 

Set id

pub fn with_position(self, x: f32, y: f32, z: f32) -> Self

Set position

pub fn with_size(self, width: f32, height: f32) -> Self

Set size

pub fn transparent(self) -> Self

Set to event transparent

pub fn hide(self) -> Self

Hides an entity by adding a HiddenPropagate component

pub fn reactive(self) -> Self

Add mouse reactive

pub fn with_anchor(self, anchor: Anchor) -> Self

Set anchor

pub fn with_stretch(self, stretch: Stretch) -> Self

Set stretch

Trait Implementations

impl<G> Default for UiTransformData<G>

fn default() -> Self

Returns the "default value" for a type.

impl<G: Clone> Clone for UiTransformData<G>

fn clone(&self) -> UiTransformData<G>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G: Debug> Debug for UiTransformData<G>

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

Formats the value using the given formatter.

impl<G> Serialize for UiTransformData<G>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, G> Deserialize<'de> for UiTransformData<G> where
    UiTransformData<G>: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a, G> PrefabData<'a> for UiTransformData<G> where
    G: Send + Sync + 'static, 

type SystemData = (WriteStorage<'a, UiTransform>, WriteStorage<'a, Interactable>, WriteStorage<'a, HiddenPropagate>, WriteStorage<'a, Selectable<G>>)

SystemData needed to perform the load

type Result = ()

The result type returned by the load operation

fn add_to_entity(
    &self,
    entity: Entity,
    system_data: &mut Self::SystemData,
    _: &[Entity],
    _: &[Entity]
) -> Result<(), Error>

Add the data for this prefab onto the given Entity

fn load_sub_assets(
    &mut self,
    _progress: &mut ProgressCounter,
    _system_data: &mut Self::SystemData
) -> Result<bool, Error>

Trigger asset loading for any sub assets.