Asset Browser: Initial Asset Catalog UI

The Asset Browser now displays a tree with asset catalogs in the left
sidebar.
This replaces the asset categories. It uses the new UI tree-view API
(https://wiki.blender.org/wiki/Source/Interface/Views#Tree-View).
Buttons are displayed for adding and removing of catalogs. Parent items
can be collapsed, but the collapsed/uncollapsed state is not stored in
files yet.
Note that edits to catalogs (e.g. new or removed catalogs) are only
written to the asset library's catalog definition files when saving a
.blend.

In the "Current File" asset library, we try to show asset catalogs from
a parent asset library, or if that fails, from the directory the file is
stored in. See adaf4f56e1ed.

There are plenty of TODOs and smaller glitches to be fixed still. Plus a
UI polishing pass should be done.

Important missing UI features:
* Dragging assets into catalogs (WIP, close to being ready).
* Renaming catalogs
* Proper handling of catalogs in the "Current File" asset library
  (currently not working well).

The "Current File" asset library is especially limited still. Since this
is the only place where you can assign assets to a catalog, this makes
the catalogs very cumbersome in general. To assign an asset to a
catalog, one has to manually copy the Catalog ID (a random hash like
number) to the asset metadata through a temporary UI in the Asset
Browser Sidebar. These limitations should be addressed over the next few
days, they are high priority.

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

1 files changed, 230 insertions, 0 deletions

diff --git a/source/blender/editors/space_file/asset_catalog_tree_view.cc b/source/blender/editors/space_file/asset_catalog_tree_view.cc
new file mode 100644
index 00000000000..7eea9af925b
--- /dev/null
+++ b/source/blender/editors/space_file/asset_catalog_tree_view.cc
@@ -0,0 +1,230 @@
+/*
+ * 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.
+ *
+ * The Original Code is Copyright (C) 2007 Blender Foundation.
+ * All rights reserved.
+ */
+
+/** \file
+ * \ingroup spfile
+ */
+
+#include "ED_fileselect.h"
+
+#include "DNA_space_types.h"
+
+#include "BKE_asset_catalog.hh"
+#include "BKE_asset_library.hh"
+
+#include "BLI_string_ref.hh"
+
+#include "BLT_translation.h"
+
+#include "RNA_access.h"
+
+#include "UI_interface.h"
+#include "UI_interface.hh"
+#include "UI_resources.h"
+#include "UI_tree_view.hh"
+
+#include "WM_api.h"
+#include "WM_types.h"
+
+#include "file_intern.h"
+
+using namespace blender;
+using namespace blender::bke;
+
+namespace blender::ed::asset_browser {
+
+class AssetCatalogTreeView : public ui::AbstractTreeView {
+  /** The asset catalog tree this tree-view represents. */
+  bke::AssetCatalogTree *catalog_tree_;
+  FileAssetSelectParams *params_;
+
+  friend class AssetCatalogTreeViewItem;
+
+ public:
+  AssetCatalogTreeView(::AssetLibrary *library, FileAssetSelectParams *params);
+
+  void build_tree() override;
+
+ private:
+  ui::BasicTreeViewItem &build_catalog_items_recursive(ui::TreeViewItemContainer &view_parent_item,
+                                                       AssetCatalogTreeItem &catalog);
+
+  void add_all_item();
+  void add_unassigned_item();
+  bool is_active_catalog(CatalogID catalog_id) const;
+};
+/* ---------------------------------------------------------------------- */
+
+class AssetCatalogTreeViewItem : public ui::BasicTreeViewItem {
+  /** The catalog tree item this tree view item represents. */
+  AssetCatalogTreeItem &catalog_item_;
+
+ public:
+  AssetCatalogTreeViewItem(AssetCatalogTreeItem *catalog_item)
+      : BasicTreeViewItem(catalog_item->get_name()), catalog_item_(*catalog_item)
+  {
+  }
+
+  void on_activate() override
+  {
+    const AssetCatalogTreeView &tree_view = static_cast<const AssetCatalogTreeView &>(
+        get_tree_view());
+    tree_view.params_->asset_catalog_visibility = FILE_SHOW_ASSETS_FROM_CATALOG;
+    tree_view.params_->catalog_id = catalog_item_.get_catalog_id();
+    WM_main_add_notifier(NC_SPACE | ND_SPACE_ASSET_PARAMS, nullptr);
+  }
+
+  void build_row(uiLayout &row) override
+  {
+    ui::BasicTreeViewItem::build_row(row);
+
+    if (!is_active()) {
+      return;
+    }
+
+    PointerRNA *props;
+    const CatalogID catalog_id = catalog_item_.get_catalog_id();
+
+    props = UI_but_extra_operator_icon_add(
+        button(), "ASSET_OT_catalog_new", WM_OP_INVOKE_DEFAULT, ICON_ADD);
+    RNA_string_set(props, "parent_path", catalog_item_.catalog_path().c_str());
+
+    /* Tree items without a catalog ID represent components of catalog paths that are not
+     * associated with an actual catalog. They exist merely by the presence of a child catalog, and
+     * thus cannot be deleted themselves. */
+    if (!BLI_uuid_is_nil(catalog_id)) {
+      char catalog_id_str_buffer[UUID_STRING_LEN] = "";
+      BLI_uuid_format(catalog_id_str_buffer, catalog_id);
+
+      props = UI_but_extra_operator_icon_add(
+          button(), "ASSET_OT_catalog_delete", WM_OP_INVOKE_DEFAULT, ICON_X);
+      RNA_string_set(props, "catalog_id", catalog_id_str_buffer);
+    }
+  }
+};
+
+/** Only reason this isn't just `BasicTreeViewItem` is to add a '+' icon for adding a root level
+ * catalog. */
+class AssetCatalogTreeViewAllItem : public ui::BasicTreeViewItem {
+  using BasicTreeViewItem::BasicTreeViewItem;
+
+  void build_row(uiLayout &row) override
+  {
+    ui::BasicTreeViewItem::build_row(row);
+
+    if (!is_active()) {
+      return;
+    }
+
+    PointerRNA *props;
+    props = UI_but_extra_operator_icon_add(
+        button(), "ASSET_OT_catalog_new", WM_OP_INVOKE_DEFAULT, ICON_ADD);
+    /* No parent path to use the root level. */
+    RNA_string_set(props, "parent_path", nullptr);
+  }
+};
+
+AssetCatalogTreeView::AssetCatalogTreeView(::AssetLibrary *library, FileAssetSelectParams *params)
+    : catalog_tree_(BKE_asset_library_get_catalog_tree(library)), params_(params)
+{
+}
+
+void AssetCatalogTreeView::build_tree()
+{
+  add_all_item();
+
+  if (catalog_tree_) {
+    catalog_tree_->foreach_root_item([this](AssetCatalogTreeItem &item) {
+      ui::BasicTreeViewItem &child_view_item = build_catalog_items_recursive(*this, item);
+
+      /* Open root-level items by default. */
+      child_view_item.set_collapsed(false);
+    });
+  }
+
+  add_unassigned_item();
+}
+
+ui::BasicTreeViewItem &AssetCatalogTreeView::build_catalog_items_recursive(
+    ui::TreeViewItemContainer &view_parent_item, AssetCatalogTreeItem &catalog)
+{
+  ui::BasicTreeViewItem &view_item = view_parent_item.add_tree_item<AssetCatalogTreeViewItem>(
+      &catalog);
+  if (is_active_catalog(catalog.get_catalog_id())) {
+    view_item.set_active();
+  }
+
+  catalog.foreach_child([&view_item, this](AssetCatalogTreeItem &child) {
+    build_catalog_items_recursive(view_item, child);
+  });
+  return view_item;
+}
+
+void AssetCatalogTreeView::add_all_item()
+{
+  FileAssetSelectParams *params = params_;
+
+  ui::AbstractTreeViewItem &item = add_tree_item<AssetCatalogTreeViewAllItem>(
+      IFACE_("All"), ICON_HOME, [params](ui::BasicTreeViewItem & /*item*/) {
+        params->asset_catalog_visibility = FILE_SHOW_ASSETS_ALL_CATALOGS;
+        WM_main_add_notifier(NC_SPACE | ND_SPACE_ASSET_PARAMS, nullptr);
+      });
+  if (params->asset_catalog_visibility == FILE_SHOW_ASSETS_ALL_CATALOGS) {
+    item.set_active();
+  }
+}
+
+void AssetCatalogTreeView::add_unassigned_item()
+{
+  FileAssetSelectParams *params = params_;
+
+  ui::AbstractTreeViewItem &item = add_tree_item<ui::BasicTreeViewItem>(
+      IFACE_("Unassigned"), ICON_FILE_HIDDEN, [params](ui::BasicTreeViewItem & /*item*/) {
+        params->asset_catalog_visibility = FILE_SHOW_ASSETS_WITHOUT_CATALOG;
+        WM_main_add_notifier(NC_SPACE | ND_SPACE_ASSET_PARAMS, nullptr);
+      });
+  if (params->asset_catalog_visibility == FILE_SHOW_ASSETS_WITHOUT_CATALOG) {
+    item.set_active();
+  }
+}
+
+bool AssetCatalogTreeView::is_active_catalog(CatalogID catalog_id) const
+{
+  return (params_->asset_catalog_visibility == FILE_SHOW_ASSETS_FROM_CATALOG) &&
+         (params_->catalog_id == catalog_id);
+}
+
+}  // namespace blender::ed::asset_browser
+
+/* ---------------------------------------------------------------------- */
+
+void file_create_asset_catalog_tree_view_in_layout(::AssetLibrary *asset_library,
+                                                   uiLayout *layout,
+                                                   FileAssetSelectParams *params)
+{
+  uiBlock *block = uiLayoutGetBlock(layout);
+
+  ui::AbstractTreeView *tree_view = UI_block_add_view(
+      *block,
+      "asset catalog tree view",
+      std::make_unique<ed::asset_browser::AssetCatalogTreeView>(asset_library, params));
+
+  ui::TreeViewBuilder builder(*block);
+  builder.build_tree_view(*tree_view);
+}