guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
segmented_button.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 <cstddef>
26#include <vector>
27
28#include "guillaume/ecs/system_filler.hpp"
29
30#include "guillaume/components/segmented_button.hpp"
31
32namespace guillaume::systems
33{
71 class SegmentedButton: public ecs::SystemFiller<components::SegmentedButton>
72 {
73 public:
76 static constexpr const char *SelectedGlyph = "check";
77
82 SegmentedButton(void);
83
87 ~SegmentedButton(void) override = default;
88
108 static void install(ecs::ComponentRegistry &componentRegistry,
109 const ecs::Entity::Identifier &entityIdentifier);
110
133 static void apply(ecs::ComponentRegistry &componentRegistry,
134 const ecs::Entity::Identifier &entityIdentifier);
135
147 static void select(ecs::ComponentRegistry &componentRegistry,
148 const ecs::Entity::Identifier &entityIdentifier,
149 std::size_t index);
150
161 static void deselect(ecs::ComponentRegistry &componentRegistry,
162 const ecs::Entity::Identifier &entityIdentifier,
163 std::size_t index);
164
183 static void
184 segmentChanged(ecs::ComponentRegistry &componentRegistry,
185 const ecs::Entity::Identifier &entityIdentifier,
186 std::size_t index);
187
202 static void
204 const ecs::Entity::Identifier &entityIdentifier,
205 std::size_t index, bool disabled);
206
216 static bool isSelected(const ecs::ComponentRegistry &componentRegistry,
217 const ecs::Entity::Identifier &entityIdentifier,
218 std::size_t index);
219
228 static std::vector<std::size_t>
229 selectedIndices(const ecs::ComponentRegistry &componentRegistry,
230 const ecs::Entity::Identifier &entityIdentifier);
231
237 void update(const ecs::Entity::Identifier &entityIdentifier) override;
238 };
239
240} // namespace guillaume::systems
Stores every component of a scene, per component type and per entity identifier, and knows which ones...
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...
static void select(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index)
Select a segment from code and show it at once.
static void segmentChanged(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index)
React to the user clicking a segment.
static void apply(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Lay out the row from the current selection of the buttons.
void update(const ecs::Entity::Identifier &entityIdentifier) override
Frame entry point: call apply on one segmented button.
static void install(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Make an entity behave as a segmented button.
~SegmentedButton(void) override=default
Default destructor.
static constexpr const char * SelectedGlyph
static std::vector< std::size_t > selectedIndices(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
List the selected segments.
static bool isSelected(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index)
Whether a segment is selected.
static void deselect(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index)
Deselect a segment from code and show it at once.
SegmentedButton(void)
Create the system for the Layout phase, matching entities that have a components::SegmentedButton.
static void setSegmentDisabled(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index, bool disabled)
Enable or disable one segment and show it at once.
Rules. Every class here runs each frame on the entities that have the components it declares.