Geometry Nodes: Points to Volume Fields Update

This update of the Points to Volume node allows a field to populate the
radius input of the node and removes the implicit realization of
instances.

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

release/scripts/startup/nodeitems_builtins.py

@@ -646,6 +646,7 @@ geometry_node_categories = [
     GeometryNodeCategory("GEO_VOLUME", "Volume", items=[
         NodeItem("GeometryNodeLegacyPointsToVolume", poll=geometry_nodes_legacy_poll),
 
+        NodeItem("GeometryNodePointsToVolume"),
         NodeItem("GeometryNodeVolumeToMesh"),
     ]),
     GeometryNodeCategory("GEO_GROUP", "Group", items=node_group_items),

source/blender/blenkernel/BKE_node.h

@@ -1513,6 +1513,7 @@ int ntreeTexExecTree(struct bNodeTree *ntree,
 #define GEO_NODE_INPUT_SPLINE_LENGTH 1098
 #define GEO_NODE_CURVE_SPLINE_TYPE 1099
 #define GEO_NODE_CURVE_SET_HANDLES 1100
+#define GEO_NODE_POINTS_TO_VOLUME 1101
 /** \} */
 
 /* -------------------------------------------------------------------- */

source/blender/blenkernel/intern/node.cc

@@ -5713,6 +5713,7 @@ static void registerGeometryNodes()
   register_node_type_geo_legacy_attribute_proximity();
   register_node_type_geo_legacy_attribute_randomize();
   register_node_type_geo_legacy_material_assign();
+  register_node_type_geo_legacy_points_to_volume();
   register_node_type_geo_legacy_select_by_material();
   register_node_type_geo_legacy_curve_spline_type();
   register_node_type_geo_legacy_curve_reverse();

source/blender/makesrna/intern/rna_nodetree.c

@@ -9987,7 +9987,7 @@ static void def_geo_object_info(StructRNA *srna)
   RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_update");
 }
 
-static void def_geo_points_to_volume(StructRNA *srna)
+static void def_geo_legacy_points_to_volume(StructRNA *srna)
 {
   PropertyRNA *prop;
 
@@ -10018,6 +10018,32 @@ static void def_geo_points_to_volume(StructRNA *srna)
   RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_socket_update");
 }
 
+static void def_geo_points_to_volume(StructRNA *srna)
+{
+  PropertyRNA *prop;
+
+  static EnumPropertyItem resolution_mode_items[] = {
+      {GEO_NODE_POINTS_TO_VOLUME_RESOLUTION_MODE_AMOUNT,
+       "VOXEL_AMOUNT",
+       0,
+       "Amount",
+       "Specify the approximate number of voxels along the diagonal"},
+      {GEO_NODE_POINTS_TO_VOLUME_RESOLUTION_MODE_SIZE,
+       "VOXEL_SIZE",
+       0,
+       "Size",
+       "Specify the voxel side length"},
+      {0, NULL, 0, NULL, NULL},
+  };
+
+  RNA_def_struct_sdna_from(srna, "NodeGeometryPointsToVolume", "storage");
+
+  prop = RNA_def_property(srna, "resolution_mode", PROP_ENUM, PROP_NONE);
+  RNA_def_property_enum_items(prop, resolution_mode_items);
+  RNA_def_property_ui_text(prop, "Resolution Mode", "How the voxel size is specified");
+  RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_socket_update");
+}
+
 static void def_geo_collection_info(StructRNA *srna)
 {
   PropertyRNA *prop;

source/blender/nodes/CMakeLists.txt

@@ -240,6 +240,7 @@ set(SRC
   geometry/nodes/node_geo_mesh_to_points.cc
   geometry/nodes/node_geo_object_info.cc
   geometry/nodes/node_geo_points_to_vertices.cc
+  geometry/nodes/node_geo_points_to_volume.cc
   geometry/nodes/node_geo_proximity.cc
   geometry/nodes/node_geo_realize_instances.cc
   geometry/nodes/node_geo_separate_components.cc

source/blender/nodes/NOD_geometry.h

@@ -33,6 +33,7 @@ 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);
+void register_node_type_geo_legacy_points_to_volume(void);
 void register_node_type_geo_legacy_select_by_material(void);
 void register_node_type_geo_legacy_curve_spline_type(void);
 void register_node_type_geo_legacy_curve_reverse(void);

source/blender/nodes/NOD_static_types.h

@@ -312,7 +312,7 @@ DefNode(GeometryNode, GEO_NODE_LEGACY_POINT_ROTATE, def_geo_point_rotate, "LEGAC
 DefNode(GeometryNode, GEO_NODE_LEGACY_POINT_SCALE, def_geo_point_scale, "LEGACY_POINT_SCALE", LegacyPointScale, "Point Scale", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_POINT_SEPARATE, 0, "LEGACY_POINT_SEPARATE", LegacyPointSeparate, "Point Separate", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_POINT_TRANSLATE, def_geo_point_translate, "LEGACY_POINT_TRANSLATE", LegacyPointTranslate, "Point Translate", "")
-DefNode(GeometryNode, GEO_NODE_LEGACY_POINTS_TO_VOLUME, def_geo_points_to_volume, "LEGACY_POINTS_TO_VOLUME", LegacyPointsToVolume, "Points to Volume", "")
+DefNode(GeometryNode, GEO_NODE_LEGACY_POINTS_TO_VOLUME, def_geo_legacy_points_to_volume, "LEGACY_POINTS_TO_VOLUME", LegacyPointsToVolume, "Points to Volume", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_RAYCAST, def_geo_raycast, "LEGACY_RAYCAST", LegacyRaycast, "Raycast", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_SELECT_BY_MATERIAL, 0, "LEGACY_SELECT_BY_MATERIAL", LegacySelectByMaterial, "Select by Material", "")
 DefNode(GeometryNode, GEO_NODE_LEGACY_SUBDIVISION_SURFACE, def_geo_subdivision_surface, "LEGACY_SUBDIVISION_SURFACE", LegacySubdivisionSurface, "Subdivision Surface", "")
@@ -368,6 +368,7 @@ DefNode(GeometryNode, GEO_NODE_MESH_SUBDIVIDE, 0, "MESH_SUBDIVIDE", MeshSubdivid
 DefNode(GeometryNode, GEO_NODE_MESH_TO_POINTS, def_geo_mesh_to_points, "MESH_TO_POINTS", MeshToPoints, "Mesh to Points", "")
 DefNode(GeometryNode, GEO_NODE_OBJECT_INFO, def_geo_object_info, "OBJECT_INFO", ObjectInfo, "Object Info", "")
 DefNode(GeometryNode, GEO_NODE_POINTS_TO_VERTICES, 0, "POINTS_TO_VERTICES", PointsToVertices, "Points to Vertices", "")
+DefNode(GeometryNode, GEO_NODE_POINTS_TO_VOLUME, def_geo_points_to_volume, "POINTS_TO_VOLUME", PointsToVolume, "Points to Volume", "")
 DefNode(GeometryNode, GEO_NODE_PROXIMITY, def_geo_proximity, "PROXIMITY", Proximity, "Geometry Proximity", "")
 DefNode(GeometryNode, GEO_NODE_REALIZE_INSTANCES, 0, "REALIZE_INSTANCES", RealizeInstances, "Realize Instances", "")
 DefNode(GeometryNode, GEO_NODE_SEPARATE_COMPONENTS, 0, "SEPARATE_COMPONENTS", SeparateComponents, "Separate Components", "")

source/blender/nodes/geometry/nodes/legacy/node_geo_points_to_volume.cc

@@ -258,7 +258,7 @@ static void geo_node_points_to_volume_exec(GeoNodeExecParams params)
 
 }  // namespace blender::nodes
 
-void register_node_type_geo_points_to_volume()
+void register_node_type_geo_legacy_points_to_volume()
 {
   static bNodeType ntype;
 

source/blender/nodes/geometry/nodes/node_geo_points_to_volume.cc

@@ -0,0 +1,272 @@
+/*
+ * 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.
+ */
+
+#ifdef WITH_OPENVDB
+#  include <openvdb/openvdb.h>
+#  include <openvdb/tools/LevelSetUtil.h>
+#  include <openvdb/tools/ParticlesToLevelSet.h>
+#endif
+
+#include "node_geometry_util.hh"
+
+#include "BKE_lib_id.h"
+#include "BKE_volume.h"
+
+#include "UI_interface.h"
+#include "UI_resources.h"
+
+namespace blender::nodes {
+
+static void geo_node_points_to_volume_declare(NodeDeclarationBuilder &b)
+{
+  b.add_input<decl::Geometry>("Geometry");
+  b.add_input<decl::Float>("Density").default_value(1.0f).min(0.0f);
+  b.add_input<decl::Float>("Voxel Size").default_value(0.3f).min(0.01f).subtype(PROP_DISTANCE);
+  b.add_input<decl::Float>("Voxel Amount").default_value(64.0f).min(0.0f);
+  b.add_input<decl::Float>("Radius")
+      .default_value(0.5f)
+      .min(0.0f)
+      .subtype(PROP_DISTANCE)
+      .supports_field();
+  b.add_output<decl::Geometry>("Geometry");
+}
+
+static void geo_node_points_to_volume_layout(uiLayout *layout,
+                                             bContext *UNUSED(C),
+                                             PointerRNA *ptr)
+{
+  uiLayoutSetPropSep(layout, true);
+  uiLayoutSetPropDecorate(layout, false);
+  uiItemR(layout, ptr, "resolution_mode", 0, IFACE_("Resolution"), ICON_NONE);
+}
+
+static void geo_node_points_to_volume_init(bNodeTree *UNUSED(ntree), bNode *node)
+{
+  NodeGeometryPointsToVolume *data = (NodeGeometryPointsToVolume *)MEM_callocN(
+      sizeof(NodeGeometryPointsToVolume), __func__);
+  data->resolution_mode = GEO_NODE_POINTS_TO_VOLUME_RESOLUTION_MODE_AMOUNT;
+  node->storage = data;
+}
+
+static void geo_node_points_to_volume_update(bNodeTree *UNUSED(ntree), bNode *node)
+{
+  NodeGeometryPointsToVolume *data = (NodeGeometryPointsToVolume *)node->storage;
+  bNodeSocket *voxel_size_socket = nodeFindSocket(node, SOCK_IN, "Voxel Size");
+  bNodeSocket *voxel_amount_socket = nodeFindSocket(node, SOCK_IN, "Voxel Amount");
+  nodeSetSocketAvailability(voxel_amount_socket,
+                            data->resolution_mode ==
+                                GEO_NODE_POINTS_TO_VOLUME_RESOLUTION_MODE_AMOUNT);
+  nodeSetSocketAvailability(
+      voxel_size_socket, data->resolution_mode == GEO_NODE_POINTS_TO_VOLUME_RESOLUTION_MODE_SIZE);
+}
+
+#ifdef WITH_OPENVDB
+namespace {
+/* Implements the interface required by #openvdb::tools::ParticlesToLevelSet. */
+struct ParticleList {
+  using PosType = openvdb::Vec3R;
+
+  Span<float3> positions;
+  Span<float> radii;
+
+  size_t size() const
+  {
+    return (size_t)positions.size();
+  }
+
+  void getPos(size_t n, openvdb::Vec3R &xyz) const
+  {
+    xyz = &positions[n].x;
+  }
+
+  void getPosRad(size_t n, openvdb::Vec3R &xyz, openvdb::Real &radius) const
+  {
+    xyz = &positions[n].x;
+    radius = radii[n];
+  }
+};
+}  // namespace
+
+static openvdb::FloatGrid::Ptr generate_volume_from_points(const Span<float3> positions,
+                                                           const Span<float> radii,
+                                                           const float density)
+{
+  /* Create a new grid that will be filled. #ParticlesToLevelSet requires the background value to
+   * be positive. It will be set to zero later on. */
+  openvdb::FloatGrid::Ptr new_grid = openvdb::FloatGrid::create(1.0f);
+
+  /* Create a narrow-band level set grid based on the positions and radii. */
+  openvdb::tools::ParticlesToLevelSet op{*new_grid};
+  /* Don't ignore particles based on their radius. */
+  op.setRmin(0.0f);
+  op.setRmax(FLT_MAX);
+  ParticleList particles{positions, radii};
+  op.rasterizeSpheres(particles);
+  op.finalize();
+
+  /* Convert the level set to a fog volume. This also sets the background value to zero. Inside the
+   * fog there will be a density of 1. */
+  openvdb::tools::sdfToFogVolume(*new_grid);
+
+  /* Take the desired density into account. */
+  openvdb::tools::foreach (new_grid->beginValueOn(),
+                           [&](const openvdb::FloatGrid::ValueOnIter &iter) {
+                             iter.modifyValue([&](float &value) { value *= density; });
+                           });
+  return new_grid;
+}
+
+static float compute_voxel_size(const GeoNodeExecParams &params,
+                                Span<float3> positions,
+                                const float radius)
+{
+  const NodeGeometryPointsToVolume &storage =
+      *(const NodeGeometryPointsToVolume *)params.node().storage;
+
+  if (storage.resolution_mode == GEO_NODE_POINTS_TO_VOLUME_RESOLUTION_MODE_SIZE) {
+    return params.get_input<float>("Voxel Size");
+  }
+
+  if (positions.is_empty()) {
+    return 0.0f;
+  }
+
+  float3 min, max;
+  INIT_MINMAX(min, max);
+  minmax_v3v3_v3_array(min, max, (float(*)[3])positions.data(), positions.size());
+
+  const float voxel_amount = params.get_input<float>("Voxel Amount");
+  if (voxel_amount <= 1) {
+    return 0.0f;
+  }
+
+  /* The voxel size adapts to the final size of the volume. */
+  const float diagonal = float3::distance(min, max);
+  const float extended_diagonal = diagonal + 2.0f * radius;
+  const float voxel_size = extended_diagonal / voxel_amount;
+  return voxel_size;
+}
+
+static void gather_point_data_from_component(GeoNodeExecParams &params,
+                                             const GeometryComponent &component,
+                                             Vector<float3> &r_positions,
+                                             Vector<float> &r_radii)
+{
+  GVArray_Typed<float3> positions = component.attribute_get_for_read<float3>(
+      "position", ATTR_DOMAIN_POINT, {0, 0, 0});
+
+  Field<float> radius_field = params.get_input<Field<float>>("Radius");
+  GeometryComponentFieldContext field_context{component, ATTR_DOMAIN_POINT};
+  const int domain_size = component.attribute_domain_size(ATTR_DOMAIN_POINT);
+
+  r_positions.resize(r_positions.size() + domain_size);
+  positions->materialize(r_positions.as_mutable_span().take_back(domain_size));
+
+  r_radii.resize(r_radii.size() + domain_size);
+  fn::FieldEvaluator evaluator{field_context, domain_size};
+  evaluator.add_with_destination(radius_field, r_radii.as_mutable_span().take_back(domain_size));
+  evaluator.evaluate();
+}
+
+static void convert_to_grid_index_space(const float voxel_size,
+                                        MutableSpan<float3> positions,
+                                        MutableSpan<float> radii)
+{
+  const float voxel_size_inv = 1.0f / voxel_size;
+  for (const int i : positions.index_range()) {
+    positions[i] *= voxel_size_inv;
+    /* Better align generated grid with source points. */
+    positions[i] -= float3(0.5f);
+    radii[i] *= voxel_size_inv;
+  }
+}
+
+static void initialize_volume_component_from_points(GeoNodeExecParams &params,
+                                                    GeometrySet &r_geometry_set)
+{
+  Vector<float3> positions;
+  Vector<float> radii;
+
+  if (r_geometry_set.has<MeshComponent>()) {
+    gather_point_data_from_component(
+        params, *r_geometry_set.get_component_for_read<MeshComponent>(), positions, radii);
+  }
+  if (r_geometry_set.has<PointCloudComponent>()) {
+    gather_point_data_from_component(
+        params, *r_geometry_set.get_component_for_read<PointCloudComponent>(), positions, radii);
+  }
+  if (r_geometry_set.has<CurveComponent>()) {
+    gather_point_data_from_component(
+        params, *r_geometry_set.get_component_for_read<CurveComponent>(), positions, radii);
+  }
+
+  const float max_radius = *std::max_element(radii.begin(), radii.end());
+  const float voxel_size = compute_voxel_size(params, positions, max_radius);
+  if (voxel_size == 0.0f || positions.is_empty()) {
+    return;
+  }
+
+  Volume *volume = (Volume *)BKE_id_new_nomain(ID_VO, nullptr);
+  BKE_volume_init_grids(volume);
+
+  VolumeGrid *c_density_grid = BKE_volume_grid_add(volume, "density", VOLUME_GRID_FLOAT);
+  openvdb::FloatGrid::Ptr density_grid = openvdb::gridPtrCast<openvdb::FloatGrid>(
+      BKE_volume_grid_openvdb_for_write(volume, c_density_grid, false));
+
+  const float density = params.get_input<float>("Density");
+  convert_to_grid_index_space(voxel_size, positions, radii);
+  openvdb::FloatGrid::Ptr new_grid = generate_volume_from_points(positions, radii, density);
+  /* This merge is cheap, because the #density_grid is empty. */
+  density_grid->merge(*new_grid);
+  density_grid->transform().postScale(voxel_size);
+  r_geometry_set.keep_only({GEO_COMPONENT_TYPE_VOLUME, GEO_COMPONENT_TYPE_INSTANCES});
+  r_geometry_set.replace_volume(volume);
+}
+#endif
+
+static void geo_node_points_to_volume_exec(GeoNodeExecParams params)
+{
+  GeometrySet geometry_set = params.extract_input<GeometrySet>("Geometry");
+
+  geometry_set.modify_geometry_sets([&](GeometrySet &geometry_set) {
+#ifdef WITH_OPENVDB
+    initialize_volume_component_from_points(params, geometry_set);
+#endif
+  });
+
+  params.set_output("Geometry", std::move(geometry_set));
+}
+
+}  // namespace blender::nodes
+
+void register_node_type_geo_points_to_volume()
+{
+  static bNodeType ntype;
+
+  geo_node_type_base(
+      &ntype, GEO_NODE_POINTS_TO_VOLUME, "Points to Volume", NODE_CLASS_GEOMETRY, 0);
+  node_type_storage(&ntype,
+                    "NodeGeometryPointsToVolume",
+                    node_free_standard_storage,
+                    node_copy_standard_storage);
+  node_type_size(&ntype, 170, 120, 700);
+  node_type_init(&ntype, blender::nodes::geo_node_points_to_volume_init);
+  node_type_update(&ntype, blender::nodes::geo_node_points_to_volume_update);
+  ntype.declare = blender::nodes::geo_node_points_to_volume_declare;
+  ntype.geometry_node_execute = blender::nodes::geo_node_points_to_volume_exec;
+  ntype.draw_buttons = blender::nodes::geo_node_points_to_volume_layout;
+  nodeRegisterType(&ntype);
+}