#include <DNA_asset_types.h>

Public Attributes
char	_pad [6]

short	asset_library_type

const char *	asset_library_identifier

const char *	relative_asset_identifier

Detailed Description

Information to refer to an asset (may be stored in files) on a "best effort" basis. It should work well enough for many common cases, but can break. For example when the location of the asset changes, the available asset libraries in the Preferences change, an asset library is renamed, or when a file storing this is opened on a different system (with different Preferences).

It has two main components:

A reference to the asset library: The eAssetLibraryType and if that is not enough to identify the library, a library name (typically given by the user, but may change).
An identifier for the asset within the library: A relative path currently, which can break if the asset is moved. Could also be a unique key for a database for example.

Note: Needs freeing through the destructor, so either use a smart pointer or #MEM_delete() for explicit freeing.

Definition at line 161 of file DNA_asset_types.h.

Member Data Documentation

◆ _pad

char AssetWeakReference::_pad[6]

Definition at line 162 of file DNA_asset_types.h.

◆ asset_library_identifier

const char* AssetWeakReference::asset_library_identifier

If asset_library_type is not enough to identify the asset library, this string can provide further location info (allocated string). Null otherwise.

Definition at line 167 of file DNA_asset_types.h.

Referenced by blender::bke::asset_weak_reference_for_user_library(), BKE_asset_weak_reference_read(), BKE_asset_weak_reference_write(), blender::ed::sculpt_paint::brush_asset_delete_exec(), blender::ed::sculpt_paint::brush_asset_save_exec(), blender::asset_system::AssetLibraryService::find_custom_preferences_asset_library_from_asset_weak_ref(), operator==(), blender::ed::asset::operator_asset_reference_props_set(), paint_brush_asset_reference_from_essentials(), paint_brush_asset_reference_ptr_from_essentials(), blender::asset_system::AssetLibraryService::resolve_asset_weak_reference_to_library_path(), blender::asset_system::tests::TEST_F(), and blender::asset_system::tests::TEST_F().

◆ asset_library_type

short AssetWeakReference::asset_library_type

Definition at line 164 of file DNA_asset_types.h.

Referenced by blender::bke::asset_edit_weak_reference_from_id(), blender::bke::asset_weak_reference_for_essentials(), blender::bke::asset_weak_reference_for_user_library(), blender::ed::asset::find_asset_from_weak_ref(), blender::asset_system::AssetLibraryService::find_custom_preferences_asset_library_from_asset_weak_ref(), blender::ed::asset::operator_asset_reference_props_get_asset_from_all_library(), blender::ed::asset::operator_asset_reference_props_set(), paint_brush_asset_reference_from_essentials(), paint_brush_asset_reference_ptr_from_essentials(), blender::asset_system::AssetLibraryService::resolve_asset_weak_reference_to_exploded_path(), blender::asset_system::AssetLibraryService::resolve_asset_weak_reference_to_library_path(), blender::ed::object::shade_auto_smooth_exec(), blender::asset_system::tests::TEST_F(), blender::asset_system::tests::TEST_F(), and blender::asset_system::tests::TEST_F().

◆ relative_asset_identifier

const char* AssetWeakReference::relative_asset_identifier

Definition at line 169 of file DNA_asset_types.h.

Referenced by blender::bke::asset_edit_weak_reference_from_id(), blender::bke::asset_weak_reference_for_essentials(), blender::bke::asset_weak_reference_for_user_library(), BKE_asset_weak_reference_read(), BKE_asset_weak_reference_write(), blender::ed::asset::find_asset_from_weak_ref(), blender::asset_system::AssetLibraryService::normalize_asset_weak_reference_relative_asset_identifier(), blender::ed::asset::operator_asset_reference_props_set(), paint_brush_asset_reference_from_essentials(), paint_brush_asset_reference_ptr_from_essentials(), blender::asset_system::AssetLibraryService::resolve_asset_weak_reference_to_exploded_path(), blender::asset_system::AssetLibraryService::resolve_asset_weak_reference_to_full_path(), blender::asset_system::tests::TEST_F(), and blender::asset_system::tests::TEST_F().

The documentation for this struct was generated from the following file: