Spreadsheet: breadcrumbs and node pinning

This introduces a context path to the spreadsheet editor, which contains
information about what data is shown in the spreadsheet. The context
path (breadcrumbs) can reference a specific node in a node group
hierarchy. During object evaluation, the geometry nodes modifier checks
what data is currently requested by visible spreadsheets and stores
the corresponding geometry sets separately for later access.

The context path can be updated by the user explicitely, by clicking
on the new icon in the header of nodes. Under some circumstances,
the context path is updated automatically based on Blender's context.

This patch also consolidates the "Node" and "Final" object evaluation
mode to just "Evaluated". Based on the current context path, either
the final geometry set of an object will be displayed, or the data at
a specific node.

The new preview icon in geometry nodes now behaves more like
a toggle. It can be clicked again to clear the context path in an
open spreadsheet editor.

Previously, only an object could be pinned in the spreadsheet editor.
Now it is possible to pin the entire context path. That allows two
different spreadsheets to display geometry data from two different
nodes.

The breadcrumbs in the spreadsheet header can be collapsed by
clicking on the arrow icons. It's not ideal but works well for now.
This might be changed again, if we get a data set region on the left.

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

1 files changed, 107 insertions, 9 deletions

diff --git a/source/blender/editors/space_spreadsheet/space_spreadsheet.cc b/source/blender/editors/space_spreadsheet/space_spreadsheet.cc
index 9d79e7abcc5..7122725ad45 100644
--- a/source/blender/editors/space_spreadsheet/space_spreadsheet.cc
+++ b/source/blender/editors/space_spreadsheet/space_spreadsheet.cc
@@ -22,6 +22,7 @@
 
 #include "ED_screen.h"
 #include "ED_space_api.h"
+#include "ED_spreadsheet.h"
 
 #include "DNA_scene_types.h"
 #include "DNA_screen_types.h"
@@ -44,6 +45,7 @@
 
 #include "spreadsheet_intern.hh"
 
+#include "spreadsheet_breadcrumb.hh"
 #include "spreadsheet_data_source_geometry.hh"
 #include "spreadsheet_intern.hh"
 #include "spreadsheet_layout.hh"
@@ -91,6 +93,9 @@ static void spreadsheet_free(SpaceLink *sl)
   LISTBASE_FOREACH_MUTABLE (SpreadsheetColumn *, column, &sspreadsheet->columns) {
     spreadsheet_column_free(column);
   }
+  LISTBASE_FOREACH_MUTABLE (SpreadsheetContext *, context, &sspreadsheet->context_path) {
+    spreadsheet_context_free(context);
+  }
 }
 
 static void spreadsheet_init(wmWindowManager *UNUSED(wm), ScrArea *area)
@@ -100,10 +105,6 @@ static void spreadsheet_init(wmWindowManager *UNUSED(wm), ScrArea *area)
     sspreadsheet->runtime = (SpaceSpreadsheet_Runtime *)MEM_callocN(
         sizeof(SpaceSpreadsheet_Runtime), __func__);
   }
-  LISTBASE_FOREACH_MUTABLE (SpreadsheetColumn *, column, &sspreadsheet->columns) {
-    spreadsheet_column_free(column);
-  }
-  BLI_listbase_clear(&sspreadsheet->columns);
 }
 
 static SpaceLink *spreadsheet_duplicate(SpaceLink *sl)
@@ -118,6 +119,12 @@ static SpaceLink *spreadsheet_duplicate(SpaceLink *sl)
     BLI_addtail(&sspreadsheet_new->columns, new_column);
   }
 
+  BLI_listbase_clear(&sspreadsheet_new->context_path);
+  LISTBASE_FOREACH_MUTABLE (SpreadsheetContext *, src_context, &sspreadsheet_old->context_path) {
+    SpreadsheetContext *new_context = spreadsheet_context_copy(src_context);
+    BLI_addtail(&sspreadsheet_new->context_path, new_context);
+  }
+
   return (SpaceLink *)sspreadsheet_new;
 }
 
@@ -125,6 +132,24 @@ static void spreadsheet_keymap(wmKeyConfig *UNUSED(keyconf))
 {
 }
 
+static void spreadsheet_id_remap(ScrArea *UNUSED(area), SpaceLink *slink, ID *old_id, ID *new_id)
+{
+  SpaceSpreadsheet *sspreadsheet = (SpaceSpreadsheet *)slink;
+  LISTBASE_FOREACH (SpreadsheetContext *, context, &sspreadsheet->context_path) {
+    if (context->type == SPREADSHEET_CONTEXT_OBJECT) {
+      SpreadsheetContextObject *object_context = (SpreadsheetContextObject *)context;
+      if ((ID *)object_context->object == old_id) {
+        if (new_id && GS(new_id->name) == ID_OB) {
+          object_context->object = (Object *)new_id;
+        }
+        else {
+          object_context->object = nullptr;
+        }
+      }
+    }
+  }
+}
+
 static void spreadsheet_main_region_init(wmWindowManager *wm, ARegion *region)
 {
   region->v2d.scroll = V2D_SCROLL_RIGHT | V2D_SCROLL_BOTTOM;
@@ -139,20 +164,90 @@ static void spreadsheet_main_region_init(wmWindowManager *wm, ARegion *region)
   WM_event_add_keymap_handler(&region->handlers, keymap);
 }
 
-static ID *get_used_id(const bContext *C)
+ID *ED_spreadsheet_get_current_id(struct SpaceSpreadsheet *sspreadsheet)
+{
+  if (BLI_listbase_is_empty(&sspreadsheet->context_path)) {
+    return nullptr;
+  }
+  SpreadsheetContext *root_context = (SpreadsheetContext *)sspreadsheet->context_path.first;
+  if (root_context->type != SPREADSHEET_CONTEXT_OBJECT) {
+    return nullptr;
+  }
+  SpreadsheetContextObject *object_context = (SpreadsheetContextObject *)root_context;
+  return (ID *)object_context->object;
+}
+
+/* Check if the pinned context still exists. If it doesn't try to find a new context. */
+static void update_pinned_context_path_if_outdated(const bContext *C)
 {
   SpaceSpreadsheet *sspreadsheet = CTX_wm_space_spreadsheet(C);
-  if (sspreadsheet->pinned_id != nullptr) {
-    return sspreadsheet->pinned_id;
+
+  /* Currently, this only checks if the object has been deleted. In the future we can have a more
+   * sophisticated check for the entire context (including modifier and nodes). */
+  LISTBASE_FOREACH (SpreadsheetContext *, context, &sspreadsheet->context_path) {
+    if (context->type == SPREADSHEET_CONTEXT_OBJECT) {
+      SpreadsheetContextObject *object_context = (SpreadsheetContextObject *)context;
+      if (object_context->object == nullptr) {
+        ED_spreadsheet_context_path_clear(sspreadsheet);
+        break;
+      }
+    }
+  }
+  if (BLI_listbase_is_empty(&sspreadsheet->context_path)) {
+    Object *active_object = CTX_data_active_object(C);
+    if (active_object != nullptr) {
+      SpreadsheetContext *new_context = spreadsheet_context_new(SPREADSHEET_CONTEXT_OBJECT);
+      ((SpreadsheetContextObject *)new_context)->object = active_object;
+      BLI_addtail(&sspreadsheet->context_path, new_context);
+    }
   }
+
+  if (BLI_listbase_is_empty(&sspreadsheet->context_path)) {
+    /* Don't pin empty context_path, that could be annoying. */
+    sspreadsheet->flag &= ~SPREADSHEET_FLAG_PINNED;
+  }
+}
+
+static void update_context_path_from_context(const bContext *C)
+{
+  SpaceSpreadsheet *sspreadsheet = CTX_wm_space_spreadsheet(C);
   Object *active_object = CTX_data_active_object(C);
-  return (ID *)active_object;
+  if (active_object == nullptr) {
+    ED_spreadsheet_context_path_clear(sspreadsheet);
+    return;
+  }
+  if (!BLI_listbase_is_empty(&sspreadsheet->context_path)) {
+    SpreadsheetContext *root_context = (SpreadsheetContext *)sspreadsheet->context_path.first;
+    if (root_context->type == SPREADSHEET_CONTEXT_OBJECT) {
+      SpreadsheetContextObject *object_context = (SpreadsheetContextObject *)root_context;
+      if (object_context->object != active_object) {
+        ED_spreadsheet_context_path_clear(sspreadsheet);
+      }
+    }
+  }
+  if (BLI_listbase_is_empty(&sspreadsheet->context_path)) {
+    SpreadsheetContext *new_context = spreadsheet_context_new(SPREADSHEET_CONTEXT_OBJECT);
+    ((SpreadsheetContextObject *)new_context)->object = active_object;
+    BLI_addtail(&sspreadsheet->context_path, new_context);
+  }
+}
+
+static void update_context_path(const bContext *C)
+{
+  SpaceSpreadsheet *sspreadsheet = CTX_wm_space_spreadsheet(C);
+  if (sspreadsheet->flag & SPREADSHEET_FLAG_PINNED) {
+    update_pinned_context_path_if_outdated(C);
+  }
+  else {
+    update_context_path_from_context(C);
+  }
 }
 
 static std::unique_ptr<DataSource> get_data_source(const bContext *C)
 {
   Depsgraph *depsgraph = CTX_data_depsgraph_pointer(C);
-  ID *used_id = get_used_id(C);
+  SpaceSpreadsheet *sspreadsheet = CTX_wm_space_spreadsheet(C);
+  ID *used_id = ED_spreadsheet_get_current_id(sspreadsheet);
   if (used_id == nullptr) {
     return {};
   }
@@ -227,6 +322,7 @@ static void update_visible_columns(ListBase &columns, DataSource &data_source)
 static void spreadsheet_main_region_draw(const bContext *C, ARegion *region)
 {
   SpaceSpreadsheet *sspreadsheet = CTX_wm_space_spreadsheet(C);
+  update_context_path(C);
 
   std::unique_ptr<DataSource> data_source = get_data_source(C);
   if (!data_source) {
@@ -317,6 +413,7 @@ static void spreadsheet_header_region_init(wmWindowManager *UNUSED(wm), ARegion
 
 static void spreadsheet_header_region_draw(const bContext *C, ARegion *region)
 {
+  update_context_path(C);
   ED_region_header(C, region);
 }
 
@@ -422,6 +519,7 @@ void ED_spacetype_spreadsheet(void)
   st->duplicate = spreadsheet_duplicate;
   st->operatortypes = spreadsheet_operatortypes;
   st->keymap = spreadsheet_keymap;
+  st->id_remap = spreadsheet_id_remap;
 
   /* regions: main window */
   art = (ARegionType *)MEM_callocN(sizeof(ARegionType), "spacetype spreadsheet region");