guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
system_phase.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 <cstddef>
26#include <tuple>
27#include <type_traits>
28
29#include "guillaume/ecs/entity_tree_traveler.hpp"
30#include "guillaume/ecs/level_order_traveler.hpp"
31#include "guillaume/ecs/reverse_level_order_traveler.hpp"
32
33namespace guillaume::ecs
34{
35
52 enum class Phase : std::size_t {
62 };
63
77 template<Phase Value, InheritFromEntityTreeTraveler TravelerType>
79 {
80 public:
81 static constexpr Phase phase = Value;
83
84 private:
85 TravelerType
86 _traveler;
87
88 public:
92 SystemPhase(void) = default;
93
97 ~SystemPhase(void) = default;
98
103 constexpr Phase getPhase(void) const;
104
110 const EntityTreeTraveler &getTraveler(void) const;
111 };
112
117
123
129
134
140 std::tuple<EventPhase, MeasurePhase, LayoutPhase, RenderPhase>;
141
142} // namespace guillaume::ecs
143
144// Include the implementation of the SystemPhase template class
145#include "guillaume/ecs/system_phase.tpp"
Decides in which order the entities of a scene are visited.
Ties a Phase to the order in which its systems visit the entities.
constexpr Phase getPhase(void) const
Get the phase this definition describes.
SystemPhase(void)=default
Create the phase definition and its traveler.
~SystemPhase(void)=default
Destroy the phase definition and its traveler.
const EntityTreeTraveler & getTraveler(void) const
Get the traveler that orders the entities for this phase.
The entity-component-system core, independent of any widget.
Definition component.hpp:28
SystemPhase< Phase::Layout, LevelOrderTraveler > LayoutPhase
The Layout phase: entities are visited parents before children, so a parent is placed before it place...
Phase
The four steps of a frame. Every system belongs to one of them.
@ Count
Number of phases; not a phase.
SystemPhase< Phase::Measure, ReverseLevelOrderTraveler > MeasurePhase
The Measure phase: entities are visited children before parents, so a parent is sized after its child...
SystemPhase< Phase::Event, ReverseLevelOrderTraveler > EventPhase
The Event phase: entities are visited children before parents.
SystemPhase< Phase::Render, LevelOrderTraveler > RenderPhase
The Render phase: entities are visited parents before children.
std::tuple< EventPhase, MeasurePhase, LayoutPhase, RenderPhase > SystemPhaseList
Every phase, in the order a frame runs them: Event, Measure, Layout, Render.