#include <AS_asset_library.hh>

Inherited by blender::asset_system::AllAssetLibrary, blender::asset_system::OnDiskAssetLibrary, and blender::asset_system::RuntimeAssetLibrary.

Public Member Functions
	AssetLibrary (eAssetLibraryType library_type, StringRef name="", StringRef root_path="")
virtual	~AssetLibrary ()
virtual std::optional< AssetLibraryReference >	library_reference () const =0
void	load_or_reload_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 (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

Static Public Member Functions
static void	foreach_loaded (FunctionRef< void(AssetLibrary &)> fn, bool include_all_library)

Static Public Attributes
static bool	save_catalogs_when_file_is_saved = true

Protected Member Functions
virtual void	refresh_catalogs ()

Protected Attributes
std::unique_ptr< AssetCatalogService >	catalog_service_
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_ {}

Friends
class	AssetLibraryService
class	AssetRepresentation

Detailed Description

AssetLibrary provides access to an asset library's data.

The asset library contains catalogs and storage for asset representations. It could be extended to also include asset indexes and more.

Definition at line 41 of file AS_asset_library.hh.

Constructor & Destructor Documentation

◆ AssetLibrary()

blender::asset_system::AssetLibrary::AssetLibrary	(	eAssetLibraryType	library_type,
		StringRef	name = "",
		StringRef	root_path = "" )

Parameters

name	The name this asset library will be displayed in the UI as. Will also be used as a weak way to identify an asset library (e.g. by AssetWeakReference). Make sure this is set for any custom (not builtin) asset library. That is, ASSET_LIBRARY_CUSTOM ones.
root_path	If this is an asset library on disk, the top-level directory path.

Definition at line 230 of file asset_library.cc.

References catalog_service_, library_type(), name(), and root_path().

Referenced by blender::asset_system::AllAssetLibrary::AllAssetLibrary(), AssetRepresentation, foreach_loaded(), blender::asset_system::OnDiskAssetLibrary::OnDiskAssetLibrary(), blender::asset_system::AllAssetLibrary::rebuild_catalogs_from_nested(), and blender::asset_system::RuntimeAssetLibrary::RuntimeAssetLibrary().

◆ ~AssetLibrary()

blender::asset_system::AssetLibrary::~AssetLibrary ( )

virtual

Definition at line 238 of file asset_library.cc.

References on_blend_save_handler_unregister(), and on_save_callback_store_.

Member Function Documentation

◆ add_external_asset()

std::weak_ptr< AssetRepresentation > blender::asset_system::AssetLibrary::add_external_asset	(	StringRef	relative_asset_path,
		StringRef	name,
		int	id_type,
		std::unique_ptr< AssetMetaData >	metadata )

Create a representation of an asset to be considered part of this library. Once the representation is not needed anymore, it must be freed using remove_asset(), or there will be leaking that's only cleared when the library storage is destructed (typically on exit or loading a different file).

Parameters

relative_asset_path The path of the asset relative to the asset library root. With this the asset must be uniquely identifiable within the asset library.

Returns: A weak pointer to the new asset representation. The caller needs to keep some reference stored to be able to call remove_asset(). This would be dangling once the asset library is destructed, so a weak pointer should be used to reference it.

Definition at line 281 of file asset_library.cc.

References name().

Referenced by blender::asset_system::tests::AssetRepresentationTest::add_dummy_asset(), and filelist_readjob_list_lib_add_datablock().

◆ add_local_id_asset()

std::weak_ptr< AssetRepresentation > blender::asset_system::AssetLibrary::add_local_id_asset ( ID & id )

See #AssetLibrary::add_external_asset().

Definition at line 291 of file asset_library.cc.

Referenced by blender::asset_system::tests::AssetRepresentationTest::add_dummy_id_asset(), and filelist_readjob_main_assets_add_items().

◆ catalog_service()

AssetCatalogService & blender::asset_system::AssetLibrary::catalog_service ( ) const

Definition at line 274 of file asset_library.cc.

References catalog_service_.

◆ foreach_loaded()

void blender::asset_system::AssetLibrary::foreach_loaded	(	FunctionRef< void(AssetLibrary &)>	fn,
		bool	include_all_library )

static

Execute fn for every asset library that is loaded. The asset library is passed to the fn call.

Parameters

skip_all_library When true, the fn will also be executed for the "All" asset library. This is just a combination of the other ones, so usually iterating over it is redundant.

Definition at line 245 of file asset_library.cc.

References AssetLibrary(), AssetLibraryService, blender::asset_system::AssetLibraryService::foreach_loaded_asset_library(), and blender::asset_system::AssetLibraryService::get().

Referenced by filelist_readjob_all_asset_library(), and blender::asset_system::AllAssetLibrary::rebuild_catalogs_from_nested().

◆ library_reference()

virtual std::optional< AssetLibraryReference > blender::asset_system::AssetLibrary::library_reference ( ) const

pure virtual

Get the AssetLibraryReference referencing this library. This can fail for custom libraries, which have too look up their bUserAssetLibrary. It will not return a value for values that were loaded directly through a path.

Implemented in blender::asset_system::AllAssetLibrary, blender::asset_system::EssentialsAssetLibrary, blender::asset_system::OnDiskAssetLibrary, blender::asset_system::PreferencesOnDiskAssetLibrary, and blender::asset_system::RuntimeAssetLibrary.

References AssetRepresentation, and name().

Referenced by blender::ed::sculpt_paint::brush_asset_save_as_invoke(), and blender::ed::sculpt_paint::visit_active_library_catalogs_catalog_for_search_fn().

◆ library_type()

eAssetLibraryType blender::asset_system::AssetLibrary::library_type ( ) const

Definition at line 415 of file asset_library.cc.

Referenced by AssetLibrary(), AssetRepresentation, blender::asset_system::OnDiskAssetLibrary::library_reference(), and blender::asset_system::OnDiskAssetLibrary::OnDiskAssetLibrary().

◆ load_or_reload_catalogs()

void blender::asset_system::AssetLibrary::load_or_reload_catalogs ( )

Definition at line 252 of file asset_library.cc.

References catalog_service(), catalog_service_, catalog_service_mutex_, lock, refresh_catalogs(), and root_path().

◆ name()

StringRefNull blender::asset_system::AssetLibrary::name ( ) const

Definition at line 420 of file asset_library.cc.

Referenced by add_external_asset(), AssetLibrary(), AssetRepresentation, compare_asset_catalog(), library_reference(), blender::asset_system::OnDiskAssetLibrary::OnDiskAssetLibrary(), and blender::asset_system::PreferencesOnDiskAssetLibrary::PreferencesOnDiskAssetLibrary().

◆ on_blend_save_handler_register()

void blender::asset_system::AssetLibrary::on_blend_save_handler_register ( )

Definition at line 366 of file asset_library.cc.

References BKE_callback_add(), BKE_CB_EVT_SAVE_POST, and on_save_callback_store_.

Referenced by blender::asset_system::OnDiskAssetLibrary::OnDiskAssetLibrary(), and blender::asset_system::RuntimeAssetLibrary::RuntimeAssetLibrary().

◆ on_blend_save_handler_unregister()

void blender::asset_system::AssetLibrary::on_blend_save_handler_unregister ( )

Definition at line 377 of file asset_library.cc.

References BKE_callback_remove(), BKE_CB_EVT_SAVE_POST, and on_save_callback_store_.

Referenced by ~AssetLibrary().

◆ on_blend_save_post()

void blender::asset_system::AssetLibrary::on_blend_save_post	(	Main *	bmain,
		PointerRNA **	pointers,
		int	num_pointers )

Definition at line 384 of file asset_library.cc.

References catalog_service(), Main::filepath, save_catalogs_when_file_is_saved, and blender::asset_system::AssetCatalogService::write_to_disk().

◆ refresh_catalog_simplename()

void blender::asset_system::AssetLibrary::refresh_catalog_simplename ( AssetMetaData * asset_data )

Update catalog_simple_name by looking up the asset's catalog by its ID.

No-op if the catalog cannot be found. This could be the kind of "the catalog definition file is corrupt/lost" scenario that the simple name is meant to help recover from.

Definition at line 400 of file asset_library.cc.

References BLI_uuid_is_nil(), AssetMetaData::catalog_id, catalog_service(), AssetMetaData::catalog_simple_name, blender::asset_system::AssetCatalogService::find_catalog(), blender::asset_system::AssetCatalog::simple_name, and STRNCPY().

◆ refresh_catalogs()

void blender::asset_system::AssetLibrary::refresh_catalogs ( )

protectedvirtual

Load catalogs that have changed on disk.

Reimplemented in blender::asset_system::AllAssetLibrary, and blender::asset_system::OnDiskAssetLibrary.

Definition at line 279 of file asset_library.cc.

Referenced by load_or_reload_catalogs().

◆ remap_ids_and_remove_invalid()

void blender::asset_system::AssetLibrary::remap_ids_and_remove_invalid ( const blender::bke::id::IDRemapper & mappings )

Remap ID pointers for local ID assets, see #BKE_lib_remap.hh. When an ID pointer would be mapped to null (typically when an ID gets removed), the asset is removed, because we don't support such empty/null assets.

Definition at line 314 of file asset_library.cc.

References blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::bke::id::IDRemapper::apply(), AssetRepresentation, BLI_assert, ID_REMAP_APPLY_DEFAULT, ID_REMAP_RESULT_SOURCE_UNASSIGNED, blender::asset_system::AssetRepresentation::is_local_id(), remove_asset(), and result.

Referenced by AS_asset_library_remap_ids().

◆ remove_asset()

bool blender::asset_system::AssetLibrary::remove_asset ( AssetRepresentation & asset )

Remove an asset from the library that was added using add_external_asset() or add_local_id_asset(). Can usually be expected to be constant time complexity (worst case may differ).