The meta-data of an asset. By creating and giving this for a data-block (ID.asset_data), the data-block becomes an asset. More...

#include <DNA_asset_types.h>

Public Attributes
struct AssetTypeInfo *	local_type_info

struct IDProperty *	properties

struct bUUID	catalog_id

char	catalog_simple_name [64]

char *	author

char *	description

char *	copyright

char *	license

ListBase	tags

short	active_tag

short	tot_tags

char	_pad [4]

Detailed Description

The meta-data of an asset. By creating and giving this for a data-block (ID.asset_data), the data-block becomes an asset.

Note: This struct must be readable without having to read anything but blocks from the ID it is attached to! That way, asset information of a file can be read, without reading anything more than that from the file. So pointers to other IDs or ID data are strictly forbidden.

Definition at line 45 of file DNA_asset_types.h.

Member Data Documentation

◆ _pad

char AssetMetaData::_pad[4]

Definition at line 86 of file DNA_asset_types.h.

◆ active_tag

short AssetMetaData::active_tag

Definition at line 81 of file DNA_asset_types.h.

◆ author

char* AssetMetaData::author

Optional name of the author for display in the UI. Dynamic length.

Definition at line 66 of file DNA_asset_types.h.

Referenced by BKE_asset_metadata_read(), BKE_asset_metadata_write(), blender::ed::sculpt_paint::brush_asset_edit_metadata_exec(), blender::ed::sculpt_paint::brush_asset_edit_metadata_invoke(), blender::ed::asset::index::init_indexer_entry_from_value(), and blender::ed::asset::index::init_value_from_file_indexer_entry().

◆ catalog_id

struct bUUID AssetMetaData::catalog_id

Asset Catalog identifier. Should not contain spaces. Mapped to a path in the asset catalog hierarchy by an #AssetCatalogService. Use BKE_asset_metadata_catalog_id_set() to ensure a valid ID is set.

Definition at line 57 of file DNA_asset_types.h.

Referenced by BKE_asset_metadata_catalog_id_clear(), BKE_asset_metadata_catalog_id_set(), blender::ed::sculpt_paint::brush_asset_edit_metadata_invoke(), blender::ed::sculpt_paint::brush_asset_save_as_invoke(), blender::ed::asset::build_filtered_all_catalog_tree(), blender::ed::asset::build_filtered_catalog_tree(), blender::ed::asset::shelf::AssetView::build_items(), compare_asset_catalog(), blender::ed::asset_browser::file_is_asset_visible_in_catalog_filter_settings(), blender::ed::asset::index::init_indexer_entry_from_value(), blender::ed::asset::index::init_value_from_file_indexer_entry(), and blender::asset_system::AssetLibrary::refresh_catalog_simplename().

◆ catalog_simple_name

char AssetMetaData::catalog_simple_name[64]

Short name of the asset's catalog. This is for debugging purposes only, to allow (partial) reconstruction of asset catalogs in the unfortunate case that the mapping from catalog UUID to catalog path is lost. The catalog's simple name is copied to catalog_simple_name whenever catalog_id is updated.

Definition at line 63 of file DNA_asset_types.h.

Referenced by BKE_asset_metadata_catalog_id_clear(), BKE_asset_metadata_catalog_id_set(), blender::ed::asset::index::init_indexer_entry_from_value(), blender::ed::asset::index::init_value_from_file_indexer_entry(), blender::asset_system::AssetLibrary::refresh_catalog_simplename(), and blender::asset_system::tests::TEST_F().

◆ copyright

char* AssetMetaData::copyright

Optional copyright of this asset for display in the UI. Dynamic length.

Definition at line 72 of file DNA_asset_types.h.

Referenced by BKE_asset_metadata_read(), BKE_asset_metadata_write(), blender::ed::asset::index::init_indexer_entry_from_value(), and blender::ed::asset::index::init_value_from_file_indexer_entry().

◆ description

char* AssetMetaData::description

Optional description of this asset for display in the UI. Dynamic length.

Definition at line 69 of file DNA_asset_types.h.

Referenced by blender::ed::asset::asset_tooltip(), BKE_asset_metadata_read(), BKE_asset_metadata_write(), blender::ed::sculpt_paint::brush_asset_edit_metadata_exec(), blender::ed::sculpt_paint::brush_asset_edit_metadata_invoke(), blender::ed::asset::index::init_indexer_entry_from_value(), blender::ed::asset::index::init_value_from_file_indexer_entry(), blender::ed::object::modifier_add_asset_get_description(), blender::ed::space_node::node_add_group_asset_get_description(), node_group_ui_description(), blender::bke::node_tree_asset_on_clear_asset(), blender::bke::node_tree_asset_on_mark_asset(), and blender::ed::geometry::run_node_group_get_description().

◆ license

char* AssetMetaData::license

Optional license of this asset for display in the UI. Dynamic length.

Definition at line 75 of file DNA_asset_types.h.

Referenced by BKE_asset_metadata_read(), BKE_asset_metadata_write(), blender::ed::asset::index::init_indexer_entry_from_value(), and blender::ed::asset::index::init_value_from_file_indexer_entry().

◆ local_type_info

struct AssetTypeInfo* AssetMetaData::local_type_info

Runtime type, to reference event callbacks. Only valid for local assets.

Definition at line 47 of file DNA_asset_types.h.

Referenced by BKE_asset_metadata_read(), and blender::ed::asset::pre_save_assets().

◆ properties

struct IDProperty* AssetMetaData::properties

Custom asset meta-data. Cannot store pointers to IDs (STRUCT_NO_DATABLOCK_IDPROPERTIES)!

Definition at line 50 of file DNA_asset_types.h.

Referenced by BKE_asset_metadata_idprop_ensure(), BKE_asset_metadata_idprop_find(), BKE_asset_metadata_read(), BKE_asset_metadata_write(), blender::ed::asset::index::init_indexer_entry_from_value(), and blender::ed::asset::index::init_value_from_file_indexer_entry().

◆ tags

ListBase AssetMetaData::tags

User defined tags for this asset. The asset manager uses these for filtering, but how they function exactly (e.g. how they are registered to provide a list of searchable available tags) is up to the asset-engine.

Definition at line 80 of file DNA_asset_types.h.

Referenced by asset_metadata_tag_add(), asset_tag_matches_filter(), BKE_asset_metadata_read(), BKE_asset_metadata_tag_add(), BKE_asset_metadata_tag_ensure(), BKE_asset_metadata_tag_remove(), BKE_asset_metadata_write(), blender::ed::asset::filter_matches_asset(), and blender::ed::asset::index::init_value_from_file_indexer_entry().

◆ tot_tags

short AssetMetaData::tot_tags

Store the number of tags to avoid continuous counting. Could be turned into runtime data, we can always reliably reconstruct it from the list.

Definition at line 84 of file DNA_asset_types.h.

Referenced by asset_metadata_tag_add(), BKE_asset_metadata_read(), and BKE_asset_metadata_tag_remove().

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

DNA_asset_types.h

Public Attributes