Flecs: include/flecs/addons/cpp/mixins/entity/impl.hpp Source File
Description: A fast entity component system (ECS) for C & C++

| Flecs v4.0 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
8namespace flecs {
9
10template <typename T>
11 flecs::entity ref<T>::entity() const {
12 return flecs::entity(world_, ref_.entity);
13}
14
15template <typename Self>
16template <typename Func>
17 inline const Self& entity_builder<Self>::insert(const Func& func) const {
18 _::entity_with_delegate<Func>::invoke_ensure(
19 this->world_, this->id_, func);
20 return to_base();
21}
22
23template <typename T, if_t< is_enum<T>::value > >
24const T* entity_view::get() const {
25 entity_t r = _::type<T>::id(world_);
26 entity_t c = ecs_get_target(world_, id_, r, 0);
27
28 if (c) {
29 // Get constant value from constant entity
30 const T* v = static_cast<const T*>(ecs_get_id(world_, c, r));
31 ecs_assert(v != NULL, ECS_INTERNAL_ERROR,
32 "missing enum constant value");
33 return v;
34 } else {
35 // If there is no matching pair for (r, *), try just r
36 return static_cast<const T*>(ecs_get_id(world_, id_, r));
37 }
38}
39
40template<typename First>
41 inline flecs::entity entity_view::target(int32_t index) const
42{
43 return flecs::entity(world_,
44 ecs_get_target(world_, id_, _::type<First>::id(world_), index));
45}
46
47 inline flecs::entity entity_view::target(
48 flecs::entity_t relationship,
49 int32_t index) const
50{
51 return flecs::entity(world_,
52 ecs_get_target(world_, id_, relationship, index));
53}
54
55 inline flecs::entity entity_view::target_for(
56 flecs::entity_t relationship,
57 flecs::id_t id) const
58{
59 return flecs::entity(world_,
60 ecs_get_target_for_id(world_, id_, relationship, id));
61}
62
63template <typename T>
64inline flecs::entity entity_view::target_for(flecs::entity_t relationship) const {
65 return target_for(relationship, _::type<T>::id(world_));
66}
67
68template <typename First, typename Second>
69inline flecs::entity entity_view::target_for(flecs::entity_t relationship) const {
70 return target_for(relationship, _::type<First, Second>::id(world_));
71}
72
73 inline flecs::entity entity_view::parent() const {
74 return target(flecs::ChildOf);
75}
76
77 inline flecs::entity entity_view::mut(const flecs::world& stage) const {
78 ecs_assert(!stage.is_readonly(), ECS_INVALID_PARAMETER,
79 "cannot use readonly world/stage to create mutable handle");
80 return flecs::entity(id_).set_stage(stage.c_ptr());
81}
82
83 inline flecs::entity entity_view::mut(const flecs::iter& it) const {
84 ecs_assert(!it.world().is_readonly(), ECS_INVALID_PARAMETER,
85 "cannot use iterator created for readonly world/stage to create mutable handle");
86 return flecs::entity(id_).set_stage(it.world().c_ptr());
87}
88
89 inline flecs::entity entity_view::mut(const flecs::entity_view& e) const {
90 ecs_assert(!e.world().is_readonly(), ECS_INVALID_PARAMETER,
91 "cannot use entity created for readonly world/stage to create mutable handle");
92 return flecs::entity(id_).set_stage(e.world_);
93}
94
95inline flecs::entity entity_view::set_stage(world_t *stage) {
96 return flecs::entity(stage, id_);
97}
98
99 inline flecs::type entity_view::type() const {
100 return flecs::type(world_, ecs_get_type(world_, id_));
101}
102
103 inline flecs::table entity_view::table() const {
104 return flecs::table(world_, ecs_get_table(world_, id_));
105}
106
107 inline flecs::table_range entity_view::range() const {
108 ecs_record_t *r = ecs_record_find(world_, id_);
109 if (r) {
110 return flecs::table_range(world_, r->table,
111 ECS_RECORD_TO_ROW(r->row), 1);
112 }
113 return flecs::table_range();
114}
115
116template <typename Func>
117 inline void entity_view::each(const Func& func) const {
118 const ecs_type_t *type = ecs_get_type(world_, id_);
119 if (!type) {
120 return;
121 }
122
123 const ecs_id_t *ids = type->array;
124 int32_t count = type->count;
125
126 for (int i = 0; i < count; i ++) {
127 ecs_id_t id = ids[i];
128 flecs::id ent(world_, id);
129 func(ent);
130 }
131}
132
133template <typename Func>
134 inline void entity_view::each(flecs::id_t pred, flecs::id_t obj, const Func& func) const {
135 flecs::world_t *real_world = const_cast<flecs::world_t*>(
136 ecs_get_world(world_));
137
138 const ecs_table_t *table = ecs_get_table(world_, id_);
139 if (!table) {
140 return;
141 }
142
143 const ecs_type_t *type = ecs_table_get_type(table);
144 if (!type) {
145 return;
146 }
147
148 flecs::id_t pattern = pred;
149 if (obj) {
150 pattern = ecs_pair(pred, obj);
151 }
152
153 int32_t cur = 0;
154 id_t *ids = type->array;
155
156 while (-1 != (cur = ecs_search_offset(real_world, table, cur, pattern, 0)))
157 {
158 flecs::id ent(world_, ids[cur]);
159 func(ent);
160 cur ++;
161 }
162}
163
164template <typename Func>
165 inline void entity_view::each(const flecs::entity_view& rel, const Func& func) const {
166 return this->each(rel, flecs::Wildcard, [&](flecs::id id) {
167 flecs::entity obj = id.second();
168 func(obj);
169 });
170}
171
172template <typename Func, if_t< is_callable<Func>::value > >
173 inline bool entity_view::get(const Func& func) const {
174 return _::entity_with_delegate<Func>::invoke_get(world_, id_, func);
175}
176
177 inline flecs::entity entity_view::lookup(const char *path, bool search_path) const {
178 ecs_assert(id_ != 0, ECS_INVALID_PARAMETER, "invalid lookup from null handle");
179 auto id = ecs_lookup_path_w_sep(world_, id_, path, "::", "::", search_path);
180 return flecs::entity(world_, id);
181}
182
183inline flecs::entity entity_view::clone(bool copy_value, flecs::entity_t dst_id) const {
184 if (!dst_id) {
185 dst_id = ecs_new(world_);
186 }
187
188 flecs::entity dst = flecs::entity(world_, dst_id);
189 ecs_clone(world_, dst_id, id_, copy_value);
190 return dst;
191}
192
193// Entity mixin implementation
194template <typename... Args>
195 inline flecs::entity world::entity(Args &&... args) const {
196 return flecs::entity(world_, FLECS_FWD(args)...);
197}
198
199template <typename E, if_t< is_enum<E>::value >>
200 inline flecs::id world::id(E value) const {
201 flecs::entity_t constant = enum_type<E>(world_).entity(value);
202 return flecs::id(world_, constant);
203}
204
205template <typename E, if_t< is_enum<E>::value >>
206 inline flecs::entity world::entity(E value) const {
207 flecs::entity_t constant = enum_type<E>(world_).entity(value);
208 return flecs::entity(world_, constant);
209}
210
211template <typename T>
212 inline flecs::entity world::entity(const char *name) const {
213 return flecs::entity(world_,
214 _::type<T>::id_explicit(world_, name, true, 0, false) );
215}
216
217template <typename... Args>
218 inline flecs::entity world::prefab(Args &&... args) const {
219 flecs::entity result = flecs::entity(world_, FLECS_FWD(args)...);
220 result.add(flecs::Prefab);
221 return result;
222}
223
224template <typename T>
225 inline flecs::entity world::prefab(const char *name) const {
226 flecs::entity result = flecs::component<T>(world_, name, true);
227 result.add(flecs::Prefab);
228 return result;
229}
230
231}
ecs_assert
#define ecs_assert(condition, error_code,...)
Assert.
Definition log.h:352
ecs_id_t
uint64_t ecs_id_t
Ids are the things that can be added to an entity.
Definition flecs.h:340
ecs_table_t
struct ecs_table_t ecs_table_t
A table stores entities and components for a specific type.
Definition flecs.h:397
flecs::component::constant
untyped_component & constant(const char *name, int32_t value)
Add constant.
Definition untyped_component.inl:191
flecs::world::entity
flecs::entity entity(Args &&... args) const
Create an entity.
Definition impl.hpp:195
flecs::world::prefab
flecs::entity prefab(Args &&... args) const
Create a prefab.
Definition impl.hpp:218
flecs::type::array
flecs::id_t * array() const
Return pointer to array.
Definition type.hpp:42
flecs::type::count
int32_t count() const
Return number of ids in type.
Definition type.hpp:34
ecs_clone
ecs_entity_t ecs_clone(ecs_world_t *world, ecs_entity_t dst, ecs_entity_t src, bool copy_value)
Clone an entity This operation clones the components of one entity into another entity.
ecs_new
ecs_entity_t ecs_new(ecs_world_t *world)
Create new entity id.
ecs_get_target
ecs_entity_t ecs_get_target(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel, int32_t index)
Get the target of a relationship.
ecs_get_type
const ecs_type_t * ecs_get_type(const ecs_world_t *world, ecs_entity_t entity)
Get the type of an entity.
ecs_get_target_for_id
ecs_entity_t ecs_get_target_for_id(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel, ecs_id_t id)
Get the target of a relationship for a given id.
ecs_get_table
ecs_table_t * ecs_get_table(const ecs_world_t *world, ecs_entity_t entity)
Get the table of an entity.
ecs_get_id
const void * ecs_get_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get an immutable pointer to a component.
ecs_record_find
ecs_record_t * ecs_record_find(const ecs_world_t *world, ecs_entity_t entity)
Find record for entity.
ecs_lookup_path_w_sep
ecs_entity_t ecs_lookup_path_w_sep(const ecs_world_t *world, ecs_entity_t parent, const char *path, const char *sep, const char *prefix, bool recursive)
Lookup an entity from a path.
ecs_table_get_type
const ecs_type_t * ecs_table_get_type(const ecs_table_t *table)
Get type for table.
ecs_search_offset
int32_t ecs_search_offset(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t id, ecs_id_t *id_out)
Search for component id in table type starting from an offset.
ecs_get_world
const ecs_world_t * ecs_get_world(const ecs_poly_t *poly)
Get world from poly.
ecs_record_t
Record for entity index.
Definition flecs.h:494
ecs_record_t::table
ecs_table_t * table
Identifies a type (and table) in world.
Definition flecs.h:496
ecs_record_t::row
uint32_t row
Table row of the entity.
Definition flecs.h:497
ecs_type_t
A type is a list of (component) ids.
Definition flecs.h:364
flecs::_::entity_with_delegate
Definition delegate.hpp:882
flecs::_::type
Definition flecs.hpp:38
flecs::component
Component class.
Definition flecs.hpp:30
flecs::entity_builder::insert
const Self & insert(const Func &func) const
Set 1..N components.
Definition impl.hpp:17
flecs::entity_builder::add
const Self & add() const
Add a component to an entity.
Definition builder.hpp:25
flecs::entity_view
Entity view.
Definition entity_view.hpp:28
flecs::entity_view::type
flecs::type type() const
Get the entity's type.
Definition impl.hpp:99
flecs::entity_view::get
const T * get() const
Get component value.
Definition entity_view.hpp:259
flecs::entity_view::path
flecs::string path(const char *sep="::", const char *init_sep="::") const
Return the entity path.
Definition entity_view.hpp:94
flecs::entity_view::range
flecs::table_range range() const
Get table range for the entity.
Definition impl.hpp:107
flecs::entity_view::target_for
flecs::entity target_for(flecs::entity_t relationship, flecs::id_t id) const
Get the target of a pair for a given relationship id.
Definition impl.hpp:55
flecs::entity_view::lookup
flecs::entity lookup(const char *path, bool search_path=false) const
Lookup an entity by name.
Definition impl.hpp:177
flecs::entity_view::table
flecs::table table() const
Get the entity's table.
Definition impl.hpp:103
flecs::entity_view::parent
flecs::entity parent() const
Get parent of entity.
Definition impl.hpp:73
flecs::entity_view::each
void each(const Func &func) const
Iterate (component) ids of an entity.
Definition impl.hpp:117
flecs::entity_view::target
flecs::entity target(int32_t index=0) const
Get target for a given pair.
Definition impl.hpp:41
flecs::entity_view::mut
flecs::entity mut(const flecs::world &stage) const
Return mutable entity handle for current stage When an entity handle created from the world is used w...
Definition impl.hpp:77
flecs::entity
Entity.
Definition entity.hpp:30
flecs::id
Class that wraps around a flecs::id_t.
Definition decl.hpp:27
flecs::id::second
flecs::entity second() const
Get second element from a pair.
Definition impl.hpp:31
flecs::iter
Class for iterating over query results.
Definition iter.hpp:68
flecs::table_range
Definition table.hpp:317
flecs::table
Definition table.hpp:18
flecs::type
Type class.
Definition type.hpp:21
flecs::world
The world.
Definition world.hpp:137
flecs::world::id
flecs::id id() const
Get id from a type.
Definition impl.hpp:70
flecs::world::c_ptr
world_t * c_ptr() const
Obtain pointer to C world object.
Definition world.hpp:237
flecs::world::is_readonly
bool is_readonly() const
Test whether the current world object is readonly.
Definition world.hpp:505