diff options
| -rw-r--r-- | release/scripts/startup/nodeitems_builtins.py | 1 | ||||
| -rw-r--r-- | source/blender/blenkernel/BKE_node.h | 1 | ||||
| -rw-r--r-- | source/blender/blenkernel/BKE_spline.hh | 1 | ||||
| -rw-r--r-- | source/blender/blenkernel/intern/curve_eval.cc | 17 | ||||
| -rw-r--r-- | source/blender/blenkernel/intern/node.cc | 1 | ||||
| -rw-r--r-- | source/blender/makesdna/DNA_node_types.h | 5 | ||||
| -rw-r--r-- | source/blender/makesrna/intern/rna_nodetree.c | 24 | ||||
| -rw-r--r-- | source/blender/nodes/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | source/blender/nodes/NOD_geometry.h | 1 | ||||
| -rw-r--r-- | source/blender/nodes/NOD_static_types.h | 1 | ||||
| -rw-r--r-- | source/blender/nodes/geometry/nodes/node_geo_curve_sample.cc | 292 |
11 files changed, 345 insertions, 0 deletions
diff --git a/release/scripts/startup/nodeitems_builtins.py b/release/scripts/startup/nodeitems_builtins.py index bc024ac96cf..b8bb4e551d2 100644 --- a/release/scripts/startup/nodeitems_builtins.py +++ b/release/scripts/startup/nodeitems_builtins.py @@ -527,6 +527,7 @@ geometry_node_categories = [ NodeItem("GeometryNodeCurveFill"), NodeItem("GeometryNodeCurveTrim"), NodeItem("GeometryNodeCurveLength"), + NodeItem("GeometryNodeCurveSample", poll=geometry_nodes_fields_poll), ]), GeometryNodeCategory("GEO_PRIMITIVES_CURVE", "Curve Primitives", items=[ NodeItem("GeometryNodeCurvePrimitiveLine"), diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h index 45ce843ef78..e4e9a6eff3a 100644 --- a/source/blender/blenkernel/BKE_node.h +++ b/source/blender/blenkernel/BKE_node.h @@ -1495,6 +1495,7 @@ int ntreeTexExecTree(struct bNodeTree *ntree, #define GEO_NODE_MATERIAL_ASSIGN 1082 #define GEO_NODE_REALIZE_INSTANCES 1083 #define GEO_NODE_ATTRIBUTE_STATISTIC 1084 +#define GEO_NODE_CURVE_SAMPLE 1085 /** \} */ diff --git a/source/blender/blenkernel/BKE_spline.hh b/source/blender/blenkernel/BKE_spline.hh index 0fbf39a52fa..541ff19c1cd 100644 --- a/source/blender/blenkernel/BKE_spline.hh +++ b/source/blender/blenkernel/BKE_spline.hh @@ -565,6 +565,7 @@ struct CurveEval { blender::Array<int> control_point_offsets() const; blender::Array<int> evaluated_point_offsets() const; + blender::Array<float> accumulated_spline_lengths() const; void assert_valid_point_attributes() const; }; diff --git a/source/blender/blenkernel/intern/curve_eval.cc b/source/blender/blenkernel/intern/curve_eval.cc index ea84766943d..8eec7f5dfab 100644 --- a/source/blender/blenkernel/intern/curve_eval.cc +++ b/source/blender/blenkernel/intern/curve_eval.cc @@ -143,6 +143,23 @@ blender::Array<int> CurveEval::evaluated_point_offsets() const return offsets; } +/** + * Return the accumulated length at the start of every spline in the curve. + * + * \note The result is one longer than the spline count; the last element is the total length. + */ +blender::Array<float> CurveEval::accumulated_spline_lengths() const +{ + Array<float> spline_lengths(splines_.size() + 1); + float spline_length = 0.0f; + for (const int i : splines_.index_range()) { + spline_lengths[i] = spline_length; + spline_length += splines_[i]->length(); + } + spline_lengths.last() = spline_length; + return spline_lengths; +} + static BezierSpline::HandleType handle_type_from_dna_bezt(const eBezTriple_Handle dna_handle_type) { switch (dna_handle_type) { diff --git a/source/blender/blenkernel/intern/node.cc b/source/blender/blenkernel/intern/node.cc index 7d679cfd076..e2891f00119 100644 --- a/source/blender/blenkernel/intern/node.cc +++ b/source/blender/blenkernel/intern/node.cc @@ -5183,6 +5183,7 @@ static void registerGeometryNodes() register_node_type_geo_bounding_box(); register_node_type_geo_collection_info(); register_node_type_geo_convex_hull(); + register_node_type_geo_curve_sample(); register_node_type_geo_curve_endpoints(); register_node_type_geo_curve_fill(); register_node_type_geo_curve_length(); diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index f4c88333528..49083542fd7 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -1452,6 +1452,11 @@ typedef struct NodeGeometryCurveToPoints { uint8_t mode; } NodeGeometryCurveToPoints; +typedef struct NodeGeometryCurveSample { + /* GeometryNodeCurveSampleMode. */ + uint8_t mode; +} NodeGeometryCurveSample; + typedef struct NodeGeometryAttributeTransfer { /* AttributeDomain. */ int8_t domain; diff --git a/source/blender/makesrna/intern/rna_nodetree.c b/source/blender/makesrna/intern/rna_nodetree.c index ae5f8d5f5da..d0bf60d5d02 100644 --- a/source/blender/makesrna/intern/rna_nodetree.c +++ b/source/blender/makesrna/intern/rna_nodetree.c @@ -9088,6 +9088,30 @@ static void def_geo_curve_primitive_bezier_segment(StructRNA *srna) RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_socket_update"); } +static void def_geo_curve_sample(StructRNA *srna) +{ + static EnumPropertyItem mode_items[] = { + {GEO_NODE_CURVE_SAMPLE_FACTOR, + "FACTOR", + 0, + "Factor", + "Find sample positions on the curve using a factor of its total length"}, + {GEO_NODE_CURVE_SAMPLE_LENGTH, + "LENGTH", + 0, + "Length", + "Find sample positions on the curve using a distance from its beginning"}, + {0, NULL, 0, NULL, NULL}, + }; + + RNA_def_struct_sdna_from(srna, "NodeGeometryCurveSample", "storage"); + + PropertyRNA *prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_items(prop, mode_items); + RNA_def_property_ui_text(prop, "Mode", "Method for sampling input"); + RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_socket_update"); +} + static void def_geo_triangulate(StructRNA *srna) { PropertyRNA *prop; diff --git a/source/blender/nodes/CMakeLists.txt b/source/blender/nodes/CMakeLists.txt index 6da7b0be4e9..842c76935d1 100644 --- a/source/blender/nodes/CMakeLists.txt +++ b/source/blender/nodes/CMakeLists.txt @@ -170,6 +170,7 @@ set(SRC geometry/nodes/node_geo_collection_info.cc geometry/nodes/node_geo_common.cc geometry/nodes/node_geo_convex_hull.cc + geometry/nodes/node_geo_curve_sample.cc geometry/nodes/node_geo_curve_endpoints.cc geometry/nodes/node_geo_curve_fill.cc geometry/nodes/node_geo_curve_length.cc diff --git a/source/blender/nodes/NOD_geometry.h b/source/blender/nodes/NOD_geometry.h index 5e8abce6eb8..63330b7df62 100644 --- a/source/blender/nodes/NOD_geometry.h +++ b/source/blender/nodes/NOD_geometry.h @@ -59,6 +59,7 @@ void register_node_type_geo_convex_hull(void); void register_node_type_geo_curve_endpoints(void); void register_node_type_geo_curve_fill(void); void register_node_type_geo_curve_length(void); +void register_node_type_geo_curve_sample(void); void register_node_type_geo_curve_primitive_bezier_segment(void); void register_node_type_geo_curve_primitive_circle(void); void register_node_type_geo_curve_primitive_line(void); diff --git a/source/blender/nodes/NOD_static_types.h b/source/blender/nodes/NOD_static_types.h index 0be5459c9e1..918c82dec1c 100644 --- a/source/blender/nodes/NOD_static_types.h +++ b/source/blender/nodes/NOD_static_types.h @@ -312,6 +312,7 @@ DefNode(GeometryNode, GEO_NODE_BOOLEAN, def_geo_boolean, "BOOLEAN", Boolean, "Bo DefNode(GeometryNode, GEO_NODE_BOUNDING_BOX, 0, "BOUNDING_BOX", BoundBox, "Bounding Box", "") DefNode(GeometryNode, GEO_NODE_COLLECTION_INFO, def_geo_collection_info, "COLLECTION_INFO", CollectionInfo, "Collection Info", "") DefNode(GeometryNode, GEO_NODE_CONVEX_HULL, 0, "CONVEX_HULL", ConvexHull, "Convex Hull", "") +DefNode(GeometryNode, GEO_NODE_CURVE_SAMPLE, def_geo_curve_sample, "CURVE_SAMPLE", CurveSample, "Curve Sample", "") DefNode(GeometryNode, GEO_NODE_CURVE_ENDPOINTS, 0, "CURVE_ENDPOINTS", CurveEndpoints, "Curve Endpoints", "") DefNode(GeometryNode, GEO_NODE_CURVE_FILL, def_geo_curve_fill, "CURVE_FILL", CurveFill, "Curve Fill", "") DefNode(GeometryNode, GEO_NODE_CURVE_LENGTH, 0, "CURVE_LENGTH", CurveLength, "Curve Length", "") diff --git a/source/blender/nodes/geometry/nodes/node_geo_curve_sample.cc b/source/blender/nodes/geometry/nodes/node_geo_curve_sample.cc new file mode 100644 index 00000000000..1dbb1f20915 --- /dev/null +++ b/source/blender/nodes/geometry/nodes/node_geo_curve_sample.cc @@ -0,0 +1,292 @@ +/* + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +#include "BLI_task.hh" + +#include "BKE_spline.hh" + +#include "UI_interface.h" +#include "UI_resources.h" + +#include "node_geometry_util.hh" + +namespace blender::nodes { + +static void geo_node_curve_sample_declare(NodeDeclarationBuilder &b) +{ + b.add_input<decl::Geometry>("Curve"); + b.add_input<decl::Float>("Factor").min(0.0f).max(1.0f).subtype(PROP_FACTOR); + b.add_input<decl::Float>("Length").min(0.0f).subtype(PROP_DISTANCE); + + b.add_output<decl::Vector>("Position"); + b.add_output<decl::Vector>("Tangent"); + b.add_output<decl::Vector>("Normal"); +} + +static void geo_node_curve_sample_layout(uiLayout *layout, bContext *UNUSED(C), PointerRNA *ptr) +{ + uiItemR(layout, ptr, "mode", UI_ITEM_R_EXPAND, nullptr, ICON_NONE); +} + +static void geo_node_curve_sample_type_init(bNodeTree *UNUSED(tree), bNode *node) +{ + NodeGeometryCurveSample *data = (NodeGeometryCurveSample *)MEM_callocN( + sizeof(NodeGeometryCurveSample), __func__); + data->mode = GEO_NODE_CURVE_SAMPLE_LENGTH; + node->storage = data; +} + +static void geo_node_curve_sample_update(bNodeTree *UNUSED(ntree), bNode *node) +{ + const NodeGeometryCurveSample &node_storage = *(NodeGeometryCurveSample *)node->storage; + const GeometryNodeCurveSampleMode mode = (GeometryNodeCurveSampleMode)node_storage.mode; + + bNodeSocket *factor = ((bNodeSocket *)node->inputs.first)->next; + bNodeSocket *length = factor->next; + + nodeSetSocketAvailability(factor, mode == GEO_NODE_CURVE_SAMPLE_FACTOR); + nodeSetSocketAvailability(length, mode == GEO_NODE_CURVE_SAMPLE_LENGTH); +} + +template<typename T> static T sample_with_lookup(const Spline::LookupResult lookup, Span<T> data) +{ + return attribute_math::mix2( + lookup.factor, data[lookup.evaluated_index], data[lookup.next_evaluated_index]); +} + +class SampleCurveFunction : public fn::MultiFunction { + private: + /** + * The function holds a geometry set instead of a curve or a curve component in order to + * maintain a reference to the geometry while the field tree is being built, so that the + * curve is not freed before the function can execute. + */ + GeometrySet geometry_set_; + /** + * To support factor inputs, the node adds another field operation before this one to multiply by + * the curve's total length. Since that must calculate the spline lengths anyway, store them to + * reuse the calculation. + */ + Array<float> spline_lengths_; + /** The last member of #spline_lengths_, extracted for convenience. */ + const float total_length_; + + public: + SampleCurveFunction(GeometrySet geometry_set, Array<float> spline_lengths) + : geometry_set_(std::move(geometry_set)), + spline_lengths_(std::move(spline_lengths)), + total_length_(spline_lengths_.last()) + { + static fn::MFSignature signature = create_signature(); + this->set_signature(&signature); + } + + static fn::MFSignature create_signature() + { + blender::fn::MFSignatureBuilder signature{"Curve Sample"}; + signature.single_input<float>("Length"); + signature.single_output<float3>("Position"); + signature.single_output<float3>("Tangent"); + signature.single_output<float3>("Normal"); + return signature.build(); + } + + void call(IndexMask mask, fn::MFParams params, fn::MFContext UNUSED(context)) const override + { + // MutableSpan<float3> sampled_positions = params.uninitialized_single_output<float3>(1, + // "Position"); + // MutableSpan<float3> sampled_tangents = params.uninitialized_single_output<float3>(2, + // "Tangent"); + // MutableSpan<float3> sampled_normals = params.uninitialized_single_output<float3>(3, + // "Normal"); + MutableSpan<float3> sampled_positions = params.uninitialized_single_output_if_required<float3>( + 1, "Position"); + MutableSpan<float3> sampled_tangents = params.uninitialized_single_output_if_required<float3>( + 2, "Tangent"); + MutableSpan<float3> sampled_normals = params.uninitialized_single_output_if_required<float3>( + 3, "Normal"); + + auto return_default = [&]() { + if (!sampled_positions.is_empty()) { + sampled_positions.fill_indices(mask, {0, 0, 0}); + } + if (!sampled_tangents.is_empty()) { + sampled_tangents.fill_indices(mask, {0, 0, 0}); + } + if (!sampled_normals.is_empty()) { + sampled_normals.fill_indices(mask, {0, 0, 0}); + } + }; + + if (!geometry_set_.has_curve()) { + return return_default(); + } + + const CurveComponent *curve_component = geometry_set_.get_component_for_read<CurveComponent>(); + const CurveEval *curve = curve_component->get_for_read(); + Span<SplinePtr> splines = curve->splines(); + if (splines.is_empty()) { + return return_default(); + } + + const VArray<float> &lengths_varray = params.readonly_single_input<float>(0, "Length"); + const VArray_Span lengths{lengths_varray}; +#ifdef DEBUG + for (const float length : lengths) { + /* Lengths must be in range of the curve's total length. This is ensured in + * #get_length_input_field by adding another multi-function before this one + * to clamp the lengths. */ + BLI_assert(length >= 0.0f && length <= total_length_); + } +#endif + + Array<int> spline_indices(mask.min_array_size()); + for (const int i : mask) { + const float *offset = std::lower_bound( + spline_lengths_.begin(), spline_lengths_.end(), lengths[i]); + const int index = offset - spline_lengths_.data() - 1; + spline_indices[i] = std::max(index, 0); + } + + Array<Spline::LookupResult> lookups(mask.min_array_size()); + for (const int i : mask) { + const float length_in_spline = lengths[i] - spline_lengths_[spline_indices[i]]; + lookups[i] = splines[spline_indices[i]]->lookup_evaluated_length(length_in_spline); + } + + if (!sampled_positions.is_empty()) { + for (const int i : mask) { + const Spline::LookupResult &lookup = lookups[i]; + const Span<float3> evaluated_positions = splines[spline_indices[i]]->evaluated_positions(); + sampled_positions[i] = sample_with_lookup(lookup, evaluated_positions); + } + } + + if (!sampled_tangents.is_empty()) { + for (const int i : mask) { + const Spline::LookupResult &lookup = lookups[i]; + const Span<float3> evaluated_tangents = splines[spline_indices[i]]->evaluated_tangents(); + sampled_tangents[i] = sample_with_lookup(lookup, evaluated_tangents).normalized(); + } + } + + if (!sampled_normals.is_empty()) { + for (const int i : mask) { + const Spline::LookupResult &lookup = lookups[i]; + const Span<float3> evaluated_normals = splines[spline_indices[i]]->evaluated_normals(); + sampled_normals[i] = sample_with_lookup(lookup, evaluated_normals).normalized(); + } + } + } +}; + +/** + * Pre-process the lengths or factors used for the sampling, turning factors into lengths, and + * clamping between zero and the total length of the curve. Do this as a separate operation in the + * field tree to make the sampling simpler, and to let the evaluator optimize better. + * + * \todo Use a mutable single input instead when they are supported. + */ +static Field<float> get_length_input_field(const GeoNodeExecParams ¶ms, + const float curve_total_length) +{ + const NodeGeometryCurveSample &node_storage = *(NodeGeometryCurveSample *)params.node().storage; + const GeometryNodeCurveSampleMode mode = (GeometryNodeCurveSampleMode)node_storage.mode; + + if (mode == GEO_NODE_CURVE_SAMPLE_LENGTH) { + return params.get_input<Field<float>>("Length"); + Field<float> length_field = params.get_input<Field<float>>("Length"); + auto clamp_fn = std::make_unique<fn::CustomMF_SI_SO<float, float>>( + __func__, [curve_total_length](float length) { + return std::clamp(length, 0.0f, curve_total_length); + }); + auto clamp_op = std::make_shared<FieldOperation>( + FieldOperation(std::move(clamp_fn), {std::move(length_field)})); + + return Field<float>(std::move(clamp_op), 0); + } + + Field<float> factor_field = params.get_input<Field<float>>("Factor"); + auto clamp_fn = std::make_unique<fn::CustomMF_SI_SO<float, float>>( + __func__, [curve_total_length](float factor) { + const float length = factor * curve_total_length; + return std::clamp(length, 0.0f, curve_total_length); + }); + auto process_op = std::make_shared<FieldOperation>( + FieldOperation(std::move(clamp_fn), {std::move(factor_field)})); + + return Field<float>(std::move(process_op), 0); +} + +static void geo_node_curve_sample_exec(GeoNodeExecParams params) +{ + GeometrySet geometry_set = params.extract_input<GeometrySet>("Curve"); + + auto return_default = [&]() { + params.set_output("Position", fn::make_constant_field<float3>({0.0f, 0.0f, 0.0f})); + params.set_output("Tangent", fn::make_constant_field<float3>({0.0f, 0.0f, 0.0f})); + params.set_output("Normal", fn::make_constant_field<float3>({0.0f, 0.0f, 0.0f})); + }; + + const CurveComponent *component = geometry_set.get_component_for_read<CurveComponent>(); + if (component == nullptr) { + return return_default(); + } + + const CurveEval *curve = component->get_for_read(); + if (curve == nullptr) { + return return_default(); + } + + if (curve->splines().is_empty()) { + return return_default(); + } + + Array<float> spline_lengths = curve->accumulated_spline_lengths(); + const float total_length = spline_lengths.last(); + if (total_length == 0.0f) { + return return_default(); + } + + Field<float> length_field = get_length_input_field(params, total_length); + + auto sample_fn = std::make_unique<SampleCurveFunction>(std::move(geometry_set), + std::move(spline_lengths)); + auto sample_op = std::make_shared<FieldOperation>( + FieldOperation(std::move(sample_fn), {length_field})); + + params.set_output("Position", Field<float3>(sample_op, 0)); + params.set_output("Tangent", Field<float3>(sample_op, 1)); + params.set_output("Normal", Field<float3>(sample_op, 2)); +} + +} // namespace blender::nodes + +void register_node_type_geo_curve_sample() +{ + static bNodeType ntype; + + geo_node_type_base(&ntype, GEO_NODE_CURVE_SAMPLE, "Curve Sample", NODE_CLASS_GEOMETRY, 0); + ntype.geometry_node_execute = blender::nodes::geo_node_curve_sample_exec; + ntype.declare = blender::nodes::geo_node_curve_sample_declare; + node_type_init(&ntype, blender::nodes::geo_node_curve_sample_type_init); + node_type_update(&ntype, blender::nodes::geo_node_curve_sample_update); + node_type_storage( + &ntype, "NodeGeometryCurveSample", node_free_standard_storage, node_copy_standard_storage); + ntype.draw_buttons = blender::nodes::geo_node_curve_sample_layout; + + nodeRegisterType(&ntype); +} |