Geometry Nodes: Add Attribute Clamp Node

This adds a Clamp node for Geometry Nodes Attributes.

Supports both Min-Max and Range clamp modes.

Float, Vector, Color and Int data types supported.

Reviewed By: HooglyBoogly, simonthommes

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

8 files changed, 330 insertions, 2 deletions

diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h
index a894b545b2b..22a0ff3746e 100644
--- a/source/blender/blenkernel/BKE_node.h
+++ b/source/blender/blenkernel/BKE_node.h
@@ -1395,6 +1395,7 @@ int ntreeTexExecTree(struct bNodeTree *ntree,
 #define GEO_NODE_MESH_PRIMITIVE_LINE 1038
 #define GEO_NODE_MESH_PRIMITIVE_PLANE 1039
 #define GEO_NODE_ATTRIBUTE_MAP_RANGE 1040
+#define GEO_NODE_ATTRIBUTE_CLAMP 1041
 
 /** \} */
 
diff --git a/source/blender/blenkernel/intern/node.cc b/source/blender/blenkernel/intern/node.cc
index fd74f865b54..9263071241d 100644
--- a/source/blender/blenkernel/intern/node.cc
+++ b/source/blender/blenkernel/intern/node.cc
@@ -4903,6 +4903,7 @@ static void registerGeometryNodes()
   register_node_type_geo_group();
 
   register_node_type_geo_align_rotation_to_vector();
+  register_node_type_geo_attribute_clamp();
   register_node_type_geo_attribute_color_ramp();
   register_node_type_geo_attribute_combine_xyz();
   register_node_type_geo_attribute_compare();
diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h
index 7abf4883c60..1b7d1aaee9d 100644
--- a/source/blender/makesdna/DNA_node_types.h
+++ b/source/blender/makesdna/DNA_node_types.h
@@ -1108,6 +1108,14 @@ typedef struct NodeDenoise {
   char hdr;
 } NodeDenoise;
 
+typedef struct NodeAttributeClamp {
+  /* CustomDataType. */
+  uint8_t data_type;
+
+  /* NodeClampOperation. */
+  uint8_t operation;
+} NodeAttributeClamp;
+
 typedef struct NodeAttributeCompare {
   /* FloatCompareOperation. */
   uint8_t operation;
diff --git a/source/blender/makesrna/intern/rna_nodetree.c b/source/blender/makesrna/intern/rna_nodetree.c
index 7f2120c02e9..b697d872cf3 100644
--- a/source/blender/makesrna/intern/rna_nodetree.c
+++ b/source/blender/makesrna/intern/rna_nodetree.c
@@ -329,8 +329,12 @@ const EnumPropertyItem rna_enum_node_map_range_items[] = {
 };
 
 const EnumPropertyItem rna_enum_node_clamp_items[] = {
-    {NODE_CLAMP_MINMAX, "MINMAX", 0, "Min Max", "Clamp values using Min and Max values"},
-    {NODE_CLAMP_RANGE, "RANGE", 0, "Range", "Clamp values between Min and Max range"},
+    {NODE_CLAMP_MINMAX, "MINMAX", 0, "Min Max", "Constrain value between min and max"},
+    {NODE_CLAMP_RANGE,
+     "RANGE",
+     0,
+     "Range",
+     "Constrain value between min and max, swapping arguments when min > max"},
     {0, NULL, 0, NULL, NULL},
 };
 
@@ -1886,6 +1890,19 @@ static const EnumPropertyItem *itemf_function_check(
   return item_array;
 }
 
+static bool attribute_clamp_type_supported(const EnumPropertyItem *item)
+{
+  return ELEM(item->value, CD_PROP_FLOAT, CD_PROP_FLOAT3, CD_PROP_INT32, CD_PROP_COLOR);
+}
+static const EnumPropertyItem *rna_GeometryNodeAttributeClamp_type_itemf(bContext *UNUSED(C),
+                                                                         PointerRNA *UNUSED(ptr),
+                                                                         PropertyRNA *UNUSED(prop),
+                                                                         bool *r_free)
+{
+  *r_free = true;
+  return itemf_function_check(rna_enum_attribute_type_items, attribute_clamp_type_supported);
+}
+
 static bool attribute_random_type_supported(const EnumPropertyItem *item)
 {
   return ELEM(item->value, CD_PROP_FLOAT, CD_PROP_FLOAT3, CD_PROP_BOOL, CD_PROP_INT32);
@@ -9006,6 +9023,26 @@ static void def_geo_attribute_mix(StructRNA *srna)
   RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_socket_update");
 }
 
+static void def_geo_attribute_clamp(StructRNA *srna)
+{
+  PropertyRNA *prop;
+
+  RNA_def_struct_sdna_from(srna, "NodeAttributeClamp", "storage");
+
+  prop = RNA_def_property(srna, "data_type", PROP_ENUM, PROP_NONE);
+  RNA_def_property_enum_bitflag_sdna(prop, NULL, "data_type");
+  RNA_def_property_enum_items(prop, rna_enum_attribute_type_items);
+  RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_GeometryNodeAttributeClamp_type_itemf");
+  RNA_def_property_ui_text(prop, "Data Type", "");
+  RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_socket_update");
+
+  prop = RNA_def_property(srna, "operation", PROP_ENUM, PROP_NONE);
+  RNA_def_property_enum_items(prop, rna_enum_node_clamp_items);
+  RNA_def_property_enum_default(prop, NODE_CLAMP_MINMAX);
+  RNA_def_property_ui_text(prop, "Operation", "");
+  RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_update");
+}
+
 static void def_geo_attribute_attribute_compare(StructRNA *srna)
 {
   PropertyRNA *prop;
diff --git a/source/blender/nodes/CMakeLists.txt b/source/blender/nodes/CMakeLists.txt
index 8f0156c3aad..e8b26b8e08f 100644
--- a/source/blender/nodes/CMakeLists.txt
+++ b/source/blender/nodes/CMakeLists.txt
@@ -139,6 +139,7 @@ set(SRC
   function/node_function_util.cc
 
   geometry/nodes/node_geo_align_rotation_to_vector.cc
+  geometry/nodes/node_geo_attribute_clamp.cc
   geometry/nodes/node_geo_attribute_color_ramp.cc
   geometry/nodes/node_geo_attribute_combine_xyz.cc
   geometry/nodes/node_geo_attribute_compare.cc
diff --git a/source/blender/nodes/NOD_geometry.h b/source/blender/nodes/NOD_geometry.h
index d330218485d..def211d0b45 100644
--- a/source/blender/nodes/NOD_geometry.h
+++ b/source/blender/nodes/NOD_geometry.h
@@ -27,6 +27,7 @@ void register_node_tree_type_geo(void);
 void register_node_type_geo_group(void);
 
 void register_node_type_geo_align_rotation_to_vector(void);
+void register_node_type_geo_attribute_clamp(void);
 void register_node_type_geo_attribute_color_ramp(void);
 void register_node_type_geo_attribute_combine_xyz(void);
 void register_node_type_geo_attribute_compare(void);
diff --git a/source/blender/nodes/NOD_static_types.h b/source/blender/nodes/NOD_static_types.h
index a46178d0d61..0e19db6866e 100644
--- a/source/blender/nodes/NOD_static_types.h
+++ b/source/blender/nodes/NOD_static_types.h
@@ -307,6 +307,7 @@ DefNode(GeometryNode, GEO_NODE_MESH_PRIMITIVE_CONE, def_geo_mesh_cone, "MESH_PRI
 DefNode(GeometryNode, GEO_NODE_MESH_PRIMITIVE_LINE, def_geo_mesh_line, "MESH_PRIMITIVE_LINE", MeshLine, "Line", "")
 DefNode(GeometryNode, GEO_NODE_MESH_PRIMITIVE_PLANE, 0, "MESH_PRIMITIVE_PLANE", MeshPlane, "Plane", "")
 DefNode(GeometryNode, GEO_NODE_ATTRIBUTE_MAP_RANGE, def_geo_attribute_map_range, "ATTRIBUTE_MAP_RANGE", AttributeMapRange, "Attribute Map Range", "")
+DefNode(GeometryNode, GEO_NODE_ATTRIBUTE_CLAMP, def_geo_attribute_clamp, "ATTRIBUTE_CLAMP", AttributeClamp, "Attribute Clamp", "")
 
 /* undefine macros */
 #undef DefNode
diff --git a/source/blender/nodes/geometry/nodes/node_geo_attribute_clamp.cc b/source/blender/nodes/geometry/nodes/node_geo_attribute_clamp.cc
new file mode 100644
index 00000000000..93e4124bd70
--- /dev/null
+++ b/source/blender/nodes/geometry/nodes/node_geo_attribute_clamp.cc
@@ -0,0 +1,278 @@
+
+/*
+ * 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 "node_geometry_util.hh"
+
+#include "UI_interface.h"
+#include "UI_resources.h"
+
+static bNodeSocketTemplate geo_node_attribute_clamp_in[] = {
+    {SOCK_GEOMETRY, N_("Geometry")},
+    {SOCK_STRING, N_("Attribute")},
+    {SOCK_STRING, N_("Result")},
+    {SOCK_VECTOR, N_("Min"), 0.0f, 0.0f, 0.0f, 0.0f, -FLT_MAX, FLT_MAX},
+    {SOCK_VECTOR, N_("Max"), 1.0f, 1.0f, 1.0f, 0.0f, -FLT_MAX, FLT_MAX},
+    {SOCK_FLOAT, N_("Min"), 0.0f, 0.0f, 0.0f, 0.0f, -FLT_MAX, FLT_MAX},
+    {SOCK_FLOAT, N_("Max"), 1.0f, 0.0f, 0.0f, 0.0f, -FLT_MAX, FLT_MAX},
+    {SOCK_INT, N_("Min"), 0.0f, 0.0f, 0.0f, 0.0f, -100000, 100000},
+    {SOCK_INT, N_("Max"), 100.0f, 0.0f, 0.0f, 0.0f, -100000, 100000},
+    {SOCK_RGBA, N_("Min"), 0.5, 0.5, 0.5, 1.0},
+    {SOCK_RGBA, N_("Max"), 0.5, 0.5, 0.5, 1.0},
+    {-1, ""},
+};
+
+static bNodeSocketTemplate geo_node_attribute_clamp_out[] = {
+    {SOCK_GEOMETRY, N_("Geometry")},
+    {-1, ""},
+};
+
+static void geo_node_attribute_clamp_layout(uiLayout *layout, bContext *UNUSED(C), PointerRNA *ptr)
+{
+  uiItemR(layout, ptr, "data_type", 0, "", ICON_NONE);
+  uiItemR(layout, ptr, "operation", 0, "", ICON_NONE);
+}
+
+static void geo_node_attribute_clamp_init(bNodeTree *UNUSED(tree), bNode *node)
+{
+  NodeAttributeClamp *data = (NodeAttributeClamp *)MEM_callocN(sizeof(NodeAttributeClamp),
+                                                               __func__);
+  data->data_type = CD_PROP_FLOAT;
+  data->operation = NODE_CLAMP_MINMAX;
+  node->storage = data;
+}
+
+static void geo_node_attribute_clamp_update(bNodeTree *UNUSED(ntree), bNode *node)
+{
+  bNodeSocket *sock_min_vector = (bNodeSocket *)BLI_findlink(&node->inputs, 3);
+  bNodeSocket *sock_max_vector = sock_min_vector->next;
+  bNodeSocket *sock_min_float = sock_max_vector->next;
+  bNodeSocket *sock_max_float = sock_min_float->next;
+  bNodeSocket *sock_min_int = sock_max_float->next;
+  bNodeSocket *sock_max_int = sock_min_int->next;
+  bNodeSocket *sock_min_color = sock_max_int->next;
+  bNodeSocket *sock_max_color = sock_min_color->next;
+
+  const NodeAttributeClamp &storage = *(const NodeAttributeClamp *)node->storage;
+  const CustomDataType data_type = static_cast<CustomDataType>(storage.data_type);
+  nodeSetSocketAvailability(sock_min_vector, data_type == CD_PROP_FLOAT3);
+  nodeSetSocketAvailability(sock_max_vector, data_type == CD_PROP_FLOAT3);
+  nodeSetSocketAvailability(sock_min_float, data_type == CD_PROP_FLOAT);
+  nodeSetSocketAvailability(sock_max_float, data_type == CD_PROP_FLOAT);
+  nodeSetSocketAvailability(sock_min_int, data_type == CD_PROP_INT32);
+  nodeSetSocketAvailability(sock_max_int, data_type == CD_PROP_INT32);
+  nodeSetSocketAvailability(sock_min_color, data_type == CD_PROP_COLOR);
+  nodeSetSocketAvailability(sock_max_color, data_type == CD_PROP_COLOR);
+}
+
+namespace blender::nodes {
+
+template<typename T> T clamp_value(const T val, const T min, const T max);
+
+template<> inline float clamp_value(const float val, const float min, const float max)
+{
+  return std::min(std::max(val, min), max);
+}
+
+template<> inline int clamp_value(const int val, const int min, const int max)
+{
+  return std::min(std::max(val, min), max);
+}
+
+template<> inline float3 clamp_value(const float3 val, const float3 min, const float3 max)
+{
+  float3 tmp;
+  tmp.x = std::min(std::max(val.x, min.x), max.x);
+  tmp.y = std::min(std::max(val.y, min.y), max.y);
+  tmp.z = std::min(std::max(val.z, min.z), max.z);
+  return tmp;
+}
+
+template<> inline Color4f clamp_value(const Color4f val, const Color4f min, const Color4f max)
+{
+  Color4f tmp;
+  tmp.r = std::min(std::max(val.r, min.r), max.r);
+  tmp.g = std::min(std::max(val.g, min.g), max.g);
+  tmp.b = std::min(std::max(val.b, min.b), max.b);
+  tmp.a = std::min(std::max(val.a, min.a), max.a);
+  return tmp;
+}
+
+template<typename T>
+static void clamp_attribute(Span<T> read_span, MutableSpan<T> span, const T min, const T max)
+{
+  for (const int i : span.index_range()) {
+    span[i] = clamp_value<T>(read_span[i], min, max);
+  }
+}
+
+static AttributeDomain get_result_domain(const GeometryComponent &component,
+                                         StringRef source_name,
+                                         StringRef result_name)
+{
+  ReadAttributePtr result_attribute = component.attribute_try_get_for_read(result_name);
+  if (result_attribute) {
+    return result_attribute->domain();
+  }
+  ReadAttributePtr source_attribute = component.attribute_try_get_for_read(source_name);
+  if (source_attribute) {
+    return source_attribute->domain();
+  }
+  return ATTR_DOMAIN_POINT;
+}
+
+static void clamp_attribute(GeometryComponent &component, const GeoNodeExecParams &params)
+{
+  const std::string attribute_name = params.get_input<std::string>("Attribute");
+  const std::string result_name = params.get_input<std::string>("Result");
+
+  if (attribute_name.empty() || result_name.empty()) {
+    return;
+  }
+
+  if (!component.attribute_exists(attribute_name)) {
+    params.error_message_add(NodeWarningType::Error,
+                             TIP_("No attribute with name \"") + attribute_name + "\"");
+    return;
+  }
+
+  const NodeAttributeClamp &storage = *(const NodeAttributeClamp *)params.node().storage;
+  const CustomDataType data_type = static_cast<CustomDataType>(storage.data_type);
+  const AttributeDomain domain = get_result_domain(component, attribute_name, result_name);
+  const int operation = static_cast<int>(storage.operation);
+
+  ReadAttributePtr attribute_input = component.attribute_try_get_for_read(
+      attribute_name, domain, data_type);
+
+  OutputAttributePtr attribute_result = component.attribute_try_get_for_output(
+      result_name, domain, data_type);
+
+  if (!attribute_result) {
+    params.error_message_add(NodeWarningType::Error,
+                             TIP_("Could not find or create attribute with name \"") +
+                                 result_name + "\"");
+    return;
+  }
+
+  switch (data_type) {
+    case CD_PROP_FLOAT3: {
+      Span<float3> read_span = attribute_input->get_span<float3>();
+      MutableSpan<float3> span = attribute_result->get_span_for_write_only<float3>();
+      float3 min = params.get_input<float3>("Min");
+      float3 max = params.get_input<float3>("Max");
+      if (operation == NODE_CLAMP_RANGE) {
+        if (min.x > max.x) {
+          std::swap(min.x, max.x);
+        }
+        if (min.y > max.y) {
+          std::swap(min.y, max.y);
+        }
+        if (min.z > max.z) {
+          std::swap(min.z, max.z);
+        }
+      }
+      clamp_attribute<float3>(read_span, span, min, max);
+      break;
+    }
+    case CD_PROP_FLOAT: {
+      Span<float> read_span = attribute_input->get_span<float>();
+      MutableSpan<float> span = attribute_result->get_span_for_write_only<float>();
+      const float min = params.get_input<float>("Min_001");
+      const float max = params.get_input<float>("Max_001");
+      if (operation == NODE_CLAMP_RANGE && min > max) {
+        clamp_attribute<float>(read_span, span, max, min);
+      }
+      else {
+        clamp_attribute<float>(read_span, span, min, max);
+      }
+      break;
+    }
+    case CD_PROP_INT32: {
+      Span<int> read_span = attribute_input->get_span<int>();
+      MutableSpan<int> span = attribute_result->get_span_for_write_only<int>();
+      const int min = params.get_input<int>("Min_002");
+      const int max = params.get_input<int>("Max_002");
+      if (operation == NODE_CLAMP_RANGE && min > max) {
+        clamp_attribute<int>(read_span, span, max, min);
+      }
+      else {
+        clamp_attribute<int>(read_span, span, min, max);
+      }
+      break;
+    }
+    case CD_PROP_COLOR: {
+      Span<Color4f> read_span = attribute_input->get_span<Color4f>();
+      MutableSpan<Color4f> span = attribute_result->get_span_for_write_only<Color4f>();
+      Color4f min = params.get_input<Color4f>("Min_003");
+      Color4f max = params.get_input<Color4f>("Max_003");
+      if (operation == NODE_CLAMP_RANGE) {
+        if (min.r > max.r) {
+          std::swap(min.r, max.r);
+        }
+        if (min.g > max.g) {
+          std::swap(min.g, max.g);
+        }
+        if (min.b > max.b) {
+          std::swap(min.b, max.b);
+        }
+        if (min.a > max.a) {
+          std::swap(min.a, max.a);
+        }
+      }
+      clamp_attribute<Color4f>(read_span, span, min, max);
+      break;
+    }
+    default: {
+      BLI_assert(false);
+      break;
+    }
+  }
+
+  attribute_result.apply_span_and_save();
+}
+
+static void geo_node_attribute_clamp_exec(GeoNodeExecParams params)
+{
+  GeometrySet geometry_set = params.extract_input<GeometrySet>("Geometry");
+
+  geometry_set = geometry_set_realize_instances(geometry_set);
+
+  if (geometry_set.has<MeshComponent>()) {
+    clamp_attribute(geometry_set.get_component_for_write<MeshComponent>(), params);
+  }
+  if (geometry_set.has<PointCloudComponent>()) {
+    clamp_attribute(geometry_set.get_component_for_write<PointCloudComponent>(), params);
+  }
+
+  params.set_output("Geometry", geometry_set);
+}
+
+}  // namespace blender::nodes
+
+void register_node_type_geo_attribute_clamp()
+{
+  static bNodeType ntype;
+
+  geo_node_type_base(&ntype, GEO_NODE_ATTRIBUTE_CLAMP, "Attribute Clamp", NODE_CLASS_ATTRIBUTE, 0);
+  node_type_socket_templates(&ntype, geo_node_attribute_clamp_in, geo_node_attribute_clamp_out);
+  node_type_init(&ntype, geo_node_attribute_clamp_init);
+  node_type_update(&ntype, geo_node_attribute_clamp_update);
+  ntype.geometry_node_execute = blender::nodes::geo_node_attribute_clamp_exec;
+  ntype.draw_buttons = geo_node_attribute_clamp_layout;
+  node_type_storage(
+      &ntype, "NodeAttributeClamp", node_free_standard_storage, node_copy_standard_storage);
+  nodeRegisterType(&ntype);
+}