|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
Tracks which XR controller buttons are held on which entities. More...
#include <headers/guillaume/systems/hand_button.hpp>


Public Member Functions | |
| HandButton (event::EventBus &eventBus) | |
| Create the system, in the Event phase, and subscribe it to hand button events. | |
| ~HandButton (void) | |
| Destructor. | |
| void | prepare (void) override |
| Take the next pending hand button event, once per frame. | |
| void | cleanup (void) override |
| Does nothing. | |
| virtual void | update (const ecs::Entity::Identifier &entityIdentifier) override |
| Apply the current hand button event to one entity. Events with an unknown button are ignored. | |
| Public Member Functions inherited from guillaume::ecs::SystemFiller< components::HandButtonInteraction, components::Transform, components::Bound > | |
| 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(). | |
| Public Member Functions inherited from guillaume::event::EventManager< utility::event::HandButtonEvent > | |
| EventManager (EventBus &eventBus) | |
| Subscribe to a bus; events of type EventType published after this call are queued. | |
| virtual | ~EventManager (void)=default |
| Virtual destructor. | |
| bool | hasPendingEvents (void) const |
| Tell whether at least one event is queued, waiting for consumeNextEvent(). | |
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. | |
| Protected Member Functions inherited from guillaume::event::EventManager< utility::event::HandButtonEvent > | |
| void | consumeNextEvent (void) |
| Take the oldest queued event and make it the last event. | |
| std::shared_ptr< EventType > | getLastEvent (void) |
| Get the event taken by the most recent consumeNextEvent() that found one. | |
Tracks which XR controller buttons are held on which entities.
The hand counterpart of systems::MouseButton. Runs in the Event phase on entities that have a components::HandButtonInteraction, a Transform and a Bound. It casts the forward ray of the aim pose of the current hand button event and tests it against the rectangle of the entity, grown by its accessibility margin (a disabled entity is never hit). Then, for the button of the event:
systems::Drag, systems::Focus and systems::StyleState read the pressed flags later in the same phase.
Definition at line 62 of file hand_button.hpp.
| guillaume::systems::HandButton::HandButton | ( | event::EventBus & | eventBus | ) |
Create the system, in the Event phase, and subscribe it to hand button events.
| eventBus | The event bus delivering the hand button events. |
Definition at line 28 of file hand_button.cpp.

| guillaume::systems::HandButton::~HandButton | ( | void | ) |
Destructor.
Definition at line 36 of file hand_button.cpp.
|
overridevirtual |
Does nothing.
Reimplemented from guillaume::ecs::System.
Definition at line 45 of file hand_button.cpp.
|
overridevirtual |
Take the next pending hand button event, once per frame.
When none is pending, the previous event stays the current one.
Reimplemented from guillaume::ecs::System.
Definition at line 40 of file hand_button.cpp.

|
overridevirtual |
Apply the current hand button event to one entity. Events with an unknown button are ignored.
| entityIdentifier | The entity holding the components::HandButtonInteraction. |
Implements guillaume::ecs::System.
Definition at line 49 of file hand_button.cpp.
