Blender V5.3
BKE_asset.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_compiler_attrs.hh"
12#include "BLI_function_ref.hh"
13
14#include "DNA_asset_types.h"
15
16namespace blender {
17
19struct AssetMetaData;
20struct AssetTag;
21struct BlendDataReader;
22struct BlendWriter;
23struct ID;
24struct IDProperty;
25struct Main;
26struct PreviewImage;
27
28using PreSaveFn = void (*)(void *asset_ptr, AssetMetaData *asset_data);
29using OnMarkAssetFn = void (*)(void *asset_ptr, AssetMetaData *asset_data);
30using OnClearAssetDataFn = void (*)(void *asset_ptr, AssetMetaData *asset_data);
31
45
47void BKE_asset_metadata_free(AssetMetaData **asset_data);
48
55
58 /* Set to false if a tag of this name was already present. */
59 bool is_new;
60};
61
62AssetTag *BKE_asset_metadata_tag_add(AssetMetaData *asset_data, const char *name)
63 ATTR_NONNULL(1, 2);
69
73 bUUID catalog_id,
74 const char *catalog_simple_name);
75
77
80 const char *name) ATTR_WARN_UNUSED_RESULT;
81
83 const ID *owner_id);
84
85void BKE_asset_metadata_write(BlendWriter *writer, AssetMetaData *asset_data);
87
90
92 FunctionRef<void(AssetWeakReference &weak_ref)> fn);
93
94void BKE_asset_catalog_path_list_free(ListBaseT<AssetCatalogPathLink> &catalog_path_list);
95ListBaseT<AssetCatalogPathLink> BKE_asset_catalog_path_list_duplicate(
96 const ListBaseT<AssetCatalogPathLink> &catalog_path_list);
98 BlendWriter *writer, const ListBaseT<AssetCatalogPathLink> &catalog_path_list);
100 BlendDataReader *reader, ListBaseT<AssetCatalogPathLink> &catalog_path_list);
101bool BKE_asset_catalog_path_list_has_path(const ListBaseT<AssetCatalogPathLink> &catalog_path_list,
102 const char *catalog_path);
103void BKE_asset_catalog_path_list_add_path(ListBaseT<AssetCatalogPathLink> &catalog_path_list,
104 const char *catalog_path);
105bool BKE_asset_catalog_path_list_remove_path(ListBaseT<AssetCatalogPathLink> &catalog_path_list,
106 const char *catalog_path);
107
108} // namespace blender
BMesh Iterators.
void BKE_asset_metadata_catalog_id_clear(AssetMetaData *asset_data)
Definition asset.cc:158
void BKE_asset_catalog_path_list_free(ListBaseT< AssetCatalogPathLink > &catalog_path_list)
void BKE_asset_metadata_idprop_ensure(AssetMetaData *asset_data, IDProperty *prop)
Definition asset.cc:172
void BKE_asset_metadata_write(BlendWriter *writer, AssetMetaData *asset_data)
Definition asset.cc:201
bool BKE_asset_catalog_path_list_has_path(const ListBaseT< AssetCatalogPathLink > &catalog_path_list, const char *catalog_path)
void BKE_asset_weak_reference_foreach_main(Main &bmain, FunctionRef< void(AssetWeakReference &weak_ref)> fn)
AssetMetaData * BKE_asset_metadata_copy(const AssetMetaData *source)
Definition asset.cc:42
void BKE_asset_metadata_free(AssetMetaData **asset_data)
Definition asset.cc:36
void BKE_asset_metadata_catalog_id_set(AssetMetaData *asset_data, bUUID catalog_id, const char *catalog_simple_name)
Definition asset.cc:164
PreviewImage * BKE_asset_metadata_preview_get_from_id(const AssetMetaData *asset_data, const ID *owner_id)
Definition asset.cc:193
void BKE_asset_metadata_tag_remove(AssetMetaData *asset_data, AssetTag *tag)
Definition asset.cc:144
AssetTag * BKE_asset_metadata_tag_add(AssetMetaData *asset_data, const char *name) ATTR_NONNULL(1
Definition asset.cc:114
void(*)(void *asset_ptr, AssetMetaData *asset_data) OnMarkAssetFn
Definition BKE_asset.hh:29
void BKE_asset_catalog_path_list_blend_read_data(BlendDataReader *reader, ListBaseT< AssetCatalogPathLink > &catalog_path_list)
IDProperty * BKE_asset_metadata_idprop_find(const AssetMetaData *asset_data, const char *name) ATTR_WARN_UNUSED_RESULT
Definition asset.cc:183
void BKE_asset_weak_reference_write(BlendWriter *writer, const AssetWeakReference *weak_ref)
void(*)(void *asset_ptr, AssetMetaData *asset_data) OnClearAssetDataFn
Definition BKE_asset.hh:30
void BKE_asset_library_reference_init_default(AssetLibraryReference *library_ref)
Definition asset.cc:153
AssetTag AssetTagEnsureResult BKE_asset_metadata_tag_ensure(AssetMetaData *asset_data, const char *name)
Definition asset.cc:121
AssetMetaData * BKE_asset_metadata_create()
Definition asset.cc:31
void BKE_asset_metadata_read(BlendDataReader *reader, AssetMetaData *asset_data)
Definition asset.cc:219
bool BKE_asset_catalog_path_list_remove_path(ListBaseT< AssetCatalogPathLink > &catalog_path_list, const char *catalog_path)
void BKE_asset_weak_reference_read(BlendDataReader *reader, AssetWeakReference *weak_ref)
void BKE_asset_catalog_path_list_blend_write(BlendWriter *writer, const ListBaseT< AssetCatalogPathLink > &catalog_path_list)
bool ATTR_WARN_UNUSED_RESULT
void ATTR_NONNULL(1, 2)
void BKE_asset_catalog_path_list_add_path(ListBaseT< AssetCatalogPathLink > &catalog_path_list, const char *catalog_path)
ListBaseT< AssetCatalogPathLink > BKE_asset_catalog_path_list_duplicate(const ListBaseT< AssetCatalogPathLink > &catalog_path_list)
void(*)(void *asset_ptr, AssetMetaData *asset_data) PreSaveFn
Definition BKE_asset.hh:28
The meta-data of an asset. By creating and giving this for a data-block (ID.asset_data),...
User defined tag. Currently only used by assets, could be used more often at some point....
OnClearAssetDataFn on_clear_asset_fn
Definition BKE_asset.hh:43
OnMarkAssetFn on_mark_asset_fn
Definition BKE_asset.hh:38
Universally Unique Identifier according to RFC4122.