Blender: BKE_asset.hh File Reference

Blender V4.3

#include "BLI_compiler_attrs.h"
#include "BLI_utildefines.h"
#include "DNA_asset_types.h"

Go to the source code of this file.

Classes
struct	AssetTypeInfo

struct	AssetTagEnsureResult

Typedefs
using	PreSaveFn = void ()(void asset_ptr, AssetMetaData *asset_data)

using	OnMarkAssetFn = void ()(void asset_ptr, AssetMetaData *asset_data)

using	OnClearAssetDataFn = void ()(void asset_ptr, AssetMetaData *asset_data)

Functions
AssetMetaData *	BKE_asset_metadata_create ()

void	BKE_asset_metadata_free (AssetMetaData **asset_data)

AssetMetaData *	BKE_asset_metadata_copy (const AssetMetaData *source)

AssetTag *	BKE_asset_metadata_tag_add (AssetMetaData asset_data, const char name) ATTR_NONNULL(1

AssetTag AssetTagEnsureResult	BKE_asset_metadata_tag_ensure (AssetMetaData asset_data, const char name)

void	BKE_asset_metadata_tag_remove (AssetMetaData asset_data, AssetTag tag)

void	BKE_asset_metadata_catalog_id_clear (AssetMetaData *asset_data)

void	BKE_asset_metadata_catalog_id_set (AssetMetaData asset_data, bUUID catalog_id, const char catalog_simple_name)

void	BKE_asset_library_reference_init_default (AssetLibraryReference *library_ref)

void	BKE_asset_metadata_idprop_ensure (AssetMetaData asset_data, IDProperty prop)

IDProperty *	BKE_asset_metadata_idprop_find (const AssetMetaData asset_data, const char name) ATTR_WARN_UNUSED_RESULT

PreviewImage *	BKE_asset_metadata_preview_get_from_id (const AssetMetaData asset_data, const ID owner_id)

void	BKE_asset_metadata_write (BlendWriter writer, AssetMetaData asset_data)

void	BKE_asset_metadata_read (BlendDataReader reader, AssetMetaData asset_data)

void	BKE_asset_weak_reference_write (BlendWriter writer, const AssetWeakReference weak_ref)

void	BKE_asset_weak_reference_read (BlendDataReader reader, AssetWeakReference weak_ref)

void	BKE_asset_catalog_path_list_free (ListBase &catalog_path_list)

ListBase	BKE_asset_catalog_path_list_duplicate (const ListBase &catalog_path_list)

void	BKE_asset_catalog_path_list_blend_write (BlendWriter *writer, const ListBase &catalog_path_list)

void	BKE_asset_catalog_path_list_blend_read_data (BlendDataReader *reader, ListBase &catalog_path_list)

bool	BKE_asset_catalog_path_list_has_path (const ListBase &catalog_path_list, const char *catalog_path)

void	BKE_asset_catalog_path_list_add_path (ListBase &catalog_path_list, const char *catalog_path)

Typedef Documentation

◆ OnClearAssetDataFn

using OnClearAssetDataFn = void (*)(void *asset_ptr, AssetMetaData *asset_data)

Definition at line 27 of file BKE_asset.hh.

◆ OnMarkAssetFn

using OnMarkAssetFn = void (*)(void *asset_ptr, AssetMetaData *asset_data)

Definition at line 26 of file BKE_asset.hh.

◆ PreSaveFn

using PreSaveFn = void (*)(void *asset_ptr, AssetMetaData *asset_data)

Definition at line 25 of file BKE_asset.hh.

Function Documentation

◆ BKE_asset_catalog_path_list_add_path()

void BKE_asset_catalog_path_list_add_path	(	ListBase &	catalog_path_list,
		const char *	catalog_path )

Definition at line 173 of file asset_weak_reference.cc.

References BLI_addtail(), BLI_strdup(), and AssetCatalogPathLink::path.

Referenced by BKE_preferences_asset_shelf_settings_ensure_catalog_path_enabled(), and blender::ed::asset::shelf::settings_set_catalog_path_enabled().

◆ BKE_asset_catalog_path_list_blend_read_data()

void BKE_asset_catalog_path_list_blend_read_data	(	BlendDataReader *	reader,
		ListBase &	catalog_path_list )

Definition at line 157 of file asset_weak_reference.cc.

References BLO_read_string(), BLO_read_struct_list, and LISTBASE_FOREACH.

Referenced by read_userdef(), and blender::ed::asset::shelf::settings_blend_read_data().

◆ BKE_asset_catalog_path_list_blend_write()

void BKE_asset_catalog_path_list_blend_write	(	BlendWriter *	writer,
		const ListBase &	catalog_path_list )

Definition at line 148 of file asset_weak_reference.cc.

References BLO_write_string(), BLO_write_struct, and LISTBASE_FOREACH.

Referenced by blender::ed::asset::shelf::settings_blend_write(), and write_userdef().

◆ BKE_asset_catalog_path_list_duplicate()

ListBase BKE_asset_catalog_path_list_duplicate ( const ListBase & catalog_path_list )

Definition at line 134 of file asset_weak_reference.cc.

References BLI_addtail(), BLI_strdup(), LISTBASE_FOREACH, and AssetCatalogPathLink::path.

◆ BKE_asset_catalog_path_list_free()

void BKE_asset_catalog_path_list_free ( ListBase & catalog_path_list )

Definition at line 125 of file asset_weak_reference.cc.

References BLI_assert, BLI_freelinkN(), BLI_listbase_is_empty(), and LISTBASE_FOREACH_MUTABLE.

Referenced by BKE_blender_userdef_data_free(), and blender::ed::asset::shelf::settings_clear_enabled_catalogs().

◆ BKE_asset_catalog_path_list_has_path()

bool BKE_asset_catalog_path_list_has_path	(	const ListBase &	catalog_path_list,
		const char *	catalog_path )

Definition at line 166 of file asset_weak_reference.cc.

References BLI_findstring_ptr(), and offsetof.

Referenced by BKE_preferences_asset_shelf_settings_is_catalog_path_enabled(), blender::ed::asset::shelf::settings_is_catalog_path_enabled(), and blender::ed::asset::shelf::settings_set_catalog_path_enabled().

◆ BKE_asset_library_reference_init_default()

void BKE_asset_library_reference_init_default ( AssetLibraryReference * library_ref )

Definition at line 149 of file asset.cc.

References DNA_struct_default_get.

Referenced by blo_do_versions_300(), and workspace_init_data().

◆ BKE_asset_metadata_catalog_id_clear()

void BKE_asset_metadata_catalog_id_clear ( AssetMetaData * asset_data )

Clean up the catalog ID (white-spaces removed, length reduced, etc.) and assign it.

Definition at line 154 of file asset.cc.

References BLI_uuid_nil(), AssetMetaData::catalog_id, and AssetMetaData::catalog_simple_name.

Referenced by blender::bke::tests::TEST().

◆ BKE_asset_metadata_catalog_id_set()

void BKE_asset_metadata_catalog_id_set	(	AssetMetaData *	asset_data,
		bUUID	catalog_id,
		const char *	catalog_simple_name )

Referenced by blender::ed::sculpt_paint::brush_asset_edit_metadata_exec(), blender::ed::sculpt_paint::brush_asset_save_as_exec(), blender::ed::asset_browser::AssetCatalogDropTarget::drop_assets_into_catalog(), and blender::bke::tests::TEST().

◆ BKE_asset_metadata_copy()

AssetMetaData * BKE_asset_metadata_copy ( const AssetMetaData * source )

Create a copy of the AssetMetaData so that it can be assigned to another asset.

The caller becomes the owner of the returned pointer.

Definition at line 44 of file asset.cc.

Referenced by BKE_libblock_copy_in_lib(), and blender::ed::asset::copy_to_id().

◆ BKE_asset_metadata_create()

AssetMetaData * BKE_asset_metadata_create ( )

Definition at line 32 of file asset.cc.

References DNA_struct_default_get.

Referenced by blender::ed::asset::index::init_indexer_entry_from_value(), and blender::ed::asset::mark_id().

◆ BKE_asset_metadata_free()

void BKE_asset_metadata_free ( AssetMetaData ** asset_data )

Definition at line 38 of file asset.cc.

Referenced by BKE_lib_id_clear_library_data(), BKE_libblock_free_data(), BLO_datablock_info_free(), blender::ed::asset::clear_id(), and blender::ed::asset::copy_to_id().

◆ BKE_asset_metadata_idprop_ensure()

void BKE_asset_metadata_idprop_ensure	(	AssetMetaData *	asset_data,
		IDProperty *	prop )

Definition at line 175 of file asset.cc.

References IDP_ReplaceInGroup(), and AssetMetaData::properties.

Referenced by blender::bke::action_asset_metadata_ensure(), brush_asset_metadata_ensure(), blender::bke::node_update_asset_metadata(), and object_asset_metadata_ensure().

◆ BKE_asset_metadata_idprop_find()

IDProperty * BKE_asset_metadata_idprop_find	(	const AssetMetaData *	asset_data,
		const char *	name )

Definition at line 186 of file asset.cc.

References IDP_GetPropertyFromGroup(), and AssetMetaData::properties.

Referenced by blender::ed::geometry::build_catalog_tree(), blender::ed::object::build_catalog_tree(), blender::ed::space_node::build_catalog_tree(), blender::ed::space_node::node_group_drop_poll(), blender::ed::geometry::run_node_group_depends_on_cursor(), blender::ed::space_node::search_link_ops_for_asset_metadata(), view3d_geometry_nodes_drop_poll(), and view3d_ob_drop_on_enter().

◆ BKE_asset_metadata_preview_get_from_id()

PreviewImage * BKE_asset_metadata_preview_get_from_id	(	const AssetMetaData *	asset_data,
		const ID *	owner_id )

Definition at line 196 of file asset.cc.

References BKE_previewimg_id_get().

Referenced by filelist_readjob_main_assets_add_items().

◆ BKE_asset_metadata_read()

void BKE_asset_metadata_read	(	BlendDataReader *	reader,
		AssetMetaData *	asset_data )

Definition at line 222 of file asset.cc.

References AssetMetaData::author, BLI_assert, BLI_listbase_count(), BLO_read_string(), BLO_read_struct, BLO_read_struct_list, AssetMetaData::copyright, AssetMetaData::description, IDP_BlendDataRead, AssetMetaData::license, AssetMetaData::local_type_info, AssetMetaData::properties, AssetMetaData::tags, and AssetMetaData::tot_tags.

Referenced by blo_read_asset_data_block(), and direct_link_id_common().

◆ BKE_asset_metadata_tag_add()

AssetTag * BKE_asset_metadata_tag_add	(	AssetMetaData *	asset_data,
		const char *	name )

Referenced by blender::ed::asset::index::init_indexer_entry_from_value().

◆ BKE_asset_metadata_tag_ensure()

AssetTag AssetTagEnsureResult BKE_asset_metadata_tag_ensure	(	AssetMetaData *	asset_data,
		const char *	name )

Make sure there is a tag with name name, create one if needed.

Definition at line 118 of file asset.cc.

References asset_metadata_tag_add(), BLI_findstring(), offsetof, result, and AssetMetaData::tags.

◆ BKE_asset_metadata_tag_remove()

void BKE_asset_metadata_tag_remove	(	AssetMetaData *	asset_data,
		AssetTag *	tag )

Definition at line 140 of file asset.cc.

References BLI_assert, BLI_findindex(), BLI_freelinkN(), BLI_listbase_count(), AssetMetaData::tags, and AssetMetaData::tot_tags.

◆ BKE_asset_metadata_write()

void BKE_asset_metadata_write	(	BlendWriter *	writer,
		AssetMetaData *	asset_data )

Definition at line 204 of file asset.cc.

References AssetMetaData::author, BLO_write_string(), BLO_write_struct, AssetMetaData::copyright, AssetMetaData::description, IDP_BlendWrite(), AssetMetaData::license, LISTBASE_FOREACH, AssetMetaData::properties, and AssetMetaData::tags.

Referenced by BKE_id_blend_write().

◆ BKE_asset_weak_reference_read()

void BKE_asset_weak_reference_read	(	BlendDataReader *	reader,
		AssetWeakReference *	weak_ref )

Definition at line 119 of file asset_weak_reference.cc.

References AssetWeakReference::asset_library_identifier, BLO_read_string(), and AssetWeakReference::relative_asset_identifier.

Referenced by BKE_paint_blend_read_data().

◆ BKE_asset_weak_reference_write()

void BKE_asset_weak_reference_write	(	BlendWriter *	writer,
		const AssetWeakReference *	weak_ref )

Definition at line 112 of file asset_weak_reference.cc.

References AssetWeakReference::asset_library_identifier, BLO_write_string(), BLO_write_struct, and AssetWeakReference::relative_asset_identifier.

Referenced by BKE_paint_blend_write().