Blender V5.3
BKE_lib_override.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2016 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
25
26#include "BLI_enum_flags.hh"
27#include "BLI_map.hh"
28
29#include <optional>
30
31namespace blender {
32
34struct Collection;
35struct ID;
39struct Library;
40struct Main;
41struct Object;
42struct PointerRNA;
43struct PropertyRNA;
44struct ReportList;
45struct Scene;
46struct ViewLayer;
47
49
51
52} // namespace bke::liboverride
53
54enum eID_OverrideLib_Op : short;
55enum eID_OverrideLib_PropTag : short;
56
81
85IDOverrideLibrary *BKE_lib_override_library_init(ID *local_id, ID *reference_id);
89void BKE_lib_override_library_copy(ID *dst_id, const ID *src_id, bool do_full_copy);
101 bool value);
102
114 ID *id,
115 ID *owner_id_hint,
116 ID **r_owner_id);
117
122
126bool BKE_lib_override_library_is_system_defined(const Main *bmain, const ID *id);
127
137 const ID *id,
138 const IDOverrideLibraryProperty *liboverride_prop,
139 const PropertyRNA *override_rna_prop,
140 const int rnaprop_index);
141
149
157
164ID *BKE_lib_override_library_create_from_id(Main *bmain, ID *reference_id, bool do_tagged_remap);
200 Library *owner_library,
201 const ID *id_root_reference,
202 ID *id_hierarchy_root,
203 const ID *id_hierarchy_root_reference,
204 bool do_no_main,
205 const bool do_fully_editable);
241 Scene *scene,
242 ViewLayer *view_layer,
243 Library *owner_library,
244 ID *id_root_reference,
245 ID *id_hierarchy_root_reference,
246 ID *id_instance_hint,
247 ID **r_id_root_override,
248 const bool do_fully_editable);
249
261 Scene *scene,
262 ViewLayer *view_layer,
263 Object *ob_proxy);
270
292
300 Main *bmain,
302 ReportList *reports = nullptr);
303
318bool BKE_lib_override_library_resync(Main *bmain,
319 Scene *scene,
320 ViewLayer *view_layer,
321 ID *id_root,
322 Collection *override_resync_residual_storage,
323 bool do_hierarchy_enforce,
324 BlendFileReadReport *reports);
346 Main *bmain,
347 const Map<Library *, Library *> *new_to_old_libraries_map,
348 Scene *scene,
349 ViewLayer *view_layer,
350 BlendFileReadReport *reports);
351
360void BKE_lib_override_library_delete(Main *bmain, ID *id_root);
361
372void BKE_lib_override_library_make_local(Main *bmain, ID *id);
373
383
387IDOverrideLibraryProperty *BKE_lib_override_library_property_find(IDOverrideLibrary *liboverride,
388 const char *rna_path);
392IDOverrideLibraryProperty *BKE_lib_override_library_property_get(IDOverrideLibrary *liboverride,
393 const char *rna_path,
394 bool *r_created);
398void BKE_lib_override_library_property_delete(IDOverrideLibrary *liboverride,
399 IDOverrideLibraryProperty *liboverride_property);
405bool BKE_lib_override_library_property_search_and_delete(IDOverrideLibrary *liboverride,
406 const char *rna_path);
407
419bool BKE_lib_override_library_property_rna_path_change(IDOverrideLibrary *liboverride,
420 const char *old_rna_path,
421 const char *new_rna_path);
422
432bool BKE_lib_override_rna_property_find(PointerRNA *idpoin,
433 const IDOverrideLibraryProperty *library_prop,
434 PointerRNA *r_override_poin,
435 PropertyRNA **r_override_prop,
436 int *r_index);
437
445IDOverrideLibraryPropertyOperation *BKE_lib_override_library_property_operation_find(
446 IDOverrideLibraryProperty *liboverride_property,
447 const char *subitem_refname,
448 const char *subitem_locname,
449 const std::optional<const ID *> &subitem_refid,
450 const std::optional<const ID *> &subitem_locid,
451 int subitem_refindex,
452 int subitem_locindex,
453 bool strict,
454 bool *r_strict);
458IDOverrideLibraryPropertyOperation *BKE_lib_override_library_property_operation_get(
459 IDOverrideLibraryProperty *liboverride_property,
460 eID_OverrideLib_Op operation,
461 const char *subitem_refname,
462 const char *subitem_locname,
463 const std::optional<ID *> &subitem_refid,
464 const std::optional<ID *> &subitem_locid,
465 int subitem_refindex,
466 int subitem_locindex,
467 bool strict,
468 bool *r_strict,
469 bool *r_created);
474 IDOverrideLibraryProperty *liboverride_property,
475 IDOverrideLibraryPropertyOperation *liboverride_property_operation);
476
481 IDOverrideLibraryPropertyOperation *liboverride_property_operation,
482 PointerRNA *ptr_dst,
483 PointerRNA *ptr_src,
484 PointerRNA *ptr_storage,
485 PropertyRNA *prop_dst,
486 PropertyRNA *prop_src,
487 PropertyRNA *prop_storage);
488
493 IDOverrideLibraryPropertyOperation &liboverride_property_operation,
494 StringRefNull label,
495 StringRefNull tooltip);
496
500void BKE_lib_override_library_validate(Main *bmain, ID *id, ReportList *reports);
504void BKE_lib_override_library_main_validate(Main *bmain, ReportList *reports);
505
517bool BKE_lib_override_library_status_check_local(Main *bmain, ID *local);
529bool BKE_lib_override_library_status_check_reference(Main *bmain, ID *local);
530
545void BKE_lib_override_library_operations_create(Main *bmain, ID *local, int *r_report_flags);
552 bool force_auto,
553 int *r_report_flags);
554
564void BKE_lib_override_library_operations_restore(Main *bmain, ID *local, int *r_report_flags);
574void BKE_lib_override_library_main_operations_restore(Main *bmain, int *r_report_flags);
575
582void BKE_lib_override_library_id_reset(Main *bmain, ID *id_root, bool do_reset_system_override);
590 ID *id_root,
591 bool do_reset_system_override);
592
596void BKE_lib_override_library_operations_tag(IDOverrideLibraryProperty *liboverride_property,
598 bool do_set);
602void BKE_lib_override_library_properties_tag(IDOverrideLibrary *liboverride,
604 bool do_set);
608void BKE_lib_override_library_main_tag(Main *bmain, eID_OverrideLib_PropTag tag, bool do_set);
609
618
622void BKE_lib_override_library_update(Main *bmain, ID *local);
627
631bool BKE_lib_override_library_id_is_user_deletable(Main *bmain, ID *id);
632
636StringRefNull BKE_lib_override_operation_as_string(const eID_OverrideLib_Op operation);
637
641void BKE_lib_override_debug_print(IDOverrideLibrary *liboverride, const char *intro_txt);
642
643} // namespace blender
Definition scene.h:133
CCL_NAMESPACE_BEGIN struct Options options
ENUM_OPERATORS(Layer::Flags)
BMesh Iterators.
void BKE_lib_override_library_tag_set(IDOverrideLibrary &liboverride, IDOverrideLibraryTag tag, bool value)
void BKE_lib_override_library_clear(IDOverrideLibrary *liboverride, bool do_id_user)
IDOverrideLibraryPropertyOperation * 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)
bool 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 BKE_lib_override_library_is_user_edited(const ID *id)
bool 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)
StringRefNull BKE_lib_override_operation_as_string(const eID_OverrideLib_Op operation)
void BKE_lib_override_library_property_operation_ui_info_set(IDOverrideLibraryPropertyOperation &liboverride_property_operation, StringRefNull label, StringRefNull tooltip)
void BKE_lib_override_flag_subdata_local(ID &id)
eID_OverrideLib_PropTag
Definition DNA_ID.h:237
void BKE_lib_override_id_tag_on_deg_tag_from_user(ID *id)
ID * BKE_lib_override_library_create_from_id(Main *bmain, ID *reference_id, bool do_tagged_remap)
void BKE_lib_override_library_operations_restore(Main *bmain, ID *local, int *r_report_flags)
bool 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)
bool BKE_lib_override_library_is_system_defined(const Main *bmain, const ID *id)
eID_OverrideLib_Op
Definition DNA_ID.h:182
bool BKE_lib_override_library_status_check_local(Main *bmain, ID *local)
void BKE_lib_override_library_main_tag(Main *bmain, eID_OverrideLib_PropTag tag, bool do_set)
LibOverride_HierarchyRoot_ValidateOptions
@ ONLY_PROCESS_NULL_ROOT_POINTERS
@ REPORT_NULL_ROOT_POINTERS
void BKE_lib_override_library_main_proxy_convert(Main *bmain, BlendFileReadReport *reports)
void BKE_lib_override_library_update(Main *bmain, ID *local)
void BKE_lib_override_library_validate(Main *bmain, ID *id, ReportList *reports)
void BKE_lib_override_library_id_unused_cleanup(ID *local)
void BKE_lib_override_library_main_operations_restore(Main *bmain, int *r_report_flags)
void BKE_lib_override_library_delete(Main *bmain, ID *id_root)
void BKE_lib_override_library_main_hierarchy_root_ensure(Main *bmain, LibOverride_HierarchyRoot_ValidateOptions options={}, ReportList *reports=nullptr)
void BKE_lib_override_library_properties_tag(IDOverrideLibrary *liboverride, eID_OverrideLib_PropTag tag, bool do_set)
void BKE_lib_override_library_operations_tag(IDOverrideLibraryProperty *liboverride_property, eID_OverrideLib_PropTag tag, bool do_set)
void BKE_lib_override_library_make_local(Main *bmain, ID *id)
void BKE_lib_override_library_copy(ID *dst_id, const ID *src_id, bool do_full_copy)
void BKE_lib_override_library_property_operation_delete(IDOverrideLibraryProperty *liboverride_property, IDOverrideLibraryPropertyOperation *liboverride_property_operation)
bool BKE_lib_override_library_status_check_reference(Main *bmain, ID *local)
void BKE_lib_override_library_id_reset(Main *bmain, ID *id_root, bool do_reset_system_override)
IDOverrideLibraryProperty * BKE_lib_override_library_property_find(IDOverrideLibrary *liboverride, const char *rna_path)
bool BKE_lib_override_library_property_search_and_delete(IDOverrideLibrary *liboverride, const char *rna_path)
IDOverrideLibrary * BKE_lib_override_library_init(ID *local_id, ID *reference_id)
void BKE_lib_override_library_main_operations_create(Main *bmain, bool force_auto, int *r_report_flags)
void 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 BKE_lib_override_library_main_update(Main *bmain)
void BKE_lib_override_library_main_validate(Main *bmain, ReportList *reports)
bool BKE_lib_override_library_is_hierarchy_leaf(Main *bmain, ID *id)
void BKE_lib_override_library_free(IDOverrideLibrary **liboverride, bool do_id_user)
bool BKE_lib_override_library_property_rna_path_change(IDOverrideLibrary *liboverride, const char *old_rna_path, const char *new_rna_path)
IDOverrideLibraryProperty * BKE_lib_override_library_property_get(IDOverrideLibrary *liboverride, const char *rna_path, bool *r_created)
void BKE_lib_override_debug_print(IDOverrideLibrary *liboverride, const char *intro_txt)
void BKE_lib_override_library_main_unused_cleanup(Main *bmain)
bool BKE_lib_override_rna_property_find(PointerRNA *idpoin, const IDOverrideLibraryProperty *library_prop, PointerRNA *r_override_poin, PropertyRNA **r_override_prop, int *r_index)
bool BKE_lib_override_library_proxy_convert(Main *bmain, Scene *scene, ViewLayer *view_layer, Object *ob_proxy)
bool 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)
void BKE_lib_override_library_operations_create(Main *bmain, ID *local, int *r_report_flags)
bool BKE_lib_override_library_property_is_animated(const ID *id, const IDOverrideLibraryProperty *liboverride_prop, const PropertyRNA *override_rna_prop, const int rnaprop_index)
void BKE_lib_override_library_property_delete(IDOverrideLibrary *liboverride, IDOverrideLibraryProperty *liboverride_property)
void BKE_lib_override_library_id_hierarchy_reset(Main *bmain, ID *id_root, bool do_reset_system_override)
IDOverrideLibraryPropertyOperation * 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)
bool BKE_lib_override_library_id_is_user_deletable(Main *bmain, ID *id)
IDOverrideLibrary * BKE_lib_override_library_get(Main *bmain, ID *id, ID *owner_id_hint, ID **r_owner_id)