guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
switch.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#pragma once
23
24#include "guillaume/ecs/system_filler.hpp"
25
26#include "guillaume/components/switch.hpp"
27
28namespace guillaume::systems
29{
65 class Switch: public ecs::SystemFiller<components::Switch>
66 {
67 public:
72 Switch(void);
73
77 ~Switch(void) override = default;
78
97 static void install(ecs::ComponentRegistry &componentRegistry,
98 const ecs::Entity::Identifier &entityIdentifier);
99
124 static void apply(ecs::ComponentRegistry &componentRegistry,
125 const ecs::Entity::Identifier &entityIdentifier);
126
134 static bool isDisabled(const ecs::ComponentRegistry &componentRegistry,
135 const ecs::Entity::Identifier &entityIdentifier);
136
145 static bool isChecked(const ecs::ComponentRegistry &componentRegistry,
146 const ecs::Entity::Identifier &entityIdentifier);
147
160 static void setChecked(ecs::ComponentRegistry &componentRegistry,
161 const ecs::Entity::Identifier &entityIdentifier,
162 bool checked);
163
177 static void toggle(ecs::ComponentRegistry &componentRegistry,
178 const ecs::Entity::Identifier &entityIdentifier);
179
185 void update(const ecs::Entity::Identifier &entityIdentifier) override;
186 };
187
188} // 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...
Switch(void)
Create the system for the Layout phase, matching entities that have a components::Switch.
Definition switch.cpp:61
static void setChecked(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, bool checked)
Turn the switch on or off from code.
Definition switch.cpp:109
~Switch(void) override=default
Default destructor.
void update(const ecs::Entity::Identifier &entityIdentifier) override
Frame entry point: call apply on one switch.
Definition switch.cpp:211
static bool isChecked(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Whether the switch is on.
Definition switch.cpp:100
static void install(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Make an entity behave as a switch.
Definition switch.cpp:66
static bool isDisabled(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Whether the switch ignores input and is drawn disabled.
Definition switch.cpp:90
static void toggle(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Flip the switch as a click does.
Definition switch.cpp:117
static void apply(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Draw one switch from its components: thumb position, colors and accessibility.
Definition switch.cpp:135
Rules. Every class here runs each frame on the entities that have the components it declares.