ED_asset_catalog.hh File Reference

#include <optional>
#include "AS_asset_catalog.hh"
#include "BLI_string_ref.hh"

Go to the source code of this file.

Namespaces
namespace	blender
namespace	blender::asset_system
namespace	blender::ed
namespace	blender::ed::asset

Functions
void	blender::ed::asset::catalogs_save_from_main_path (asset_system::AssetLibrary *library, const Main *bmain)
void	blender::ed::asset::catalogs_save_from_asset_reference (asset_system::AssetLibrary &library, const AssetWeakReference &reference)
void	blender::ed::asset::catalogs_set_save_catalogs_when_file_is_saved (bool should_save)
bool	blender::ed::asset::catalogs_get_save_catalogs_when_file_is_saved ()
bool	blender::ed::asset::catalogs_read_only (const asset_system::AssetLibrary &library)
asset_system::AssetCatalog *	blender::ed::asset::catalog_add (asset_system::AssetLibrary *library, StringRefNull name, StringRef parent_path=nullptr)
void	blender::ed::asset::catalog_remove (asset_system::AssetLibrary *library, const asset_system::CatalogID &catalog_id)
void	blender::ed::asset::catalog_rename (asset_system::AssetLibrary *library, asset_system::CatalogID catalog_id, StringRefNull new_name)
void	blender::ed::asset::catalog_move (asset_system::AssetLibrary *library, asset_system::CatalogID src_catalog_id, std::optional< asset_system::CatalogID > dst_parent_catalog_id=std::nullopt)

Detailed Description

UI/Editor level API for catalog operations, creating richer functionality than the asset system catalog API provides (which this uses internally).

Functions can be expected to not perform any change when #catalogs_read_only() returns true. Generally UI code should disable such functionality in this case, so these functions are not called at all.

Note that ED_asset_catalog.hh is part of this API.

Definition in file ED_asset_catalog.hh.