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

#include <preferences_on_disk_library.hh>

Inherits blender::asset_system::OnDiskAssetLibrary.

Public Member Functions

 PreferencesOnDiskAssetLibrary (const bUserAssetLibrary &user_asset_library)
std::optional< AssetLibraryReference > library_reference () const override
const bUserAssetLibrary * user_asset_library () const override
std::optional< eAssetImportMethod > import_method () const override
bool use_relative_paths () const override
bool is_enabled () const override
Public Member Functions inherited from blender::asset_system::OnDiskAssetLibrary
 OnDiskAssetLibrary (eAssetLibraryType library_type, StringRef name, StringRef root_path, bool is_read_only)
void refresh_catalogs () override
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 void force_remote_listing_download () 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 17 of file preferences_on_disk_library.hh.

Constructor & Destructor Documentation

◆ PreferencesOnDiskAssetLibrary()

blender::asset_system::PreferencesOnDiskAssetLibrary::PreferencesOnDiskAssetLibrary ( const bUserAssetLibrary & user_asset_library)
explicit

Member Function Documentation

◆ import_method()

std::optional< eAssetImportMethod > blender::asset_system::PreferencesOnDiskAssetLibrary::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.

Reimplemented from blender::asset_system::OnDiskAssetLibrary.

Definition at line 55 of file preferences_on_disk_library.cc.

References blender::bUserAssetLibrary::import_method, and user_asset_library().

◆ is_enabled()

bool blender::asset_system::PreferencesOnDiskAssetLibrary::is_enabled ( ) const
overridevirtual

◆ library_reference()

std::optional< AssetLibraryReference > blender::asset_system::PreferencesOnDiskAssetLibrary::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.

Reimplemented from blender::asset_system::OnDiskAssetLibrary.

Definition at line 31 of file preferences_on_disk_library.cc.

References blender::ASSET_LIBRARY_CUSTOM, BLI_assert_unreachable, blender::BLI_findindex(), blender::AssetLibraryReference::custom_library_index, blender::AssetLibraryReference::type, blender::U, and user_asset_library().

◆ use_relative_paths()

bool blender::asset_system::PreferencesOnDiskAssetLibrary::use_relative_paths ( ) const
overridevirtual

◆ user_asset_library()

const bUserAssetLibrary * blender::asset_system::PreferencesOnDiskAssetLibrary::user_asset_library ( ) const
overridevirtual

Get the bUserAssetLibrary that's backing this asset library, if there is any.

Reimplemented from blender::asset_system::AssetLibrary.

Definition at line 50 of file preferences_on_disk_library.cc.

Referenced by import_method(), is_enabled(), library_reference(), PreferencesOnDiskAssetLibrary(), and use_relative_paths().


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