flecs::iter_iterable< Components > Struct Template Reference

Inheritance diagram for flecs::iter_iterable< Components >:

Public Member Functions
template<typename Iterable >
	iter_iterable (Iterable *it, flecs::world_t *world)
int32_t	count ()
bool	is_true ()
flecs::entity	first ()
iter_iterable< Components... > &	set_group (uint64_t group_id)
template<typename Group >
iter_iterable< Components... > &	set_group ()
Public Member Functions inherited from flecs::iterable< Components... >
void	each (Func &&func) const
	Each iterator.
void	each (flecs::world_t *world, Func &&func) const
void	each (flecs::iter &it, Func &&func) const
void	each (flecs::entity e, Func &&func) const
void	iter (Func &&func) const
	Iter iterator.
void	iter (flecs::world_t *world, Func &&func) const
void	iter (flecs::iter &it, Func &&func) const
void	iter (flecs::entity e, Func &&func) const
iter_iterable< Components... >	iter (flecs::world_t *world=nullptr) const
	Create iterator.
page_iterable< Components... >	page (int32_t offset, int32_t limit)
	Page iterator.
worker_iterable< Components... >	worker (int32_t index, int32_t count)
	Worker iterator.
int32_t	count () const
	Return number of entities matched by iterable.
bool	is_true () const
	Return whether iterable has any matches.
flecs::entity	first () const
	Return first entity matched by iterable.

Protected Member Functions
ecs_iter_t	get_iter (flecs::world_t *world) const
ecs_iter_next_action_t	next_action () const
ecs_iter_next_action_t	next_each_action () const
Protected Member Functions inherited from flecs::iterable< Components... >
virtual ecs_iter_t	get_iter (flecs::world_t *stage) const=0
virtual ecs_iter_next_action_t	next_action () const=0
virtual ecs_iter_next_action_t	next_each_action () const=0
void	iterate (flecs::world_t *stage, Func &&func, NextFunc next, Args &&... args) const

Additional Inherited Members
Protected Attributes inherited from flecs::iterable< Components... >
friend	iter_iterable< Components... >
friend	page_iterable< Components... >
friend	worker_iterable< Components... >

Detailed Description

template<typename ... Components>
struct flecs::iter_iterable< Components >

Definition at line 150 of file iterable.hpp.

Constructor & Destructor Documentation

iter_iterable()

template<typename ... Components>

template<typename Iterable >

flecs::iter_iterable< Components >::iter_iterable ( Iterable *  it, flecs::world_t *  world  )

inline

Definition at line 152 of file iterable.hpp.

Member Function Documentation

count()

template<typename ... Components>

int32_t flecs::iter_iterable< Components >::count ( )

inline

Definition at line 167 of file iterable.hpp.

first()

template<typename ... Components>

flecs::entity flecs::iter_iterable< Components >::first ( )

inline

Definition at line 185 of file iterable.hpp.

get_iter()

template<typename ... Components>

ecs_iter_t flecs::iter_iterable< Components >::get_iter ( flecs::world_t *  world ) const

inlineprotectedvirtual

Implements flecs::iterable< Components... >.

Definition at line 208 of file iterable.hpp.

is_true()

template<typename ... Components>

bool flecs::iter_iterable< Components >::is_true ( )

inline

Definition at line 176 of file iterable.hpp.

next_action()

template<typename ... Components>

ecs_iter_next_action_t flecs::iter_iterable< Components >::next_action ( ) const

inlineprotectedvirtual

Implements flecs::iterable< Components... >.

Definition at line 217 of file iterable.hpp.

next_each_action()

template<typename ... Components>

ecs_iter_next_action_t flecs::iter_iterable< Components >::next_each_action ( ) const

inlineprotectedvirtual

Implements flecs::iterable< Components... >.

Definition at line 221 of file iterable.hpp.

set_group() [1/2]

template<typename ... Components>

template<typename Group >

iter_iterable< Components... > & flecs::iter_iterable< Components >::set_group ( )

inline

Definition at line 202 of file iterable.hpp.

set_group() [2/2]

template<typename ... Components>

iter_iterable< Components... > & flecs::iter_iterable< Components >::set_group ( uint64_t  group_id )

inline

Definition at line 195 of file iterable.hpp.

---

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

• include/flecs/addons/cpp/utils/iterable.hpp