Additional options for query terms. This can be used to configure source lookup, traversal and access mode without relying on many positional overloads. More...

#include <query_common.h>

Public Member Functions
QueryTermOptions &	src (Entity source)

QueryTermOptions &	trav (Entity relation=ChildOf)

QueryTermOptions &	trav_up (Entity relation=ChildOf)

QueryTermOptions &	trav_parent (Entity relation=ChildOf)

QueryTermOptions &	trav_self_parent (Entity relation=ChildOf)

QueryTermOptions &	trav_down (Entity relation=ChildOf)

QueryTermOptions &	trav_self_down (Entity relation=ChildOf)

QueryTermOptions &	trav_child (Entity relation=ChildOf)

QueryTermOptions &	trav_self_child (Entity relation=ChildOf)

QueryTermOptions &	trav_kind (QueryTravKind kind)

QueryTermOptions &	trav_depth (uint8_t maxDepth)

QueryTermOptions &	read ()

QueryTermOptions &	write ()

QueryTermOptions &	direct ()

QueryTermOptions &	in ()

Public Attributes
Entity	entSrc = EntityBad
	Source entity to query from.

Entity	entTrav = EntityBad
	Optional traversal relation used for source lookup.

QueryTravKind	travKind = QueryTravKind::Self \| QueryTravKind::Up
	Source traversal filter.

uint8_t	travDepth = TravDepthUnlimited
	Maximum number of traversal steps. 0 means unlimited traversal depth (bounded internally, at most MAX_TRAV_DEPTH steps).

QueryAccess	access = QueryAccess::None
	Access mode for the term. When None, typed query terms infer read/write access from template mutability.

QueryMatchKind	matchKind = QueryMatchKind::Semantic
	Match semantics for terms with special meaning, such as `Pair(Is, X)`.

Static Public Attributes
static constexpr uint8_t	TravDepthUnlimited = QueryInput::TravDepthUnlimited

Detailed Description

Additional options for query terms. This can be used to configure source lookup, traversal and access mode without relying on many positional overloads.

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

/home/runner/work/gaia-ecs/gaia-ecs/include/gaia/ecs/query_common.h

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description