Blender V5.3
blender::asset_system::AllAssetLibrary Class Reference

#include <all_library.hh>

Inherits blender::asset_system::AssetLibrary.

Public Member Functions

 AllAssetLibrary ()
void force_remote_listing_download () const override
std::optional< AssetLibraryReference > library_reference () const override
std::optional< eAssetImportMethod > import_method () const override
void refresh_catalogs () override
void rebuild_catalogs_from_nested (bool reload_nested_catalogs)
void tag_catalogs_dirty ()
bool is_catalogs_dirty () const
Public Member Functions inherited from blender::asset_system::AssetLibrary
 AssetLibrary (eAssetLibraryType library_type, bool is_read_only, StringRef name="", StringRef root_path="")
virtual ~AssetLibrary ()
virtual const bUserAssetLibrary * user_asset_library () const
virtual bool use_relative_paths () const
virtual std::optional< StringRefNull > remote_url () const
virtual std::optional< StringRefNull > auth_token () const
AssetCatalogService & catalog_service () const
std::shared_ptr< AssetCatalogService > catalog_service_ptr () const
std::weak_ptr< AssetRepresentation > add_external_on_disk_asset (StringRef relative_asset_path, StringRef name, int id_type, std::unique_ptr< AssetMetaData > metadata)
std::weak_ptr< AssetRepresentation > add_external_online_asset (StringRef relative_asset_path, StringRef name, int id_type, std::unique_ptr< AssetMetaData > metadata, OnlineAssetInfo online_info)
std::weak_ptr< AssetRepresentation > add_local_id_asset (ID &id)
bool remove_asset (AssetRepresentation &asset)
void remap_ids_and_remove_invalid (const bke::id::IDRemapper &mappings)
void refresh_catalog_simplename (AssetMetaData *asset_data)
void load_or_reload_catalogs ()
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
bool is_read_only () const

Additional Inherited Members

Static Public Member Functions inherited from blender::asset_system::AssetLibrary
static void foreach_loaded (FunctionRef< void(AssetLibrary &)> fn, bool include_all_library)
Static Public Attributes inherited from blender::asset_system::AssetLibrary
static bool save_catalogs_when_file_is_saved = true
Protected Attributes inherited from blender::asset_system::AssetLibrary
std::shared_ptr< AssetCatalogService > catalog_service_
std::recursive_mutex catalog_service_mutex_
bool may_override_import_method_ = false
bCallbackFuncStore on_save_callback_store_ {}

Detailed Description

Definition at line 18 of file all_library.hh.

Constructor & Destructor Documentation

◆ AllAssetLibrary()

blender::asset_system::AllAssetLibrary::AllAssetLibrary ( )

Member Function Documentation

◆ force_remote_listing_download()

void blender::asset_system::AllAssetLibrary::force_remote_listing_download ( ) const
overridevirtual

(Re-)download the remote listing for this library.

This only has an effect for asset libraries that are themselves a remote library, or contain one (such as the "Essentials" library if it includes online essentials, or the "All" if there are any remote libraries included).

The "Allow Online Access" option will be enforced internally, but probably some check to give a user message should be done at a higher level.

Reimplemented from blender::asset_system::AssetLibrary.

Definition at line 32 of file all_library.cc.

References blender::asset_system::AssetLibrary::AssetLibrary(), blender::asset_system::AssetLibrary::auth_token(), blender::asset_system::AssetLibrary::foreach_loaded(), blender::asset_system::remote_library_request_download(), blender::asset_system::AssetLibrary::remote_url(), and blender::asset_system::AssetLibrary::root_path().

◆ import_method()

std::optional< eAssetImportMethod > blender::asset_system::AllAssetLibrary::import_method ( ) const
overridevirtual

Get the import method that should be used for assets in this library.

Returns
The import method or no value if the library doesn't support importing. For example because the library is the "Current File" library or the library was removed from the Preferences.

Implements blender::asset_system::AssetLibrary.

Definition at line 51 of file all_library.cc.

◆ is_catalogs_dirty()

bool blender::asset_system::AllAssetLibrary::is_catalogs_dirty ( ) const

Definition at line 121 of file all_library.cc.

◆ library_reference()

std::optional< AssetLibraryReference > blender::asset_system::AllAssetLibrary::library_reference ( ) const
overridevirtual

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.

Implements blender::asset_system::AssetLibrary.

Definition at line 46 of file all_library.cc.

References blender::asset_system::all_library_reference().

◆ rebuild_catalogs_from_nested()

void blender::asset_system::AllAssetLibrary::rebuild_catalogs_from_nested ( bool reload_nested_catalogs)

Update the available catalogs and catalog tree from the nested asset libraries. Completely recreates the catalog service (invalidating pointers to the previous one).

Parameters
reload_nested_catalogsRe-read catalog definitions of nested libraries from disk and merge them into the in-memory representations.

Definition at line 56 of file all_library.cc.

References blender::asset_system::AssetLibrary::AssetLibrary(), blender::asset_system::AssetLibrary::catalog_service(), blender::asset_system::AssetLibrary::foreach_loaded(), blender::asset_system::AssetCatalogService::reload_catalogs(), blender::asset_system::AssetLibrary::remote_url(), blender::U, and USER_EXPERIMENTAL_TEST.

Referenced by refresh_catalogs().

◆ refresh_catalogs()

void blender::asset_system::AllAssetLibrary::refresh_catalogs ( )
overridevirtual

Load catalogs that have changed on disk.

Reimplemented from blender::asset_system::AssetLibrary.

Definition at line 126 of file all_library.cc.

References rebuild_catalogs_from_nested().

◆ tag_catalogs_dirty()

void blender::asset_system::AllAssetLibrary::tag_catalogs_dirty ( )

Definition at line 116 of file all_library.cc.


The documentation for this class was generated from the following files: