Pipeline of systems to orchestrate the execution of systems. More...

#include <Pipeline.hpp>

Collaboration diagram for ecstasy::Pipeline:

[legend]

Classes
class	Phase
	A phase in the pipeline. More...

Public Types
enum class	PredefinedPhases : std::size_t { OnLoad = 100 , PostLoad = 200 , PreUpdate = 300 , OnUpdate = 400 , OnValidate = 500 , PostUpdate = 600 , PreStore = 700 , OnStore = 800 }
	Some predefined phases. More...

using	SystemIterator = std::vector< std::type_index >::const_iterator
	Type of system iterator.

using	PhaseId = std::size_t
	Type of phase identifiers.

Public Member Functions
	Pipeline (Registry &registry)
	Construct a new Pipeline owned by the given registry.

Phase &	getPhase (PhaseId id, bool autoRegister=true)
	Get a Phase instance from its identifier.

const Phase &	getSystemPhase (std::type_index system) const
	Get the phase containing the given system.

template<std::derived_from< ISystem > S>
const Phase &	getSystemPhase () const
	Get the phase containing the given system.

Phase &	registerPhase (PhaseId id)
	Register a phase with the given identifier.

void	addSystem (std::type_index system, PhaseId phase=static_cast< std::size_t >(PredefinedPhases::OnUpdate))
	Add a system to the pipeline.

void	run ()
	Run a frame of the pipeline.

void	run (PhaseId phase)
	Run a specific phase of the pipeline.

Private Attributes
std::vector< std::type_index >	_systemsIds
	Ordered list of systems.

std::map< PhaseId, Phase >	_phases
	Ordered map of phases.

Registry &	_registry
	Owning registry.

Detailed Description

Pipeline of systems to orchestrate the execution of systems.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 32 of file Pipeline.hpp.

Member Typedef Documentation

◆ PhaseId

using ecstasy::Pipeline::PhaseId = std::size_t

Type of phase identifiers.

Definition at line 37 of file Pipeline.hpp.

◆ SystemIterator

using ecstasy::Pipeline::SystemIterator = std::vector<std::type_index>::const_iterator

Type of system iterator.

Definition at line 35 of file Pipeline.hpp.

Member Enumeration Documentation

◆ PredefinedPhases

enum class ecstasy::Pipeline::PredefinedPhases : std::size_t

strong

Some predefined phases.

Note: Theses phases are inspired from the default ones in flecs; The values are arbitrary and can be changed, they allow to insert custom phases between them.

Since: 1.0.0 (2024-11-21)

Enumerator
OnLoad	Load entities into the registry. (Ex: Keyboard inputs)
PostLoad	After loading entities into the registry. (Ex: Convert inputs to game actions)
PreUpdate	Before updating entities. (Ex: Initializing an empty frame/clearing the previous one)
OnUpdate	Update entities, this is the default system. (Ex: Physics simulation)
OnValidate	Validate entities state after the update. (Ex: Collision detection)
PostUpdate	After updating entities. (Ex: Collision resolution)
PreStore	Before storing entities. (Ex: Transform matrices computation)
OnStore	Store entities. (Ex: Rendering)

Definition at line 49 of file Pipeline.hpp.

                                    : std::size_t {
            OnLoad = 100,     
            PostLoad = 200,   
            PreUpdate = 300,  
            OnUpdate = 400,   
            OnValidate = 500, 
            PostUpdate = 600, 
            PreStore = 700,   
            OnStore = 800,    
        };

Constructor & Destructor Documentation

◆ Pipeline()

ecstasy::Pipeline::Pipeline ( Registry & registry )

Construct a new Pipeline owned by the given registry.

Parameters

[in] registry The registry owning this pipeline.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 37 of file Pipeline.cpp.

                                         : _registry(registry)
    {
    }

Member Function Documentation

◆ addSystem()

void ecstasy::Pipeline::addSystem	(	std::type_index	system,
		Pipeline::PhaseId	phaseId = `static_cast<std::size_t>(PredefinedPhases::OnUpdate)`
	)

Add a system to the pipeline.

Note: The systems are owned by the registry, not the pipeline.

Parameters

[in]	system	Type of the system to add.
[in]	phase	Phase in which the system should be. Default is OnUpdate.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Need to update all phases iterators

Definition at line 41 of file Pipeline.cpp.

    {
        Phase &phase = getPhase(phaseId);
 
        // Phase end is always after the last valid system (like end() in std::vector)
        _systemsIds.insert(_systemsIds.begin() + static_cast<long>(phase.end_idx()), system);
        ++phase._size;
 
        auto phaseIt = _phases.find(phaseId);
        size_t nextPhaseBegin = phase.end_idx();
 
        for (++phaseIt; phaseIt != _phases.end(); ++phaseIt) {
            phaseIt->second._begin = nextPhaseBegin;
            nextPhaseBegin = phaseIt->second.end_idx();
        }
    }

◆ getPhase()

Pipeline::Phase & ecstasy::Pipeline::getPhase	(	Pipeline::PhaseId	id,
		bool	autoRegister = `true`
	)

Get a Phase instance from its identifier.

Create it if it does not exist.

Parameters

[in]	id	Identifier of the phase.
[in]	autoRegister	Whether to register the phase if it does not exist. Default is `true`.

Returns: Phase& Reference to the phase.

Exceptions

std::out_of_range If the phase does not exist and autoRegister is false.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 76 of file Pipeline.cpp.

    {
        if (autoRegister)
            return registerPhase(id);
        auto it = _phases.find(id);
 
        if (it != _phases.end())
            return it->second;
        throw std::out_of_range("Phase not found");
    }

◆ getSystemPhase() [1/2]

template<std::derived_from< ISystem > S>

const Phase & ecstasy::Pipeline::getSystemPhase ( ) const

inline

Get the phase containing the given system.

Template Parameters

S	Type of the system to find.

Returns: const Phase& Reference to the phase containing the system.

Exceptions

std::out_of_range If the system is not in any phase.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 269 of file Pipeline.hpp.

        {
            return getSystemPhase(typeid(S));
        }

◆ getSystemPhase() [2/2]

const Pipeline::Phase & ecstasy::Pipeline::getSystemPhase ( std::type_index system ) const

Get the phase containing the given system.

Parameters

[in] system Type of the system to find.

Returns: Phase& Reference to the phase containing the system.

Exceptions

std::out_of_range If the system is not in any phase.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 87 of file Pipeline.cpp.

    {
        auto it = std::find(_systemsIds.begin(), _systemsIds.end(), system);
 
        if (it == _systemsIds.end())
            throw std::out_of_range("System not found in any phase");
        for (auto &phase : _phases) {
            if (it >= phase.second.begin() && it < phase.second.end())
                return phase.second;
        }
        throw std::out_of_range("System not found in any phase");
    }

◆ registerPhase()

Pipeline::Phase & ecstasy::Pipeline::registerPhase ( Pipeline::PhaseId id )

Register a phase with the given identifier.

Note: Does nothing if the phase already exists.

Parameters

[in] id Identifier of the phase.

Returns: Phase& Reference to the newly created phase.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 100 of file Pipeline.cpp.

    {
        auto it = _phases.find(id);
 
        if (it != _phases.end())
            return it->second;
 
        it = _phases.emplace(id, Phase(*this, id)).first;
        Phase &phase = it->second;
 
        // No phase preceeding this one, set begin to the start of the systems list
        if (it == _phases.begin()) {
            phase._begin = 0;
        } else {
            phase._begin = std::prev(it)->second.end_idx();
        }
        // No need to update following phases since our phase is empty
        return phase;
    }

◆ run() [1/2]

void ecstasy::Pipeline::run ( )

Run a frame of the pipeline.

Note: This will run all phases by ascending order of their identifier.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 59 of file Pipeline.cpp.

    {
        for (auto &phase : _phases) {
            phase.second.run();
        }
    }

◆ run() [2/2]

void ecstasy::Pipeline::run ( Pipeline::PhaseId phase )

Run a specific phase of the pipeline.

Parameters

[in] phase Identifier of the phase to run.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-21)

Definition at line 66 of file Pipeline.cpp.

    {
        auto phaseIt = _phases.find(phase);
 
        if (phaseIt == _phases.end())
            return;
 
        phaseIt->second.run();
    }

Member Data Documentation

◆ _phases

std::map<PhaseId, Phase> ecstasy::Pipeline::_phases

private

Ordered map of phases.

Definition at line 326 of file Pipeline.hpp.

◆ _registry

Registry& ecstasy::Pipeline::_registry

private

Owning registry.

Definition at line 328 of file Pipeline.hpp.

◆ _systemsIds

std::vector<std::type_index> ecstasy::Pipeline::_systemsIds

private

Ordered list of systems.

Definition at line 324 of file Pipeline.hpp.

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

src/ecstasy/system/Pipeline.hpp
src/ecstasy/system/Pipeline.cpp

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PhaseId

◆ SystemIterator

Member Enumeration Documentation

◆ PredefinedPhases

Constructor & Destructor Documentation

◆ Pipeline()

Member Function Documentation

◆ addSystem()

◆ getPhase()

◆ getSystemPhase() [1/2]

◆ getSystemPhase() [2/2]

◆ registerPhase()

◆ run() [1/2]

◆ run() [2/2]

Member Data Documentation

◆ _phases

◆ _registry

◆ _systemsIds