guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
layout.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 <cstdint>
26#include <vector>
27
28#include "guillaume/ecs/system_filler.hpp"
29
30#include "guillaume/components/bound.hpp"
31#include "guillaume/components/layout.hpp"
32#include "guillaume/components/transform.hpp"
33
34namespace guillaume::systems
35{
81 class Layout:
82 public ecs::SystemFiller<components::Layout, components::Transform,
83 components::Bound>
84 {
85 public:
91 static constexpr float LayerDepthStep = 1.0f;
92
101 static constexpr std::uint32_t ContentLayerOffset = 1;
102
106 Layout(void);
107
111 ~Layout(void) override = default;
112
118 void update(const ecs::Entity::Identifier &entityIdentifier) override;
119
141 static void
143 const ecs::Entity::Identifier &parentIdentifier,
144 const std::vector<ecs::Entity::Identifier> &childIdentifiers,
145 std::uint32_t layer = 0);
146
154 static std::uint32_t layerOf(const ecs::ComponentRegistry &registry,
155 const ecs::Entity::Identifier &identifier);
156
170 static const utility::graphic::PoseF applyLayerToPosition(
171 const utility::graphic::PositionF &position,
172 const utility::graphic::OrientationF &orientation,
173 const std::uint32_t &layer);
174
189 static const utility::graphic::PoseF
190 contentLayerPose(const utility::graphic::PositionF &position,
191 const utility::graphic::OrientationF &orientation,
192 const std::uint32_t &containerLayer);
193 };
194
195} // 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 apply(ecs::ComponentRegistry &registry, const ecs::Entity::Identifier &parentIdentifier, const std::vector< ecs::Entity::Identifier > &childIdentifiers, std::uint32_t layer=0)
Arrange children inside a container and size the container.
Definition layout.cpp:126
static constexpr std::uint32_t ContentLayerOffset
Number of layers added between a container and what is placed on it.
Definition layout.hpp:101
static const utility::graphic::PoseF contentLayerPose(const utility::graphic::PositionF &position, const utility::graphic::OrientationF &orientation, const std::uint32_t &containerLayer)
Compute the pose of content placed by hand on a container.
Definition layout.cpp:118
static std::uint32_t layerOf(const ecs::ComponentRegistry &registry, const ecs::Entity::Identifier &identifier)
Get the layer of an entity: its depth in the entity tree.
Definition layout.cpp:90
~Layout(void) override=default
Destroy the system. It owns no resource.
Layout(void)
Create the system in the Layout phase.
Definition layout.cpp:69
void update(const ecs::Entity::Identifier &entityIdentifier) override
Arrange the children listed in the components::Layout of one container, using the layer of its compon...
Definition layout.cpp:75
static constexpr float LayerDepthStep
Depth of one layer: the distance a child is moved towards the viewer, against the forward axis of its...
Definition layout.hpp:91
static const utility::graphic::PoseF applyLayerToPosition(const utility::graphic::PositionF &position, const utility::graphic::OrientationF &orientation, const std::uint32_t &layer)
Move a position in front of a container.
Definition layout.cpp:103
Rules. Every class here runs each frame on the entities that have the components it declares.