flecs::rule_base Struct Reference

Inheritance diagram for flecs::rule_base:

Public Member Functions
	rule_base (world_t *world, rule_t *rule=nullptr)
	rule_base (world_t *world, ecs_filter_desc_t *desc)
bool	is_valid () const
	operator rule_t * () const
flecs::entity	entity ()
void	destruct ()
	Free the rule.
template<typename Func >
void	each_term (const Func &func) const
void	move (flecs::rule_base &&obj)
	Move the rule.
flecs::filter_base	filter () const
flecs::string	str () const
	Converts this rule to a string expression.
flecs::string	rule_str () const
	Converts this rule to a string that can be used to aid debugging the behavior of the rule.
	operator rule<> () const

Protected Attributes
world_t *	m_world
rule_t *	m_rule

Detailed Description

Definition at line 16 of file impl.hpp.

Constructor & Destructor Documentation

rule_base() [1/3]

flecs::rule_base::rule_base ( )

inline

Definition at line 17 of file impl.hpp.

rule_base() [2/3]

flecs::rule_base::rule_base ( world_t * world, rule_t * rule = nullptr )

inline

Definition at line 21 of file impl.hpp.

rule_base() [3/3]

flecs::rule_base::rule_base ( world_t * world, ecs_filter_desc_t * desc )

inline

Definition at line 25 of file impl.hpp.

Member Function Documentation

destruct()

void flecs::rule_base::destruct ( )

inline

Free the rule.

Definition at line 47 of file impl.hpp.

each_term()

template<typename Func >

void flecs::rule_base::each_term ( const Func & func ) const

inline

Definition at line 56 of file impl.hpp.

entity()

flecs::entity flecs::rule_base::entity ( )

inline

Definition at line 42 of file impl.hpp.

filter()

flecs::filter_base flecs::rule_base::filter ( ) const

inline

Definition at line 69 of file impl.hpp.

is_valid()

bool flecs::rule_base::is_valid ( ) const

inline

Definition at line 34 of file impl.hpp.

move()

void flecs::rule_base::move ( flecs::rule_base && obj )

inline

Move the rule.

Definition at line 61 of file impl.hpp.

operator rule<>()

flecs::rule_base::operator rule<> ( ) const

inline

Definition at line 140 of file impl.hpp.

operator rule_t *()

flecs::rule_base::operator rule_t * ( ) const

inline

Definition at line 38 of file impl.hpp.

rule_str()

flecs::string flecs::rule_base::rule_str ( ) const

inline

Converts this rule to a string that can be used to aid debugging the behavior of the rule.

See also

ecs_rule_str

Definition at line 87 of file impl.hpp.

str()

flecs::string flecs::rule_base::str ( ) const

inline

Converts this rule to a string expression.

See also

ecs_filter_str

Definition at line 76 of file impl.hpp.

Member Data Documentation

m_rule

rule_t* flecs::rule_base::m_rule

protected

Definition at line 96 of file impl.hpp.

m_world

world_t* flecs::rule_base::m_world

protected

Definition at line 95 of file impl.hpp.

---

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

• include/flecs/addons/cpp/mixins/rule/impl.hpp