Blender V5.3
blender::LibQueryUnusedIDsData Struct Reference

#include <BKE_lib_query.hh>

Public Attributes

bool do_local_ids = false
bool do_linked_ids = false
bool do_recursive = false
FunctionRef< bool(ID *id)> filter_fn = nullptr
std::array< int, INDEX_ID_MAX > num_total
std::array< int, INDEX_ID_MAX > num_local
std::array< int, INDEX_ID_MAX > num_linked

Detailed Description

Parameters and result data structure for the 'unused IDs' functions below.

Definition at line 421 of file BKE_lib_query.hh.

Member Data Documentation

◆ do_linked_ids

bool blender::LibQueryUnusedIDsData::do_linked_ids = false

◆ do_local_ids

bool blender::LibQueryUnusedIDsData::do_local_ids = false

◆ do_recursive

bool blender::LibQueryUnusedIDsData::do_recursive = false

Process all actually unused data-blocks, including these that are currently only used by other unused data-blocks, and 'dependency islands' of several data-blocks using each-other, without any external valid user.

Definition at line 431 of file BKE_lib_query.hh.

Referenced by blender::BKE_lib_query_unused_ids_amounts(), blender::bpy_orphans_purge(), blender::lib_override_cleanup_after_resync(), and blender::bke::blendfile::PartialWriteContext::remove_unused().

◆ filter_fn

FunctionRef<bool(ID *id)> blender::LibQueryUnusedIDsData::filter_fn = nullptr

Callback filter, if defined and it returns true, the given id may be considered as unused, otherwise it will always be considered as used.

Allows for more complex handling of which IDs should be deleted, on top of the basic local/linked choices.

TODO: Refactor this to return some optional UnusedIDsData::Status value instead, and always call it. This will allow this callback to have full control over the final status of the given ID, if it decides to.

Definition at line 444 of file BKE_lib_query.hh.

Referenced by blender::lib_override_cleanup_after_resync().

◆ num_linked

std::array<int, INDEX_ID_MAX> blender::LibQueryUnusedIDsData::num_linked

Amount of detected as unused linked data-blocks, per type and total as the last value of the array (INDEX_ID_NULL).

Note
Return value, set by the executed function.

Definition at line 466 of file BKE_lib_query.hh.

Referenced by blender::BKE_lib_query_unused_ids_amounts(), and blender::BKE_lib_query_unused_ids_tag().

◆ num_local

std::array<int, INDEX_ID_MAX> blender::LibQueryUnusedIDsData::num_local

Amount of detected as unused local data-blocks, per type and total as the last value of the array (INDEX_ID_NULL).

Note
Return value, set by the executed function.

Definition at line 459 of file BKE_lib_query.hh.

Referenced by blender::BKE_lib_query_unused_ids_amounts(), blender::BKE_lib_query_unused_ids_tag(), and blender::lib_override_cleanup_after_resync().

◆ num_total

std::array<int, INDEX_ID_MAX> blender::LibQueryUnusedIDsData::num_total

Amount of detected as unused data-blocks, per type and total as the last value of the array (INDEX_ID_NULL).

Note
Return value, set by the executed function.

Definition at line 452 of file BKE_lib_query.hh.

Referenced by blender::BKE_lib_query_unused_ids_amounts(), blender::BKE_lib_query_unused_ids_tag(), blender::bpy_orphans_purge(), blender::lib_override_cleanup_after_resync(), and blender::bke::blendfile::PartialWriteContext::remove_unused().


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