guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
loading_indicator.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/color.hpp>
26
27#include "guillaume/ecs/system_filler.hpp"
28
29#include "guillaume/components/loading_indicator.hpp"
30
31namespace guillaume::systems
32{
68 public ecs::SystemFiller<components::LoadingIndicator>
69 {
70 public:
74 LoadingIndicator(void);
75
79 ~LoadingIndicator(void) override = default;
80
97 static void install(ecs::ComponentRegistry &componentRegistry,
98 const ecs::Entity::Identifier &entityIdentifier);
99
115 static void
116 installChildren(ecs::ComponentRegistry &componentRegistry,
117 const ecs::Entity::Identifier &entityIdentifier);
118
139 static void apply(ecs::ComponentRegistry &componentRegistry,
140 const ecs::Entity::Identifier &entityIdentifier);
141
147 static void start(ecs::ComponentRegistry &componentRegistry,
148 const ecs::Entity::Identifier &entityIdentifier);
149
159 static void stop(ecs::ComponentRegistry &componentRegistry,
160 const ecs::Entity::Identifier &entityIdentifier);
161
169 static bool isRunning(const ecs::ComponentRegistry &componentRegistry,
170 const ecs::Entity::Identifier &entityIdentifier);
171
185 static void startFade(ecs::ComponentRegistry &componentRegistry,
186 const ecs::Entity::Identifier &entityIdentifier);
187
195 static utility::graphic::Color32Bit
196 indicatorColor(const ecs::ComponentRegistry &componentRegistry,
197 const ecs::Entity::Identifier &entityIdentifier);
198
207 static float
208 strokeWidth(const ecs::ComponentRegistry &componentRegistry,
209 const ecs::Entity::Identifier &entityIdentifier);
210
219 void update(const ecs::Entity::Identifier &entityIdentifier) override;
220 };
221
222} // 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 installChildren(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Wire the looping animation of the animated child and start it.
static void startFade(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Start fading towards the opacity the running state calls for.
static bool isRunning(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Whether the looping animation is running.
static void install(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Give a loading indicator its accessibility role and its fade.
void update(const ecs::Entity::Identifier &entityIdentifier) override
Run apply() on one loading indicator; called by the frame loop.
LoadingIndicator(void)
Create the system in the Layout phase.
~LoadingIndicator(void) override=default
Default destructor.
static float strokeWidth(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Get the stroke width of the circular arc, in dp.
static utility::graphic::Color32Bit indicatorColor(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Get the color of the arc or bar at full opacity.
static void stop(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Stop the looping animation.
static void start(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Start the looping animation and fade the indicator in.
static void apply(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Size one loading indicator and draw its animated child at the current loop progress and opacity.
Rules. Every class here runs each frame on the entities that have the components it declares.