Struct UiButton

Source

pub struct UiButton { /* private fields */ }

Expand description

Button component that holds UiButtonData

Implementations§

Source §

impl UiButton

Source

pub fn new<S: Into<String> + Clone>(value: S, font: &Handle) -> UiButton

Creates a UiButton with the provided string value and font handle

Examples found in repository ?

examples/despawn.rs (line 38)

24fn spawn_main_menu(mut commands: Commands) {
25    let font = &DEFAULT_FONT_HANDLE.typed::<Font>();
26
27    let root = Root::congregated();
28
29    let mut main_container = Container::height(400.0);
30    let top_wrapper = Container::auto();
31    let mut bottom_wrapper = Container::height(200.0);
32    let actions_wrapper = Container::auto();
33    let footer_wrapper = Container::auto();
34
35    let mut title = EmbossedText::extra_large("Game Over", font);
36    let instructions = SimpleText::small("Use the mouse to interact with the buttons", font);
37
38    let mut despawn = UiButton::new("Despawn UI", font);
39
40    title.color(Color::TEAL);
41
42    main_container.justify_between();
43    bottom_wrapper.justify_between();
44
45    despawn.id(DESPAWN_BUTTON_ID).selected_color(Color::TEAL);
46
47    root.spawn(&mut commands, |parent| {
48        main_container.spawn(parent, |parent| {
49            top_wrapper.spawn(parent, |parent| {
50                title.spawn(parent);
51            });
52            bottom_wrapper.spawn(parent, |parent| {
53                actions_wrapper.spawn(parent, |parent| {
54                    despawn.spawn(parent);
55                });
56                footer_wrapper.spawn(parent, |parent| {
57                    instructions.spawn(parent);
58                });
59            });
60        });
61    });
62}

Source

pub fn square<S: Into<String> + Clone>( value: S, font: &Handle, ) -> UiButton

Creates a square UiButton with the provided string value and font handle

Source

pub fn color(&mut self, color: Color) -> &mut UiButton

Sets text color with the provided Color

Source

pub fn selected_color(&mut self, color: Color) -> &mut UiButton

Sets background color with the provided Color

Examples found in repository ?

examples/despawn.rs (line 45)

24fn spawn_main_menu(mut commands: Commands) {
25    let font = &DEFAULT_FONT_HANDLE.typed::<Font>();
26
27    let root = Root::congregated();
28
29    let mut main_container = Container::height(400.0);
30    let top_wrapper = Container::auto();
31    let mut bottom_wrapper = Container::height(200.0);
32    let actions_wrapper = Container::auto();
33    let footer_wrapper = Container::auto();
34
35    let mut title = EmbossedText::extra_large("Game Over", font);
36    let instructions = SimpleText::small("Use the mouse to interact with the buttons", font);
37
38    let mut despawn = UiButton::new("Despawn UI", font);
39
40    title.color(Color::TEAL);
41
42    main_container.justify_between();
43    bottom_wrapper.justify_between();
44
45    despawn.id(DESPAWN_BUTTON_ID).selected_color(Color::TEAL);
46
47    root.spawn(&mut commands, |parent| {
48        main_container.spawn(parent, |parent| {
49            top_wrapper.spawn(parent, |parent| {
50                title.spawn(parent);
51            });
52            bottom_wrapper.spawn(parent, |parent| {
53                actions_wrapper.spawn(parent, |parent| {
54                    despawn.spawn(parent);
55                });
56                footer_wrapper.spawn(parent, |parent| {
57                    instructions.spawn(parent);
58                });
59            });
60        });
61    });
62}

Source

pub fn width(&mut self, width: f32) -> &mut UiButton

Sets width with the provided width in pixels

Source

pub fn height(&mut self, height: f32) -> &mut UiButton

Sets height with the provided height in pixels

Source

pub fn id(&mut self, id: usize) -> &mut UiButton

Sets id of UiButtonData with the provided id

Examples found in repository ?

examples/despawn.rs (line 45)

24fn spawn_main_menu(mut commands: Commands) {
25    let font = &DEFAULT_FONT_HANDLE.typed::<Font>();
26
27    let root = Root::congregated();
28
29    let mut main_container = Container::height(400.0);
30    let top_wrapper = Container::auto();
31    let mut bottom_wrapper = Container::height(200.0);
32    let actions_wrapper = Container::auto();
33    let footer_wrapper = Container::auto();
34
35    let mut title = EmbossedText::extra_large("Game Over", font);
36    let instructions = SimpleText::small("Use the mouse to interact with the buttons", font);
37
38    let mut despawn = UiButton::new("Despawn UI", font);
39
40    title.color(Color::TEAL);
41
42    main_container.justify_between();
43    bottom_wrapper.justify_between();
44
45    despawn.id(DESPAWN_BUTTON_ID).selected_color(Color::TEAL);
46
47    root.spawn(&mut commands, |parent| {
48        main_container.spawn(parent, |parent| {
49            top_wrapper.spawn(parent, |parent| {
50                title.spawn(parent);
51            });
52            bottom_wrapper.spawn(parent, |parent| {
53                actions_wrapper.spawn(parent, |parent| {
54                    despawn.spawn(parent);
55                });
56                footer_wrapper.spawn(parent, |parent| {
57                    instructions.spawn(parent);
58                });
59            });
60        });
61    });
62}

Source

pub fn payload<S: Into<String> + Clone>(&mut self, payload: S) -> &mut UiButton

Sets payload of UiButtonData

Source

pub fn spawn(self, parent: &mut ChildBuilder<'_, '_, '_>)

Spawns the underlaying bundle with the provided parent (mutable reference to ChildBuilder)

Examples found in repository ?

examples/despawn.rs (line 54)

24fn spawn_main_menu(mut commands: Commands) {
25    let font = &DEFAULT_FONT_HANDLE.typed::<Font>();
26
27    let root = Root::congregated();
28
29    let mut main_container = Container::height(400.0);
30    let top_wrapper = Container::auto();
31    let mut bottom_wrapper = Container::height(200.0);
32    let actions_wrapper = Container::auto();
33    let footer_wrapper = Container::auto();
34
35    let mut title = EmbossedText::extra_large("Game Over", font);
36    let instructions = SimpleText::small("Use the mouse to interact with the buttons", font);
37
38    let mut despawn = UiButton::new("Despawn UI", font);
39
40    title.color(Color::TEAL);
41
42    main_container.justify_between();
43    bottom_wrapper.justify_between();
44
45    despawn.id(DESPAWN_BUTTON_ID).selected_color(Color::TEAL);
46
47    root.spawn(&mut commands, |parent| {
48        main_container.spawn(parent, |parent| {
49            top_wrapper.spawn(parent, |parent| {
50                title.spawn(parent);
51            });
52            bottom_wrapper.spawn(parent, |parent| {
53                actions_wrapper.spawn(parent, |parent| {
54                    despawn.spawn(parent);
55                });
56                footer_wrapper.spawn(parent, |parent| {
57                    instructions.spawn(parent);
58                });
59            });
60        });
61    });
62}

Trait Implementations§

Source §

impl Default for UiButton

Source §

fn default() -> UiButton

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for UiButton

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T, U> AsBindGroupShaderType for T
where U: ShaderType, &'a T: for<'a> Into,

Source §

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> Downcast<T> for T

Source §

fn downcast(&self) -> &T

Source §

impl<T> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §