BKE_lib_override.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2016 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <optional>
 
struct BlendFileReadReport;
struct Collection;
struct ID;
struct IDOverrideLibrary;
struct IDOverrideLibraryProperty;
struct IDOverrideLibraryPropertyOperation;
struct Library;
struct Main;
struct Object;
struct PointerRNA;
struct PropertyRNA;
struct ReportList;
struct Scene;
struct ViewLayer;
 
IDOverrideLibrary *BKE_lib_override_library_init(ID *local_id, ID *reference_id);
void BKE_lib_override_library_copy(ID *dst_id, const ID *src_id, bool do_full_copy);
void BKE_lib_override_library_clear(IDOverrideLibrary *liboverride, bool do_id_user);
void BKE_lib_override_library_free(IDOverrideLibrary **liboverride, bool do_id_user);
 
IDOverrideLibrary *BKE_lib_override_library_get(Main *bmain,
                                                ID *id,
                                                ID *owner_id_hint,
                                                ID **r_owner_id);
 
bool BKE_lib_override_library_is_user_edited(const ID *id);
 
bool BKE_lib_override_library_is_system_defined(const Main *bmain, const ID *id);
 
bool BKE_lib_override_library_property_is_animated(
    const ID *id,
    const IDOverrideLibraryProperty *liboverride_prop,
    const PropertyRNA *override_rna_prop,
    const int rnaprop_index);
 
bool BKE_lib_override_library_is_hierarchy_leaf(Main *bmain, ID *id);
 
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);
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);
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_proxy_convert(Main *bmain,
                                            Scene *scene,
                                            ViewLayer *view_layer,
                                            Object *ob_proxy);
void BKE_lib_override_library_main_proxy_convert(Main *bmain, BlendFileReadReport *reports);
 
void BKE_lib_override_library_main_hierarchy_root_ensure(Main *bmain);
 
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);
void BKE_lib_override_library_main_resync(Main *bmain,
                                          Scene *scene,
                                          ViewLayer *view_layer,
                                          BlendFileReadReport *reports);
 
void BKE_lib_override_library_delete(Main *bmain, ID *id_root);
 
void BKE_lib_override_library_make_local(Main *bmain, ID *id);
 
IDOverrideLibraryProperty *BKE_lib_override_library_property_find(IDOverrideLibrary *liboverride,
                                                                  const char *rna_path);
IDOverrideLibraryProperty *BKE_lib_override_library_property_get(IDOverrideLibrary *liboverride,
                                                                 const char *rna_path,
                                                                 bool *r_created);
void BKE_lib_override_library_property_delete(IDOverrideLibrary *liboverride,
                                              IDOverrideLibraryProperty *liboverride_property);
bool BKE_lib_override_library_property_search_and_delete(IDOverrideLibrary *liboverride,
                                                         const char *rna_path);
 
bool BKE_lib_override_library_property_rna_path_change(IDOverrideLibrary *liboverride,
                                                       const char *old_rna_path,
                                                       const char *new_rna_path);
 
bool BKE_lib_override_rna_property_find(PointerRNA *idpoin,
                                        const IDOverrideLibraryProperty *library_prop,
                                        PointerRNA *r_override_poin,
                                        PropertyRNA **r_override_prop,
                                        int *r_index);
 
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);
IDOverrideLibraryPropertyOperation *BKE_lib_override_library_property_operation_get(
    IDOverrideLibraryProperty *liboverride_property,
    short 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 BKE_lib_override_library_property_operation_delete(
    IDOverrideLibraryProperty *liboverride_property,
    IDOverrideLibraryPropertyOperation *liboverride_property_operation);
 
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);
 
void BKE_lib_override_library_validate(Main *bmain, ID *id, ReportList *reports);
void BKE_lib_override_library_main_validate(Main *bmain, ReportList *reports);
 
bool BKE_lib_override_library_status_check_local(Main *bmain, ID *local);
bool BKE_lib_override_library_status_check_reference(Main *bmain, ID *local);
 
void BKE_lib_override_library_operations_create(Main *bmain, ID *local, int *r_report_flags);
void BKE_lib_override_library_main_operations_create(Main *bmain,
                                                     bool force_auto,
                                                     int *r_report_flags);
 
void BKE_lib_override_library_operations_restore(Main *bmain, ID *local, int *r_report_flags);
void BKE_lib_override_library_main_operations_restore(Main *bmain, int *r_report_flags);
 
void BKE_lib_override_library_id_reset(Main *bmain, ID *id_root, bool do_reset_system_override);
void BKE_lib_override_library_id_hierarchy_reset(Main *bmain,
                                                 ID *id_root,
                                                 bool do_reset_system_override);
 
void BKE_lib_override_library_operations_tag(IDOverrideLibraryProperty *liboverride_property,
                                             short tag,
                                             bool do_set);
void BKE_lib_override_library_properties_tag(IDOverrideLibrary *liboverride,
                                             short tag,
                                             bool do_set);
void BKE_lib_override_library_main_tag(Main *bmain, short tag, bool do_set);
 
void BKE_lib_override_library_id_unused_cleanup(ID *local);
void BKE_lib_override_library_main_unused_cleanup(Main *bmain);
 
void BKE_lib_override_library_update(Main *bmain, ID *local);
void BKE_lib_override_library_main_update(Main *bmain);
 
bool BKE_lib_override_library_id_is_user_deletable(Main *bmain, ID *id);
 
void BKE_lib_override_debug_print(IDOverrideLibrary *liboverride, const char *intro_txt);
 
/* Storage (.blend file writing) part. */
 
/* For now, we just use a temp main list. */
using OverrideLibraryStorage = Main;
 
OverrideLibraryStorage *BKE_lib_override_library_operations_store_init();
ID *BKE_lib_override_library_operations_store_start(Main *bmain,
                                                    OverrideLibraryStorage *liboverride_storage,
                                                    ID *local);
void BKE_lib_override_library_operations_store_end(OverrideLibraryStorage *liboverride_storage,
                                                   ID *local);
void BKE_lib_override_library_operations_store_finalize(
    OverrideLibraryStorage *liboverride_storage);