guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
navigation_bar.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 <string>
27
28#include "guillaume/ecs/system_filler.hpp"
29
30#include "guillaume/components/navigation_bar.hpp"
31
32namespace guillaume::systems
33{
72 class NavigationBar: public ecs::SystemFiller<components::NavigationBar>
73 {
74 public:
78 NavigationBar(void);
79
83 ~NavigationBar(void) override = default;
84
103 static void install(ecs::ComponentRegistry &componentRegistry,
104 const ecs::Entity::Identifier &entityIdentifier);
105
124 static void apply(ecs::ComponentRegistry &componentRegistry,
125 const ecs::Entity::Identifier &entityIdentifier);
126
138 static void select(ecs::ComponentRegistry &componentRegistry,
139 const ecs::Entity::Identifier &entityIdentifier,
140 std::size_t index);
141
156 static void press(ecs::ComponentRegistry &componentRegistry,
157 const ecs::Entity::Identifier &entityIdentifier,
158 std::size_t index);
159
175 static void
177 const ecs::Entity::Identifier &entityIdentifier,
178 std::size_t index);
179
193 static void setBadge(ecs::ComponentRegistry &componentRegistry,
194 const ecs::Entity::Identifier &entityIdentifier,
195 std::size_t index, const std::string &badge);
196
205 static std::size_t
206 selectedIndex(const ecs::ComponentRegistry &componentRegistry,
207 const ecs::Entity::Identifier &entityIdentifier);
208
217 void update(const ecs::Entity::Identifier &entityIdentifier) override;
218 };
219
220} // 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...
~NavigationBar(void) override=default
Default destructor.
void update(const ecs::Entity::Identifier &entityIdentifier) override
Run apply() on one navigation bar; called by the frame loop.
static void setBadge(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index, const std::string &badge)
Set the badge of a destination and restyle that destination.
static void install(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Connect a navigation bar to its destinations.
static void press(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index)
Activate a destination as a press on it would.
static std::size_t selectedIndex(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Get the index of the selected destination.
NavigationBar(void)
Create the system in the Layout phase.
static void apply(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Color the bar, size and style its destinations and place them in a row.
static void select(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index)
Select a destination from code.
static void destinationSelected(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, std::size_t index)
React to a destination that became selected without going through the bar.
Rules. Every class here runs each frame on the entities that have the components it declares.