guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
guillaume::ecs::SystemPhase< Value, TravelerType > Class Template Reference

Ties a Phase to the order in which its systems visit the entities. More...

#include <headers/guillaume/ecs/system_phase.hpp>

Public Member Functions

 SystemPhase (void)=default
 Create the phase definition and its traveler.
 ~SystemPhase (void)=default
 Destroy the phase definition and its traveler.
constexpr Phase getPhase (void) const
 Get the phase this definition describes.
const EntityTreeTraveler & getTraveler (void) const
 Get the traveler that orders the entities for this phase.

Static Public Attributes

static constexpr Phase phase = Value

Detailed Description

template<Phase Value, InheritFromEntityTreeTraveler TravelerType>
class guillaume::ecs::SystemPhase< Value, TravelerType >

Ties a Phase to the order in which its systems visit the entities.

Application keeps one instance per phase (SystemPhaseList) and, for each, runs the systems registered for getPhase() with getTraveler(). Use the aliases EventPhase, MeasurePhase, LayoutPhase and RenderPhase rather than this template.

Template Parameters
ValueThe phase.
TravelerTypeThe traveler that orders the entities for the systems of this phase.
See also
EntityTreeTraveler

Definition at line 78 of file system_phase.hpp.

Member Function Documentation

◆ getPhase()

template<Phase Value, InheritFromEntityTreeTraveler TravelerType>
Phase guillaume::ecs::SystemPhase< Value, TravelerType >::getPhase ( void ) const
constexpr

Get the phase this definition describes.

Returns
The phase, equal to SystemPhase::phase.

◆ getTraveler()

template<Phase Value, InheritFromEntityTreeTraveler TravelerType>
const EntityTreeTraveler & guillaume::ecs::SystemPhase< Value, TravelerType >::getTraveler ( void ) const

Get the traveler that orders the entities for this phase.

Returns
Reference to the traveler, valid as long as this object; pass it to System::routine.

Member Data Documentation

◆ phase

template<Phase Value, InheritFromEntityTreeTraveler TravelerType>
Phase guillaume::ecs::SystemPhase< Value, TravelerType >::phase = Value
staticconstexpr

The phase, known at compile time

Definition at line 81 of file system_phase.hpp.


The documentation for this class was generated from the following file: