Blender V5.3
node_geo_instances_to_points.cc
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#include "BLI_array_utils.hh"
6
8
9#include "BKE_instances.hh"
10#include "BKE_pointcloud.hh"
11
12#include "node_geometry_util.hh"
13
15
17{
18 b.add_input<decl::Geometry>("Instances"_ustr)
19 .only_instances()
20 .description("Instances to convert to points");
21 b.add_input<decl::Bool>("Selection"_ustr)
22 .default_value(true)
23 .hide_value()
24 .evaluated_geometry_field();
25 b.add_input<decl::Vector>("Position"_ustr)
26 .evaluated_geometry_field()
28 b.add_input<decl::Float>("Radius"_ustr)
29 .default_value(0.05f)
30 .min(0.0f)
32 .evaluated_geometry_field();
33 b.add_output<decl::Geometry>("Points"_ustr).propagate_all_geometry();
34}
35
36static void convert_instances_to_points(GeometrySet &geometry_set,
37 Field<float3> position_field,
38 Field<float> radius_field,
39 Field<bool> selection_field,
40 const AttributeFilter &attribute_filter)
41{
42 const bke::Instances &instances = *geometry_set.get_instances();
43
44 const bke::InstancesFieldContext context{instances};
45 fn::FieldEvaluator evaluator{context, instances.instances_num()};
46 evaluator.set_selection(std::move(selection_field));
47 evaluator.add(std::move(position_field));
48 evaluator.add(std::move(radius_field));
49 evaluator.evaluate();
50 const IndexMask selection = evaluator.get_evaluated_selection_as_mask();
51 if (selection.is_empty()) {
52 return;
53 }
54 const VArray<float3> positions = evaluator.get_evaluated<float3>(0);
55 const VArray<float> radii = evaluator.get_evaluated<float>(1);
56
58 geometry_set.replace_pointcloud(pointcloud);
59 array_utils::gather(positions, selection, pointcloud->positions_for_write());
60
61 bke::MutableAttributeAccessor dst_attributes = pointcloud->attributes_for_write();
62 if (const std::optional<float> radius_single = radii.get_if_single()) {
63 dst_attributes.add<float>(
64 "radius", bke::AttrDomain::Point, bke::AttributeInitValue{*radius_single});
65 }
66 else {
67 bke::SpanAttributeWriter point_radii = dst_attributes.lookup_or_add_for_write_only_span<float>(
68 "radius", AttrDomain::Point);
69 array_utils::gather(radii, selection, point_radii.span);
70 point_radii.finish();
71 }
72
73 const bke::AttributeAccessor src_attributes = instances.attributes();
74
75 /* TODO: Investigate replacing this with #gather_attributes. */
76 src_attributes.foreach_attribute([&](const bke::AttributeIter &iter) {
77 const StringRef name = iter.name;
78 if (iter.is_builtin && !dst_attributes.is_builtin(name)) {
79 return;
80 }
81 /* These two attributes are added by the implicit inputs above. */
82 if (ELEM(name, "position", "radius")) {
83 return;
84 }
85 if (attribute_filter.allow_skip(name)) {
86 return;
87 }
88 const bke::AttrType type = iter.data_type;
89 const GAttributeReader src = iter.get();
90 const CommonVArrayInfo info = src.varray.common_info();
93 dst_attributes.add(name, AttrDomain::Point, type, init);
94 return;
95 }
96
97 if (selection.size() == instances.instances_num() && src.sharing_info &&
99 {
101 dst_attributes.add(name, AttrDomain::Point, type, init);
102 }
103 else {
105 name, AttrDomain::Point, type);
106 array_utils::gather(src.varray, selection, dst.span);
107 dst.finish();
108 }
109 });
110}
111
113{
114 GeometrySet geometry_set = params.extract_input<GeometrySet>("Instances"_ustr);
115
116 if (geometry_set.has_instances()) {
117 convert_instances_to_points(geometry_set,
118 params.extract_input<Field<float3>>("Position"_ustr),
119 params.extract_input<Field<float>>("Radius"_ustr),
120 params.extract_input<Field<bool>>("Selection"_ustr),
121 params.get_attribute_filter("Points"_ustr));
123 params.set_output("Points"_ustr, std::move(geometry_set));
124 }
125 else {
127 }
128}
129
130static void node_register()
131{
132 static bke::bNodeType ntype;
133
134 geo_node_type_base(&ntype, "GeometryNodeInstancesToPoints"_ustr, GEO_NODE_INSTANCES_TO_POINTS);
135 ntype.ui_name = "Instances to Points";
136 ntype.ui_description =
137 "Generate points at the origins of instances.\nNote: Nested instances are not affected by "
138 "this node";
139 ntype.enum_name_legacy = "INSTANCES_TO_POINTS";
141 ntype.declare = node_declare;
144}
146
147} // namespace blender::nodes::node_geo_instances_to_points_cc
#define NODE_CLASS_GEOMETRY
Definition BKE_node.hh:492
#define GEO_NODE_INSTANCES_TO_POINTS
General operations for point clouds.
#define NOD_REGISTER_NODE(REGISTER_FUNC)
#define ELEM(...)
GPointer()=default
CommonVArrayInfo common_info() const
void foreach_attribute(const FunctionRef< void(const AttributeIter &)> fn) const
bool is_builtin(const StringRef name) const
GAttributeReader get() const
bke::AttributeAccessor attributes() const
Definition instances.cc:68
int instances_num() const
Definition instances.cc:408
bool add(const StringRef name, const AttrDomain domain, const AttrType data_type, const AttributeInit &initializer)
GSpanAttributeWriter lookup_or_add_for_write_only_span(StringRef name, AttrDomain domain, AttrType data_type)
void set_selection(Field< bool > selection)
int add(GField field, GVArray *varray_ptr)
IndexMask get_evaluated_selection_as_mask() const
const GVArray & get_evaluated(const int field_index) const
NodeAttributeFilter get_attribute_filter(const UString output_identifier) const
T extract_input(const UString identifier)
void set_output(const UString identifier, T &&value)
void gather(const GVArray &src, const IndexMask &indices, GMutableSpan dst, exec_mode::Mode mode=exec_mode::parallel)
void node_register_type(bNodeType &ntype)
Definition node.cc:2920
static void convert_instances_to_points(GeometrySet &geometry_set, Field< float3 > position_field, Field< float > radius_field, Field< bool > selection_field, const AttributeFilter &attribute_filter)
PointCloud * BKE_pointcloud_new_nomain(PointCloudType type, int totpoint)
VecBase< float, 3 > float3
@ PROP_DISTANCE
Definition RNA_types.hh:313
void geo_node_type_base(bke::bNodeType *ntype, UString idname, const std::optional< int16_t > legacy_type)
bool allow_skip(const StringRef name) const
const ImplicitSharingInfo * sharing_info
void keep_only(Span< GeometryComponent::Type > component_types)
void replace_pointcloud(PointCloud *pointcloud, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
const Instances * get_instances() const
Defines a node type.
Definition BKE_node.hh:265
std::string ui_description
Definition BKE_node.hh:271
NodeGeometryExecFunction geometry_node_execute
Definition BKE_node.hh:385
const char * enum_name_legacy
Definition BKE_node.hh:274
NodeDeclareFunction declare
Definition BKE_node.hh:393