AS_asset_library.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <memory>
#include <mutex>
 
#include "AS_asset_catalog.hh"
 
#include "DNA_asset_types.h"
 
#include "BLI_set.hh"
#include "BLI_string_ref.hh"
#include "BLI_vector.hh"
 
#include "BKE_callbacks.hh"
 
struct Main;
 
namespace blender::bke::id {
class IDRemapper;
}
 
namespace blender::asset_system {
 
class AssetRepresentation;
 
class AssetLibrary {
  eAssetLibraryType library_type_;
  std::string name_;
  std::shared_ptr<std::string> root_path_;
 
  struct AssetStorage {
    /* Uses shared pointers so the UI can acquire weak pointers. It can then ensure pointers are
     * not dangling before accessing. */
 
    Set<std::shared_ptr<AssetRepresentation>> external_assets;
    /* Store local ID assets separately for efficient lookups.
     * TODO(Julian): A [ID *, asset] or even [ID.session_uid, asset] map would be preferable for
     * faster lookups. Not possible until each asset is only represented once in the storage. */
    Set<std::shared_ptr<AssetRepresentation>> local_id_assets;
  };
  AssetStorage asset_storage_;
 
 protected:
  /* Changing this pointer should be protected using #catalog_service_mutex_. Note that changes
   * within the catalog service may still happen without the mutex being locked. They should be
   * protected separately. */
  std::unique_ptr<AssetCatalogService> catalog_service_;
  std::mutex catalog_service_mutex_;
 
  std::optional<eAssetImportMethod> import_method_;
  bool may_override_import_method_ = false;
 
  bool use_relative_path_ = true;
 
  bCallbackFuncStore on_save_callback_store_{};
 
 public:
  /* Controlled by #ed::asset::catalogs_set_save_catalogs_when_file_is_saved,
   * for managing the "Save Catalog Changes" in the quit-confirmation dialog box. */
  static bool save_catalogs_when_file_is_saved;
 
  friend class AssetLibraryService;
  friend class AssetRepresentation;
 
 public:
  AssetLibrary(eAssetLibraryType library_type, StringRef name = "", StringRef root_path = "");
  virtual ~AssetLibrary();
 
  static void foreach_loaded(FunctionRef<void(AssetLibrary &)> fn, bool include_all_library);
 
  void load_catalogs();
 
  AssetCatalogService &catalog_service() const;
 
  std::weak_ptr<AssetRepresentation> add_external_asset(StringRef relative_asset_path,
                                                        StringRef name,
                                                        int id_type,
                                                        std::unique_ptr<AssetMetaData> metadata);
  std::weak_ptr<AssetRepresentation> add_local_id_asset(StringRef relative_asset_path, ID &id);
  bool remove_asset(AssetRepresentation &asset);
 
  void remap_ids_and_remove_invalid(const blender::bke::id::IDRemapper &mappings);
 
  void refresh_catalog_simplename(AssetMetaData *asset_data);
 
  void on_blend_save_handler_register();
  void on_blend_save_handler_unregister();
 
  void on_blend_save_post(Main *bmain, PointerRNA **pointers, int num_pointers);
 
  std::string resolve_asset_weak_reference_to_full_path(const AssetWeakReference &asset_reference);
 
  eAssetLibraryType library_type() const;
  StringRefNull name() const;
  StringRefNull root_path() const;
 
 protected:
  virtual void refresh_catalogs();
};
 
Vector<AssetLibraryReference> all_valid_asset_library_refs();
 
AssetLibraryReference all_library_reference();
void all_library_reload_catalogs_if_dirty();
 
}  // namespace blender::asset_system
 
blender::asset_system::AssetLibrary *AS_asset_library_load(
    const Main *bmain, const AssetLibraryReference &library_reference);
 
std::string AS_asset_library_root_path_from_library_ref(
    const AssetLibraryReference &library_reference);
 
std::string AS_asset_library_find_suitable_root_path_from_path(blender::StringRefNull input_path);
 
std::string AS_asset_library_find_suitable_root_path_from_main(const Main *bmain);
 
void AS_asset_libraries_exit();
 
blender::asset_system::AssetLibrary *AS_asset_library_load(const char *name,
                                                           const char *library_dirpath);
 
bool AS_asset_library_has_any_unsaved_catalogs();
 
void AS_asset_library_remap_ids(const blender::bke::id::IDRemapper &mappings);
 
void AS_asset_full_path_explode_from_weak_ref(const AssetWeakReference *asset_reference,
                                              char r_path_buffer[1090 /* FILE_MAX_LIBEXTRA */],
                                              char **r_dir,
                                              char **r_group,
                                              char **r_name);