|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
Scrolls content with the mouse wheel. More...
#include <headers/guillaume/systems/scroll.hpp>


Public Member Functions | |
| Scroll (event::EventBus &eventBus) | |
| Create the system, in the Event phase, and subscribe it to mouse wheel events. | |
| ~Scroll (void) | |
| Destructor. | |
| void | prepare (void) override |
| Take the next pending mouse wheel event, once per frame. | |
| void | update (const ecs::Entity::Identifier &entityIdentifier) override |
| Scroll one entity by the current wheel event and clamp its content offset to its Bound. | |
| Public Member Functions inherited from guillaume::ecs::SystemFiller< components::Scrollable, 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(). | |
| virtual void | cleanup (void) |
| Called once per pass, after the last update(). | |
| Public Member Functions inherited from guillaume::event::EventManager< utility::event::MouseWheelEvent > | |
| 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::MouseWheelEvent > | |
| 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. | |
Scrolls content with the mouse wheel.
Runs in the Event phase on entities that have a components::Scrollable and a components::Bound. It reads the wheel offset of the current mouse wheel event and the scroll step of the component, adds offset * step (per axis) to the content offset of components::Scrollable, then clamps the result with the Bound as the viewport size.
Definition at line 56 of file scroll.hpp.
| guillaume::systems::Scroll::Scroll | ( | event::EventBus & | eventBus | ) |
Create the system, in the Event phase, and subscribe it to mouse wheel events.
| eventBus | The event bus delivering the mouse wheel events. |
Definition at line 27 of file scroll.cpp.

| guillaume::systems::Scroll::~Scroll | ( | void | ) |
Destructor.
Definition at line 34 of file scroll.cpp.
|
overridevirtual |
Take the next pending mouse wheel event, once per frame.
When none is pending, the previous event stays the current one.
Reimplemented from guillaume::ecs::System.
Definition at line 38 of file scroll.cpp.

|
overridevirtual |
Scroll one entity by the current wheel event and clamp its content offset to its Bound.
| entityIdentifier | The entity holding the components::Scrollable. |
Implements guillaume::ecs::System.
Definition at line 43 of file scroll.cpp.
