guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
hierarchy.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#pragma once
23
24#include <cstdint>
25#include <vector>
26
27#include "guillaume/ecs/component.hpp"
28#include "guillaume/ecs/entity.hpp"
29
31{
32
61 {
62 private:
63 ecs::Entity::Identifier _parentIdentifier {
65 };
66
67 std::vector<ecs::Entity::Identifier>
68 _childIdentifiers;
69 std::int32_t _layer { 0 };
70
71 public:
75 Hierarchy(void) = default;
76
80 ~Hierarchy(void) = default;
81
88
100
105 bool hasParent(void) const noexcept;
106
111 const std::vector<ecs::Entity::Identifier> &
112 getChildIdentifiers(void) const noexcept;
113
119 bool hasChild(ecs::Entity::Identifier identifier) const noexcept;
120
130 bool addChild(ecs::Entity::Identifier identifier);
131
141 bool removeChild(ecs::Entity::Identifier identifier);
142
148 std::int32_t getLayer(void) const noexcept;
149
160 Hierarchy &setLayer(std::int32_t layer);
161 };
162
163} // namespace guillaume::components
bool hasParent(void) const noexcept
Check whether the entity has a parent.
Definition hierarchy.cpp:43
bool removeChild(ecs::Entity::Identifier identifier)
Remove an entity from the direct children.
Definition hierarchy.cpp:71
Hierarchy & setParentIdentifier(ecs::Entity::Identifier identifier)
Store the identifier of the parent entity.
Definition hierarchy.cpp:34
std::int32_t getLayer(void) const noexcept
Get the depth of the entity in the tree.
Definition hierarchy.cpp:83
Hierarchy & setLayer(std::int32_t layer)
Store the depth of the entity in the tree.
Definition hierarchy.cpp:88
~Hierarchy(void)=default
Default destructor.
bool hasChild(ecs::Entity::Identifier identifier) const noexcept
Check whether an entity is a direct child of this one.
Definition hierarchy.cpp:54
const std::vector< ecs::Entity::Identifier > & getChildIdentifiers(void) const noexcept
Get the direct children, in the order they were attached.
Definition hierarchy.cpp:49
ecs::Entity::Identifier getParentIdentifier(void) const noexcept
Get the identifier of the parent entity.
Definition hierarchy.cpp:28
bool addChild(ecs::Entity::Identifier identifier)
Append an entity to the direct children.
Definition hierarchy.cpp:61
Hierarchy(void)=default
Construct the hierarchy of a root entity without children.
Base class of every component: a piece of state attached to an entity, plus a "changed" flag.
Definition component.hpp:72
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
static constexpr Identifier InvalidIdentifier
"No entity": never the identifier of a real entity
Definition entity.hpp:93
State. Every class here is plain data attached to an entity.