Flecs v4.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
impl.hpp
Go to the documentation of this file.
1
6#pragma once
7
8#include "builder.hpp"
9
10namespace flecs
11{
12
17struct query_base {
20
23 : query_(q) {
24 flecs_poly_claim(q);
25 }
26
29 : query_(ECS_CONST_CAST(query_t*, q)) {
30 flecs_poly_claim(q);
31 }
32
35 if (desc->entity && desc->terms[0].id == 0) {
36 const flecs::Poly *query_poly = ecs_get_pair(
37 world, desc->entity, EcsPoly, EcsQuery);
38 if (query_poly) {
39 query_ = static_cast<flecs::query_t*>(query_poly->poly);
40 flecs_poly_claim(query_);
41 return;
42 }
43 }
44
45 query_ = ecs_query_init(world, desc);
46 }
47
49 query_base(const query_base& obj) {
50 this->query_ = obj.query_;
51 if (this->query_)
52 {
53 flecs_poly_claim(this->query_);
54 }
55 }
56
59 this->~query_base();
60 this->query_ = obj.query_;
61 if (this->query_)
62 {
63 flecs_poly_claim(this->query_);
64 }
65 return *this;
66 }
67
69 query_base(query_base&& obj) noexcept {
70 this->query_ = obj.query_;
71 obj.query_ = nullptr;
72 }
73
75 query_base& operator=(query_base&& obj) noexcept {
76 this->query_ = obj.query_;
77 obj.query_ = nullptr;
78 return *this;
79 }
80
83 return flecs::entity(query_->world, query_->entity);
84 }
85
87 const flecs::query_t* c_ptr() const {
88 return query_;
89 }
90
92 operator const flecs::query_t*() const {
93 return query_;
94 }
95
97 operator bool() const {
98 return query_ != nullptr;
99 }
100
106 void destruct() {
107 ecs_assert(query_->entity != 0, ECS_INVALID_OPERATION, "destruct() "
108 "should only be called on queries associated with entities");
109 ecs_query_fini(query_);
110 query_ = nullptr;
111 }
112
115 if (query_ && !query_->entity) {
116 if (!flecs_poly_release(query_)) {
117 ecs_query_fini(query_);
118 query_ = nullptr;
119 }
120 }
121 }
122
132 bool changed() const {
133 return ecs_query_changed(query_);
134 }
135
141 const flecs::query_group_info_t* group_info(uint64_t group_id) const {
142 return ecs_query_get_group_info(query_, group_id);
143 }
144
150 void* group_ctx(uint64_t group_id) const {
151 const flecs::query_group_info_t *gi = group_info(group_id);
152 if (gi) {
153 return gi->ctx;
154 } else {
155 return NULL;
156 }
157 }
158
160 template <typename Func>
161 void each_term(const Func& func) {
162 for (int i = 0; i < query_->term_count; i ++) {
163 flecs::term t(query_->world, query_->terms[i]);
164 func(t);
165 t.reset(); // prevent freeing resources
166 }
167 }
168
170 flecs::term term(int32_t index) const {
171 return flecs::term(query_->world, query_->terms[index]);
172 }
173
175 int32_t term_count() const {
176 return query_->term_count;
177 }
178
180 int32_t field_count() const {
181 return query_->field_count;
182 }
183
185 int32_t find_var(const char *name) const {
186 return ecs_query_find_var(query_, name);
187 }
188
191 char *result = ecs_query_str(query_);
192 return flecs::string(result);
193 }
194
200 char *result = ecs_query_plan(query_);
201 return flecs::string(result);
202 }
203
205 operator query<>() const;
206
207# ifdef FLECS_JSON
208# include "../json/query.inl"
209# endif
210
211protected:
212 query_t *query_ = nullptr;
213};
214
219template<typename ... Components>
220struct query : query_base, iterable<Components...> {
221private:
222 using Fields = typename _::field_ptrs<Components...>::array;
223
224public:
226
228 query() : query_base() { } // necessary not to confuse MSVC
229
231 query(const query& obj) : query_base(obj) { }
232
234 query& operator=(const query& obj) {
236 return *this;
237 }
238
240 query(query&& obj) noexcept : query_base(FLECS_MOV(obj)) { }
241
243 query& operator=(query&& obj) noexcept {
244 query_base::operator=(FLECS_FWD(obj));
245 return *this;
246 }
247
250 const flecs::query_t *q = ecs_query_get_cache_query(query_);
251 return flecs::query<>(q);
252 }
253
254private:
255 ecs_iter_t get_iter(flecs::world_t *world) const override {
256 ecs_assert(query_ != nullptr, ECS_INVALID_PARAMETER,
257 "cannot iterate invalid query");
258 if (!world) {
259 world = query_->world;
260 }
261 return ecs_query_iter(world, query_);
262 }
263
264 ecs_iter_next_action_t next_action() const override {
265 return ecs_query_next;
266 }
267};
268
269// World mixin implementation
270template <typename... Comps, typename... Args>
271inline flecs::query<Comps...> world::query(Args &&... args) const {
272 return flecs::query_builder<Comps...>(world_, FLECS_FWD(args)...)
273 .build();
274}
275
276inline flecs::query<> world::query(flecs::entity query_entity) const {
277 ecs_query_desc_t desc = {};
278 desc.entity = query_entity;
279 return flecs::query<>(world_, &desc);
280}
281
282template <typename... Comps, typename... Args>
283inline flecs::query_builder<Comps...> world::query_builder(Args &&... args) const {
284 return flecs::query_builder<Comps...>(world_, FLECS_FWD(args)...);
285}
286
287// world::each
288namespace _ {
289
290// Each with entity parameter
291template<typename Func, typename ... Args>
293
294template<typename Func, typename E>
295struct query_delegate_w_ent<Func, arg_list<E> >
296{
297 query_delegate_w_ent(const flecs::world& world, Func&& func) {
299
300 for (int32_t i = 0; i < entities.alive_count; i ++) {
301 func(flecs::entity(world, entities.ids[i]));
302 }
303 }
304};
305
306template<typename Func, typename E, typename ... Args>
307struct query_delegate_w_ent<Func, arg_list<E, Args ...> >
308{
309 query_delegate_w_ent(const flecs::world& world, Func&& func) {
310 auto f = world.query<Args ...>();
311 f.each(FLECS_MOV(func));
312 }
313};
314
315// Each without entity parameter
316template<typename Func, typename ... Args>
318
319template<typename Func, typename ... Args>
320struct query_delegate_no_ent<Func, arg_list<Args ...> >
321{
322 query_delegate_no_ent(const flecs::world& world, Func&& func) {
323 auto f = world.query<Args ...>();
324 f.each(FLECS_MOV(func));
325 }
326};
327
328// Switch between function with and without entity parameter
329template<typename Func, typename T = int>
331
332template <typename Func>
333struct query_delegate<Func, if_t<is_same<first_arg_t<Func>, flecs::entity>::value> > {
334 query_delegate(const flecs::world& world, Func&& func) {
336 }
337};
338
339template <typename Func>
340struct query_delegate<Func, if_not_t<is_same<first_arg_t<Func>, flecs::entity>::value> > {
341 query_delegate(const flecs::world& world, Func&& func) {
343 }
344};
345
346}
347
348template <typename Func>
349inline void world::each(Func&& func) const {
350 _::query_delegate<Func> f_delegate(*this, FLECS_MOV(func));
351}
352
353template <typename T, typename Func>
354inline void world::each(Func&& func) const {
355 ecs_iter_t it = ecs_each_id(world_, _::type<T>::id(world_));
356
357 while (ecs_each_next(&it)) {
358 _::each_delegate<Func, T>(func).invoke(&it);
359 }
360}
361
362template <typename Func>
363inline void world::each(flecs::id_t each_id, Func&& func) const {
364 ecs_iter_t it = ecs_each_id(world_, each_id);
365
366 while (ecs_each_next(&it)) {
367 _::each_delegate<Func>(func).invoke(&it);
368 }
369}
370
371// query_base implementation
372inline query_base::operator flecs::query<> () const {
373 return flecs::query<>(query_);
374}
375
376}
typename first_arg< Func >::type first_arg_t
Convenience alias for the first argument type of a callable.
const ecs_entity_t EcsQuery
Tag added to queries.
#define ecs_assert(condition, error_code,...)
Assert.
Definition log.h:473
#define ECS_INVALID_OPERATION
Invalid operation error code.
Definition log.h:659
#define ECS_INVALID_PARAMETER
Invalid parameter error code.
Definition log.h:661
flecs::query_builder< Comps... > query_builder(Args &&... args) const
Create a query builder.
void each(Func &&func) const
Iterate over all entities with components in the argument list of the function.
flecs::query< Comps... > query(Args &&... args) const
Create a query.
ecs_id_t id_t
ID type.
Definition c_types.hpp:20
ecs_world_t world_t
World type.
Definition c_types.hpp:18
ecs_iter_t ecs_each_id(const ecs_world_t *world, ecs_id_t component)
Iterate all entities with a specified (component ID).
bool ecs_each_next(ecs_iter_t *it)
Progress an iterator created with ecs_each_id().
#define ecs_get_pair(world, subject, First, second)
Get the first element of a pair.
Definition flecs_c.h:390
bool(* ecs_iter_next_action_t)(ecs_iter_t *it)
Function prototype for iterating an iterator.
Definition flecs.h:587
bool ecs_query_next(ecs_iter_t *it)
Progress a query iterator.
const ecs_query_group_info_t * ecs_query_get_group_info(const ecs_query_t *query, uint64_t group_id)
Get information about a query group.
int32_t ecs_query_find_var(const ecs_query_t *query, const char *name)
Find a variable index.
void ecs_query_fini(ecs_query_t *query)
Delete a query.
char * ecs_query_plan(const ecs_query_t *query)
Convert a query to a string.
ecs_iter_t ecs_query_iter(const ecs_world_t *world, const ecs_query_t *query)
Create a query iterator.
char * ecs_query_str(const ecs_query_t *query)
Convert a query to a string expression.
ecs_query_t * ecs_query_init(ecs_world_t *world, const ecs_query_desc_t *desc)
Create a query.
bool ecs_query_changed(ecs_query_t *query)
Return whether the query data changed since the last iteration.
const ecs_query_t * ecs_query_get_cache_query(const ecs_query_t *query)
Get the query used to populate the cache.
ecs_entities_t ecs_get_entities(const ecs_world_t *world)
Return entity identifiers in the world.
const ecs_world_t * ecs_get_world(const ecs_poly_t *poly)
Get the world from a poly.
Query builder.
JSON query mixin.
Component for storing a poly object.
Definition flecs.h:1572
ecs_poly_t * poly
Pointer to poly object.
Definition flecs.h:1573
Type returned by ecs_get_entities().
Definition flecs.h:2084
int32_t alive_count
Number of alive entity IDs.
Definition flecs.h:2087
const ecs_entity_t * ids
Array with all entity IDs in the world.
Definition flecs.h:2085
Iterator.
Definition flecs.h:1166
Used with ecs_query_init().
Definition flecs.h:1275
ecs_term_t terms[32]
Query terms.
Definition flecs.h:1280
ecs_entity_t entity
Entity associated with query (optional).
Definition flecs.h:1342
Type that contains information about a query group.
Definition flecs.h:1540
void * ctx
Group context, returned by on_group_create.
Definition flecs.h:1544
Queries are lists of constraints (terms) that match entities.
Definition flecs.h:834
ecs_world_t * world
World or stage the query was created with.
Definition flecs.h:867
ecs_entity_t entity
Entity associated with query (optional).
Definition flecs.h:865
ecs_term_t * terms
Query terms.
Definition flecs.h:837
int8_t term_count
Number of query terms.
Definition flecs.h:844
int8_t field_count
Number of fields returned by the query.
Definition flecs.h:845
ecs_id_t id
Component ID to be matched by term.
Definition flecs.h:811
Entity.
Definition entity.hpp:30
Base class for iterable query objects.
Definition iterable.hpp:22
Base class for queries.
Definition impl.hpp:17
const flecs::query_t * c_ptr() const
Get a pointer to the underlying C query.
Definition impl.hpp:87
query_base(world_t *world, ecs_query_desc_t *desc)
Construct from a world and a query descriptor.
Definition impl.hpp:34
bool changed() const
Return whether the query data changed since the last iteration.
Definition impl.hpp:132
query_base & operator=(const query_base &obj)
Copy assignment operator.
Definition impl.hpp:58
flecs::entity entity() const
Get the entity associated with the query.
Definition impl.hpp:82
void each_term(const Func &func)
Iterate each term in the query, invoking a callback for each.
Definition impl.hpp:161
query_base(query_base &&obj) noexcept
Move constructor.
Definition impl.hpp:69
query_base()
Default constructor.
Definition impl.hpp:19
void * group_ctx(uint64_t group_id) const
Get context for a group.
Definition impl.hpp:150
query_base(const query_t *q)
Construct from a const query pointer.
Definition impl.hpp:28
flecs::string plan() const
Return a string representing the query plan.
Definition impl.hpp:199
flecs::term term(int32_t index) const
Get term at the specified index.
Definition impl.hpp:170
query_base(query_t *q)
Construct from a mutable query pointer.
Definition impl.hpp:22
query_base & operator=(query_base &&obj) noexcept
Move assignment operator.
Definition impl.hpp:75
query_base(const query_base &obj)
Copy constructor.
Definition impl.hpp:49
~query_base()
Destructor.
Definition impl.hpp:114
int32_t term_count() const
Get the number of terms in the query.
Definition impl.hpp:175
const flecs::query_group_info_t * group_info(uint64_t group_id) const
Get info for a group.
Definition impl.hpp:141
flecs::string str() const
Convert the query to a string expression.
Definition impl.hpp:190
void destruct()
Free a persistent query.
Definition impl.hpp:106
int32_t find_var(const char *name) const
Find a variable by name.
Definition impl.hpp:185
int32_t field_count() const
Get the number of fields in the query.
Definition impl.hpp:180
Query builder.
Definition builder.hpp:24
Typed query.
Definition impl.hpp:220
query_base()
Default constructor.
Definition impl.hpp:19
query()
Default constructor.
Definition impl.hpp:228
query(const query &obj)
Copy constructor.
Definition impl.hpp:231
flecs::query cache_query() const
Get the cache query, if any.
Definition impl.hpp:249
query & operator=(query &&obj) noexcept
Move assignment operator.
Definition impl.hpp:243
query & operator=(const query &obj)
Copy assignment operator.
Definition impl.hpp:234
query(query &&obj) noexcept
Move constructor.
Definition impl.hpp:240
Owned string wrapper.
Definition string.hpp:15
Class that describes a term.
Definition impl.hpp:16
void reset()
Reset the term to its default state.
Definition impl.hpp:82
The world.
Definition world.hpp:246
world_t * world_
Pointer to the underlying C world.
Definition world.hpp:1545
enable_if_t< false==V, int > if_not_t
Convenience enable_if alias for negated conditions.
Definition utils.hpp:172
enable_if_t< V, int > if_t
Convenience enable_if alias using int as default type.
Definition utils.hpp:168