Blender V5.3
BKE_geometry_fields.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
12
14#include "BKE_geometry_set.hh"
15
16#include "BLI_fixed_string.hh"
17
19
20namespace blender {
21
22struct Mesh;
23struct PointCloud;
24
25namespace bke {
26
27class CurvesGeometry;
29namespace greasepencil {
30class Drawing;
31}
32
34 private:
35 const Mesh &mesh_;
36 AttrDomain domain_;
37
38 public:
40 const Mesh &mesh() const
41 {
42 return mesh_;
43 }
44
46 {
47 return domain_;
48 }
49};
50
52 private:
53 const CurvesGeometry &curves_;
54 AttrDomain domain_;
55 const Curves *curves_id_ = nullptr;
56
57 public:
60
61 const CurvesGeometry &curves() const
62 {
63 return curves_;
64 }
65
66 const Curves *curves_id() const
67 {
68 return curves_id_;
69 }
70
72 {
73 return domain_;
74 }
75};
76
78 private:
79 const PointCloud &pointcloud_;
80
81 public:
83
84 const PointCloud &pointcloud() const
85 {
86 return pointcloud_;
87 }
88};
89
91 private:
92 const GreasePencil &grease_pencil_;
93
94 public:
96
98 {
99 return grease_pencil_;
100 }
101};
102
104 private:
105 const GreasePencil &grease_pencil_;
106 AttrDomain domain_;
107 int layer_index_;
108
109 public:
112 int layer_index)
113 : grease_pencil_(grease_pencil), domain_(domain), layer_index_(layer_index)
114 {
115 }
116
118 {
119 return grease_pencil_;
120 }
121
123 {
124 return domain_;
125 }
126
127 int layer_index() const
128 {
129 return layer_index_;
130 }
131
133 const IndexMask &mask,
134 ResourceScope &scope) const override;
135};
136
138 private:
139 const Instances &instances_;
140
141 public:
143
144 const Instances &instances() const
145 {
146 return instances_;
147 }
148};
149
155 private:
161 const void *geometry_;
162 const GeometryComponent::Type type_;
163 AttrDomain domain_;
164 const Curves *curves_id_ = nullptr;
169 int grease_pencil_layer_index_;
170
171 friend GeometryFieldInput;
172
173 public:
176 GeometryFieldContext(const void *geometry,
185 GeometryFieldContext(const PointCloud &points);
187
188 const void *geometry() const
189 {
190 return geometry_;
191 }
192
194 {
195 return type_;
196 }
197
199 {
200 return domain_;
201 }
202
204 {
207 return grease_pencil_layer_index_;
208 }
209
210 std::optional<AttributeAccessor> attributes() const;
211 const Mesh *mesh() const;
212 const CurvesGeometry *curves() const;
213 const PointCloud *pointcloud() const;
214 const GreasePencil *grease_pencil() const;
216 const Instances *instances() const;
217 const CurvesGeometry *curves_or_strokes() const;
218 const Curves *curves_id() const;
219};
220
237 struct None {};
239 struct Domain {
241 };
242
243 struct Constant {};
244
245 std::variant<None, Domain, Constant> variant;
246
247 NativeFieldDomain(const None & /*tag*/) : variant(None{}) {}
248 NativeFieldDomain(const Domain &domain) : variant(domain) {}
250};
251
253 public:
256 const IndexMask &mask,
257 ResourceScope &scope) const override;
259 const IndexMask &mask) const = 0;
260 virtual std::optional<AttrDomain> preferred_domain(const GeometryComponent &component) const;
261 virtual NativeFieldDomain native_domain_info(const GeometryComponent &component) const;
262};
263
265 public:
268 const IndexMask &mask,
269 ResourceScope &scope) const override;
271 AttrDomain domain,
272 const IndexMask &mask) const = 0;
273 virtual std::optional<AttrDomain> preferred_domain(const Mesh &mesh) const;
274 virtual NativeFieldDomain native_domain_info(const Mesh &mesh) const;
275};
276
278 public:
281 const IndexMask &mask,
282 ResourceScope &scope) const override;
284 AttrDomain domain,
285 const IndexMask &mask) const = 0;
286 virtual std::optional<AttrDomain> preferred_domain(const CurvesGeometry &curves) const;
287};
288
290 public:
293 const IndexMask &mask,
294 ResourceScope &scope) const override;
295 virtual GVArray get_varray_for_context(const PointCloud &pointcloud,
296 const IndexMask &mask) const = 0;
297};
298
300 public:
303 const IndexMask &mask,
304 ResourceScope &scope) const override;
305 virtual GVArray get_varray_for_context(const Instances &instances,
306 const IndexMask &mask) const = 0;
307};
308
310 private:
311 std::string name_;
312 std::optional<std::string> socket_inspection_name_;
313
314 public:
315 AttributeFieldInput(std::string name,
316 const CPPType &type,
317 std::optional<std::string> socket_inspection_name = std::nullopt)
318 : GeometryFieldInput(type, name),
319 name_(std::move(name)),
320 socket_inspection_name_(std::move(socket_inspection_name))
321 {
322 }
323
324 static fn::GField from(std::string name,
325 const CPPType &type,
326 std::optional<std::string> socket_inspection_name = std::nullopt)
327 {
329 std::move(name), type, std::move(socket_inspection_name));
330 }
331 template<typename T>
332 static fn::Field<T> from(std::string name,
333 std::optional<std::string> socket_inspection_name = std::nullopt)
334 {
335 return from(std::move(name), CPPType::get<T>(), std::move(socket_inspection_name))
336 .template typed<T>();
337 }
338
340 {
341 return name_;
342 }
343
345 const IndexMask &mask) const override;
346
347 std::string socket_inspection_name() const override;
348
349 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
350 std::optional<AttrDomain> preferred_domain(const GeometryComponent &component) const override;
351 NativeFieldDomain native_domain_info(const GeometryComponent &component) const override;
352
353 template<typename T, FixedString FStr> static const fn::Field<T> &get_field()
354 {
355 static const auto field = fn::Field<T>::template from_input<AttributeFieldInput>(
356 FStr.data, CPPType::get<T>());
357 /* Use a non-owning wrapper to avoid unnecessary reference counting of a static field. */
358 static const auto field_ref = fn::Field<T>::from_non_owning_ref(field);
359 return field_ref;
360 }
361};
362
364 private:
365 std::string name_;
366
367 public:
368 AttributeExistsFieldInput(std::string name, const CPPType &type)
369 : GeometryFieldInput(type, name), name_(std::move(name))
370 {
371 }
372
373 static fn::Field<bool> from(std::string name)
374 {
375 const CPPType &type = CPPType::get<bool>();
376 return fn::GField::from_input<AttributeExistsFieldInput>(std::move(name), type).typed<bool>();
377 }
378
380 const IndexMask &mask) const final;
381 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
382 NativeFieldDomain native_domain_info(const GeometryComponent &component) const override;
383};
384
386 private:
387 std::string layer_name_;
388
389 public:
390 NamedLayerSelectionFieldInput(std::string layer_name)
391 : bke::GeometryFieldInput(CPPType::get<bool>(), "Named Layer node"),
392 layer_name_(std::move(layer_name))
393 {
394 }
395
397 const IndexMask &mask) const final;
398 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
399 std::optional<AttrDomain> preferred_domain(const GeometryComponent &component) const override;
400};
401
403 public:
405
407 const IndexMask &mask) const override;
408
409 std::string socket_inspection_name() const override;
410
411 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
412
414 static const fn::Field<int> &get_field();
415};
416
418
420 const IndexMask &mask,
421 AttrDomain domain,
422 bool no_corner_normals = false,
423 bool true_normals = false);
424
426 bool legacy_corner_normals_ = false;
427 bool true_normals_ = false;
428
429 public:
430 NormalFieldInput(const bool legacy_corner_normals = false, const bool true_normals = false)
432 legacy_corner_normals_(legacy_corner_normals),
433 true_normals_(true_normals)
434 {
435 }
436
438 const IndexMask &mask) const override;
439
440 std::string socket_inspection_name() const override;
441
442 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
443
444 NativeFieldDomain native_domain_info(const GeometryComponent &component) const override;
445
447 static const fn::Field<float3> &get_field();
448};
449
451 public:
454 AttrDomain domain,
455 const IndexMask &mask) const final;
456 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
457 std::optional<AttrDomain> preferred_domain(const bke::CurvesGeometry &curves) const final;
458};
459
461 private:
462 fn::Field<int> index_field_;
463 fn::GField value_field_;
464 AttrDomain value_field_domain_;
465
466 public:
468 fn::GField value_field,
469 AttrDomain value_field_domain);
470
472 const IndexMask &mask) const final;
473 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
474 std::optional<AttrDomain> preferred_domain(const GeometryComponent & /*component*/) const final
475 {
476 return value_field_domain_;
477 }
478};
479
480class SampleIndexFunction : public mf::MultiFunction {
481 GeometrySet src_geometry_;
482 fn::GField src_field_;
483 AttrDomain domain_;
484
485 mf::Signature signature_;
486
487 mutable CacheMutex mutex_;
488 mutable std::optional<bke::GeometryFieldContext> geometry_context_;
489 mutable std::unique_ptr<fn::FieldEvaluator> evaluator_;
490 mutable const GVArray *src_data_ = nullptr;
491
492 public:
494 void prepare_for_execution() const override;
495 void call(const IndexMask &mask, mf::Params params, mf::Context /*context*/) const override;
496 void hash_unique(UniqueHashBytes &hash) const override;
497
499 AttrDomain domain);
500};
501
503 private:
504 fn::GField src_field_;
505 AttrDomain src_domain_;
506
507 public:
509
511 const IndexMask & /*mask*/) const final;
512 void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override;
513 void foreach_recursive_field(FunctionRef<void(const fn::GField &)> fn) const override;
514
515 std::optional<AttrDomain> preferred_domain(
516 const GeometryComponent & /*component*/) const override;
517 NativeFieldDomain native_domain_info(const GeometryComponent & /*component*/) const override;
518};
519
521 const fn::FieldContext &field_context,
522 Span<StringRef> names,
523 AttrDomain domain,
524 const fn::Field<bool> &selection,
525 Span<fn::GField> fields);
526
528 const fn::FieldContext &field_context,
529 const StringRef name,
530 AttrDomain domain,
531 const fn::Field<bool> &selection,
532 const fn::GField &field)
533{
535 attributes, field_context, {name}, domain, selection, {field});
536}
537
539 Span<StringRef> names,
540 AttrDomain domain,
541 Span<fn::GField> fields);
542
544 const StringRef name,
545 AttrDomain domain,
546 const fn::GField &field)
547{
548 return try_capture_fields_on_geometry(component, {name}, domain, {field});
549}
550
552 Span<StringRef> names,
553 AttrDomain domain,
554 const fn::Field<bool> &selection,
555 Span<fn::GField> fields);
556
558 const StringRef name,
559 AttrDomain domain,
560 const fn::Field<bool> &selection,
561 const fn::GField &field)
562{
563 return try_capture_fields_on_geometry(component, {name}, domain, selection, {field});
564}
565
570std::optional<AttrDomain> try_detect_field_domain(const GeometryComponent &component,
571 const fn::GField &field);
572
578std::optional<AttrDomain> try_detect_native_field_domain(const GeometryComponent &component,
579 const fn::GField &field);
580
581} // namespace bke
582} // namespace blender
#define final(a, b, c)
Definition BLI_hash_c.hh:21
#define ELEM(...)
static const CPPType & get()
GVArray get_varray_for_context(const bke::GeometryFieldContext &context, const IndexMask &mask) const final
static fn::Field< bool > from(std::string name)
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
NativeFieldDomain native_domain_info(const GeometryComponent &component) const override
AttributeExistsFieldInput(std::string name, const CPPType &type)
NativeFieldDomain native_domain_info(const GeometryComponent &component) const override
static fn::Field< T > from(std::string name, std::optional< std::string > socket_inspection_name=std::nullopt)
static fn::GField from(std::string name, const CPPType &type, std::optional< std::string > socket_inspection_name=std::nullopt)
AttributeFieldInput(std::string name, const CPPType &type, std::optional< std::string > socket_inspection_name=std::nullopt)
GVArray get_varray_for_context(const GeometryFieldContext &context, const IndexMask &mask) const override
std::string socket_inspection_name() const override
std::optional< AttrDomain > preferred_domain(const GeometryComponent &component) const override
static const fn::Field< T > & get_field()
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
GVArray get_varray_for_context(const CurvesGeometry &curves, AttrDomain domain, const IndexMask &mask) const final
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
std::optional< AttrDomain > preferred_domain(const bke::CurvesGeometry &curves) const final
const CurvesGeometry & curves() const
CurvesFieldContext(const CurvesGeometry &curves, AttrDomain domain)
GVArray get_varray_for_context(const fn::FieldContext &context, const IndexMask &mask, ResourceScope &scope) const override
virtual std::optional< AttrDomain > preferred_domain(const CurvesGeometry &curves) const
virtual GVArray get_varray_for_context(const CurvesGeometry &curves, AttrDomain domain, const IndexMask &mask) const =0
GVArray get_varray_for_context(const bke::GeometryFieldContext &context, const IndexMask &mask) const final
EvaluateAtIndexInput(fn::Field< int > index_field, fn::GField value_field, AttrDomain value_field_domain)
std::optional< AttrDomain > preferred_domain(const GeometryComponent &) const final
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
std::optional< AttrDomain > preferred_domain(const GeometryComponent &) const override
NativeFieldDomain native_domain_info(const GeometryComponent &) const override
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
EvaluateOnDomainInput(fn::GField field, AttrDomain domain)
GVArray get_varray_for_context(const bke::GeometryFieldContext &context, const IndexMask &) const final
void foreach_recursive_field(FunctionRef< void(const fn::GField &)> fn) const override
std::optional< AttributeAccessor > attributes() const
const Instances * instances() const
const PointCloud * pointcloud() const
GeometryFieldContext(const GeometryFieldContext &other, AttrDomain domain)
const greasepencil::Drawing * grease_pencil_layer_drawing() const
const CurvesGeometry * curves_or_strokes() const
GeometryComponent::Type type() const
GVArray get_varray_for_context(const fn::FieldContext &context, const IndexMask &mask, ResourceScope &scope) const override
virtual std::optional< AttrDomain > preferred_domain(const GeometryComponent &component) const
virtual GVArray get_varray_for_context(const GeometryFieldContext &context, const IndexMask &mask) const =0
virtual NativeFieldDomain native_domain_info(const GeometryComponent &component) const
const GreasePencil & grease_pencil() const
GreasePencilFieldContext(const GreasePencil &grease_pencil)
GreasePencilLayerFieldContext(const GreasePencil &grease_pencil, AttrDomain domain, int layer_index)
GVArray get_varray_for_input(const fn::FieldInput &field_input, const IndexMask &mask, ResourceScope &scope) const override
static const fn::Field< int > & get_field()
GVArray get_varray_for_context(const GeometryFieldContext &context, const IndexMask &mask) const override
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
std::string socket_inspection_name() const override
InstancesFieldContext(const Instances &instances)
GVArray get_varray_for_context(const fn::FieldContext &context, const IndexMask &mask, ResourceScope &scope) const override
virtual GVArray get_varray_for_context(const Instances &instances, const IndexMask &mask) const =0
MeshFieldContext(const Mesh &mesh, AttrDomain domain)
virtual std::optional< AttrDomain > preferred_domain(const Mesh &mesh) const
virtual GVArray get_varray_for_context(const Mesh &mesh, AttrDomain domain, const IndexMask &mask) const =0
virtual NativeFieldDomain native_domain_info(const Mesh &mesh) const
GVArray get_varray_for_context(const fn::FieldContext &context, const IndexMask &mask, ResourceScope &scope) const override
std::optional< AttrDomain > preferred_domain(const GeometryComponent &component) const override
GVArray get_varray_for_context(const bke::GeometryFieldContext &context, const IndexMask &mask) const final
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
GVArray get_varray_for_context(const GeometryFieldContext &context, const IndexMask &mask) const override
static const fn::Field< float3 > & get_field()
NativeFieldDomain native_domain_info(const GeometryComponent &component) const override
NormalFieldInput(const bool legacy_corner_normals=false, const bool true_normals=false)
void hash_unique(UniqueHashBytes &hash, fn::FieldHashDeep &deep_hash_cache) const override
std::string socket_inspection_name() const override
PointCloudFieldContext(const PointCloud &pointcloud)
virtual GVArray get_varray_for_context(const PointCloud &pointcloud, const IndexMask &mask) const =0
GVArray get_varray_for_context(const fn::FieldContext &context, const IndexMask &mask, ResourceScope &scope) const override
SampleIndexFunction(GeometrySet geometry, fn::GField src_field, AttrDomain domain)
static const GeometryComponent * find_source_component(const GeometrySet &geometry, AttrDomain domain)
void prepare_for_execution() const override
void hash_unique(UniqueHashBytes &hash) const override
void call(const IndexMask &mask, mf::Params params, mf::Context) const override
FieldInput(const CPPType &type, std::string debug_name="")
Definition field.cc:19
uint64_t hash() const
Definition field.cc:185
static Field from_non_owning_ref(const Field &field)
Definition FN_field.hh:477
static GField from_input(Args &&...args)
Definition FN_field.hh:482
const Field< T > & typed() const
Definition FN_field.hh:584
std::optional< AttrDomain > try_detect_native_field_domain(const GeometryComponent &component, const fn::GField &field)
std::optional< AttrDomain > try_detect_field_domain(const GeometryComponent &component, const fn::GField &field)
bool try_capture_field_on_geometry(MutableAttributeAccessor attributes, const fn::FieldContext &field_context, const StringRef name, AttrDomain domain, const fn::Field< bool > &selection, const fn::GField &field)
bool try_capture_fields_on_geometry(MutableAttributeAccessor attributes, const fn::FieldContext &field_context, Span< StringRef > names, AttrDomain domain, const fn::Field< bool > &selection, Span< fn::GField > fields)
VArray< float3 > curve_normals_varray(const CurvesGeometry &curves, AttrDomain domain)
VArray< float3 > mesh_normals_varray(const Mesh &mesh, const IndexMask &mask, AttrDomain domain, bool no_corner_normals=false, bool true_normals=false)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
VecBase< float, 3 > float3
#define hash
Definition noise_c.cc:156
std::variant< None, Domain, Constant > variant