 |
Blender V4.3
|
|
Blender V4.3
|
Go to the source code of this file.
Classes | |
| struct | LibraryIDLinkCallbackData |
| struct | LibQueryUnusedIDsData |
Macros | |
| #define | BKE_LIB_FOREACHID_PROCESS_ID_NOCHECK(data_, id_, cb_flag_) |
| #define | BKE_LIB_FOREACHID_PROCESS_ID(data_, id_, cb_flag_) |
| #define | BKE_LIB_FOREACHID_PROCESS_IDSUPER_P(data_, id_super_p_, cb_flag_) |
| #define | BKE_LIB_FOREACHID_PROCESS_IDSUPER(data_, id_super_, cb_flag_) |
| #define | BKE_LIB_FOREACHID_PROCESS_FUNCTION_CALL(data_, func_call_) |
Typedefs | |
| using | LibraryIDLinkCallback = int(LibraryIDLinkCallbackData *cb_data) |
API to perform operations over all ID pointers used by a given data-block.
BKE_lib_ files are for operations over data-blocks themselves, although they might alter Main as well (when creating/renaming/deleting an ID e.g.).BKE_lib_query_ should be used for functions in that file. Definition in file BKE_lib_query.hh.
| #define BKE_LIB_FOREACHID_PROCESS_FUNCTION_CALL | ( | data_, | |
| func_call_ ) |
Definition at line 278 of file BKE_lib_query.hh.
Referenced by armature_foreach_id(), armature_foreach_id_bone(), armature_foreach_id_bone_collection(), armature_foreach_id_editbone(), BKE_animdata_foreach_id(), BKE_nla_strip_foreach_id(), brush_foreach_id(), blender::bke::node_interface::item_types::item_foreach_id(), library_foreach_constraintObjectLooper(), library_foreach_gpencil_modifiersForeachIDLink(), library_foreach_modifiersForeachIDLink(), blender::bke::library_foreach_node_socket(), library_foreach_particlesystemsObjectLooper(), library_foreach_shaderfxForeachIDLink(), light_foreach_id(), linestyle_foreach_id(), material_foreach_id(), blender::bke::node_node_foreach_id(), object_foreach_id(), particle_settings_foreach_id(), scene_foreach_id(), scene_foreach_rigidbodyworldSceneLooper(), screen_foreach_id(), texture_foreach_id(), window_manager_foreach_id(), and world_foreach_id().
| #define BKE_LIB_FOREACHID_PROCESS_ID | ( | data_, | |
| id_, | |||
| cb_flag_ ) |
Definition at line 255 of file BKE_lib_query.hh.
Referenced by action_foreach_id(), blender::bke::action_foreach_id(), BKE_fcurve_foreach_id(), BKE_keyingsets_foreach_id(), BKE_lib_query_idpropertiesForeachIDLink_callback(), BKE_viewer_path_foreach_id(), buttons_foreach_id(), collection_foreach_id(), graph_foreach_id(), mask_foreach_id(), nla_foreach_id(), blender::bke::node_foreach_id(), blender::ed::space_node::node_foreach_id(), blender::bke::node_node_foreach_id(), object_foreach_id(), blender::ed::outliner::outliner_foreach_id(), and shapekey_foreach_id().
| #define BKE_LIB_FOREACHID_PROCESS_ID_NOCHECK | ( | data_, | |
| id_, | |||
| cb_flag_ ) |
Should typically only be used when processing deprecated ID types (like IPO ones).
Definition at line 246 of file BKE_lib_query.hh.
Referenced by blender::bke::action_foreach_id(), camera_foreach_id(), curve_foreach_id(), lattice_foreach_id(), light_foreach_id(), material_foreach_id(), mesh_foreach_id(), metaball_foreach_id(), object_foreach_id(), shapekey_foreach_id(), sound_foreach_id(), texture_foreach_id(), and world_foreach_id().
| #define BKE_LIB_FOREACHID_PROCESS_IDSUPER | ( | data_, | |
| id_super_, | |||
| cb_flag_ ) |
Definition at line 272 of file BKE_lib_query.hh.
Referenced by action_foreach_id(), blender::bke::action_foreach_id(), BKE_animdata_foreach_id(), BKE_nla_strip_foreach_id(), BKE_screen_foreach_id_screen_area(), BKE_texture_mtex_foreach_id(), brush_foreach_id(), buttons_foreach_id(), camera_foreach_id(), clip_foreach_id(), collection_foreach_id(), curve_foreach_id(), curves_foreach_id(), graph_foreach_id(), grease_pencil_foreach_id(), greasepencil_foreach_id(), image_foreach_id(), ipo_foreach_id(), lattice_foreach_id(), library_foreach_id(), blender::bke::library_foreach_node_socket(), lightprobe_foreach_id(), linestyle_foreach_id(), material_foreach_id(), mesh_foreach_id(), metaball_foreach_id(), movie_clip_foreach_id(), nla_foreach_id(), blender::bke::node_foreach_id(), blender::ed::space_node::node_foreach_id(), object_foreach_id(), particle_settings_foreach_id(), pointcloud_foreach_id(), scene_foreach_id(), scene_foreach_layer_collection(), screen_foreach_id(), script_foreach_id(), sequencer_foreach_id(), blender::bke::node_interface::socket_types::socket_data_foreach_id_impl(), blender::bke::node_interface::socket_types::socket_data_foreach_id_impl(), blender::bke::node_interface::socket_types::socket_data_foreach_id_impl(), blender::bke::node_interface::socket_types::socket_data_foreach_id_impl(), blender::bke::node_interface::socket_types::socket_data_foreach_id_impl(), speaker_foreach_id(), text_foreach_id(), texture_foreach_id(), view3d_foreach_id(), volume_foreach_id(), window_manager_foreach_id(), and workspace_foreach_id().
| #define BKE_LIB_FOREACHID_PROCESS_IDSUPER_P | ( | data_, | |
| id_super_p_, | |||
| cb_flag_ ) |
Definition at line 262 of file BKE_lib_query.hh.
| using LibraryIDLinkCallback = int(LibraryIDLinkCallbackData *cb_data) |
Call a callback for each ID link which the given ID uses.
Definition at line 157 of file BKE_lib_query.hh.
| anonymous enum |
| Enumerator | |
|---|---|
| IDWALK_CB_NOP | |
| IDWALK_CB_NEVER_NULL | |
| IDWALK_CB_NEVER_SELF | |
| IDWALK_CB_INDIRECT_USAGE | Indicates whether this is direct (i.e. by local data) or indirect (i.e. by linked data) usage. |
| IDWALK_CB_DIRECT_WEAK_LINK | Indicates that this is a direct weak link usage, i.e. if the user is a local ID, and is using (pointing to) a linked ID, that usage does not make the linked ID directly linked. E.g. usages of linked collections or objects by ViewLayerCollections or Bases in scenes. Also used for most Editors ID usages (active node tree in the Node editor, shown image in the Image editor, and so on). See also ID_FLAG_INDIRECT_WEAK_LINK in DNA_ID.h |
| IDWALK_CB_EMBEDDED | That ID is used as mere sub-data by its owner (only case currently: those root node-trees in materials etc., and the Scene's master collections). This means callback shall not do anything, only use this as informative data if it needs it. |
| IDWALK_CB_EMBEDDED_NOT_OWNING | That ID pointer points to an embedded ID, but does not own it. E.g the |
| IDWALK_CB_LOOPBACK | That ID is not really used by its owner, it's just an internal hint/helper. This marks the 'from' pointers issue, like Key->from. How to handle that kind of cases totally depends on what caller code is doing... |
| IDWALK_CB_INTERNAL | Indicates that this is an internal runtime ID pointer, like e.g.
|
| IDWALK_CB_READFILE_IGNORE | This ID usage should not be processed during readfile (neither during lib-linking nor expanding). Note that all embedded IDs pointers (IDWALK_CB_EMBEDDED and IDWALK_CB_EMBEDDED_NOT_OWNING) cases are also ignored during readfile. Mainly used for some 'loopback' pointers like the 'owner_id' of the embedded IDs. |
| IDWALK_CB_USER | This ID usage is fully refcounted. Callback is responsible to deal accordingly with ID.us if needed. |
| IDWALK_CB_USER_ONE | This ID usage is not refcounted, but at least one user should be generated by it (to avoid e.g. losing the used ID on save/reload). Callback is responsible to deal accordingly with ID.us if needed. |
| IDWALK_CB_OVERRIDE_LIBRARY_REFERENCE | This ID is used as library override's reference by its owner. |
| IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE | This ID pointer is not overridable. |
| IDWALK_CB_OVERRIDE_LIBRARY_HIERARCHY_DEFAULT | This ID pointer is expected to be overridden by default, in liboverride hierarchy context. |
Definition at line 34 of file BKE_lib_query.hh.
| anonymous enum |
| Enumerator | |
|---|---|
| IDWALK_RET_NOP | |
| IDWALK_RET_STOP_ITER | Completely stop iteration.
|
| IDWALK_RET_STOP_RECURSION | Stop recursion, that is, do not loop over ID used by current one.
|
Definition at line 118 of file BKE_lib_query.hh.
| anonymous enum |
| Enumerator | |
|---|---|
| IDWALK_NOP | |
| IDWALK_READONLY | The callback will never modify the ID pointers it processes. WARNING: It is very important to pass this flag when valid, as it can lead to important optimizations and debug/assert code. |
| IDWALK_RECURSE | Recurse into 'descendant' IDs. Each ID is only processed once. Order of ID processing is not guaranteed. Also implies IDWALK_READONLY, and excludes IDWALK_DO_INTERNAL_RUNTIME_POINTERS. NOTE: When enabled, embedded IDs are processed separately from their owner, as if they were regular IDs. The owner ID remains available in the LibraryForeachIDData callback data, unless IDWALK_IGNORE_MISSING_OWNER_ID is passed. |
| IDWALK_INCLUDE_UI | Include UI pointers (from WM and screens editors). |
| IDWALK_IGNORE_EMBEDDED_ID | Do not process ID pointers inside embedded IDs. Needed by depsgraph processing e.g. |
| IDWALK_NO_ORIG_POINTERS_ACCESS | Do not access original processed pointer's data, only process its address value. This is required in cases where to current address may not be valid anymore (e.g. during readfile process). A few ID pointers (like e.g. the
|
| IDWALK_IGNORE_MISSING_OWNER_ID | Do not attempt to find the owner ID of an embedded one if not explicitly given.
|
| IDWALK_DO_INTERNAL_RUNTIME_POINTERS | Also process internal ID pointers like |
| IDWALK_DO_LIBRARY_POINTER | Also process the ID.lib pointer. It is an option because this pointer can usually be fully ignored. |
| IDWALK_DO_DEPRECATED_POINTERS | Also process the DNA-deprecated pointers. Should only be used in readfile related code (for proper lib_linking and expanding of older files). |
Definition at line 160 of file BKE_lib_query.hh.
| bool BKE_lib_query_foreachid_iter_stop | ( | const LibraryForeachIDData * | data | ) |
Check whether current iteration over ID usages should be stopped or not.
Definition at line 66 of file lib_query.cc.
References IDWALK_STOP.
Referenced by BKE_lib_query_foreachid_process(), BKE_library_foreach_ID_embedded(), library_foreach_ID_link(), and window_manager_foreach_id().
| void BKE_lib_query_foreachid_process | ( | LibraryForeachIDData * | data, |
| ID ** | id_pp, | ||
| int | cb_flag ) |
Definition at line 71 of file lib_query.cc.
References BKE_lib_query_foreachid_iter_stop(), BLI_assert, BLI_assert_msg, BLI_gset_add(), BLI_LINKSTACK_PUSH, flag, IDWALK_CB_INTERNAL, IDWALK_CB_LOOPBACK, IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE, IDWALK_CB_OVERRIDE_LIBRARY_REFERENCE, IDWALK_READONLY, IDWALK_RECURSE, IDWALK_RET_STOP_ITER, IDWALK_RET_STOP_RECURSION, IDWALK_STOP, and LibraryIDLinkCallbackData::user_data.
Referenced by BKE_library_foreach_ID_embedded(), library_foreach_constraintObjectLooper(), library_foreach_gpencil_modifiersForeachIDLink(), library_foreach_ID_link(), library_foreach_modifiersForeachIDLink(), library_foreach_particlesystemsObjectLooper(), library_foreach_shaderfxForeachIDLink(), scene_foreach_rigidbodyworldSceneLooper(), and window_manager_foreach_id().
| int BKE_lib_query_foreachid_process_callback_flag_override | ( | LibraryForeachIDData * | data, |
| int | cb_flag, | ||
| bool | do_replace ) |
Definition at line 130 of file lib_query.cc.
| int BKE_lib_query_foreachid_process_flags_get | ( | const LibraryForeachIDData * | data | ) |
Definition at line 120 of file lib_query.cc.
Referenced by action_foreach_id(), blender::bke::action_foreach_id(), BKE_particlesystem_id_loop(), buttons_foreach_id(), camera_foreach_id(), clip_foreach_id(), collection_foreach_id(), curve_foreach_id(), file_foreach_id(), graph_foreach_id(), image_foreach_id(), ipo_foreach_id(), lattice_foreach_id(), light_foreach_id(), material_foreach_id(), mesh_foreach_id(), metaball_foreach_id(), blender::ed::space_node::node_foreach_id(), object_foreach_id(), blender::ed::outliner::outliner_foreach_id(), particle_settings_foreach_id(), scene_foreach_id(), scene_foreach_layer_collection(), screen_foreach_id(), seq_foreach_member_id_cb(), shapekey_foreach_id(), sound_foreach_id(), texture_foreach_id(), view3d_foreach_id(), window_manager_foreach_id(), and world_foreach_id().
| Main * BKE_lib_query_foreachid_process_main_get | ( | const LibraryForeachIDData * | data | ) |
Definition at line 125 of file lib_query.cc.
Referenced by blender::bke::action_foreach_id().
| void BKE_lib_query_idpropertiesForeachIDLink_callback | ( | IDProperty * | id_prop, |
| void * | user_data ) |
Definition at line 152 of file lib_query.cc.
References BKE_LIB_FOREACHID_PROCESS_ID, BLI_assert, IDProperty::data, IDProperty::flag, IDP_FLAG_OVERRIDABLE_LIBRARY, IDP_ID, IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE, IDWALK_CB_USER, IDPropertyData::pointer, and IDProperty::type.
| void BKE_lib_query_unused_ids_amounts | ( | Main * | bmain, |
| LibQueryUnusedIDsData & | parameters ) |
Compute amount of unused IDs (a.k.a 'orphaned').
By default only consider IDs with 0 user count. If do_recursive is set, it will check dependencies to detect all IDs that are not actually used in current file, including 'archipelagos‘ (i.e. set of IDs referencing each other in loops, but without any 'external’ valid usages.
Valid usages here are defined as ref-counting usages, which are not towards embedded or loop-back data.
| r_num_total | A zero-initialized array of INDEX_ID_MAX integers. Number of IDs detected as unused from given parameters, per ID type in the matching index, and as total in INDEX_ID_NULL item. |
| r_num_local | A zero-initialized array of INDEX_ID_MAX integers. Number of local IDs detected as unused from given parameters (but assuming do_local_ids is true), per ID type in the matching index, and as total in INDEX_ID_NULL item. |
| r_num_linked | A zero-initialized array of INDEX_ID_MAX integers. Number of linked IDs detected as unused from given parameters (but assuming do_linked_ids is true), per ID type in the matching index, and as total in INDEX_ID_NULL item. |
Definition at line 904 of file lib_query.cc.
References BKE_main_relations_create(), BKE_main_relations_free(), data, lib_query_unused_ids_tag(), and parameters.
Referenced by blender::ed::outliner::outliner_orphans_purge_check(), and blender::ed::outliner::unused_message_popup_width_compute().
| void BKE_lib_query_unused_ids_tag | ( | Main * | bmain, |
| int | tag, | ||
| LibQueryUnusedIDsData & | parameters ) |
Tag all unused IDs (a.k.a 'orphaned').
By default only tag IDs with 0 user count. If do_recursive is set, it will check dependencies to detect all IDs that are not actually used in current file, including 'archipelagos‘ (i.e. set of IDs referencing each other in loops, but without any 'external’ valid usages.
Valid usages here are defined as ref-counting usages, which are not towards embedded or loop-back data.
| tag | the ID tag to use to mark the ID as unused. Should never be 0. |
| r_num_tagged_total | A zero-initialized array of INDEX_ID_MAX integers. Number of IDs tagged as unused from given parameters, per ID type in the matching index, and as total in INDEX_ID_NULL item. |
Definition at line 962 of file lib_query.cc.
References BKE_main_relations_create(), BKE_main_relations_free(), BLI_assert, data, lib_query_unused_ids_tag(), and parameters.
Referenced by bpy_orphans_purge(), lib_override_cleanup_after_resync(), blender::ed::outliner::outliner_orphans_purge_exec(), and blender::bke::blendfile::PartialWriteContext::remove_unused().
| void BKE_library_foreach_ID_embedded | ( | LibraryForeachIDData * | data, |
| ID ** | id_pp ) |
Process embedded ID pointers (root node-trees, master collections, ...).
Those require specific care, since they are technically sub-data of their owner, yet in some cases they still behave as regular IDs.
Definition at line 163 of file lib_query.cc.
References BKE_lib_query_foreachid_iter_stop(), BKE_lib_query_foreachid_process(), BLI_assert, BLI_gset_add(), BLI_LINKSTACK_PUSH, flag, ID::flag, IDWALK_CB_EMBEDDED, IDWALK_IGNORE_EMBEDDED_ID, IDWALK_RECURSE, IDWALK_STOP, and library_foreach_ID_link().
Referenced by light_foreach_id(), linestyle_foreach_id(), material_foreach_id(), scene_foreach_id(), texture_foreach_id(), and world_foreach_id().
| void BKE_library_foreach_ID_link | ( | Main * | bmain, |
| ID * | id, | ||
| blender::FunctionRef< LibraryIDLinkCallback > | callback, | ||
| void * | user_data, | ||
| int | flag ) |
Loop over all of the ID's this data-block links to.
| bmain | The Main data-base containing owner_id, may be null. |
| id | The ID to process. Note that currently, embedded IDs may also be passed here. |
| callback | The callback processing a given ID usage (i.e. a given ID pointer within the given id data). |
| user_data | Opaque user data for the callback processing a given ID usage. |
| flag | Flags controlling how/which ID pointers are processed. |
Definition at line 416 of file lib_query.cc.
References callback, flag, and library_foreach_ID_link().
Referenced by BKE_blendfile_link_append_instantiate_loose(), BKE_id_copy_for_use_in_bmain(), BKE_id_copy_in_lib(), BKE_lib_id_clear_library_data(), BKE_lib_id_expand_local(), BKE_lib_override_library_is_hierarchy_leaf(), BKE_libblock_management_main_add(), BKE_libblock_management_usercounts_clear(), BKE_libblock_management_usercounts_set(), BKE_library_ID_test_usages(), BKE_library_ID_use_ID(), BKE_library_indirectly_used_data_tag_clear(), BKE_library_unused_linked_data_set_tag(), BKE_main_id_refcount_recompute(), BKE_main_relations_create(), BKE_mesh_new_from_object_to_bmain(), blendfile_append_define_actions(), BLO_expand_main(), bpy_user_map(), blender::deg::deg_validate_eval_copy_datablock(), foreach_libblock_link_append_common_processing(), gather_frames_to_render(), blender::bke::blendfile::PartialWriteContext::id_add(), blender::bke::blendfile::PartialWriteContext::is_valid(), lib_link_all(), lib_override_libraries_index_define(), libblock_relink_to_newid_prepare_data(), libblock_remap_data(), library_ID_is_used(), memfile_undosys_step_decode(), paste_material_exec(), previews_ensure_exec(), read_undo_remap_noundo_data(), blender::animrig::internal::rebuild_slot_user_cache(), reuse_bmain_data_invalid_local_usages_fix(), reuse_editable_asset_bmain_data_for_blendfile(), sequencer_write_copy_paste_file(), swap_old_bmain_data_dependencies_process(), blender::ed::object::tag_localizable_objects(), blender::bke::tests::TEST(), blender::bke::tests::TEST(), blender::deg::DepsgraphNodeBuilder::update_invalid_cow_pointers(), and write_file_handle().
| void BKE_library_foreach_subdata_id | ( | Main * | bmain, |
| ID * | owner_id, | ||
| ID * | self_id, | ||
| blender::FunctionRef< void(LibraryForeachIDData *data)> | subdata_foreach_id, | ||
| blender::FunctionRef< LibraryIDLinkCallback > | callback, | ||
| void * | user_data, | ||
| const int | flag ) |
Apply callback to all ID usages of the data as defined by subdata_foreach_id. Useful to e.g. process all ID usages of a node, or a modifier, and so on.
subdata_foreach_id callback is responsible to decide which data to process, and to call the relevant 'foreach_id' helpers (typically shared with the relevant IDTypeInfo::foreach_id code path). This is typically done by using a lambda as subdata_foreach_id, which captures the required extra parameters do process the target subdata.main, owner_id and self_id may be null. There is also no requirement for owner_id or self_id to be actual owner IDs of the processed subdata. This function merely initializes a LibraryForeachIDData object with given parameters, and wraps a call to given subdata_foreach_id.| bmain | The Main data-base containing owner_id, may be null. |
| owner_id | The owner ID, i.e. the data-block owning the given sub-data (may differ from self_id in case the later is an embedded ID). |
| self_id | Typically the same as owner_id, unless it is an embedded ID. |
| subdata_foreach_id | The callback handling which data to process, and iterating over all ID usages of this subdata. Typically a lambda capturing that subdata, see comments above for details. |
| callback | The callback processing a given ID usage, see BKE_library_foreach_ID_link. |
| user_data | Opaque user data for the callback processing a given ID usage, see BKE_library_foreach_ID_link. |
| flag | Flags controlling the process, see BKE_library_foreach_ID_link. Note that some flags are not accepted here (IDWALK_RECURSE, IDWALK_DO_INTERNAL_RUNTIME_POINTERS, IDWALK_DO_LIBRARY_POINTER, IDWALK_INCLUDE_UI). |
Definition at line 436 of file lib_query.cc.
References BLI_assert, LibraryForeachIDData::bmain, callback, flag, ID::flag, IDWALK_DO_INTERNAL_RUNTIME_POINTERS, IDWALK_DO_LIBRARY_POINTER, IDWALK_INCLUDE_UI, and IDWALK_RECURSE.
Referenced by blender::ed::space_node::NodeClipboard::copy_add_node(), blender::ed::space_node::NodeClipboard::paste_update_node_id_references(), blender::ed::space_node::NodeClipboard::paste_validate_id_references(), and blender::bke::tests::TEST().
| uint64_t BKE_library_id_can_use_filter_id | ( | const ID * | owner_id, |
| const bool | include_ui, | ||
| const IDTypeInfo * | owner_id_type = nullptr ) |
Given the owner_id return the type of id_types it can use as a filter_id.
Definition at line 461 of file lib_query.cc.
References BKE_animdata_from_id(), BKE_idtype_get_info_from_id(), BLI_assert_unreachable, IDTypeInfo::dependencies_id_types, FILTER_ID_ALL, GS, ID_IS_OVERRIDE_LIBRARY_REAL, ID_SCR, ID::name, blender::bke::node_tree_from_id(), and ID::properties.
Referenced by BKE_library_id_can_use_idtype(), and libblock_remap_data().
| bool BKE_library_id_can_use_idtype | ( | ID * | owner_id, |
| short | id_type_used ) |
Say whether given owner_id may use (in any way) a data-block of id_type_used.
This is a 'simplified' abstract version of BKE_library_foreach_ID_link() above, quite useful to reduce useless iterations in some cases.
Definition at line 502 of file lib_query.cc.
References BKE_idtype_get_info_from_id(), BKE_idtype_idcode_to_idfilter(), and BKE_library_id_can_use_filter_id().
Referenced by BKE_library_ID_test_usages(), and library_ID_is_used().
| bool BKE_library_ID_is_indirectly_used | ( | Main * | bmain, |
| void * | idv ) |
Check whether given ID is used indirectly (i.e. by another linked ID).
Definition at line 613 of file lib_query.cc.
References library_ID_is_used().
Referenced by blender::ed::object::base_free_and_unlink(), blender::ed::object::base_free_and_unlink_no_indirect_check(), BKE_brush_delete(), blender::ed::outliner::id_delete_tag(), blender::ed::object::object_delete_exec(), blender::ed::outliner::outliner_batch_delete_object_tag(), and blender::ed::outliner::outliner_object_delete_fn().
| bool BKE_library_ID_is_locally_used | ( | Main * | bmain, |
| void * | idv ) |
Check whether given ID is used locally (i.e. by another non-linked ID).
Definition at line 608 of file lib_query.cc.
References library_ID_is_used().
| void BKE_library_ID_test_usages | ( | Main * | bmain, |
| void * | idv, | ||
| bool * | r_is_used_local, | ||
| bool * | r_is_used_linked ) |
Combine BKE_library_ID_is_locally_used() and BKE_library_ID_is_indirectly_used() in a single call.
Definition at line 618 of file lib_query.cc.
References BKE_library_foreach_ID_link(), BKE_library_id_can_use_idtype(), IDUsersIter::count_direct, IDUsersIter::count_indirect, IDUsersIter::curr_id, ListBase::first, foreach_libblock_id_users_callback(), GS, IDUsersIter::id, IDWALK_READONLY, INDEX_ID_MAX, ID::next, and set_listbasepointers().
Referenced by BKE_lib_id_make_local_generic_action_define().
Return the number of times given id_user uses/references id_used.
| id_user | the ID which is supposed to use (reference) id_used. |
| id_used | the ID which is supposed to be used (referenced) by id_user. |
Definition at line 560 of file lib_query.cc.
References BKE_library_foreach_ID_link(), IDUsersIter::count_direct, IDUsersIter::count_indirect, IDUsersIter::curr_id, foreach_libblock_id_users_callback(), IDUsersIter::id, and IDWALK_READONLY.
| void BKE_library_indirectly_used_data_tag_clear | ( | Main * | bmain | ) |
Untag linked data blocks used by other untagged linked data-blocks. Used to detect data-blocks that we can forcefully make local (instead of copying them to later get rid of original): All data-blocks we want to make local are tagged by caller, after this function has ran caller knows data-blocks still tagged can directly be made local, since they are only used by other data-blocks that will also be made fully local.
Definition at line 1035 of file lib_query.cc.
References BKE_library_foreach_ID_link(), foreach_libblock_used_linked_data_tag_clear_cb(), ID_IS_LINKED, ID_TAG_DOIT, IDWALK_READONLY, INDEX_ID_MAX, LISTBASE_FOREACH, and set_listbasepointers().
| void BKE_library_unused_linked_data_set_tag | ( | Main * | bmain, |
| bool | do_init_tag ) |
Detect orphaned linked data blocks (i.e. linked data not used (directly or indirectly) in any way by any local data), including complex cases like 'linked archipelagoes', i.e. linked data-blocks that use each other in loops, which prevents their deletion by 'basic' usage checks.
| do_init_tag | if true, all linked data are checked, if false, only linked data-blocks already tagged with ID_TAG_DOIT are checked. |
Definition at line 1006 of file lib_query.cc.
References BKE_library_foreach_ID_link(), foreach_libblock_used_linked_data_tag_clear_cb(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, ID_TAG_DOIT, ID_TAG_INDIRECT, IDWALK_READONLY, and ID::tag.
Re-usable function, use when replacing ID's.
Definition at line 425 of file lib_query.cc.
References id_us_ensure_real(), id_us_min(), id_us_plus(), IDWALK_CB_USER, and IDWALK_CB_USER_ONE.