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

#include <essentials_library.hh>

Inherits blender::asset_system::RemoteAssetLibrary.

Public Member Functions

Online Essentials Library

Internally this is a separate library. To the user, it's part of the normal Essentials library.

 OnlineEssentialsLibrary ()
std::optional< AssetLibraryReference > library_reference () const override
Public Member Functions inherited from blender::asset_system::RemoteAssetLibrary
 RemoteAssetLibrary (eAssetLibraryType library_type, bool is_read_only, StringRef remote_url, StringRef name, StringRef root_path)
void force_remote_listing_download () const override
std::optional< eAssetImportMethod > import_method () const override
std::optional< StringRefNull > remote_url () const override
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 const bUserAssetLibrary * user_asset_library () const
virtual bool use_relative_paths () 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

Static Public Attributes

static constexpr StringRefNull URL
Static Public Attributes inherited from blender::asset_system::AssetLibrary
static bool save_catalogs_when_file_is_saved = true

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)
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 29 of file essentials_library.hh.

Constructor & Destructor Documentation

◆ OnlineEssentialsLibrary()

Member Function Documentation

◆ library_reference()

std::optional< AssetLibraryReference > blender::asset_system::OnlineEssentialsLibrary::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 196 of file essentials_library.cc.

References blender::ASSET_LIBRARY_ONLINE_ESSENTIALS, blender::AssetLibraryReference::custom_library_index, and blender::AssetLibraryReference::type.

Member Data Documentation

◆ URL

StringRefNull blender::asset_system::OnlineEssentialsLibrary::URL
staticconstexpr
Initial value:
=
"https://cdn.extensions.blender.org/asset-libraries/essentials/"

Definition at line 34 of file essentials_library.hh.

Referenced by blender::asset_system::is_online_essentials_url(), blender::asset_system::online_essentials_url(), and OnlineEssentialsLibrary().


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