Blender V5.3
BKE_lib_override.hh File Reference
#include "BLI_enum_flags.hh"
#include "BLI_map.hh"
#include <optional>

Go to the source code of this file.

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::bke
namespace  blender::bke::liboverride

Enumerations

enum class  blender::IDOverrideLibraryTag { blender::TAG_NEEDS_RELOAD = 1 << 0 , blender::TAG_NEEDS_RESTORE = 1 << 1 , blender::TAG_RESYNC_ISOLATED_FROM_ROOT = 1 << 2 , blender::TAG_NEED_RESYNC_ORIGINAL = 1 << 3 }
enum  blender::LibOverride_HierarchyRoot_ValidateOptions { blender::ONLY_PROCESS_NULL_ROOT_POINTERS = 1 << 0 , blender::REPORT_NULL_ROOT_POINTERS = 1 << 16 }

Functions

bool blender::bke::liboverride::is_auto_resync_enabled ()
 blender::ENUM_OPERATORS (IDOverrideLibraryTag)
IDOverrideLibrary * blender::BKE_lib_override_library_init (ID *local_id, ID *reference_id)
void blender::BKE_lib_override_library_copy (ID *dst_id, const ID *src_id, bool do_full_copy)
void blender::BKE_lib_override_library_clear (IDOverrideLibrary *liboverride, bool do_id_user)
void blender::BKE_lib_override_library_free (IDOverrideLibrary **liboverride, bool do_id_user)
void blender::BKE_lib_override_library_tag_set (IDOverrideLibrary &liboverride, IDOverrideLibraryTag tag, bool value)
IDOverrideLibrary * blender::BKE_lib_override_library_get (Main *bmain, ID *id, ID *owner_id_hint, ID **r_owner_id)
bool blender::BKE_lib_override_library_is_user_edited (const ID *id)
bool blender::BKE_lib_override_library_is_system_defined (const Main *bmain, const ID *id)
bool blender::BKE_lib_override_library_property_is_animated (const ID *id, const IDOverrideLibraryProperty *liboverride_prop, const PropertyRNA *override_rna_prop, const int rnaprop_index)
bool blender::BKE_lib_override_library_is_hierarchy_leaf (Main *bmain, ID *id)
void blender::BKE_lib_override_id_tag_on_deg_tag_from_user (ID *id)
ID * blender::BKE_lib_override_library_create_from_id (Main *bmain, ID *reference_id, bool do_tagged_remap)
bool blender::BKE_lib_override_library_create_from_tag (Main *bmain, Library *owner_library, const ID *id_root_reference, ID *id_hierarchy_root, const ID *id_hierarchy_root_reference, bool do_no_main, const bool do_fully_editable)
bool blender::BKE_lib_override_library_create (Main *bmain, Scene *scene, ViewLayer *view_layer, Library *owner_library, ID *id_root_reference, ID *id_hierarchy_root_reference, ID *id_instance_hint, ID **r_id_root_override, const bool do_fully_editable)
bool blender::BKE_lib_override_library_proxy_convert (Main *bmain, Scene *scene, ViewLayer *view_layer, Object *ob_proxy)
void blender::BKE_lib_override_library_main_proxy_convert (Main *bmain, BlendFileReadReport *reports)
 blender::ENUM_OPERATORS (LibOverride_HierarchyRoot_ValidateOptions)
void blender::BKE_lib_override_library_main_hierarchy_root_ensure (Main *bmain, LibOverride_HierarchyRoot_ValidateOptions options={}, ReportList *reports=nullptr)
bool blender::BKE_lib_override_library_resync (Main *bmain, Scene *scene, ViewLayer *view_layer, ID *id_root, Collection *override_resync_residual_storage, bool do_hierarchy_enforce, BlendFileReadReport *reports)
void blender::BKE_lib_override_library_main_resync (Main *bmain, const Map< Library *, Library * > *new_to_old_libraries_map, Scene *scene, ViewLayer *view_layer, BlendFileReadReport *reports)
void blender::BKE_lib_override_library_delete (Main *bmain, ID *id_root)
void blender::BKE_lib_override_library_make_local (Main *bmain, ID *id)
void blender::BKE_lib_override_flag_subdata_local (ID &id)
IDOverrideLibraryProperty * blender::BKE_lib_override_library_property_find (IDOverrideLibrary *liboverride, const char *rna_path)
IDOverrideLibraryProperty * blender::BKE_lib_override_library_property_get (IDOverrideLibrary *liboverride, const char *rna_path, bool *r_created)
void blender::BKE_lib_override_library_property_delete (IDOverrideLibrary *liboverride, IDOverrideLibraryProperty *liboverride_property)
bool blender::BKE_lib_override_library_property_search_and_delete (IDOverrideLibrary *liboverride, const char *rna_path)
bool blender::BKE_lib_override_library_property_rna_path_change (IDOverrideLibrary *liboverride, const char *old_rna_path, const char *new_rna_path)
bool blender::BKE_lib_override_rna_property_find (PointerRNA *idpoin, const IDOverrideLibraryProperty *library_prop, PointerRNA *r_override_poin, PropertyRNA **r_override_prop, int *r_index)
IDOverrideLibraryPropertyOperation * blender::BKE_lib_override_library_property_operation_find (IDOverrideLibraryProperty *liboverride_property, const char *subitem_refname, const char *subitem_locname, const std::optional< const ID * > &subitem_refid, const std::optional< const ID * > &subitem_locid, int subitem_refindex, int subitem_locindex, bool strict, bool *r_strict)
IDOverrideLibraryPropertyOperation * blender::BKE_lib_override_library_property_operation_get (IDOverrideLibraryProperty *liboverride_property, eID_OverrideLib_Op operation, const char *subitem_refname, const char *subitem_locname, const std::optional< ID * > &subitem_refid, const std::optional< ID * > &subitem_locid, int subitem_refindex, int subitem_locindex, bool strict, bool *r_strict, bool *r_created)
void blender::BKE_lib_override_library_property_operation_delete (IDOverrideLibraryProperty *liboverride_property, IDOverrideLibraryPropertyOperation *liboverride_property_operation)
bool blender::BKE_lib_override_library_property_operation_operands_validate (IDOverrideLibraryPropertyOperation *liboverride_property_operation, PointerRNA *ptr_dst, PointerRNA *ptr_src, PointerRNA *ptr_storage, PropertyRNA *prop_dst, PropertyRNA *prop_src, PropertyRNA *prop_storage)
void blender::BKE_lib_override_library_property_operation_ui_info_set (IDOverrideLibraryPropertyOperation &liboverride_property_operation, StringRefNull label, StringRefNull tooltip)
void blender::BKE_lib_override_library_validate (Main *bmain, ID *id, ReportList *reports)
void blender::BKE_lib_override_library_main_validate (Main *bmain, ReportList *reports)
bool blender::BKE_lib_override_library_status_check_local (Main *bmain, ID *local)
bool blender::BKE_lib_override_library_status_check_reference (Main *bmain, ID *local)
void blender::BKE_lib_override_library_operations_create (Main *bmain, ID *local, int *r_report_flags)
void blender::BKE_lib_override_library_main_operations_create (Main *bmain, bool force_auto, int *r_report_flags)
void blender::BKE_lib_override_library_operations_restore (Main *bmain, ID *local, int *r_report_flags)
void blender::BKE_lib_override_library_main_operations_restore (Main *bmain, int *r_report_flags)
void blender::BKE_lib_override_library_id_reset (Main *bmain, ID *id_root, bool do_reset_system_override)
void blender::BKE_lib_override_library_id_hierarchy_reset (Main *bmain, ID *id_root, bool do_reset_system_override)
void blender::BKE_lib_override_library_operations_tag (IDOverrideLibraryProperty *liboverride_property, eID_OverrideLib_PropTag tag, bool do_set)
void blender::BKE_lib_override_library_properties_tag (IDOverrideLibrary *liboverride, eID_OverrideLib_PropTag tag, bool do_set)
void blender::BKE_lib_override_library_main_tag (Main *bmain, eID_OverrideLib_PropTag tag, bool do_set)
void blender::BKE_lib_override_library_id_unused_cleanup (ID *local)
void blender::BKE_lib_override_library_main_unused_cleanup (Main *bmain)
void blender::BKE_lib_override_library_update (Main *bmain, ID *local)
void blender::BKE_lib_override_library_main_update (Main *bmain)
bool blender::BKE_lib_override_library_id_is_user_deletable (Main *bmain, ID *id)
StringRefNull blender::BKE_lib_override_operation_as_string (const eID_OverrideLib_Op operation)
void blender::BKE_lib_override_debug_print (IDOverrideLibrary *liboverride, const char *intro_txt)

Detailed Description

API to manage data-blocks inside of Blender's Main data-base, or as independent runtime-only data.

Note
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.).

Names

Warning
Descriptions below is ideal goal, current status of naming does not yet fully follow it (this is WIP).
  • BKE_lib_override_library_ should be used for function affecting a single ID.
  • BKE_lib_override_library_main_ should be used for function affecting the whole collection of IDs in a given Main data-base.

Definition in file BKE_lib_override.hh.