Blender V5.3
BKE_instances.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
21
22#include <optional>
23
24#include "BLI_array.hh"
25#include "BLI_function_ref.hh"
26#include "BLI_index_mask_fwd.hh"
29#include "BLI_shared_cache.hh"
30#include "BLI_string_ref.hh"
31#include "BLI_vector.hh"
33
36#include "BKE_geometry_set.hh"
37
38namespace blender {
39
40struct Object;
41struct Collection;
42namespace bke {
45} // namespace bke
46
47namespace bke {
48
49struct GeometrySet;
51
57 public:
58 enum class Type {
64 None,
68 };
69
70 private:
71 Type type_ = Type::None;
73 void *data_ = nullptr;
74 std::unique_ptr<GeometrySet> geometry_set_;
75
76 public:
77 InstanceReference() = default;
81 InstanceReference(std::unique_ptr<GeometrySet> geometry_set);
82
85
88
89 Type type() const;
90 Object &object() const;
91 Collection &collection() const;
93 const GeometrySet &geometry_set() const;
94
101 void to_geometry_set(GeometrySet &r_geometry_set) const;
102
103 StringRefNull name() const;
104
105 bool owns_direct_data() const;
107
108 void count_memory(MemoryCounter &memory) const;
109
110 friend bool operator==(const InstanceReference &a, const InstanceReference &b);
111
112 uint64_t hash() const;
113};
114
116 private:
121 Vector<InstanceReference> references_;
122
123 int instances_num_ = 0;
124
125 bke::AttributeStorage attributes_;
126
130 mutable SharedCache<Array<int>> reference_user_counts_;
131
132 /* These unique ids are generated based on the `id` attribute, which might not contain
133 * unique ids at all. */
134 mutable SharedCache<Array<int>> unique_ids_cache_;
135
136 public:
138 Instances(int size);
139 Instances(Instances &&other);
140 Instances(const Instances &other);
142
143 Instances &operator=(const Instances &other);
144 Instances &operator=(Instances &&other);
145
151 void resize(int size);
152
158 int add_reference(const InstanceReference &reference);
159 int add_reference(InstanceReference &&reference);
164 std::optional<int> find_reference_handle(const InstanceReference &query);
165
168
170
182 GeometrySet &geometry_set_from_reference(int reference_index);
183
188
189 int instances_num() const;
190 int references_num() const;
191
196 void remove(const IndexMask &mask, const AttributeFilter &attribute_filter);
201 Span<int> unique_ids() const;
202
207
210
213
215 FunctionRef<void(const GeometrySet &geometry_set)> callback) const;
216
217 bool owns_direct_data() const;
219
220 void count_memory(MemoryCounter &memory) const;
221
223 {
224 reference_user_counts_.tag_dirty();
225 unique_ids_cache_.tag_dirty();
226 }
227};
228
232
233/* -------------------------------------------------------------------- */
236
237inline InstanceReference::InstanceReference(std::unique_ptr<GeometrySet> geometry_set)
238 : type_(Type::GeometrySet), geometry_set_(std::move(geometry_set))
239{
240}
241
243{
244}
245
250
252 : type_(other.type_), data_(other.data_), geometry_set_(std::move(other.geometry_set_))
253{
254 other.type_ = Type::None;
255 other.data_ = nullptr;
256}
257
259{
260 if (this == &other) {
261 return *this;
262 }
263 this->~InstanceReference();
264 new (this) InstanceReference(other);
265 return *this;
266}
267
269{
270 if (this == &other) {
271 return *this;
272 }
273 this->~InstanceReference();
274 new (this) InstanceReference(std::move(other));
275 return *this;
276}
277
279{
280 return type_;
281}
282
284{
285 BLI_assert(type_ == Type::Object);
286 return *static_cast<Object *>(data_);
287}
288
290{
292 return *static_cast<Collection *>(data_);
293}
294
296{
298 return *geometry_set_;
299}
300
302{
304 return *geometry_set_;
305}
306
308{
309 return attributes_;
310}
311
313{
314 return attributes_;
315}
316
318
319} // namespace bke
320} // namespace blender
void count_memory(MemoryCounter &memory) const
Definition instances.cc:56
InstanceReference & operator=(const InstanceReference &other)
void to_geometry_set(GeometrySet &r_geometry_set) const
Definition instances.cc:115
StringRefNull name() const
Definition instances.cc:140
friend bool operator==(const InstanceReference &a, const InstanceReference &b)
Definition instances.cc:155
Collection & collection() const
Span< int > reference_handles() const
Definition instances.cc:222
MutableSpan< int > reference_handles_for_write()
Definition instances.cc:229
int add_reference(const InstanceReference &reference)
Definition instances.cc:268
void remove(const IndexMask &mask, const AttributeFilter &attribute_filter)
Definition instances.cc:300
GeometrySet & geometry_set_from_reference(int reference_index)
Definition instances.cc:248
Span< float4x4 > transforms() const
Definition instances.cc:235
Span< InstanceReference > references() const
Definition instances.cc:290
Span< int > reference_user_counts() const
Definition instances.cc:503
int add_new_reference(InstanceReference reference)
Definition instances.cc:284
Instances & operator=(const Instances &other)
Definition instances.cc:196
int references_num() const
Definition instances.cc:413
bke::MutableAttributeAccessor attributes_for_write()
Definition instances.cc:73
void foreach_referenced_geometry(FunctionRef< void(const GeometrySet &geometry_set)> callback) const
bke::AttributeAccessor attributes() const
Definition instances.cc:68
MutableSpan< InstanceReference > references_for_write()
Definition instances.cc:295
int instances_num() const
Definition instances.cc:408
void count_memory(MemoryCounter &memory) const
Definition instances.cc:438
bke::AttributeStorage & attribute_storage()
bool owns_direct_data() const
Definition instances.cc:418
void resize(int size)
Definition instances.cc:216
std::optional< int > find_reference_handle(const InstanceReference &query)
Definition instances.cc:257
MutableSpan< float4x4 > transforms_for_write()
Definition instances.cc:242
Span< int > unique_ids() const
Definition instances.cc:520
VArray< float3 > instance_position_varray(const Instances &instances)
Definition instances.cc:544
VMutableArray< float3 > instance_position_varray_for_write(Instances &instances)
Definition instances.cc:550
const AttributeAccessorFunctions & instance_attribute_accessor_functions()
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
unsigned __int64 uint64_t
Definition BKE_text.h:91