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 "guillaume/ecs/component.hpp"
26
28{
52 {
53 public:
57 Backdrop(void) = default;
58
62 ~Backdrop(void) = default;
63
69 bool isVisible(void) const;
70
80 Backdrop &setVisible(bool visible);
81
87 float getProgress(void) const;
88
99 Backdrop &setProgress(float progress);
100
101 private:
102 bool _visible { false };
103 float _progress { 0.0f };
104 };
105
106} // namespace guillaume::components
Backdrop & setProgress(float progress)
Set the fade-in progress. Called by the entity's fade animation on every sample.
Definition backdrop.cpp:47
Backdrop(void)=default
Default constructor.
bool isVisible(void) const
Check whether the backdrop is shown.
Definition backdrop.cpp:27
float getProgress(void) const
Get the fade-in progress.
Definition backdrop.cpp:42
~Backdrop(void)=default
Default destructor.
Backdrop & setVisible(bool visible)
Store whether the backdrop is shown.
Definition backdrop.cpp:32
Base class of every component: a piece of state attached to an entity, plus a "changed" flag.
Definition component.hpp:72
State. Every class here is plain data attached to an entity.