|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
Marks the entities an XR hand pinches (thumb and index brought together while pointing at them). More...
#include <headers/guillaume/systems/hand_pinch.hpp>


Public Member Functions | |
| HandPinch (event::EventBus &eventBus) | |
| Create the system, in the Event phase, and subscribe it to hand pinch events. | |
| ~HandPinch (void) override | |
| Destructor. | |
| Public Member Functions inherited from guillaume::systems::HandRaySystem< components::HandPinchInteraction, utility::event::HandPinchEvent > | |
| void | update (const ecs::Entity::Identifier &entityIdentifier) override |
| Test the hand ray of the current event against one entity, store the result with setEngaged() and call the event handler of the interaction component on a hit. | |
| Public Member Functions inherited from guillaume::systems::HandEventSystem< InteractionType, EventType > | |
| HandEventSystem (event::EventBus &eventBus) | |
| Create the system, in the Event phase, and subscribe it to events of type EventType. | |
| ~HandEventSystem (void) override=default | |
| Default destructor. | |
| void | prepare (void) override |
| Take the next pending event, once per frame. | |
| void | cleanup (void) override |
| Does nothing. | |
| Public Member Functions inherited from guillaume::ecs::SystemFiller< InteractionType, 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< EventType > | |
| 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(). | |
Protected Member Functions | |
| void | setEngaged (components::HandPinchInteraction &interaction, bool engaged) override |
| Write the pinching flag of the interaction component. | |
| Protected Member Functions inherited from guillaume::systems::HandRaySystem< components::HandPinchInteraction, utility::event::HandPinchEvent > | |
| virtual void | setEngaged (InteractionType &interaction, bool engaged)=0 |
| Write the result of the hit test on the interaction component. Called for every visited entity, hit or not. | |
| 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< EventType > | |
| 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. | |
Marks the entities an XR hand pinches (thumb and index brought together while pointing at them).
Runs in the Event phase on entities that have a components::HandPinchInteraction, a Transform and a Bound. The hit test and the handler call are those of systems::HandRaySystem; this class only says that the result is written to the pinching flag of the component. An entity is therefore pinching while the hand ray of the current pinch event hits it, and its event handler is called on every frame that is true.
systems::Focus and systems::StyleState read the flag later in the same phase: a pinch focuses an entity and shows it pressed.
Definition at line 51 of file hand_pinch.hpp.
|
explicit |
Create the system, in the Event phase, and subscribe it to hand pinch events.
| eventBus | The event bus delivering the hand pinch events. |
Definition at line 27 of file hand_pinch.cpp.
|
overrideprotected |
Write the pinching flag of the interaction component.
| interaction | The pinch interaction component of the entity. |
| engaged | True when the hand ray of the current pinch event hits the entity. |
Definition at line 35 of file hand_pinch.cpp.