Blender V5.3
blender::BKEIDDeleteOptions Struct Reference

#include <BKE_lib_id.hh>

Public Attributes

int extra_remapping_flags = 0
bool prevent_liboverride_hierarchy_root_ensure = false
bool prevent_invariants_update = false

Detailed Description

Helper struct to pass advanced control options to BKE_id_delete and related APIs.

Definition at line 592 of file BKE_lib_id.hh.

Member Data Documentation

◆ extra_remapping_flags

int blender::BKEIDDeleteOptions::extra_remapping_flags = 0

Additional ID_REMAP_ flags to pass to remapping code when ensuring that deleted IDs are not used by any other ID in given bmain. Typical example would be e.g. ID_REMAP_FORCE_UI_POINTERS, required when default UI-handling callbacks of remapping code won't be working (e.g. from readfile code).

Definition at line 599 of file BKE_lib_id.hh.

◆ prevent_invariants_update

bool blender::BKEIDDeleteOptions::prevent_invariants_update = false

Do not update invariants after deletion.

This is required when deleting data in cases where there is no fully valid Main available (e.g. from readfile code).

Definition at line 613 of file BKE_lib_id.hh.

◆ prevent_liboverride_hierarchy_root_ensure

bool blender::BKEIDDeleteOptions::prevent_liboverride_hierarchy_root_ensure = false

If true, do not validate and update liboverride hierarchy root pointers after deleting some IDs. Useful e.g. for ID deletion within liboverride resync process and the like.

Definition at line 605 of file BKE_lib_id.hh.


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