|
| | query_builder_i (ecs_query_desc_t *desc, int32_t term_index=0) |
| |
| Base & | query_flags (ecs_flags32_t flags) |
| |
| Base & | cache_kind (query_cache_kind_t kind) |
| |
| Base & | cached () |
| |
| Base & | expr (const char *expr) |
| |
| template<typename T > |
| Base & | with () |
| |
| Base & | with (id_t component_id) |
| |
| Base & | with (const char *component_name) |
| |
| Base & | with (const char *first, const char *second) |
| |
| Base & | with (entity_t first, entity_t second) |
| |
| Base & | with (entity_t first, const char *second) |
| |
| Base & | with (const char *first, entity_t second) |
| |
| template<typename First > |
| Base & | with (entity_t second) |
| |
| template<typename First > |
| Base & | with (const char *second) |
| |
| template<typename First , typename Second > |
| Base & | with () |
| |
| template<typename E , if_t< is_enum< E >::value > = 0> |
| Base & | with (E value) |
| |
| Base & | with (flecs::term &term) |
| |
| Base & | with (flecs::term &&term) |
| |
| template<typename ... Args> |
| Base & | without (Args &&... args) |
| |
| template<typename T , typename ... Args> |
| Base & | without (Args &&... args) |
| |
| template<typename First , typename Second > |
| Base & | without () |
| |
| Base & | write () |
| |
| template<typename ... Args> |
| Base & | write (Args &&... args) |
| |
| template<typename T , typename ... Args> |
| Base & | write (Args &&... args) |
| |
| template<typename First , typename Second > |
| Base & | write () |
| |
| Base & | read () |
| |
| template<typename ... Args> |
| Base & | read (Args &&... args) |
| |
| template<typename T , typename ... Args> |
| Base & | read (Args &&... args) |
| |
| template<typename First , typename Second > |
| Base & | read () |
| |
| Base & | scope_open () |
| |
| Base & | scope_close () |
| |
| Base & | term () |
| | Sets the current term to next one in term list.
|
| |
| template<typename T > |
| Base & | term_at () |
| | Sets the current term to the one with the provided type.
|
| |
| Base & | term_at (int32_t term_index) |
| | Sets the current term to the one at the provided index.
|
| |
| template<typename T > |
| Base & | term_at (int32_t term_index) |
| | Sets the current term to the one at the provided index and asserts that the type matches.
|
| |
| template<typename T > |
| Base & | order_by (int(*compare)(flecs::entity_t, const T *, flecs::entity_t, const T *)) |
| | Sort the output of a query.
|
| |
| Base & | order_by (flecs::entity_t component, int(*compare)(flecs::entity_t, const void *, flecs::entity_t, const void *)) |
| | Sort the output of a query.
|
| |
| template<typename T > |
| Base & | group_by (uint64_t(*group_by_action)(flecs::world_t *, flecs::table_t *table, flecs::id_t id, void *ctx)) |
| | Group and sort matched tables.
|
| |
| Base & | group_by (flecs::entity_t component, uint64_t(*group_by_action)(flecs::world_t *, flecs::table_t *table, flecs::id_t id, void *ctx)) |
| | Group and sort matched tables.
|
| |
| template<typename T > |
| Base & | group_by () |
| | Group and sort matched tables.
|
| |
| Base & | group_by (flecs::entity_t component) |
| | Group and sort matched tables.
|
| |
| Base & | group_by_ctx (void *ctx, ecs_ctx_free_t ctx_free=nullptr) |
| | Specify context to be passed to group_by function.
|
| |
| Base & | on_group_create (ecs_group_create_action_t action) |
| | Specify on_group_create action.
|
| |
| Base & | on_group_delete (ecs_group_delete_action_t action) |
| | Specify on_group_delete action.
|
| |
| | 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 & | up (flecs::entity_t trav=0) |
| |
| template<typename Trav > |
| Base & | up () |
| |
| Base & | cascade (flecs::entity_t trav=0) |
| |
| template<typename Trav > |
| Base & | cascade () |
| |
| Base & | desc () |
| |
| Base & | parent () |
| |
| Base & | trav (flecs::entity_t trav, flecs::flags32_t flags=0) |
| |
| Base & | id_flags (id_t flags) |
| | Set id flags for term.
|
| |
| Base & | inout (flecs::inout_kind_t inout) |
| | Set read/write access of term.
|
| |
| Base & | inout_stage (flecs::inout_kind_t inout) |
| | Set read/write access for stage.
|
| |
| Base & | write () |
| | Short for inout_stage(flecs::Out).
|
| |
| Base & | read () |
| | Short for inout_stage(flecs::In).
|
| |
| Base & | read_write () |
| | Short for inout_stage(flecs::InOut).
|
| |
| Base & | in () |
| | Short for inout(flecs::In)
|
| |
| Base & | out () |
| | Short for inout(flecs::Out)
|
| |
| Base & | inout () |
| | Short for inout(flecs::InOut)
|
| |
| Base & | inout_none () |
| | Short for inout(flecs::In)
|
| |
| Base & | oper (flecs::oper_kind_t oper) |
| | Set operator of term.
|
| |
| Base & | and_ () |
| |
| Base & | or_ () |
| |
| Base & | not_ () |
| |
| Base & | optional () |
| |
| Base & | and_from () |
| |
| Base & | or_from () |
| |
| Base & | not_from () |
| |
| Base & | singleton () |
| | Match singleton.
|
| |
| Base & | filter () |
| |
| Base & | self () |
| |
| 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) |
| |
template<typename Base, typename ... Components>
struct flecs::query_builder_i< Base, Components >
Query builder interface.
Definition at line 18 of file builder_i.hpp.
template<typename Base , typename ... Components>
template<typename T >
| Base & flecs::query_builder_i< Base, Components >::group_by |
( |
uint64_t(*)(flecs::world_t *, flecs::table_t *table, flecs::id_t id, void *ctx) | group_by_action | ) |
|
|
inline |
Group and sort matched tables.
Similar to ecs_query_order_by(), but instead of sorting individual entities, this operation only sorts matched tables. This can be useful of a query needs to enforce a certain iteration order upon the tables it is iterating, for example by giving a certain component or tag a higher priority.
The sorting function assigns a "rank" to each type, which is then used to sort the tables. Tables with higher ranks will appear later in the iteration.
Resorting happens when a query iterator is obtained, and only if the set of matched tables for a query has changed. If table sorting is enabled together with entity sorting, table sorting takes precedence, and entities will be sorted within each set of tables that are assigned the same rank.
- Template Parameters
-
| T | The component used to determine the group rank. |
- Parameters
-
| group_by_action | Callback that determines group id for table. |
Definition at line 326 of file builder_i.hpp.
template<typename Base , typename ... Components>
template<typename T >
| Base & flecs::query_builder_i< Base, Components >::order_by |
( |
int(*)(flecs::entity_t, const T *, flecs::entity_t, const T *) | compare | ) |
|
|
inline |
Sort the output of a query.
This enables sorting of entities across matched tables. As a result of this operation, the order of entities in the matched tables may be changed. Resorting happens when a query iterator is obtained, and only if the table data has changed.
If multiple queries that match the same (down)set of tables specify different sorting functions, resorting is likely to happen every time an iterator is obtained, which can significantly slow down iterations.
The sorting function will be applied to the specified component. Resorting only happens if that component has changed, or when the entity order in the table has changed. If no component is provided, resorting only happens when the entity order changes.
- Template Parameters
-
| T | The component used to sort. |
- Parameters
-
| compare | The compare function used to sort the components. |
Definition at line 291 of file builder_i.hpp.
Public Member Functions inherited from flecs::term_builder_i< Base >