Spreadsheet: Display geometry volume component grids

This shows a geometry's volume grids in the spreadsheet.
Three columns are displayed:
 - Name: The text name of each grid
 - Data type: Float, Vector, etc.
 - Class: Fog volume, Level Set, or unkown

In the future, values of the voxels themselves could be displayed,
but that is a much more complex problem, with important performance
implications, etc.

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

1 files changed, 95 insertions, 0 deletions

diff --git a/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc b/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc
index c1d345d1861..04784dc3e2b 100644
--- a/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc
+++ b/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc
@@ -20,6 +20,7 @@
 #include "BKE_mesh.h"
 #include "BKE_mesh_wrapper.h"
 #include "BKE_modifier.h"
+#include "BKE_volume.h"
 
 #include "DNA_ID.h"
 #include "DNA_mesh_types.h"
@@ -33,6 +34,11 @@
 
 #include "NOD_geometry_nodes_eval_log.hh"
 
+#include "BLT_translation.h"
+
+#include "RNA_access.h"
+#include "RNA_enum_types.h"
+
 #include "FN_field_cpp_type.hh"
 
 #include "bmesh.h"
@@ -112,6 +118,9 @@ std::unique_ptr<ColumnValues> ExtraColumns::get_column_values(
                                            r_cell_value.value_color = *(
                                                const ColorGeometry4f *)value;
                                            break;
+                                         case SPREADSHEET_VALUE_TYPE_STRING:
+                                           r_cell_value.value_string = *(const std::string *)value;
+                                           break;
                                          case SPREADSHEET_VALUE_TYPE_INSTANCES:
                                            break;
                                        }
@@ -487,6 +496,89 @@ int InstancesDataSource::tot_rows() const
   return component_->instances_amount();
 }
 
+void VolumeDataSource::foreach_default_column_ids(
+    FunctionRef<void(const SpreadsheetColumnID &, bool is_extra)> fn) const
+{
+  if (component_->is_empty()) {
+    return;
+  }
+
+  for (const char *name : {"Grid Name", "Data Type", "Class"}) {
+    SpreadsheetColumnID column_id{(char *)name};
+    fn(column_id, false);
+  }
+}
+
+std::unique_ptr<ColumnValues> VolumeDataSource::get_column_values(
+    const SpreadsheetColumnID &column_id) const
+{
+  const Volume *volume = component_->get_for_read();
+  if (volume == nullptr) {
+    return {};
+  }
+
+#ifdef WITH_OPENVDB
+  const int size = this->tot_rows();
+  if (STREQ(column_id.name, "Grid Name")) {
+    return column_values_from_function(
+        SPREADSHEET_VALUE_TYPE_STRING,
+        IFACE_("Grid Name"),
+        size,
+        [volume](int index, CellValue &r_cell_value) {
+          const VolumeGrid *volume_grid = BKE_volume_grid_get_for_read(volume, index);
+          r_cell_value.value_string = BKE_volume_grid_name(volume_grid);
+        },
+        6.0f);
+  }
+  if (STREQ(column_id.name, "Data Type")) {
+    return column_values_from_function(
+        SPREADSHEET_VALUE_TYPE_STRING,
+        IFACE_("Type"),
+        size,
+        [volume](int index, CellValue &r_cell_value) {
+          const VolumeGrid *volume_grid = BKE_volume_grid_get_for_read(volume, index);
+          const VolumeGridType type = BKE_volume_grid_type(volume_grid);
+          const char *name = nullptr;
+          RNA_enum_name_from_value(rna_enum_volume_grid_data_type_items, type, &name);
+          r_cell_value.value_string = IFACE_(name);
+        },
+        5.0f);
+  }
+  if (STREQ(column_id.name, "Class")) {
+    return column_values_from_function(
+        SPREADSHEET_VALUE_TYPE_STRING,
+        IFACE_("Class"),
+        size,
+        [volume](int index, CellValue &r_cell_value) {
+          const VolumeGrid *volume_grid = BKE_volume_grid_get_for_read(volume, index);
+          openvdb::GridBase::ConstPtr grid = BKE_volume_grid_openvdb_for_read(volume, volume_grid);
+          openvdb::GridClass grid_class = grid->getGridClass();
+          if (grid_class == openvdb::GridClass::GRID_FOG_VOLUME) {
+            r_cell_value.value_string = IFACE_("Fog Volume");
+          }
+          else if (grid_class == openvdb::GridClass::GRID_LEVEL_SET) {
+            r_cell_value.value_string = IFACE_("Level Set");
+          }
+          else {
+            r_cell_value.value_string = IFACE_("Unkown");
+          }
+        },
+        5.0f);
+  }
+#endif
+
+  return {};
+}
+
+int VolumeDataSource::tot_rows() const
+{
+  const Volume *volume = component_->get_for_read();
+  if (volume == nullptr) {
+    return 0;
+  }
+  return BKE_volume_num_grids(volume);
+}
+
 GeometrySet spreadsheet_get_display_geometry_set(const SpaceSpreadsheet *sspreadsheet,
                                                  Object *object_eval,
                                                  const GeometryComponentType used_component_type)
@@ -682,6 +774,9 @@ std::unique_ptr<DataSource> data_source_from_geometry(const bContext *C, Object
   if (component_type == GEO_COMPONENT_TYPE_INSTANCES) {
     return std::make_unique<InstancesDataSource>(geometry_set, std::move(extra_columns));
   }
+  if (component_type == GEO_COMPONENT_TYPE_VOLUME) {
+    return std::make_unique<VolumeDataSource>(geometry_set);
+  }
   return std::make_unique<GeometryDataSource>(
       object_eval, geometry_set, component_type, domain, std::move(extra_columns));
 }