Blender
V3.3
|
Go to the source code of this file.
Typedefs | |
typedef struct Main | OverrideLibraryStorage |
API to manage data-blocks inside of Blender's Main data-base, or as independent runtime-only data.
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_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.h.
typedef struct Main OverrideLibraryStorage |
Definition at line 477 of file BKE_lib_override.h.
void BKE_lib_override_library_clear | ( | struct IDOverrideLibrary * | override, |
bool | do_id_user | ||
) |
Clear any overriding data from given override.
Definition at line 218 of file lib_override.cc.
References BLI_assert, BLI_freelistN(), BLI_ghash_clear(), ELEM, id_us_min(), lib_override_library_property_clear(), LISTBASE_FOREACH, and override.
Referenced by BKE_lib_override_library_copy(), and BKE_lib_override_library_free().
void BKE_lib_override_library_copy | ( | struct ID * | dst_id, |
const struct ID * | src_id, | ||
bool | do_full_copy | ||
) |
Shallow or deep copy of a whole override from src_id to dst_id.
Referenced by BKE_libblock_copy_ex().
bool BKE_lib_override_library_create | ( | struct Main * | bmain, |
struct Scene * | scene, | ||
struct ViewLayer * | view_layer, | ||
struct Library * | owner_library, | ||
struct ID * | id_root_reference, | ||
struct ID * | id_hierarchy_root_reference, | ||
struct ID * | id_instance_hint, | ||
struct ID ** | r_id_root_override, | ||
const bool | do_fully_editable | ||
) |
Advanced 'smart' function to create fully functional overrides.
view_layer | the active view layer to search instantiated collections in, can be NULL (in which case scene's master collection children hierarchy is used instead). |
owner_library | the library in which the overrides should be created. Besides versioning and resync code path, this should always be NULL (i.e. the local .blend file). |
id_root_reference | The linked root ID to create an override from. May be a sub-root of the overall hierarchy, in which case calling code is expected to have already tagged required 'path' of IDs leading from the given id_hierarchy_root to the given id_root . |
id_hierarchy_root_reference | The ID to be used a hierarchy root of the overrides to be created. Can be either the linked root ID of the whole override hierarchy, (typically the same as id_root , unless a sub-part only of the hierarchy is overridden), or the already existing override hierarchy root if part of the hierarchy is already overridden. |
id_instance_hint | Some ID used as hint/reference to do some post-processing after overrides have been created, may be NULL. Typically, the Empty object instantiating the linked collection we override, currently. |
r_id_root_override | if not NULL, the override generated for the given id_root. |
do_fully_editable | if true, tag all created overrides as user-editable by default. |
Definition at line 1371 of file lib_override.cc.
References BKE_lib_override_library_main_operations_create(), BKE_main_id_newptr_and_tag_clear(), BKE_main_id_tag_all(), lib_override_library_create_do(), lib_override_library_create_post_process(), LIB_TAG_DOIT, ID::newid, OBACT, and scene.
Referenced by BKE_lib_override_library_proxy_convert(), id_override_library_create_hierarchy(), make_override_library_exec(), and ui_template_id_liboverride_hierarchy_make().
struct ID* BKE_lib_override_library_create_from_id | ( | struct Main * | bmain, |
struct ID * | reference_id, | ||
bool | do_tagged_remap | ||
) |
Create an overridden local copy of linked reference.
Definition at line 393 of file lib_override.cc.
References BKE_key_from_id(), BKE_libblock_relink_ex(), BLI_assert, IDOverrideLibrary::flag, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, IDOverrideLibrary::hierarchy_root, Key::id, ID_IS_LINKED, ID_REMAP_SKIP_INDIRECT_USAGE, ID_REMAP_SKIP_OVERRIDE_LIBRARY, IDOVERRIDE_LIBRARY_FLAG_NO_HIERARCHY, IDOVERRIDE_LIBRARY_FLAG_SYSTEM_DEFINED, lib_override_library_create_from(), LIB_TAG_DOIT, ID::override_library, and ID::tag.
Referenced by id_override_library_create_hierarchy().
bool BKE_lib_override_library_create_from_tag | ( | struct Main * | bmain, |
struct Library * | owner_library, | ||
const struct ID * | id_root_reference, | ||
struct ID * | id_hierarchy_root, | ||
const struct ID * | id_hierarchy_root_reference, | ||
bool | do_no_main, | ||
const bool | do_fully_editable | ||
) |
Create overridden local copies of all tagged data-blocks in given Main.
id->newid
of overridden libs with newly created overrides, caller is responsible to clean those pointers before/after usage as needed.owner_library | the library in which the overrides should be created. Besides versioning and resync code path, this should always be NULL (i.e. the local .blend file). |
id_root_reference | the linked ID that is considered as the root of the overridden hierarchy. |
id_hierarchy_root | the override ID that is the root of the hierarchy. May be NULL, in which case it is assumed that the given id_root_reference is tagged for override, and its newly created override will be used as hierarchy root. Must be NULL if id_hierarchy_root_reference is not NULL. |
id_hierarchy_root_reference | the linked ID that is the root of the hierarchy. Must be tagged for override. May be NULL, in which case it is assumed that the given id_root_reference is tagged for override, and its newly created override will be used as hierarchy root. Must be NULL if id_hierarchy_root is not NULL. |
do_no_main | Create the new override data outside of Main database. Used for resyncing of linked overrides. |
do_fully_editable | if true, tag all created overrides as user-editable by default. |
Advanced 'smart' function to delete library overrides (including their existing override hierarchy) and remap their usages to their linked reference IDs.
id_root | The root liboverride ID to delete. |
Definition at line 2757 of file lib_override.cc.
References BKE_id_multi_tagged_delete(), BKE_libblock_remap(), BKE_main_id_tag_all(), BKE_main_relations_create(), BKE_main_relations_free(), BLI_assert, data, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, IDOverrideLibrary::hierarchy_root, id, ID_IS_OVERRIDE_LIBRARY_REAL, ID_REMAP_SKIP_INDIRECT_USAGE, lib_override_group_tag_data_clear(), lib_override_group_tag_data_object_to_collection_init(), lib_override_overrides_group_tag(), LIB_TAG_DOIT, LIB_TAG_MISSING, ID::override_library, IDOverrideLibrary::reference, and ID::tag.
Referenced by id_override_library_delete_hierarchy_process().
void BKE_lib_override_library_free | ( | struct IDOverrideLibrary ** | override, |
bool | do_id_user | ||
) |
Free given override.
Definition at line 237 of file lib_override.cc.
References BKE_lib_override_library_clear(), BLI_assert, BLI_ghash_free(), MEM_freeN, and MEM_SAFE_FREE.
Referenced by BKE_lib_override_library_copy(), BKE_lib_override_library_make_local(), and BKE_libblock_free_data().
IDOverrideLibrary* BKE_lib_override_library_get | ( | struct Main * | bmain, |
struct ID * | id, | ||
struct ID * | owner_id_hint, | ||
struct ID ** | r_owner_id | ||
) |
Return the actual IDOverrideLibrary data 'controlling' the given id
, and the actual ID owning it.
id
is a non-real override (e.g. embedded ID like a master collection or root node tree, or a shape key).owner_id_hint | If not NULL, a potential owner for the given override-embedded id . |
r_owner_id | If given, will be set with the actual ID owning the return liboverride data. |
Definition at line 120 of file lib_override.cc.
References BKE_lib_override_library_get().
Referenced by blender::ed::outliner::id_is_in_override_hierarchy(), and ui_template_id_liboverride_hierarchy_make().
void BKE_lib_override_library_id_hierarchy_reset | ( | struct Main * | bmain, |
struct ID * | id_root, | ||
bool | do_reset_system_override | ||
) |
Reset all overrides in given id_root and its dependencies, while preserving ID relations.
do_reset_system_override | If true, reset the given ID and all of its descendants in the override hierarchy as system override ones (i.e. non-editable). |
Definition at line 3600 of file lib_override.cc.
References BKE_lib_override_library_update(), BKE_main_relations_create(), BKE_main_relations_free(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id, ID_IS_OVERRIDE_LIBRARY_REAL, IDOVERRIDE_LIBRARY_RUNTIME_TAG_NEEDS_RELOAD, lib_override_library_id_hierarchy_recursive_reset(), ID::override_library, IDOverrideLibrary::runtime, and IDOverrideLibraryRuntime::tag.
Referenced by id_override_library_reset_fn().
In case an ID is used by another liboverride ID, user may not be allowed to delete it.
Definition at line 3867 of file lib_override.cc.
References BKE_collection_has_object(), Main::collections, GS, id, ID_IS_OVERRIDE_LIBRARY, ID_OB, LISTBASE_FOREACH, and ID::name.
Referenced by ED_object_base_free_and_unlink(), join_shapes_exec(), object_delete_exec(), and object_join_exec().
void BKE_lib_override_library_id_reset | ( | struct Main * | bmain, |
struct ID * | id_root, | ||
bool | do_reset_system_override | ||
) |
Reset all overrides in given id_root, while preserving ID relations.
do_reset_system_override | If true, reset the given ID as a system override one (i.e. non-editable). |
Definition at line 3538 of file lib_override.cc.
References BKE_lib_override_library_update(), ID_IS_OVERRIDE_LIBRARY_REAL, IDOVERRIDE_LIBRARY_RUNTIME_TAG_NEEDS_RELOAD, lib_override_library_id_reset_do(), ID::override_library, IDOverrideLibrary::runtime, and IDOverrideLibraryRuntime::tag.
Referenced by clear_override_library_exec(), id_override_library_clear_single_fn(), id_override_library_reset_fn(), lib_id_override_editable_toggle_exec(), override_idtemplate_clear_exec(), override_idtemplate_reset_exec(), reset_override_library_exec(), and ui_template_id_liboverride_hierarchy_make().
Remove all tagged-as-unused properties and operations from that ID override data.
Definition at line 3668 of file lib_override.cc.
References BKE_lib_override_library_property_delete(), BKE_lib_override_library_property_operation_delete(), ID_IS_OVERRIDE_LIBRARY_REAL, IDOVERRIDE_LIBRARY_TAG_UNUSED, LISTBASE_FOREACH_MUTABLE, ID::override_library, and IDOverrideLibrary::properties.
Referenced by BKE_lib_override_library_main_unused_cleanup().
struct IDOverrideLibrary* BKE_lib_override_library_init | ( | struct ID * | local_id, |
struct ID * | reference_id | ||
) |
Initialize empty overriding of reference_id by local_id.
Definition at line 134 of file lib_override.cc.
References BKE_lib_override_library_copy(), BLI_assert, IDOverrideLibrary::flag, ID_IS_LINKED, id_us_min(), id_us_plus(), IDOVERRIDE_LIBRARY_FLAG_SYSTEM_DEFINED, LIB_TAG_OVERRIDE_LIBRARY_REFOK, ID::override_library, IDOverrideLibrary::reference, and ID::tag.
Referenced by BKE_lib_override_library_copy(), BKE_lib_override_library_proxy_convert(), BKE_lib_override_library_template_create(), and lib_override_library_create_from().
Check if given ID is a leaf in its liboverride hierarchy (i.e. if it does not use any other override ID).
NOTE: Embedded IDs of override IDs are not considered as leaves.
Definition at line 381 of file lib_override.cc.
References BKE_library_foreach_ID_link(), foreachid_is_hierarchy_leaf_fn(), ID_IS_OVERRIDE_LIBRARY_REAL, and IDWALK_READONLY.
Referenced by clear_override_library_exec(), id_override_library_clear_single_fn(), and override_idtemplate_clear_exec().
Check if given ID is a system override.
Referenced by BKE_id_is_editable(), lib_id_override_editable_toggle_exec(), outliner_draw_overrides_restrictbuts(), and rna_property_editable_do().
Check if given ID has some override rules that actually indicate the user edited it.
Referenced by blo_do_versions_300().
Find and set the 'hierarchy root' ID pointer of all library overrides in given bmain
.
NOTE: Cannot be called from do_versions_after_linking
as this code needs a single complete Main database, not a split-by-libraries one.
Definition at line 1616 of file lib_override.cc.
References BKE_main_relations_create(), BKE_main_relations_free(), BKE_main_relations_tag_set(), BLI_assert, CLOG_ERROR, CLOG_WARN, ELEM, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, IDOverrideLibrary::hierarchy_root, id, ID_IS_OVERRIDE_LIBRARY_REAL, ID::lib, lib_override_root_find(), lib_override_root_hierarchy_set(), LOG, MAINIDRELATIONS_ENTRY_TAGS_PROCESSED, ID::name, and ID::override_library.
Referenced by lib_override_library_main_resync_on_library_indirect_level(), and setup_app_data().
Check all overrides from given bmain and create/update overriding operations as needed.
Definition at line 3395 of file lib_override.cc.
References BKE_lib_override_library_main_operations_create(), BKE_lib_override_library_main_tag(), BKE_lib_override_library_main_unused_cleanup(), BKE_lib_override_library_properties_tag(), BKE_pose_ensure(), BLI_assert, BLI_task_pool_create(), BLI_task_pool_free(), BLI_task_pool_push(), BLI_task_pool_work_and_wait(), LibOverrideOpCreateData::bmain, Object::data, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, GS, id, ID_IS_LINKED, ID_IS_OVERRIDE_LIBRARY_REAL, ID_OB, IDOVERRIDE_LIBRARY_TAG_UNUSED, lib_override_library_operations_create_cb(), LIB_TAG_MISSING, LIB_TAG_OVERRIDE_LIBRARY_AUTOREFRESH, LISTBASE_FOREACH, ID::name, OB_ARMATURE, Main::objects, ID::override_library, IDOverrideLibrary::reference, ID::tag, task_pool, TASK_PRIORITY_HIGH, TIMEIT_END_AVERAGED, TIMEIT_START_AVERAGED, and Object::type.
Referenced by BKE_blendfile_library_relocate(), BKE_lib_override_library_create(), BKE_lib_override_library_main_operations_create(), BKE_undosys_step_push_with_type(), setup_app_data(), and wm_file_write().
void BKE_lib_override_library_main_proxy_convert | ( | struct Main * | bmain, |
struct BlendFileReadReport * | reports | ||
) |
Convert all proxy objects into library overrides.
Definition at line 113 of file lib_override_proxy_conversion.c.
References BLI_linklist_append(), BLI_linklist_free(), CLOG_WARN, BlendFileReadReport::count, FOREACH_SCENE_OBJECT_BEGIN, FOREACH_SCENE_OBJECT_END, ID_IS_LINKED, id_us_min(), lib_override_library_proxy_convert_do(), LinkNodePair::list, LISTBASE_FOREACH, LOG, NULL, Main::objects, BlendFileReadReport::proxies_to_lib_overrides_failures, scene, and Main::scenes.
Referenced by blendfile_link_append_proxies_convert(), and setup_app_data().
void BKE_lib_override_library_main_resync | ( | struct Main * | bmain, |
struct Scene * | scene, | ||
struct ViewLayer * | view_layer, | ||
struct BlendFileReadReport * | reports | ||
) |
Detect and handle required resync of overrides data, when relations between reference linked IDs have changed.
This is a fairly complex and costly operation, typically it should be called after BKE_lib_override_library_main_update, which would already detect and tag a lot of cases.
This function will first detect the remaining cases requiring a resync (namely, either when an existing linked ID that did not require to be overridden before now would be, or when new IDs are added to the hierarchy).
Then it will handle the resync of necessary IDs (through calls to BKE_lib_override_library_resync).
view_layer | the active view layer to search instantiated collections in, can be NULL (in which case scene's master collection children hierarchy is used instead). |
Definition at line 2687 of file lib_override.cc.
References BKE_collection_add(), BKE_collection_delete(), BKE_collection_is_empty(), BKE_layer_collection_resync_allow(), BKE_layer_collection_resync_forbid(), BKE_main_namemap_validate(), BLI_assert, BLI_findstring(), CLOG_INFO, COLLECTION_HIDE_RENDER, COLLECTION_HIDE_VIEWPORT, Main::collections, Collection::flag, ID_IS_LINKED, lib_override_libraries_index_define(), lib_override_library_create_post_process(), lib_override_library_main_resync_on_library_indirect_level(), Main::libraries, library, LIBRARY_TAG_RESYNC_REQUIRED, LISTBASE_FOREACH, LOG, Scene::master_collection, OBACT, OVERRIDE_RESYNC_RESIDUAL_STORAGE_NAME, and scene.
Referenced by BKE_blendfile_library_relocate(), and setup_app_data().
Set or clear given tag in all properties and operations in that Main's ID override data.
Definition at line 3656 of file lib_override.cc.
References BKE_lib_override_library_properties_tag(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id, ID_IS_OVERRIDE_LIBRARY, and ID::override_library.
Referenced by BKE_lib_override_library_main_operations_create().
Remove all tagged-as-unused properties and operations from that Main's ID override data.
Definition at line 3687 of file lib_override.cc.
References BKE_lib_override_library_id_unused_cleanup(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id, and ID_IS_OVERRIDE_LIBRARY.
Referenced by BKE_lib_override_library_main_operations_create().
Update all overrides from given bmain.
Definition at line 3843 of file lib_override.cc.
References BKE_lib_override_library_update(), BKE_main_namemap_validate(), BLI_assert, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, G_MAIN, id, and ID::override_library.
Referenced by blo_read_file_internal(), and library_link_end().
void BKE_lib_override_library_main_validate | ( | struct Main * | bmain, |
struct ReportList * | reports | ||
) |
Check against potential bmain.
Definition at line 3198 of file lib_override.cc.
References BKE_lib_override_library_validate(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id, and ID_IS_OVERRIDE_LIBRARY.
Referenced by blo_read_file_internal(), and library_link_end().
Make given ID fully local.
Definition at line 2798 of file lib_override.cc.
References BKE_key_from_id(), BKE_lib_override_library_free(), BLI_assert_unreachable, ID::flag, GS, id, Collection::id, Key::id, ID_IS_OVERRIDE_LIBRARY, ID_IS_OVERRIDE_LIBRARY_VIRTUAL, ID_SCE, LIB_EMBEDDED_DATA_LIB_OVERRIDE, ID::name, ntreeFromID(), and ID::override_library.
Referenced by BKE_lib_override_library_validate(), BKE_library_make_local(), id_local_fn(), and template_id_cb().
Compare local and reference data-blocks and create new override operations as needed, or reset to reference values if overriding is not allowed.
.blend
file on disk (not for undo!). Knowing that info at runtime is only useful for UI/UX feedback.Definition at line 3316 of file lib_override.cc.
References BKE_pose_ensure(), BLI_assert, CLOG_INFO, Object::data, GS, ID_IS_LINKED, ID_MISSING, ID_OB, LOG, ID::name, OB_ARMATURE, ID::override_library, IDOverrideLibrary::reference, RNA_id_pointer_create(), RNA_OVERRIDE_COMPARE_CREATE, RNA_OVERRIDE_COMPARE_RESTORE, RNA_OVERRIDE_MATCH_RESULT_CREATED, RNA_OVERRIDE_MATCH_RESULT_RESTORED, RNA_struct_override_matches(), and Object::type.
Referenced by BKE_lib_override_library_operations_store_start(), and lib_override_library_operations_create_cb().
void BKE_lib_override_library_operations_store_end | ( | OverrideLibraryStorage * | override_storage, |
struct ID * | local | ||
) |
Restore given ID modified by BKE_lib_override_library_operations_store_start, to its original state.
Referenced by write_file_handle().
void BKE_lib_override_library_operations_store_finalize | ( | OverrideLibraryStorage * | override_storage | ) |
Definition at line 3982 of file lib_override.cc.
References BKE_id_free_ex(), BKE_main_free(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id, and LIB_ID_FREE_NO_UI_USER.
Referenced by write_file_handle().
OverrideLibraryStorage* BKE_lib_override_library_operations_store_init | ( | void | ) |
Initialize an override storage.
Storage (how to store overriding data into .blend
files).
Basically: 1) Only 'differential' overrides needs special handling here. All others (replacing values or inserting/removing items from a collection) can be handled with simply storing current content of local data-block. 2) We store the differential value into a second 'ghost' data-block, which is an empty ID of same type as the local one, where we only define values that need differential data.
This avoids us having to modify 'real' data-block at write time (and restoring it afterwards), which is inefficient, and potentially dangerous (in case of concurrent access...), while not using much extra memory in typical cases. It also ensures stored data-block always contains exact same data as "desired" ones (kind of "baked" data-blocks).
Definition at line 3903 of file lib_override.cc.
References BKE_main_new().
Referenced by write_file_handle().
struct ID* BKE_lib_override_library_operations_store_start | ( | struct Main * | bmain, |
OverrideLibraryStorage * | override_storage, | ||
struct ID * | local | ||
) |
Generate suitable 'write' data (this only affects differential override operations).
Note that local ID is no more modified by this call, all extra data are stored in its temp storage_id copy.
Definition at line 3908 of file lib_override.cc.
References BKE_id_copy(), BKE_id_free_ex(), BKE_lib_override_library_operations_create(), BKE_lib_override_library_operations_store_start(), BLI_assert, ID_IS_OVERRIDE_LIBRARY_REAL, ID_IS_OVERRIDE_LIBRARY_TEMPLATE, ID_IS_OVERRIDE_LIBRARY_VIRTUAL, LIB_ID_FREE_NO_UI_USER, ID::override_library, IDOverrideLibrary::reference, RNA_id_pointer_create(), RNA_struct_override_store(), IDOverrideLibrary::storage, TIMEIT_END_AVERAGED, TIMEIT_START_AVERAGED, and UNUSED_VARS_NDEBUG.
Referenced by BKE_lib_override_library_operations_store_start(), and write_file_handle().
void BKE_lib_override_library_operations_tag | ( | struct IDOverrideLibraryProperty * | override_property, |
short | tag, | ||
bool | do_set | ||
) |
Set or clear given tag in all operations in that override property data.
Definition at line 3622 of file lib_override.cc.
References LISTBASE_FOREACH, IDOverrideLibraryProperty::operations, and IDOverrideLibraryProperty::tag.
Referenced by BKE_lib_override_library_properties_tag(), and RNA_struct_override_matches().
void BKE_lib_override_library_properties_tag | ( | struct IDOverrideLibrary * | override, |
short | tag, | ||
bool | do_set | ||
) |
Set or clear given tag in all properties and operations in that override data.
Definition at line 3645 of file lib_override.cc.
References BKE_lib_override_library_operations_tag(), LISTBASE_FOREACH, and override.
Referenced by BKE_lib_override_library_main_operations_create(), and BKE_lib_override_library_main_tag().
void BKE_lib_override_library_property_delete | ( | struct IDOverrideLibrary * | override, |
struct IDOverrideLibraryProperty * | override_property | ||
) |
Remove and free given override_property from given ID override.
Definition at line 2927 of file lib_override.cc.
References BLI_freelinkN(), BLI_ghash_remove(), ELEM, lib_override_library_property_clear(), override, and IDOverrideLibraryProperty::rna_path.
Referenced by BKE_lib_override_library_id_unused_cleanup(), lib_override_library_id_reset_do(), lib_override_library_resync(), and override_remove_button_exec().
struct IDOverrideLibraryProperty* BKE_lib_override_library_property_find | ( | struct IDOverrideLibrary * | override, |
const char * | rna_path | ||
) |
Find override property from given RNA path, if it exists.
Definition at line 2857 of file lib_override.cc.
References BLI_ghash_lookup(), and override_library_rna_path_mapping_ensure().
Referenced by BKE_lib_override_library_property_get(), RNA_property_overridden(), RNA_property_override_property_find(), RNA_struct_override_matches(), version_liboverride_rnacollections_insertion_animdata(), and version_liboverride_rnacollections_insertion_object().
struct IDOverrideLibraryProperty* BKE_lib_override_library_property_get | ( | struct IDOverrideLibrary * | override, |
const char * | rna_path, | ||
bool * | r_created | ||
) |
Find override property from given RNA path, or create it if it does not exist.
Definition at line 2864 of file lib_override.cc.
References BKE_lib_override_library_property_find(), BLI_addtail(), BLI_ghash_insert(), BLI_strdup(), override, override_library_rna_path_mapping_ensure(), and IDOverrideLibraryProperty::rna_path.
Referenced by RNA_property_override_property_get().
bool BKE_lib_override_library_property_is_animated | ( | const ID * | id, |
const IDOverrideLibraryProperty * | override_prop, | ||
const struct PropertyRNA * | override_rna_prop, | ||
const int | rnaprop_index | ||
) |
Check if given Override Property for given ID is animated (through a F-Curve in an Action, or from a driver).
override_rna_prop | if not NULL, the RNA property matching the given path in the override_prop . |
rnaprop_index | Array in the RNA property, 0 if unknown or irrelevant. |
Referenced by blender::ed::outliner::iterate_properties_to_display().
void BKE_lib_override_library_property_operation_delete | ( | struct IDOverrideLibraryProperty * | override_property, |
struct IDOverrideLibraryPropertyOperation * | override_property_operation | ||
) |
Remove and free given override_property_operation from given ID override_property.
Definition at line 3093 of file lib_override.cc.
References BLI_freelinkN(), lib_override_library_property_operation_clear(), and IDOverrideLibraryProperty::operations.
Referenced by BKE_lib_override_library_id_unused_cleanup(), override_remove_button_exec(), version_liboverride_rnacollections_insertion_object(), and version_liboverride_rnacollections_insertion_object_constraints().
struct IDOverrideLibraryPropertyOperation* BKE_lib_override_library_property_operation_find | ( | struct IDOverrideLibraryProperty * | override_property, |
const char * | subitem_refname, | ||
const char * | subitem_locname, | ||
int | subitem_refindex, | ||
int | subitem_locindex, | ||
bool | strict, | ||
bool * | r_strict | ||
) |
Find override property operation from given sub-item(s), if it exists.
Definition at line 2940 of file lib_override.cc.
References BLI_findstring_ptr(), BLI_listbase_bytes_find(), ELEM, IDOverrideLibraryProperty::operations, STREQ, IDOverrideLibraryPropertyOperation::subitem_local_index, IDOverrideLibraryPropertyOperation::subitem_local_name, IDOverrideLibraryPropertyOperation::subitem_reference_index, and IDOverrideLibraryPropertyOperation::subitem_reference_name.
Referenced by BKE_lib_override_library_property_operation_get(), override_remove_button_exec(), and RNA_property_override_property_operation_find().
struct IDOverrideLibraryPropertyOperation* BKE_lib_override_library_property_operation_get | ( | struct IDOverrideLibraryProperty * | override_property, |
short | operation, | ||
const char * | subitem_refname, | ||
const char * | subitem_locname, | ||
int | subitem_refindex, | ||
int | subitem_locindex, | ||
bool | strict, | ||
bool * | r_strict, | ||
bool * | r_created | ||
) |
Find override property operation from given sub-item(s), or create it if it does not exist.
Definition at line 3027 of file lib_override.cc.
References BKE_lib_override_library_property_operation_find(), BLI_addtail(), BLI_strdup(), IDOverrideLibraryPropertyOperation::operation, IDOverrideLibraryProperty::operations, IDOverrideLibraryPropertyOperation::subitem_local_index, IDOverrideLibraryPropertyOperation::subitem_local_name, IDOverrideLibraryPropertyOperation::subitem_reference_index, and IDOverrideLibraryPropertyOperation::subitem_reference_name.
Referenced by override_remove_button_exec(), and RNA_property_override_property_operation_get().
bool BKE_lib_override_library_property_operation_operands_validate | ( | struct IDOverrideLibraryPropertyOperation * | override_property_operation, |
struct PointerRNA * | ptr_dst, | ||
struct PointerRNA * | ptr_src, | ||
struct PointerRNA * | ptr_storage, | ||
struct PropertyRNA * | prop_dst, | ||
struct PropertyRNA * | prop_src, | ||
struct PropertyRNA * | prop_storage | ||
) |
Validate that required data for a given operation are available.
Definition at line 3101 of file lib_override.cc.
References ATTR_FALLTHROUGH, BLI_assert_msg, PointerRNA::data, IDOVERRIDE_LIBRARY_OP_ADD, IDOVERRIDE_LIBRARY_OP_INSERT_AFTER, IDOVERRIDE_LIBRARY_OP_INSERT_BEFORE, IDOVERRIDE_LIBRARY_OP_MULTIPLY, IDOVERRIDE_LIBRARY_OP_NOOP, IDOVERRIDE_LIBRARY_OP_REPLACE, IDOVERRIDE_LIBRARY_OP_SUBTRACT, and IDOverrideLibraryPropertyOperation::operation.
Referenced by rna_property_override_operation_apply().
bool BKE_lib_override_library_proxy_convert | ( | struct Main * | bmain, |
struct Scene * | scene, | ||
struct ViewLayer * | view_layer, | ||
struct Object * | ob_proxy | ||
) |
Convert a given proxy object into a library override.
view_layer | the active view layer to search instantiated collections in, can be NULL (in which case scene's master collection children hierarchy is used instead). |
Definition at line 34 of file lib_override_proxy_conversion.c.
References BKE_lib_override_library_create(), BKE_lib_override_library_init(), DEG_id_tag_update(), IDOverrideLibrary::flag, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, Collection::id, Object::id, ID_IS_LINKED, ID_IS_OVERRIDABLE_LIBRARY_HIERARCHY, ID_RECALC_COPY_ON_WRITE, id_us_min(), IDOVERRIDE_LIBRARY_FLAG_SYSTEM_DEFINED, Object::instance_collection, ID::lib, LIB_TAG_DOIT, ID::newid, NULL, ID::override_library, scene, and ID::tag.
Referenced by lib_override_library_proxy_convert_do().
bool BKE_lib_override_library_resync | ( | struct Main * | bmain, |
struct Scene * | scene, | ||
struct ViewLayer * | view_layer, | ||
struct ID * | id_root, | ||
struct Collection * | override_resync_residual_storage, | ||
bool | do_hierarchy_enforce, | ||
struct BlendFileReadReport * | reports | ||
) |
Advanced 'smart' function to resync, re-create fully functional overrides up-to-date with linked data, from an existing override hierarchy.
view_layer | the active view layer to search instantiated collections in, can be NULL (in which case scene's master collection children hierarchy is used instead). |
id_root | The root liboverride ID to resync from. |
Definition at line 2174 of file lib_override.cc.
References BKE_id_free(), lib_override_library_resync(), LinkNode::link, LISTBASE_FOREACH_MUTABLE, ID::next, and scene.
Referenced by id_override_library_resync_hierarchy_process().
Check that status of local data-block is still valid against current reference one.
It means that all overridable, but not overridden, properties' local values must be equal to reference ones. Clears #LIB_TAG_OVERRIDE_OK if they do not.
This is typically used to detect whether some property has been changed in local and a new #IDOverrideProperty (of #IDOverridePropertyOperation) has to be added.
Definition at line 3210 of file lib_override.cc.
References BKE_pose_ensure(), BLI_assert, Object::data, GS, ID_IS_OVERRIDE_LIBRARY_REAL, ID_OB, LIB_TAG_OVERRIDE_LIBRARY_REFOK, ID::name, OB_ARMATURE, ID::override_library, IDOverrideLibrary::reference, RNA_id_pointer_create(), RNA_OVERRIDE_COMPARE_IGNORE_NON_OVERRIDABLE, RNA_OVERRIDE_COMPARE_IGNORE_OVERRIDDEN, RNA_struct_override_matches(), ID::tag, and Object::type.
Check that status of reference data-block is still valid against current local one.
It means that all non-overridden properties' local values must be equal to reference ones. Clears LIB_TAG_OVERRIDE_OK if they do not.
This is typically used to detect whether some reference has changed and local needs to be updated against it.
Definition at line 3260 of file lib_override.cc.
References BKE_lib_override_library_status_check_reference(), BKE_pose_ensure(), BLI_assert, Object::data, GS, ID_IS_OVERRIDE_LIBRARY_REAL, ID_OB, LIB_TAG_OVERRIDE_LIBRARY_REFOK, ID::name, OB_ARMATURE, ID::override_library, IDOverrideLibrary::reference, RNA_id_pointer_create(), RNA_OVERRIDE_COMPARE_IGNORE_OVERRIDDEN, RNA_struct_override_matches(), ID::tag, and Object::type.
Referenced by BKE_lib_override_library_status_check_reference().
Create a library override template.
Definition at line 1426 of file lib_override.cc.
References BKE_lib_override_library_init(), ID_IS_LINKED, and ID_IS_OVERRIDE_LIBRARY.
Update given override from its reference (re-applying overridden properties).
Definition at line 3707 of file lib_override.cc.
References BKE_id_copy_ex(), BKE_id_free_ex(), BKE_key_from_id(), BKE_key_from_id_p(), BKE_lib_override_library_update(), BKE_main_namemap_remove_name(), BKE_pose_clear_pointers(), BLI_assert, BLI_strncpy(), DEG_id_tag_update_ex(), DEG_relations_tag_update(), ID::flag, Key::from, GS, Key::id, ID_AR, ID_IS_OVERRIDE_LIBRARY_REAL, ID_MISSING, ID_RECALC_ALL, ID::lib, LIB_EMBEDDED_DATA_LIB_OVERRIDE, LIB_ID_COPY_DEFAULT, LIB_ID_COPY_NO_LIB_OVERRIDE_LOCAL_DATA_FLAG, LIB_ID_FREE_NO_NAMEMAP_REMOVE, LIB_ID_FREE_NO_UI_USER, lib_override_id_swap(), lib_override_object_posemode_transfer(), LIB_TAG_OVERRIDE_LIBRARY_REFOK, LISTBASE_FOREACH, ID::name, OB_ARMATURE, Main::objects, ID::override_library, POSE_RECALC, IDOverrideLibrary::reference, RNA_id_pointer_create(), RNA_OVERRIDE_APPLY_FLAG_NOP, RNA_struct_override_apply(), IDOverrideLibrary::storage, and ID::tag.
Referenced by BKE_blendfile_library_relocate(), BKE_lib_override_library_id_hierarchy_reset(), BKE_lib_override_library_id_reset(), BKE_lib_override_library_main_update(), and BKE_lib_override_library_update().
void BKE_lib_override_library_validate | ( | struct Main * | bmain, |
struct ID * | id, | ||
struct ReportList * | reports | ||
) |
Check against potential bmain.
Definition at line 3138 of file lib_override.cc.
References BKE_lib_override_library_get(), BKE_lib_override_library_make_local(), BKE_reportf(), BLI_assert, id, ID_IS_LINKED, ID_IS_OVERRIDE_LIBRARY, ID_IS_OVERRIDE_LIBRARY_VIRTUAL, LIB_EMBEDDED_DATA_LIB_OVERRIDE, ID::name, IDOverrideLibrary::reference, RPT_ERROR, and RPT_WARNING.
Referenced by BKE_lib_override_library_main_validate().
bool BKE_lib_override_rna_property_find | ( | struct PointerRNA * | idpoin, |
const struct IDOverrideLibraryProperty * | library_prop, | ||
struct PointerRNA * | r_override_poin, | ||
struct PropertyRNA ** | r_override_prop, | ||
int * | r_index | ||
) |
Get the RNA-property matching the library_prop override property. Used for UI to query additional data about the overridden property (e.g. UI name).
idpoin | Pointer to the override ID. |
library_prop | The library override property to find the matching RNA property for. |
r_index | The RNA array flat index (i.e. flattened index in case of multi-dimensional array properties). See RNA_path_resolve_full family of functions for details. |
Referenced by blender::ed::outliner::iterate_properties_to_display().