flecs::observer_builder_i< Base, Components > Struct Template Reference

Observer builder interface. More...

#include <builder_i.hpp>

Inheritance diagram for flecs::observer_builder_i< Base, Components >:

Public Types
using	BaseClass = filter_builder_i< Base, Components ... >

Public Member Functions
	observer_builder_i (ecs_observer_desc_t *desc)
Base &	event (entity_t evt)
	Specify the event(s) for when the observer should run. More...
template<typename E >
Base &	event ()
	Specify the event(s) for when the observer should run. More...
Base &	yield_existing (bool value=true)
	Invoke observer for anything that matches its filter on creation. More...
Base &	ctx (void *ptr)
	Set observer context. More...
Base &	run (ecs_iter_action_t action)
	Set observer run callback. More...
Public Member Functions inherited from flecs::filter_builder_i< Base, Components ... >
	filter_builder_i (ecs_filter_desc_t *desc, int32_t term_index=0)
Base &	instanced ()
Base &	filter_flags (ecs_flags32_t flags)
Base &	expr (const char *expr)
Base &	with (Args &&... args)
Base &	with (Args &&... args)
Base &	with ()
Base &	without (Args &&... args)
Base &	without (Args &&... args)
Base &	without ()
Base &	write ()
Base &	write (Args &&... args)
Base &	write (Args &&... args)
Base &	write ()
Base &	read ()
Base &	read (Args &&... args)
Base &	read (Args &&... args)
Base &	read ()
Base &	scope_open ()
Base &	scope_close ()
Base &	term ()
Base &	term ()
Base &	term (id_t id)
Base &	term (const char *name)
Base &	term (const char *first, const char *second)
Base &	term (entity_t r, entity_t o)
Base &	term (entity_t r, const char *o)
Base &	term (id_t o)
Base &	term (const char *second)
Base &	term ()
Base &	term (E value)
Base &	term (flecs::term &term)
Base &	term (flecs::term &&term)
Base &	term_at (int32_t term_index)
Base &	arg (int32_t term_index)
Public Member Functions inherited from flecs::term_builder_i< Base >
	term_builder_i (ecs_term_t *term_ptr)
Base &	term (id_t id)
Base &	src ()
Base &	first ()
Base &	second ()
Base &	src (flecs::entity_t id)
template<typename T >
Base &	src ()
Base &	src (const char *name)
Base &	first (flecs::entity_t id)
template<typename T >
Base &	first ()
Base &	first (const char *name)
Base &	second (flecs::entity_t id)
template<typename T >
Base &	second ()
Base &	second (const char *name)
Base &	role (id_t role)
	Set role of term. More...
Base &	inout (flecs::inout_kind_t inout)
	Set read/write access of term. More...
Base &	inout_stage (flecs::inout_kind_t inout)
	Set read/write access for stage. More...
Base &	write ()
	Short for inout_stage(flecs::Out). More...
Base &	read ()
	Short for inout_stage(flecs::In). More...
Base &	read_write ()
	Short for inout_stage(flecs::InOut). More...
Base &	in ()
	Short for inout(flecs::In) More...
Base &	out ()
	Short for inout(flecs::Out) More...
Base &	inout ()
	Short for inout(flecs::InOut) More...
Base &	inout_none ()
	Short for inout(flecs::In) More...
Base &	oper (flecs::oper_kind_t oper)
	Set operator of term. More...
Base &	and_ ()
Base &	or_ ()
Base &	not_ ()
Base &	optional ()
Base &	and_from ()
Base &	or_from ()
Base &	not_from ()
Base &	singleton ()
	Match singleton. More...
Base &	filter ()
Public Member Functions inherited from flecs::term_id_builder_i< Base >
Base &	self ()
Base &	up (flecs::entity_t trav=0)
template<typename Trav >
Base &	up ()
Base &	cascade (flecs::entity_t trav=0)
template<typename Trav >
Base &	cascade ()
Base &	parent ()
Base &	trav (flecs::entity_t trav, flecs::flags32_t flags=0)
Base &	id (flecs::entity_t id)
Base &	entity (flecs::entity_t entity)
Base &	name (const char *name)
Base &	var (const char *var_name)
Base &	flags (flecs::flags32_t flags)

Protected Member Functions
virtual flecs::world_t *	world_v ()=0
virtual flecs::world_t *	world_v ()=0
Protected Member Functions inherited from flecs::term_builder_i< Base >
virtual flecs::world_t *	world_v ()=0
void	set_term (ecs_term_t *term)
virtual flecs::world_t *	world_v ()=0

Additional Inherited Members
Public Attributes inherited from flecs::term_builder_i< Base >
ecs_term_t *	m_term
Public Attributes inherited from flecs::term_id_builder_i< Base >
ecs_term_id_t *	m_term_id
Protected Attributes inherited from flecs::filter_builder_i< Base, Components ... >
int32_t	m_term_index
int32_t	m_expr_count

Detailed Description

template<typename Base, typename ... Components>
struct flecs::observer_builder_i< Base, Components >

Observer builder interface.

Definition at line 17 of file builder_i.hpp.

Member Typedef Documentation

BaseClass

template<typename Base , typename ... Components>

using flecs::observer_builder_i< Base, Components >::BaseClass = filter_builder_i<Base, Components ...>

Definition at line 18 of file builder_i.hpp.

Constructor & Destructor Documentation

observer_builder_i() [1/2]

template<typename Base , typename ... Components>

flecs::observer_builder_i< Base, Components >::observer_builder_i ( )

inline

Definition at line 19 of file builder_i.hpp.

observer_builder_i() [2/2]

template<typename Base , typename ... Components>

flecs::observer_builder_i< Base, Components >::observer_builder_i ( ecs_observer_desc_t *  desc )

inline

Definition at line 24 of file builder_i.hpp.

Member Function Documentation

ctx()

template<typename Base , typename ... Components>

Base & flecs::observer_builder_i< Base, Components >::ctx ( void *  ptr )

inline

Set observer context.

Definition at line 53 of file builder_i.hpp.

event() [1/2]

template<typename Base , typename ... Components>

template<typename E >

Base & flecs::observer_builder_i< Base, Components >::event ( )

inline

Specify the event(s) for when the observer should run.

Template Parameters

E	The event.

Definition at line 41 of file builder_i.hpp.

event() [2/2]

template<typename Base , typename ... Components>

Base & flecs::observer_builder_i< Base, Components >::event ( entity_t  evt )

inline

Specify the event(s) for when the observer should run.

Parameters

evt	The event.

Definition at line 32 of file builder_i.hpp.

run()

template<typename Base , typename ... Components>

Base & flecs::observer_builder_i< Base, Components >::run ( ecs_iter_action_t  action )

inline

Set observer run callback.

Definition at line 59 of file builder_i.hpp.

world_v()

template<typename Base , typename ... Components>

virtual flecs::world_t * flecs::observer_builder_i< Base, Components >::world_v ( )

protectedpure virtual

Implements flecs::filter_builder_i< Base, Components ... >.

yield_existing()

template<typename Base , typename ... Components>

Base & flecs::observer_builder_i< Base, Components >::yield_existing ( bool  value = true )

inline

Invoke observer for anything that matches its filter on creation.

Definition at line 47 of file builder_i.hpp.

---

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

• include/flecs/addons/cpp/mixins/observer/builder_i.hpp