guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
scrollable.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 <utility/graphic/size.hpp>
26#include <utility/math/vector.hpp>
27
28#include "guillaume/ecs/component.hpp"
29
31{
32
58 {
59 private:
60 utility::math::Vector2F _contentOffset {
61 0.0f, 0.0f
62 };
63 utility::math::Vector2F _contentSize {
64 0.0f, 0.0f
65 };
66 utility::math::Vector2F _scrollStep {
67 1.0f, 1.0f
68 };
69
70 public:
75 Scrollable(void) = default;
76
80 ~Scrollable(void) = default;
81
87 utility::math::Vector2F getContentOffset(void) const;
88
98 Scrollable &setContentOffset(const utility::math::Vector2F &offset);
99
104 utility::math::Vector2F getContentSize(void) const;
105
116 Scrollable &setContentSize(const utility::math::Vector2F &size);
117
122 utility::math::Vector2F getScrollStep(void) const;
123
133 Scrollable &setScrollStep(const utility::math::Vector2F &step);
134
143 utility::math::Vector2F
144 getMaxOffset(const utility::graphic::SizeF &viewport) const;
145
156 Scrollable &clampOffset(const utility::graphic::SizeF &viewport);
157 };
158
159} // namespace guillaume::components
Scrollable & setContentOffset(const utility::math::Vector2F &offset)
Scroll the content to an offset.
utility::math::Vector2F getContentSize(void) const
Get the full size of the scrollable content.
utility::math::Vector2F getScrollStep(void) const
Get how much one unit of wheel movement scrolls.
Scrollable & setScrollStep(const utility::math::Vector2F &step)
Set how much one unit of wheel movement scrolls.
Scrollable & setContentSize(const utility::math::Vector2F &size)
Set the full size of the scrollable content.
utility::math::Vector2F getMaxOffset(const utility::graphic::SizeF &viewport) const
Get the largest offset that still shows content, for a viewport size.
utility::math::Vector2F getContentOffset(void) const
Get how far the content is scrolled.
Scrollable(void)=default
Construct a component scrolled to the origin, with an empty content and a scroll step of 1 on both ax...
Scrollable & clampOffset(const utility::graphic::SizeF &viewport)
Bring the offset back between 0 and getMaxOffset().
~Scrollable(void)=default
Default destructor.
Base class of every component: a piece of state attached to an entity, plus a "changed" flag.
Definition component.hpp:72
State. Every class here is plain data attached to an entity.