CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::EntityQuery< P > Class Template Reference

#include <CeresEngine/Entity/EntityQuery.hpp>

Public Types

using Predicate = P
 The query predicate type.
 

Public Member Functions

 EntityQuery (EntityManager &entityManager, Predicate &&predicate)
 Creates a new entity query instance.
 
 ~EntityQuery ()=default
 Destroys a query.
 
auto begin ()
 
auto end () noexcept
 

Private Attributes

EntityManagermEntityManager
 The entity manager the query is ran on.
 
Generator< const EntitymGenerator
 The generator used to produce the entity output.
 

Member Typedef Documentation

◆ Predicate

template<typename P >
using CeresEngine::EntityQuery< P >::Predicate = P

The query predicate type.

Constructor & Destructor Documentation

◆ EntityQuery()

template<typename P >
CeresEngine::EntityQuery< P >::EntityQuery ( EntityManager entityManager,
Predicate &&  predicate 
)

Creates a new entity query instance.

Parameters
entityManagerThe entity manager to run the query on
predicateThe query predicate

◆ ~EntityQuery()

template<typename P >
CeresEngine::EntityQuery< P >::~EntityQuery ( )
default

Destroys a query.

Member Function Documentation

◆ begin()

template<typename P >
auto CeresEngine::EntityQuery< P >::begin ( )
Returns
An iterator that points to the first entity in the query

◆ end()

template<typename P >
auto CeresEngine::EntityQuery< P >::end ( )
noexcept
Returns
An iterator that points past the last entity in the query

Member Data Documentation

◆ mEntityManager

template<typename P >
EntityManager& CeresEngine::EntityQuery< P >::mEntityManager
private

The entity manager the query is ran on.

◆ mGenerator

template<typename P >
Generator<const Entity> CeresEngine::EntityQuery< P >::mGenerator
private

The generator used to produce the entity output.


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