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

Tracks which mouse buttons are held on which entities. More...

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

Inheritance diagram for guillaume::systems::MouseButton:
Collaboration diagram for guillaume::systems::MouseButton:

Public Member Functions

 MouseButton (event::EventBus &eventBus, utility::Engine &engine)
 Create the system, in the Event phase, and subscribe it to mouse button events.
 ~MouseButton (void)
 Destructor.
void prepare (void) override
 Take the next pending mouse button event, once per frame.
void cleanup (void) override
 Does nothing.
virtual void update (const ecs::Entity::Identifier &entityIdentifier) override
 Apply the current mouse button event to one entity.
Public Member Functions inherited from guillaume::ecs::SystemFiller< components::MouseButtonInteraction, 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::MouseButtonEvent >
 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::MouseButtonEvent >
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 mouse buttons are held on which entities.

Runs in the Event phase on entities that have a components::MouseButtonInteraction, a Transform and a Bound. It turns the position of the current mouse button event into a world ray 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:

  • button down on the entity: the button is marked pressed and its press handler is called;
  • button up on the entity while it was pressed there: the button is marked released and its release handler is called. This is what a widget treats as a click;
  • button up elsewhere: the button is marked released, no handler is called, so dragging the pointer off a widget cancels the click.

Every entity is tested on its own: overlapping entities under the pointer all receive the press. systems::Drag, systems::Focus and systems::StyleState read the pressed flags later in the same phase.

See also
components::MouseButtonInteraction
systems::interaction::makeInteractive
systems::hitTest

Definition at line 65 of file mouse_button.hpp.

Constructor & Destructor Documentation

◆ MouseButton()

guillaume::systems::MouseButton::MouseButton ( event::EventBus & eventBus,
utility::Engine & engine )

Create the system, in the Event phase, and subscribe it to mouse button events.

Parameters
eventBusThe event bus delivering the mouse button events.
engineThe engine whose view converts the pointer position into a world ray. It must outlive the system.

Definition at line 28 of file mouse_button.cpp.

Here is the call graph for this function:

◆ ~MouseButton()

guillaume::systems::MouseButton::~MouseButton ( void )

Destructor.

Definition at line 37 of file mouse_button.cpp.

Member Function Documentation

◆ cleanup()

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

Does nothing.

Reimplemented from guillaume::ecs::System.

Definition at line 46 of file mouse_button.cpp.

◆ prepare()

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

Take the next pending mouse button event, once per frame.

When none is pending, the previous event stays the current one.

Reimplemented from guillaume::ecs::System.

Definition at line 41 of file mouse_button.cpp.

Here is the call graph for this function:

◆ update()

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

Apply the current mouse button event to one entity.

Events with an unknown button are ignored. When the view cannot convert the pointer position (it throws std::out_of_range), a warning is logged and the entity is left as it was.

Parameters
entityIdentifierThe entity holding the components::MouseButtonInteraction.

Implements guillaume::ecs::System.

Definition at line 50 of file mouse_button.cpp.

Here is the call graph for this function:

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