guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
overlay_helpers.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 "guillaume/ecs/component_registry.hpp"
26#include "guillaume/ecs/entity.hpp"
27
28#include "guillaume/components/overlay.hpp"
29
30namespace guillaume::entities
31{
32
47 const ecs::Entity::Identifier &identifier,
48 bool visible)
49 {
50 registry.getComponent<components::Overlay>(identifier)
51 .setVisible(visible);
52 }
53
62 inline bool isOverlayVisible(const ecs::ComponentRegistry &registry,
63 const ecs::Entity::Identifier &identifier)
64 {
65 return registry.getComponent<components::Overlay>(identifier)
66 .isVisible();
67 }
68
69} // namespace guillaume::entities
Marks an entity as something shown temporarily above the rest of the interface (a dialog,...
Definition overlay.hpp:55
Stores every component of a scene, per component type and per entity identifier, and knows which ones...
ComponentType & getComponent(const Entity::Identifier &entityIdentifier)
Get a component of an entity, to read or modify it.
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
Widgets: the classes used to create entities with the right components and children.
Definition app_bar.hpp:46
void setOverlayVisible(ecs::ComponentRegistry &registry, const ecs::Entity::Identifier &identifier, bool visible)
Show or hide an overlay widget (dialog, menu, snackbar, tooltip).
bool isOverlayVisible(const ecs::ComponentRegistry &registry, const ecs::Entity::Identifier &identifier)
Tell whether an overlay widget is shown.