guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
backdrop.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/pose.hpp>
26
27#include "guillaume/ecs/system_filler.hpp"
28
29#include "guillaume/components/animation.hpp"
30#include "guillaume/components/backdrop.hpp"
31#include "guillaume/components/scrim.hpp"
32#include "guillaume/components/transform.hpp"
33
34namespace guillaume::systems
35{
68 class Backdrop:
69 public ecs::SystemFiller<components::Backdrop, components::Scrim>
70 {
71 public:
74 static constexpr float Extent = 8192.0f;
75
79 Backdrop(void);
80
84 ~Backdrop(void) override = default;
85
96 static void apply(ecs::ComponentRegistry &componentRegistry,
97 const ecs::Entity::Identifier &entityIdentifier);
98
111 static void setVisible(ecs::ComponentRegistry &componentRegistry,
112 const ecs::Entity::Identifier &entityIdentifier,
113 bool visible);
114
129 static void follow(ecs::ComponentRegistry &componentRegistry,
130 const ecs::Entity::Identifier &entityIdentifier,
131 const utility::graphic::PoseF &ownerPose,
132 float ownerWidth, float ownerHeight);
133
139 void update(const ecs::Entity::Identifier &entityIdentifier) override;
140 };
141
142} // 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 follow(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, const utility::graphic::PoseF &ownerPose, float ownerWidth, float ownerHeight)
Center a backdrop on its owner and place it half a layer behind it.
Definition backdrop.cpp:76
static void apply(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Write the Scrim color that matches the current state of a backdrop.
Definition backdrop.cpp:39
static void setVisible(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, bool visible)
Show or hide a backdrop.
Definition backdrop.cpp:55
Backdrop(void)
Create the system in the Layout phase.
Definition backdrop.cpp:33
static constexpr float Extent
Definition backdrop.hpp:74
~Backdrop(void) override=default
Destroy the system. It owns no resource.
void update(const ecs::Entity::Identifier &entityIdentifier) override
Write the Scrim color of one backdrop for this frame, so a theme change is picked up without any call...
Definition backdrop.cpp:92
Rules. Every class here runs each frame on the entities that have the components it declares.