guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
guillaume::systems::HandMotion Class Reference

Tracks which entities an XR hand is pointing at. More...

#include <headers/guillaume/systems/hand_motion.hpp>

Inheritance diagram for guillaume::systems::HandMotion:
Collaboration diagram for guillaume::systems::HandMotion:

Public Member Functions

 HandMotion (event::EventBus &eventBus)
 Create the system, in the Event phase, and subscribe it to hand motion events.
 ~HandMotion (void)
 Destructor.
void prepare (void) override
 Take the next pending hand motion event, once per frame.
void cleanup (void) override
 Does nothing.
virtual void update (const ecs::Entity::Identifier &entityIdentifier) override
 Test the hand ray against one entity and update its hovered flag, calling the hover or unhover handler when the flag changes.
Public Member Functions inherited from guillaume::ecs::SystemFiller< components::HandHoverInteraction, 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::HandMotionEvent >
 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::HandMotionEvent >
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.

Detailed Description

Tracks which entities an XR hand is pointing at.

The hand counterpart of systems::MouseMotion. Runs in the Event phase on entities that have a components::HandHoverInteraction, a Transform and a Bound. It casts the forward ray of the aim pose of the current hand motion event and tests it against the rectangle of the entity, grown by its accessibility margin. It writes the hovered flag of components::HandHoverInteraction and calls its hover handler when the ray enters and its unhover handler when it leaves. A disabled entity is never hovered.

Every entity is tested on its own: overlapping entities on the ray are all hovered. Nothing is tested until a first hand motion event has been received.

See also
components::HandHoverInteraction
systems::MouseMotion
systems::hitTest

Definition at line 58 of file hand_motion.hpp.

Constructor & Destructor Documentation

◆ HandMotion()

guillaume::systems::HandMotion::HandMotion ( event::EventBus & eventBus)

Create the system, in the Event phase, and subscribe it to hand motion events.

Parameters
eventBusThe event bus delivering the hand motion events.

Definition at line 28 of file hand_motion.cpp.

Here is the call graph for this function:

◆ ~HandMotion()

guillaume::systems::HandMotion::~HandMotion ( void )

Destructor.

Definition at line 36 of file hand_motion.cpp.

Member Function Documentation

◆ cleanup()

void guillaume::systems::HandMotion::cleanup ( void )
overridevirtual

Does nothing.

Reimplemented from guillaume::ecs::System.

Definition at line 45 of file hand_motion.cpp.

◆ prepare()

void guillaume::systems::HandMotion::prepare ( void )
overridevirtual

Take the next pending hand motion 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_motion.cpp.

Here is the call graph for this function:

◆ update()

void guillaume::systems::HandMotion::update ( const ecs::Entity::Identifier & entityIdentifier)
overridevirtual

Test the hand ray against one entity and update its hovered flag, calling the hover or unhover handler when the flag changes.

Parameters
entityIdentifierThe entity holding the components::HandHoverInteraction.

Implements guillaume::ecs::System.

Definition at line 49 of file hand_motion.cpp.

Here is the call graph for this function:

The documentation for this class was generated from the following files: