Geometry Nodes: Set Handle Type Node Field Update

This update of the Set Handle Type node allows for a bool field to be
used as the selection of the affected control point handles for
bezier splines. If no bezier splines are provided a info message is
shown.

Differential Revision: https://developer.blender.org/D12526

5 files changed, 155 insertions, 2 deletions

diff --git a/source/blender/nodes/CMakeLists.txt b/source/blender/nodes/CMakeLists.txt
index 9bfbc807409..78b6ee1d7a6 100644
--- a/source/blender/nodes/CMakeLists.txt
+++ b/source/blender/nodes/CMakeLists.txt
@@ -209,6 +209,7 @@ set(SRC
   geometry/nodes/node_geo_curve_resample.cc
   geometry/nodes/node_geo_curve_reverse.cc
   geometry/nodes/node_geo_curve_sample.cc
+  geometry/nodes/node_geo_curve_set_handles.cc
   geometry/nodes/node_geo_curve_spline_type.cc
   geometry/nodes/node_geo_curve_subdivide.cc
   geometry/nodes/node_geo_curve_to_mesh.cc
diff --git a/source/blender/nodes/NOD_geometry.h b/source/blender/nodes/NOD_geometry.h
index a5f00fedc33..bb90c7b6c51 100644
--- a/source/blender/nodes/NOD_geometry.h
+++ b/source/blender/nodes/NOD_geometry.h
@@ -29,6 +29,7 @@ void register_node_tree_type_geo(void);
 void register_node_type_geo_group(void);
 void register_node_type_geo_custom_group(bNodeType *ntype);
 
+void register_node_type_geo_legacy_curve_set_handles(void);
 void register_node_type_geo_legacy_attribute_proximity(void);
 void register_node_type_geo_legacy_attribute_randomize(void);
 void register_node_type_geo_legacy_material_assign(void);
diff --git a/source/blender/nodes/NOD_static_types.h b/source/blender/nodes/NOD_static_types.h
index 1ea1eb76983..d328efe9cba 100644
--- a/source/blender/nodes/NOD_static_types.h
+++ b/source/blender/nodes/NOD_static_types.h
@@ -297,7 +297,7 @@ DefNode(GeometryNode, GEO_NODE_LEGACY_ATTRIBUTE_VECTOR_ROTATE, def_geo_attribute
 DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_ENDPOINTS, 0, "LEGACY_CURVE_ENDPOINTS", LegacyCurveEndpoints, "Curve Endpoints", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_REVERSE, 0, "LEGACY_CURVE_REVERSE", LegacyCurveReverse, "Curve Reverse", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_SELECT_HANDLES, def_geo_curve_select_handles, "LEGACY_CURVE_SELECT_HANDLES", LegacyCurveSelectHandles, "Select by Handle Type", "")
-DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_SET_HANDLES, def_geo_curve_set_handles, "LEGACY_CURVE_SET_HANDLES", LegacyCurveSetHandles, "Set Handle Type", "")
+DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_SET_HANDLES, def_geo_legacy_curve_set_handles, "LEGACY_CURVE_SET_HANDLES", LegacyCurveSetHandles, "Set Handle Type", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_SPLINE_TYPE, def_geo_curve_spline_type, "LEGACY_CURVE_SPLINE_TYPE", LegacyCurveSplineType, "Set Spline Type", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_SUBDIVIDE, def_geo_legacy_curve_subdivide, "LEGACY_CURVE_SUBDIVIDE", LegacyCurveSubdivide, "Curve Subdivide", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_CURVE_TO_POINTS, def_geo_curve_to_points, "LEGACY_CURVE_TO_POINTS", LegacyCurveToPoints, "Curve to Points", "")
@@ -338,6 +338,7 @@ DefNode(GeometryNode, GEO_NODE_CURVE_RESAMPLE, def_geo_curve_resample, "CURVE_RE
 DefNode(GeometryNode, GEO_NODE_CURVE_SPLINE_TYPE, def_geo_curve_spline_type, "CURVE_SPLINE_TYPE", CurveSplineType, "Set Spline Type", "")
 DefNode(GeometryNode, GEO_NODE_CURVE_REVERSE, 0, "CURVE_REVERSE", CurveReverse, "Curve Reverse", "")
 DefNode(GeometryNode, GEO_NODE_CURVE_SAMPLE, def_geo_curve_sample, "CURVE_SAMPLE", CurveSample, "Curve Sample", "")
+DefNode(GeometryNode, GEO_NODE_CURVE_SET_HANDLES, def_geo_curve_set_handles, "CURVE_SET_HANDLES", CurveSetHandles, "Set Handle Type", "")
 DefNode(GeometryNode, GEO_NODE_CURVE_SUBDIVIDE, 0, "CURVE_SUBDIVIDE", CurveSubdivide, "Curve Subdivide", "")
 DefNode(GeometryNode, GEO_NODE_CURVE_TO_MESH, 0, "CURVE_TO_MESH", CurveToMesh, "Curve to Mesh", "")
 DefNode(GeometryNode, GEO_NODE_CURVE_TRIM, def_geo_curve_trim, "CURVE_TRIM", CurveTrim, "Curve Trim", "")
diff --git a/source/blender/nodes/geometry/nodes/legacy/node_geo_curve_set_handles.cc b/source/blender/nodes/geometry/nodes/legacy/node_geo_curve_set_handles.cc
index 31c13134f79..339029336d9 100644
--- a/source/blender/nodes/geometry/nodes/legacy/node_geo_curve_set_handles.cc
+++ b/source/blender/nodes/geometry/nodes/legacy/node_geo_curve_set_handles.cc
@@ -126,7 +126,7 @@ static void geo_node_curve_set_handles_exec(GeoNodeExecParams params)
 }
 }  // namespace blender::nodes
 
-void register_node_type_geo_curve_set_handles()
+void register_node_type_geo_legacy_curve_set_handles()
 {
   static bNodeType ntype;
   geo_node_type_base(
diff --git a/source/blender/nodes/geometry/nodes/node_geo_curve_set_handles.cc b/source/blender/nodes/geometry/nodes/node_geo_curve_set_handles.cc
new file mode 100644
index 00000000000..9e7ac60c29d
--- /dev/null
+++ b/source/blender/nodes/geometry/nodes/node_geo_curve_set_handles.cc
@@ -0,0 +1,150 @@
+/*
+ * 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 "BKE_spline.hh"
+
+#include "UI_interface.h"
+#include "UI_resources.h"
+
+#include "node_geometry_util.hh"
+
+namespace blender::nodes {
+
+static void geo_node_curve_set_handles_declare(NodeDeclarationBuilder &b)
+{
+  b.add_input<decl::Geometry>("Curve");
+  b.add_input<decl::Bool>("Selection").default_value(true).hide_value().supports_field();
+  b.add_output<decl::Geometry>("Curve");
+}
+
+static void geo_node_curve_set_handles_layout(uiLayout *layout,
+                                              bContext *UNUSED(C),
+                                              PointerRNA *ptr)
+{
+  uiItemR(layout, ptr, "mode", UI_ITEM_R_EXPAND, nullptr, ICON_NONE);
+  uiItemR(layout, ptr, "handle_type", 0, "", ICON_NONE);
+}
+
+static void geo_node_curve_set_handles_init(bNodeTree *UNUSED(tree), bNode *node)
+{
+  NodeGeometryCurveSetHandles *data = (NodeGeometryCurveSetHandles *)MEM_callocN(
+      sizeof(NodeGeometryCurveSetHandles), __func__);
+
+  data->handle_type = GEO_NODE_CURVE_HANDLE_AUTO;
+  data->mode = GEO_NODE_CURVE_HANDLE_LEFT;
+  node->storage = data;
+}
+
+static BezierSpline::HandleType handle_type_from_input_type(GeometryNodeCurveHandleType type)
+{
+  switch (type) {
+    case GEO_NODE_CURVE_HANDLE_AUTO:
+      return BezierSpline::HandleType::Auto;
+    case GEO_NODE_CURVE_HANDLE_ALIGN:
+      return BezierSpline::HandleType::Align;
+    case GEO_NODE_CURVE_HANDLE_FREE:
+      return BezierSpline::HandleType::Free;
+    case GEO_NODE_CURVE_HANDLE_VECTOR:
+      return BezierSpline::HandleType::Vector;
+  }
+  BLI_assert_unreachable();
+  return BezierSpline::HandleType::Auto;
+}
+
+static void geo_node_curve_set_handles_exec(GeoNodeExecParams params)
+{
+  const NodeGeometryCurveSetHandles *node_storage =
+      (NodeGeometryCurveSetHandles *)params.node().storage;
+  const GeometryNodeCurveHandleType type = (GeometryNodeCurveHandleType)node_storage->handle_type;
+  const GeometryNodeCurveHandleMode mode = (GeometryNodeCurveHandleMode)node_storage->mode;
+
+  GeometrySet geometry_set = params.extract_input<GeometrySet>("Curve");
+  Field<bool> selection_field = params.extract_input<Field<bool>>("Selection");
+
+  bool has_bezier_spline = false;
+  geometry_set.modify_geometry_sets([&](GeometrySet &geometry_set) {
+    if (!geometry_set.has_curve()) {
+      return;
+    }
+
+    /* Retrieve data for write access so we can avoid new allocations for the handles data. */
+    CurveComponent &curve_component = geometry_set.get_component_for_write<CurveComponent>();
+    CurveEval &curve = *curve_component.get_for_write();
+    MutableSpan<SplinePtr> splines = curve.splines();
+
+    GeometryComponentFieldContext field_context{curve_component, ATTR_DOMAIN_POINT};
+    const int domain_size = curve_component.attribute_domain_size(ATTR_DOMAIN_POINT);
+
+    fn::FieldEvaluator selection_evaluator{field_context, domain_size};
+    selection_evaluator.add(selection_field);
+    selection_evaluator.evaluate();
+    const VArray<bool> &selection = selection_evaluator.get_evaluated<bool>(0);
+
+    const BezierSpline::HandleType new_handle_type = handle_type_from_input_type(type);
+    int point_index = 0;
+
+    for (SplinePtr &spline : splines) {
+      if (spline->type() != Spline::Type::Bezier) {
+        point_index += spline->positions().size();
+        continue;
+      }
+
+      has_bezier_spline = true;
+      BezierSpline &bezier_spline = static_cast<BezierSpline &>(*spline);
+      if (ELEM(new_handle_type, BezierSpline::HandleType::Free, BezierSpline::HandleType::Align)) {
+        /* In this case the automatically calculated handle types need to be "baked", because
+         * they're possibly changing from a type that is calculated automatically to a type that
+         * is positioned manually. */
+        bezier_spline.ensure_auto_handles();
+      }
+
+      for (int i_point : IndexRange(bezier_spline.size())) {
+        if (selection[point_index]) {
+          if (mode & GEO_NODE_CURVE_HANDLE_LEFT) {
+            bezier_spline.handle_types_left()[i_point] = new_handle_type;
+          }
+          if (mode & GEO_NODE_CURVE_HANDLE_RIGHT) {
+            bezier_spline.handle_types_right()[i_point] = new_handle_type;
+          }
+        }
+        point_index++;
+      }
+      bezier_spline.mark_cache_invalid();
+    }
+  });
+  if (!has_bezier_spline) {
+    params.error_message_add(NodeWarningType::Info, TIP_("No Bezier splines in input curve"));
+  }
+  params.set_output("Curve", std::move(geometry_set));
+}
+}  // namespace blender::nodes
+
+void register_node_type_geo_curve_set_handles()
+{
+  static bNodeType ntype;
+  geo_node_type_base(
+      &ntype, GEO_NODE_CURVE_SET_HANDLES, "Set Handle Type", NODE_CLASS_GEOMETRY, 0);
+  ntype.declare = blender::nodes::geo_node_curve_set_handles_declare;
+  ntype.geometry_node_execute = blender::nodes::geo_node_curve_set_handles_exec;
+  node_type_init(&ntype, blender::nodes::geo_node_curve_set_handles_init);
+  node_type_storage(&ntype,
+                    "NodeGeometryCurveSetHandles",
+                    node_free_standard_storage,
+                    node_copy_standard_storage);
+  ntype.draw_buttons = blender::nodes::geo_node_curve_set_handles_layout;
+
+  nodeRegisterType(&ntype);
+}