[Bf-blender-cvs] [2a7e83ce18e] blender-v3.3-release: LibOverride: Expose in public API the utils to get actual override data.

Bastien Montagne noreply at git.blender.org
Tue Aug 2 15:07:38 CEST 2022


Commit: 2a7e83ce18e838e12526529130ad31dd1b50cbbd
Author: Bastien Montagne
Date:   Tue Aug 2 15:03:11 2022 +0200
Branches: blender-v3.3-release
https://developer.blender.org/rB2a7e83ce18e838e12526529130ad31dd1b50cbbd

LibOverride: Expose in public API the utils to get actual override data.

This is useful when input ID is a 'non-override' one (like embedded IDs
or shapekeys), to get override data and 'owner' ID pointer.

===================================================================

M	source/blender/blenkernel/BKE_lib_override.h
M	source/blender/blenkernel/intern/lib_override.cc

===================================================================

diff --git a/source/blender/blenkernel/BKE_lib_override.h b/source/blender/blenkernel/BKE_lib_override.h
index b2162e651fd..9ad5a32e6f0 100644
--- a/source/blender/blenkernel/BKE_lib_override.h
+++ b/source/blender/blenkernel/BKE_lib_override.h
@@ -59,6 +59,19 @@ void BKE_lib_override_library_clear(struct IDOverrideLibrary *override, bool do_
  */
 void BKE_lib_override_library_free(struct IDOverrideLibrary **override, bool do_id_user);
 
+/**
+ * Return the actual #IDOverrideLibrary data 'controlling' the given `id`, and the acutal ID owning
+ * it.
+ *
+ * \note This is especially useful when `id` is a non-real override (e.g. embedded ID like a master
+ * collection or root node tree, or a shape key).
+ *
+ * \param r_owner_id If given, will be set with the actual ID owning the return liboverride data.
+ */
+IDOverrideLibrary *BKE_lib_override_library_get(struct Main *bmain,
+                                                struct ID *id,
+                                                struct ID **r_owner_id);
+
 /**
  * Check if given ID has some override rules that actually indicate the user edited it.
  */
diff --git a/source/blender/blenkernel/intern/lib_override.cc b/source/blender/blenkernel/intern/lib_override.cc
index 4ad8d26cd2a..febc91716dd 100644
--- a/source/blender/blenkernel/intern/lib_override.cc
+++ b/source/blender/blenkernel/intern/lib_override.cc
@@ -91,9 +91,9 @@ BLI_INLINE void lib_override_object_posemode_transfer(ID *id_dst, ID *id_src)
 }
 
 /** Get override data for a given ID. Needed because of our beloved shape keys snowflake. */
-BLI_INLINE const IDOverrideLibrary *lib_override_get(const Main *bmain,
-                                                     const ID *id,
-                                                     const ID **r_owner_id)
+BLI_INLINE const IDOverrideLibrary *BKE_lib_override_library_get(const Main *bmain,
+                                                                 const ID *id,
+                                                                 const ID **r_owner_id)
 {
   if (r_owner_id != nullptr) {
     *r_owner_id = id;
@@ -114,13 +114,14 @@ BLI_INLINE const IDOverrideLibrary *lib_override_get(const Main *bmain,
   return id->override_library;
 }
 
-BLI_INLINE IDOverrideLibrary *lib_override_get(Main *bmain, ID *id, ID **r_owner_id)
+IDOverrideLibrary *BKE_lib_override_library_get(Main *bmain, ID *id, ID **r_owner_id)
 {
   /* Reuse the implementation of the const access function, which does not change the arguments.
    * Add const explicitly to make it clear to the compiler to avoid just calling this function. */
-  return const_cast<IDOverrideLibrary *>(lib_override_get(const_cast<const Main *>(bmain),
-                                                          const_cast<const ID *>(id),
-                                                          const_cast<const ID **>(r_owner_id)));
+  return const_cast<IDOverrideLibrary *>(
+      BKE_lib_override_library_get(const_cast<const Main *>(bmain),
+                                   const_cast<const ID *>(id),
+                                   const_cast<const ID **>(r_owner_id)));
 }
 
 IDOverrideLibrary *BKE_lib_override_library_init(ID *local_id, ID *reference_id)
@@ -317,7 +318,7 @@ bool BKE_lib_override_library_is_system_defined(const Main *bmain, const ID *id)
 {
   if (ID_IS_OVERRIDE_LIBRARY(id)) {
     const ID *override_owner_id;
-    lib_override_get(bmain, id, &override_owner_id);
+    BKE_lib_override_library_get(bmain, id, &override_owner_id);
     return (override_owner_id->override_library->flag & IDOVERRIDE_LIBRARY_FLAG_SYSTEM_DEFINED) !=
            0;
   }
@@ -1084,8 +1085,9 @@ static void lib_override_overrides_group_tag_recursive(LibOverrideGroupTagData *
       continue;
     }
 
-    const Library *reference_lib = lib_override_get(bmain, id_owner, nullptr)->reference->lib;
-    const ID *to_id_reference = lib_override_get(bmain, to_id, nullptr)->reference;
+    const Library *reference_lib =
+        BKE_lib_override_library_get(bmain, id_owner, nullptr)->reference->lib;
+    const ID *to_id_reference = BKE_lib_override_library_get(bmain, to_id, nullptr)->reference;
     if (to_id_reference->lib != reference_lib) {
       /* We do not override data-blocks from other libraries, nor do we process them. */
       continue;
@@ -1433,7 +1435,7 @@ static ID *lib_override_root_find(Main *bmain, ID *id, const int curr_level, int
     BLI_assert(id->flag & LIB_EMBEDDED_DATA_LIB_OVERRIDE);
     ID *id_owner;
     int best_level_placeholder = 0;
-    lib_override_get(bmain, id, &id_owner);
+    BKE_lib_override_library_get(bmain, id, &id_owner);
     return lib_override_root_find(bmain, id_owner, curr_level + 1, &best_level_placeholder);
   }
   /* This way we won't process again that ID, should we encounter it again through another
@@ -1472,7 +1474,7 @@ static ID *lib_override_root_find(Main *bmain, ID *id, const int curr_level, int
     BLI_assert(id->flag & LIB_EMBEDDED_DATA_LIB_OVERRIDE);
     ID *id_owner;
     int best_level_placeholder = 0;
-    lib_override_get(bmain, best_root_id_candidate, &id_owner);
+    BKE_lib_override_library_get(bmain, best_root_id_candidate, &id_owner);
     best_root_id_candidate = lib_override_root_find(
         bmain, id_owner, curr_level + 1, &best_level_placeholder);
   }
@@ -1789,7 +1791,7 @@ static bool lib_override_library_resync(Main *bmain,
         /* While this should not happen in typical cases (and won't be properly supported here),
          * user is free to do all kind of very bad things, including having different local
          * overrides of a same linked ID in a same hierarchy. */
-        IDOverrideLibrary *id_override_library = lib_override_get(bmain, id, nullptr);
+        IDOverrideLibrary *id_override_library = BKE_lib_override_library_get(bmain, id, nullptr);
 
         if (id_override_library->hierarchy_root != id_root->override_library->hierarchy_root) {
           continue;



More information about the Bf-blender-cvs mailing list