Blender V5.3
node_geo_sort_elements.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#include <atomic>
6
7#include "BKE_attribute.hh"
8#include "BKE_instances.hh"
9
10#include "BLI_index_mask.hh"
11
13#include "GEO_reorder.hh"
14
15#include "NOD_rna_define.hh"
16
17#include "RNA_enum_types.hh"
18
20#include "UI_resources.hh"
21
22#include "node_geometry_util.hh"
23
25
27{
28 b.use_custom_socket_order();
29 b.allow_any_socket_order();
30 b.add_default_layout();
31 b.add_input<decl::Geometry>("Geometry"_ustr).description("Geometry to sort the elements of");
32 b.add_output<decl::Geometry>("Geometry"_ustr).propagate_all_geometry().align_with_previous();
33 b.add_input<decl::Bool>("Selection"_ustr)
34 .default_value(true)
35 .evaluated_geometry_field()
36 .hide_value();
37 b.add_input<decl::Int>("Group ID"_ustr).evaluated_geometry_field().hide_value();
38 b.add_input<decl::Float>("Sort Weight"_ustr).evaluated_geometry_field().hide_value();
39}
40
41static void node_layout(ui::Layout &layout, bContext * /*C*/, PointerRNA *ptr)
42{
43 layout.prop(ptr, "domain", UI_ITEM_NONE, "", ICON_NONE);
44}
45
46static void node_init(bNodeTree * /*tree*/, bNode *node)
47{
48 node->custom1 = int(bke::AttrDomain::Point);
49}
50
51static std::optional<Array<int>> sorted_indices(const fn::FieldContext &field_context,
52 const int domain_size,
53 const Field<bool> selection_field,
54 const Field<int> group_id_field,
55 const Field<float> weight_field)
56{
57 if (domain_size == 0) {
58 return std::nullopt;
59 }
60
61 FieldEvaluator evaluator(field_context, domain_size);
62 evaluator.set_selection(selection_field);
63 evaluator.add(group_id_field);
64 evaluator.add(weight_field);
65 evaluator.evaluate();
67 const VArray<int> group_id = evaluator.get_evaluated<int>(0);
68 const VArray<float> weight = evaluator.get_evaluated<float>(1);
69
70 return geometry::sort_indices_by_weights(domain_size, mask, group_id, weight);
71}
72
74{
75 GeometrySet geometry_set = params.extract_input<GeometrySet>("Geometry"_ustr);
76 const Field<bool> selection_field = params.extract_input<Field<bool>>("Selection"_ustr);
77 const Field<int> group_id_field = params.extract_input<Field<int>>("Group ID"_ustr);
78 const Field<float> weight_field = params.extract_input<Field<float>>("Sort Weight"_ustr);
79 const bke::AttrDomain domain = bke::AttrDomain(params.node().custom1);
80
81 const NodeAttributeFilter attribute_filter = params.get_attribute_filter("Geometry"_ustr);
82
84
85 std::atomic<bool> has_reorder = false;
86 std::atomic<bool> has_unsupported = false;
87 if (domain == bke::AttrDomain::Instance) {
88 if (const bke::Instances *instances = geometry_set.get_instances()) {
89 if (const std::optional<Array<int>> indices = sorted_indices(
91 instances->instances_num(),
92 selection_field,
93 group_id_field,
94 weight_field))
95 {
97 *instances, *indices, attribute_filter);
98 geometry_set.replace_instances(result);
99 has_reorder = true;
100 }
101 }
102 }
103 else {
104 geometry::foreach_real_geometry(geometry_set, [&](GeometrySet &geometry_set) {
105 for (const auto [type, domains] : geometry::components_supported_reordering().items()) {
106 const bke::GeometryComponent *src_component = geometry_set.get_component(type);
107 if (src_component == nullptr || src_component->is_empty()) {
108 continue;
109 }
110 if (!domains.contains(domain)) {
111 has_unsupported = true;
112 continue;
113 }
114 has_reorder = true;
115 const std::optional<Array<int>> indices = sorted_indices(
116 bke::GeometryFieldContext(*src_component, domain),
117 src_component->attribute_domain_size(domain),
118 selection_field,
119 group_id_field,
120 weight_field);
121 if (!indices.has_value()) {
122 continue;
123 }
125 *src_component, *indices, domain, attribute_filter);
126 geometry_set.remove(type);
127 geometry_set.add(*dst_component.get());
128 }
129 });
130 }
131
132 if (has_unsupported && !has_reorder) {
134 TIP_("Domain and geometry type combination is unsupported"));
135 }
136
137 params.set_output("Geometry"_ustr, std::move(geometry_set));
138}
139
140template<typename T>
142 const EnumPropertyItem *src_items)
143{
145 for (const EnumPropertyItem *item = src_items; item->identifier != nullptr; item++) {
146 if (values.contains(T(item->value))) {
147 items.append(*item);
148 }
149 }
150 items.append({0, nullptr, 0, nullptr, nullptr});
151 return items;
152}
153
154static void node_rna(StructRNA *srna)
155{
156 static const Vector<EnumPropertyItem> supported_items = items_value_in<bke::AttrDomain>(
163
165 "domain",
166 "Domain",
167 "",
168 supported_items.data(),
171}
172
173static void node_register()
174{
175 static bke::bNodeType ntype;
176
177 geo_node_type_base(&ntype, "GeometryNodeSortElements"_ustr, GEO_NODE_SORT_ELEMENTS);
178 ntype.ui_name = "Sort Elements";
179 ntype.ui_description = "Rearrange geometry elements, changing their indices";
180 ntype.enum_name_legacy = "SORT_ELEMENTS";
182 ntype.declare = node_declare;
183 ntype.initfunc = node_init;
187
188 node_rna(ntype.rna_ext.srna);
189}
191
192} // namespace blender::nodes::node_geo_sort_elements_cc
#define NODE_CLASS_GEOMETRY
Definition BKE_node.hh:492
#define GEO_NODE_SORT_ELEMENTS
#define TIP_(msgid)
#define NOD_REGISTER_NODE(REGISTER_FUNC)
#define NOD_inline_enum_accessors(member)
#define UI_ITEM_NONE
constexpr bool contains(const T &value) const
Definition BLI_span.hh:281
void append(const T &value)
int attribute_domain_size(AttrDomain domain) const
virtual bool is_empty() const
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
void error_message_add(const NodeWarningType type, StringRef message) const
NodeAttributeFilter get_attribute_filter(const UString output_identifier) const
T extract_input(const UString identifier)
void set_output(const UString identifier, T &&value)
static void remember_deformed_positions_if_necessary(GeometrySet &geometry)
#define T
ImplicitSharingPtr< GeometryComponent > GeometryComponentPtr
void node_register_type(bNodeType &ntype)
Definition node.cc:2920
std::optional< Array< int > > sort_indices_by_weights(int domain_size, const IndexMask &mask, const VArray< int > &group_id, const VArray< float > &weight)
Definition reorder.cc:495
void foreach_real_geometry(bke::GeometrySet &geometry, FunctionRef< void(bke::GeometrySet &geometry_set)> fn)
const MultiValueMap< bke::GeometryComponent::Type, bke::AttrDomain > & components_supported_reordering()
Definition reorder.cc:39
bke::GeometryComponentPtr reordered_component(const bke::GeometryComponent &src_component, Span< int > old_by_new_map, bke::AttrDomain domain, const bke::AttributeFilter &attribute_filter)
Definition reorder.cc:399
bke::Instances * reorder_instaces(const bke::Instances &src_instances, Span< int > old_by_new_map, const bke::AttributeFilter &attribute_filter)
Definition reorder.cc:390
static void node_declare(NodeDeclarationBuilder &b)
static void node_layout(ui::Layout &layout, bContext *, PointerRNA *ptr)
static void node_geo_exec(GeoNodeExecParams params)
static Vector< EnumPropertyItem > items_value_in(const Span< T > values, const EnumPropertyItem *src_items)
static std::optional< Array< int > > sorted_indices(const fn::FieldContext &field_context, const int domain_size, const Field< bool > selection_field, const Field< int > group_id_field, const Field< float > weight_field)
static void node_init(bNodeTree *, bNode *node)
PropertyRNA * RNA_def_node_enum(StructRNA *srna, const char *identifier, const char *ui_name, const char *ui_description, const EnumPropertyItem *static_items, const EnumRNAAccessors accessors, std::optional< int > default_value, const EnumPropertyItemFunc item_func, const bool allow_animation)
void geo_node_type_base(bke::bNodeType *ntype, UString idname, const std::optional< int16_t > legacy_type)
const EnumPropertyItem rna_enum_attribute_domain_items[]
void replace_instances(Instances *instances, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
const GeometryComponent * get_component(GeometryComponent::Type component_type) const
const Instances * get_instances() const
void remove(const GeometryComponent::Type component_type)
void add(const GeometryComponent &component)
Defines a node type.
Definition BKE_node.hh:265
void(*) draw_buttons(ui::Layout &, bContext *C, PointerRNA *ptr)
Definition BKE_node.hh:290
std::string ui_description
Definition BKE_node.hh:271
NodeGeometryExecFunction geometry_node_execute
Definition BKE_node.hh:385
void(*) initfunc(bNodeTree *ntree, bNode *node)
Definition BKE_node.hh:320
const char * enum_name_legacy
Definition BKE_node.hh:274
NodeDeclareFunction declare
Definition BKE_node.hh:393
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)