guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
scroll.hpp
1/*
2 Copyright (c) 2026 ETIB Corporation
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy of
5 this software and associated documentation files (the "Software"), to deal in
6 the Software without restriction, including without limitation the rights to
7 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
8 of the Software, and to permit persons to whom the Software is furnished to do
9 so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21 */
22
23#pragma once
24
25#include "guillaume/ecs/system_filler.hpp"
26
27#include "guillaume/event/event_bus.hpp"
28#include "guillaume/event/event_manager.hpp"
29
30#include "guillaume/components/bound.hpp"
31#include "guillaume/components/scrollable.hpp"
32
33#include <utility/event/mouse_wheel_event.hpp>
34
35namespace guillaume::systems
36{
37
56 class Scroll:
57 public ecs::SystemFiller<components::Scrollable, components::Bound>,
58 public event::EventManager<utility::event::MouseWheelEvent>
59 {
60 public:
66 Scroll(event::EventBus &eventBus);
67
71 ~Scroll(void);
72
78 void prepare(void) override;
79
86 void update(const ecs::Entity::Identifier &entityIdentifier) override;
87 };
88
89} // namespace guillaume::systems
std::size_t Identifier
The key under which an entity's components are stored. Systems and components refer to entities by th...
Definition entity.hpp:86
The base class to derive a system from: a System whose signature is the list of component types given...
Hands each engine event to the listeners subscribed to its type.
Definition event_bus.hpp:67
Base class that gives a system the input events of one type, one event per frame.
~Scroll(void)
Destructor.
Definition scroll.cpp:34
void update(const ecs::Entity::Identifier &entityIdentifier) override
Scroll one entity by the current wheel event and clamp its content offset to its Bound.
Definition scroll.cpp:43
Scroll(event::EventBus &eventBus)
Create the system, in the Event phase, and subscribe it to mouse wheel events.
Definition scroll.cpp:27
void prepare(void) override
Take the next pending mouse wheel event, once per frame.
Definition scroll.cpp:38
Rules. Every class here runs each frame on the entities that have the components it declares.