Spreadsheet: support showing data of specific node

Previously, the spreadsheet editor could only show data of the original
and of the final evaluated object. Now it is possible to show the data
at some intermediate stages too.

For that the mode has to be set to "Node" in the spreadsheet editor.
Furthermore, the preview of a specific node has to be activated by
clicking the new icon in the header of geometry nodes.

The exact ui of this feature might be refined in upcoming commits.
It is already very useful for debugging node groups in it's current
state though.

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

4 files changed, 75 insertions, 0 deletions

diff --git a/source/blender/editors/space_node/node_draw.cc b/source/blender/editors/space_node/node_draw.cc
index 07a5dbe1d7b..88234c861a0 100644
--- a/source/blender/editors/space_node/node_draw.cc
+++ b/source/blender/editors/space_node/node_draw.cc
@@ -1404,6 +1404,28 @@ static void node_draw_basis(const bContext *C,
                  "");
     UI_block_emboss_set(node->block, UI_EMBOSS);
   }
+  if (ntree->type == NTREE_GEOMETRY) {
+    /* Active preview toggle. */
+    iconofs -= iconbutw;
+    UI_block_emboss_set(node->block, UI_EMBOSS_NONE);
+    int icon = (node->flag & NODE_ACTIVE_PREVIEW) ? ICON_RESTRICT_VIEW_OFF : ICON_RESTRICT_VIEW_ON;
+    uiBut *but = uiDefIconBut(node->block,
+                              UI_BTYPE_BUT_TOGGLE,
+                              0,
+                              icon,
+                              iconofs,
+                              rct->ymax - NODE_DY,
+                              iconbutw,
+                              UI_UNIT_Y,
+                              nullptr,
+                              0,
+                              0,
+                              0,
+                              0,
+                              "Show this node's geometry output in the spreadsheet in Node mode");
+    UI_but_func_set(but, node_toggle_button_cb, node, (void *)"NODE_OT_active_preview_toggle");
+    UI_block_emboss_set(node->block, UI_EMBOSS);
+  }
 
   node_add_error_message_button(C, *ntree, *node, *rct, iconofs);
 
diff --git a/source/blender/editors/space_node/node_edit.c b/source/blender/editors/space_node/node_edit.c
index 8fdee01f78e..518f5639c93 100644
--- a/source/blender/editors/space_node/node_edit.c
+++ b/source/blender/editors/space_node/node_edit.c
@@ -41,6 +41,7 @@
 #include "BKE_node.h"
 #include "BKE_report.h"
 #include "BKE_scene.h"
+#include "BKE_workspace.h"
 
 #include "DEG_depsgraph.h"
 #include "DEG_depsgraph_build.h"
@@ -1316,6 +1317,7 @@ static int node_duplicate_exec(bContext *C, wmOperator *op)
       nodeSetSelected(node, false);
       node->flag &= ~(NODE_ACTIVE | NODE_ACTIVE_TEXTURE);
       nodeSetSelected(newnode, true);
+      newnode->flag &= ~NODE_ACTIVE_PREVIEW;
 
       do_tag_update |= (do_tag_update || node_connected_to_output(bmain, ntree, newnode));
     }
@@ -1692,6 +1694,55 @@ void NODE_OT_hide_socket_toggle(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
+static void disable_active_preview_on_all_nodes(bNodeTree *ntree)
+{
+  LISTBASE_FOREACH (bNode *, node, &ntree->nodes) {
+    node->flag &= ~NODE_ACTIVE_PREVIEW;
+  }
+}
+
+static int node_active_preview_toggle_exec(bContext *C, wmOperator *UNUSED(op))
+{
+  SpaceNode *snode = CTX_wm_space_node(C);
+  Main *bmain = CTX_data_main(C);
+  bNodeTree *ntree = snode->edittree;
+  disable_active_preview_on_all_nodes(ntree);
+  bNode *active_node = nodeGetActive(ntree);
+  active_node->flag |= NODE_ACTIVE_PREVIEW;
+
+  /* Tag for update, so that dependent objects are reevaluated. This is necessary when a
+   * spreadsheet editor displays data from a node. */
+  LISTBASE_FOREACH (wmWindow *, window, &((wmWindowManager *)bmain->wm.first)->windows) {
+    bScreen *screen = BKE_workspace_active_screen_get(window->workspace_hook);
+    LISTBASE_FOREACH (ScrArea *, area, &screen->areabase) {
+      if (area->spacetype == SPACE_SPREADSHEET) {
+        SpaceSpreadsheet *sspreadsheet = area->spacedata.first;
+        if (sspreadsheet->object_eval_state == SPREADSHEET_OBJECT_EVAL_STATE_NODE) {
+          DEG_id_tag_update(&ntree->id, ID_RECALC_COPY_ON_WRITE);
+          ED_area_tag_redraw(area);
+        }
+      }
+    }
+  }
+
+  return OPERATOR_FINISHED;
+}
+
+void NODE_OT_active_preview_toggle(wmOperatorType *ot)
+{
+  /* identifiers */
+  ot->name = "Toggle Active Preview";
+  ot->description = "Toggle active preview state of node";
+  ot->idname = "NODE_OT_active_preview_toggle";
+
+  /* callbacks */
+  ot->exec = node_active_preview_toggle_exec;
+  ot->poll = ED_operator_node_active;
+
+  /* flags */
+  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
+}
+
 /* ****************** Mute operator *********************** */
 
 static int node_mute_exec(bContext *C, wmOperator *UNUSED(op))
diff --git a/source/blender/editors/space_node/node_intern.h b/source/blender/editors/space_node/node_intern.h
index c0952cbaa42..6f281ee05cc 100644
--- a/source/blender/editors/space_node/node_intern.h
+++ b/source/blender/editors/space_node/node_intern.h
@@ -273,6 +273,7 @@ void NODE_OT_hide_toggle(struct wmOperatorType *ot);
 void NODE_OT_hide_socket_toggle(struct wmOperatorType *ot);
 void NODE_OT_preview_toggle(struct wmOperatorType *ot);
 void NODE_OT_options_toggle(struct wmOperatorType *ot);
+void NODE_OT_active_preview_toggle(struct wmOperatorType *ot);
 void NODE_OT_node_copy_color(struct wmOperatorType *ot);
 
 void NODE_OT_read_viewlayers(struct wmOperatorType *ot);
diff --git a/source/blender/editors/space_node/node_ops.c b/source/blender/editors/space_node/node_ops.c
index e35b444aa11..4168ff2922d 100644
--- a/source/blender/editors/space_node/node_ops.c
+++ b/source/blender/editors/space_node/node_ops.c
@@ -57,6 +57,7 @@ void node_operatortypes(void)
   WM_operatortype_append(NODE_OT_preview_toggle);
   WM_operatortype_append(NODE_OT_options_toggle);
   WM_operatortype_append(NODE_OT_hide_socket_toggle);
+  WM_operatortype_append(NODE_OT_active_preview_toggle);
   WM_operatortype_append(NODE_OT_node_copy_color);
 
   WM_operatortype_append(NODE_OT_duplicate);