guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
surface_tone.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#include "guillaume/ecs/component.hpp"
25#include "guillaume/theme/tokens.hpp"
26
28{
29
44 {
45 private:
46 theme::ElevationLevel _elevation {
48 };
49
50 bool _shadow { true };
51
52 public:
56 SurfaceTone(void) = default;
57
61 ~SurfaceTone(void) = default;
62
67 theme::ElevationLevel getElevation(void) const noexcept;
68
79
84 bool hasShadow(void) const noexcept;
85
94 SurfaceTone &setShadow(bool shadow);
95 };
96
97} // namespace guillaume::components
theme::ElevationLevel getElevation(void) const noexcept
Get how high the surface sits above the background.
~SurfaceTone(void)=default
Default destructor.
SurfaceTone(void)=default
Create the state of a level 1 surface with a shadow.
SurfaceTone & setShadow(bool shadow)
Turn the shadow of the surface on or off.
SurfaceTone & setElevation(theme::ElevationLevel elevation)
Set how high the surface sits above the background.
bool hasShadow(void) const noexcept
Tell whether the surface casts a shadow.
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.
ElevationLevel
How far a surface is raised above the background, in six steps.
Definition tokens.hpp:130
@ Level1
Lowest raised level.
Definition tokens.hpp:132