Queries

Collaboration diagram for Queries:

Classes
struct	flecs::query_builder< Components >
	Query builder. More...
struct	flecs::query_builder_i< Base, Components >
	Query builder interface. More...
struct	flecs::query< Components >
	Typed query. More...
struct	flecs::query_base
	Base class for queries. More...
struct	flecs::term_ref_builder_i< Base >
	Term identifier builder. More...
struct	flecs::term_builder_i< Base >
	Term builder interface. More...
struct	flecs::term
	Class that describes a term. More...
template<typename... Comps, typename... Args>
flecs::query< Comps... >	flecs::world::query (Args &&... args) const
	Create a query.
flecs::query	query (flecs::entity query_entity) const
	Create a query from an entity.
template<typename... Comps, typename... Args>
flecs::query_builder< Comps... >	query_builder (Args &&... args) const
	Create a query builder.
template<typename Func >
void	each (Func &&func) const
	Iterate over all entities with components in the argument list of the function.
template<typename T , typename Func >
void	each (Func &&func) const
	Iterate over all entities with the provided component.
template<typename Func >
void	each (flecs::id_t term_id, Func &&func) const
	Iterate over all entities with the provided (component) ID.
template<typename... Args>
flecs::term	flecs::world::term (Args &&... args) const
	Create a term.
template<typename T >
flecs::term	term () const
	Create a term for a (component) type.
template<typename First , typename Second >
flecs::term	term () const
	Create a term for a pair.

Detailed Description

Function Documentation

each() [1/2]

template<typename Func >

void each ( Func && func ) const

related

Iterate over all entities with components in the argument list of the function.

The function parameter must match the following signature:

void(*)(flecs::entity)

or:

void(*)(T&, U&, ...)

or:

void(*)(flecs::entity, T&, U&, ...)

each() [2/2]

template<typename T , typename Func >

void each ( Func && func ) const

related

Iterate over all entities with the provided component.

The function parameter must match the following signature:

void(*)(T&)

or:

void(*)(flecs::entity, T&)

query() [1/2]

template<typename... Comps, typename... Args>

flecs::query< Comps... > query

(

Args &&...

args

)

const

Create a query.

See also

ecs_query_init()

query() [2/2]

flecs::query query ( flecs::entity query_entity ) const

related

Create a query from an entity.

See also

ecs_query_init()

query_builder()

template<typename... Comps, typename... Args>

flecs::query_builder< Comps... > query_builder ( Args &&... args ) const

related

Create a query builder.

See also

ecs_query_init()