|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
Colors, sizes and lays out a floating action button (FAB): the raised square button carrying the main action of a screen. More...
#include <headers/guillaume/systems/floating_action_button.hpp>


Public Member Functions | |
| FloatingActionButton (void) | |
| Create the system for the Layout phase, matching entities that have both a components::FloatingActionButton and a components::Button. | |
| ~FloatingActionButton (void) override=default | |
| Default destructor. | |
| void | update (const ecs::Entity::Identifier &entityIdentifier) override |
| Frame entry point: call apply on one button. | |
| Public Member Functions inherited from guillaume::ecs::SystemFiller< components::FloatingActionButton, components::Button > | |
| SystemFiller (Phase phase) | |
| Create the system and set its signature from ComponentTypes. | |
| virtual | ~SystemFiller (void)=default |
| Virtual destructor. | |
| Public Member Functions inherited from guillaume::ecs::System | |
| System (Phase phase) | |
| Create a system that runs in a given phase, with an empty signature. | |
| virtual | ~System (void)=default |
| Virtual destructor. | |
| Phase | getPhase (void) const noexcept |
| Get the phase of the frame in which the system runs. | |
| Entity::Signature | getSignature (void) const noexcept |
| Get the component types an entity must declare to be visited by this system. | |
| void | routine (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry, const ecs::EntityTreeTraveler &traveler) |
| Run the system once over a scene: prepare(), update() on each matching entity, cleanup(). | |
| void | bindComponentRegistry (ecs::ComponentRegistry &componentRegistry) |
| Bind a component registry so update() can be called directly, without routine(). | |
| void | unbindComponentRegistry (void) |
| Drop the binding made by bindComponentRegistry(). | |
| virtual void | prepare (void) |
| Called once per pass, before the first update(). | |
| virtual void | cleanup (void) |
| Called once per pass, after the last update(). | |
Static Public Member Functions | |
| static void | install (ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &identifier) |
| Make an entity behave as a floating action button. | |
| static float | iconFontSize (const ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &identifier) |
| Get the font size of the icon for the configured size. | |
| static utility::graphic::Color32Bit | contentColor (const ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &identifier) |
| Get the color of the icon and label of the button when it is enabled and visible. | |
| static void | elevation (ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &identifier) |
| Write the shadow level of the button into its components::Elevation. | |
| static void | styleState (ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &identifier) |
| First half of apply: write the elevation and the colors. | |
| static void | geometry (ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &identifier) |
| Second half of apply: write the size and the corner radius of the button and place its icon and label. | |
| static void | apply (ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &identifier) |
| Style and lay out one button at once: styleState, then geometry. | |
Additional Inherited Members | |
| Protected Member Functions inherited from guillaume::ecs::System | |
| template<InheritFromComponent... ComponentTypes> | |
| void | setSignature (void) |
| Replace the signature by the one made of the given component types. | |
| ecs::EntityRegistry & | getEntityRegistry (void) |
| Get the entity registry of the scene being processed. | |
| const ecs::EntityRegistry & | getEntityRegistry (void) const |
| Get the entity registry of the scene being processed, read-only. | |
| ecs::ComponentRegistry & | getComponentRegistry (void) |
| Get the component registry of the scene being processed. | |
| const ecs::ComponentRegistry & | getComponentRegistry (void) const |
| Get the component registry of the scene being processed, read-only. | |
| template<InheritFromComponent ComponentType> | |
| bool | hasComponent (const ecs::Entity::Identifier &entityIdentifier) const |
| Tell whether an entity has a component, in the bound registry. | |
| template<InheritFromComponent ComponentType> | |
| ComponentType & | getComponent (const ecs::Entity::Identifier &entityIdentifier) |
| Get a component of an entity from the bound registry, to read or modify it. | |
| template<InheritFromComponent ComponentType> | |
| const ComponentType & | getComponent (const ecs::Entity::Identifier &entityIdentifier) const |
| Get a component of an entity from the bound registry, read-only. | |
| template<InheritFromComponent ComponentType> | |
| bool | requireComponent (const ecs::Entity::Identifier &entityIdentifier) |
| Tell whether an entity has a component, and log a warning naming the entity and the component when it does not. | |
Colors, sizes and lays out a floating action button (FAB): the raised square button carrying the main action of a screen.
This is the variant half of a button; systems::Button owns the input half (press, callbacks) and calls back into apply through the restyle function of components::Button.
A FAB that is not visible (components::Button::setVisible(false)) keeps its place and size but is drawn fully transparent, without a shadow.
Definition at line 62 of file floating_action_button.hpp.
| guillaume::systems::FloatingActionButton::FloatingActionButton | ( | void | ) |
Create the system for the Layout phase, matching entities that have both a components::FloatingActionButton and a components::Button.
Definition at line 52 of file floating_action_button.cpp.


|
static |
Style and lay out one button at once: styleState, then geometry.
The frame calls it through update. Call it yourself after changing components::FloatingActionButton or components::Button when the result must be visible before the next Layout phase; systems::Button does on every hover, press and release.
| registry | The registry holding the components. |
| identifier | The button entity. It must have the components listed in the class description. |
| std::runtime_error | If the configured size or variant is not a valid enumerator. |
Definition at line 297 of file floating_action_button.cpp.


|
static |
Get the color of the icon and label of the button when it is enabled and visible.
| registry | The registry holding the components. |
| identifier | The button entity. |
| std::runtime_error | If the configured variant is not a valid enumerator. |
Definition at line 80 of file floating_action_button.cpp.


|
static |
Write the shadow level of the button into its components::Elevation.
Level 3 at rest, or level 1 when the FAB is lowered; one level higher while hovered and not pressed; level 0 when the button is disabled, not visible or in the Flat mode. styleState calls it first, so apply covers it.
| registry | The registry holding the components. |
| identifier | The button entity. |
Definition at line 92 of file floating_action_button.cpp.


|
static |
Second half of apply: write the size and the corner radius of the button and place its icon and label.
The button is a square of the custom size of components::FloatingActionButton when set, else of the container size of its size setting. Its corner radius is the custom size divided by 3.5, or the radius of its size setting. The icon and the label (LabelLarge type role, 8 dp after the icon) are centered as a row; when that row is wider than the container, the width of the button grows to it, so the button is not square.
| registry | The registry holding the components. |
| identifier | The button entity. |
Definition at line 192 of file floating_action_button.cpp.


|
static |
Get the font size of the icon for the configured size.
The widget class uses it to create the icon child at the right size. A custom container size does not change it.
| registry | The registry holding the components. |
| identifier | The button entity. |
| std::runtime_error | If the configured size is not a valid enumerator. |
Definition at line 71 of file floating_action_button.cpp.


|
static |
Make an entity behave as a floating action button.
Adds a components::Elevation at level 0 when the entity has none, wires input through systems::Button::install, and stores apply in components::Button as the restyle function, so a hover or a press redraws the button without waiting for the Layout phase. Call it once when the entity is built; entities::FloatingActionButton does it for you.
| registry | The registry holding the components. It must outlive the entity. |
| identifier | The button entity. It must already have its components::Button and the hand and mouse hover and button interaction components. |
Definition at line 59 of file floating_action_button.cpp.

|
static |
First half of apply: write the elevation and the colors.
| registry | The registry holding the components. |
| identifier | The button entity. |
Definition at line 120 of file floating_action_button.cpp.


|
overridevirtual |
Frame entry point: call apply on one button.
| entityIdentifier | The button entity. An entity missing components::FloatingActionButton or components::Button is logged and skipped. |
Implements guillaume::ecs::System.
Definition at line 304 of file floating_action_button.cpp.
