Struct amethyst_ui::UiLabelBuilder

pub struct UiLabelBuilder<I = u32> where
    I: WidgetId,  { /* fields omitted */ }

Convenience structure for building a label

Methods

impl<'a, I> UiLabelBuilder<I> where
    I: WidgetId + 'static, 

pub fn new<S: ToString>(text: S) -> UiLabelBuilder<I>

Construct a new UiLabelBuilder. This allows the user to easily build a UI element with a text that can easily be retrieved and updated through the appropriate resource, see Widgets.

pub fn with_id(self, id: I) -> Self

Sets an ID for this widget. The type of this ID will determine which Widgets resource this widget will be added to, see Widgets.

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

Set button size

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

This will create a default UiTransform if one is not already attached. See DEFAULT_Z, DEFAULT_WIDTH, DEFAULT_HEIGHT, and DEFAULT_TAB_ORDER for the values that will be provided to the default UiTransform.

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

Add an anchor to the button.

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

Stretch the button.

pub fn with_text<S>(self, text: S) -> Self where
    S: ToString, 

This will set the rendered characters within the button. Use this to just change what characters will appear. If you need to change the font size, color, etc., then you should use with_uitext and provide a new UiText object.

pub fn with_text_color(self, text_color: [f32; 4]) -> Self

Set text color

pub fn with_font(self, font: FontHandle) -> Self

Use a different font for the button text.

pub fn with_font_size(self, size: f32) -> Self

Set font size

pub fn with_parent(self, parent: Entity) -> Self

Add a parent to the button.

pub fn build(self, res: UiLabelBuilderResources<'a, I>) -> (I, UiLabel)

Build this with the UiLabelBuilderResources.

pub fn build_from_world(self, world: &World) -> (I, UiLabel)

Create the UiLabel based on provided configuration parameters.

Trait Implementations

impl<'a, I> Default for UiLabelBuilder<I> where
    I: WidgetId + 'static, 

fn default() -> Self

Returns the "default value" for a type.

impl<I: Debug> Debug for UiLabelBuilder<I> where
    I: WidgetId, 

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

Formats the value using the given formatter.