IO: Fix bug exporting dupli parent/child relations

Exporting a scene to USD or Alembic would fail when there are multiple
duplicates of parent & child objects, duplicated by the same object. For
example, this happens when such a hierarchy of objects is contained in a
collection, and that collection is instanced multiple times by mesh
vertices. The problem here is that the 'parent' pointer of each
duplicated object points to the real parent; Blender would not figure
out properly which duplicated parent should be used.

This is now resolved by keeping track of the persistent ID of each
duplicated instance, which makes it possible to reconstruct the
parent-child relations of duplicated objects. This does use up some
memory for each dupli, so it could be heavy to export a Spring scene
(with all the pebbles and leaves), but it's only a small addition on top
of the USD/Alembic writer objects that have to be created anyway. At
least with this patch, they're created correctly.

Code-wise, the following changes are made:

- The export graph (that maps export parent to its export children) used
  to have as its key (Object, Duplicator). This is insufficient to
  correctly distinguish between multiple duplis of the same object by
  the same duplicator, so this is now extended to (Object, Duplicator,
  Persistent ID). To make this possible, new classes `ObjectIdentifier`
  and `PersistentID` are introduced.
- Finding the parent of a duplicated object is done via its persistent
  ID. In Python notation, the code first tries to find the parent
  instance where `child_persistent_id[1:] == parent_persistent_id[1:]`.
  If that fails, the dupli with persistent ID `child_persistent_id[1:]`
  is used as parent.

Reviewed By: sergey

Differential Revision: https://developer.blender.org/D8233

1 files changed, 144 insertions, 0 deletions

diff --git a/source/blender/io/common/intern/dupli_persistent_id.cc b/source/blender/io/common/intern/dupli_persistent_id.cc
new file mode 100644
index 00000000000..8563fd5cea6
--- /dev/null
+++ b/source/blender/io/common/intern/dupli_persistent_id.cc
@@ -0,0 +1,144 @@
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2020 Blender Foundation.
+ * All rights reserved.
+ */
+
+#include "dupli_parent_finder.hh"
+
+#include <climits>
+#include <cstring>
+#include <ostream>
+
+namespace blender::io {
+
+PersistentID::PersistentID()
+{
+  persistent_id_[0] = INT_MAX;
+}
+
+PersistentID::PersistentID(const DupliObject *dupli_ob)
+{
+  for (int index = 0; index < array_length_; ++index) {
+    persistent_id_[index] = dupli_ob->persistent_id[index];
+  }
+}
+
+PersistentID::PersistentID(const PIDArray &persistent_id_values)
+{
+  persistent_id_ = persistent_id_values;
+}
+
+bool PersistentID::is_from_same_instancer_as(const PersistentID &other) const
+{
+  if (persistent_id_[0] == INT_MAX || other.persistent_id_[0] == INT_MAX) {
+    /* Either one or the other is not instanced at all, so definitely not from the same instancer.
+     */
+    return false;
+  }
+
+  /* Start at index 1 to skip the first digit. */
+  for (int index = 1; index < array_length_; ++index) {
+    const int pid_digit_a = persistent_id_[index];
+    const int pid_digit_b = other.persistent_id_[index];
+
+    if (pid_digit_a != pid_digit_b) {
+      return false;
+    }
+
+    if (pid_digit_a == INT_MAX) {
+      /* Both persistent IDs were identical so far, and this marks the end of the useful data. */
+      break;
+    }
+  }
+  return true;
+}
+
+PersistentID PersistentID::instancer_pid() const
+{
+  if (persistent_id_[0] == INT_MAX) {
+    return PersistentID();
+  }
+
+  /* Left-shift the entire PID by 1. */
+  PIDArray new_pid_values;
+  int index;
+  for (index = 0; index < array_length_ - 1; ++index) {
+    new_pid_values[index] = persistent_id_[index + 1];
+  }
+  new_pid_values[index] = INT_MAX;
+
+  return PersistentID(new_pid_values);
+}
+
+bool operator<(const PersistentID &persistent_id_a, const PersistentID &persistent_id_b)
+{
+  const PersistentID::PIDArray &pid_a = persistent_id_a.persistent_id_;
+  const PersistentID::PIDArray &pid_b = persistent_id_b.persistent_id_;
+
+  for (int index = 0; index < PersistentID::array_length_; ++index) {
+    const int pid_digit_a = pid_a[index];
+    const int pid_digit_b = pid_b[index];
+
+    if (pid_digit_a != pid_digit_b) {
+      return pid_digit_a < pid_digit_b;
+    }
+
+    if (pid_a[index] == INT_MAX) {
+      break;
+    }
+  }
+  /* Both Persistent IDs were equal, so not less-than. */
+  return false;
+}
+
+bool operator==(const PersistentID &persistent_id_a, const PersistentID &persistent_id_b)
+{
+  const PersistentID::PIDArray &pid_a = persistent_id_a.persistent_id_;
+  const PersistentID::PIDArray &pid_b = persistent_id_b.persistent_id_;
+
+  for (int index = 0; index < PersistentID::array_length_; ++index) {
+    const int pid_digit_a = pid_a[index];
+    const int pid_digit_b = pid_b[index];
+
+    if (pid_digit_a != pid_digit_b) {
+      return false;
+    }
+
+    if (pid_a[index] == INT_MAX) {
+      break;
+    }
+  }
+  return true;
+}
+
+std::ostream &operator<<(std::ostream &os, const PersistentID &persistent_id)
+{
+  if (persistent_id.persistent_id_[0] == INT_MAX) {
+    return os;
+  }
+
+  const PersistentID::PIDArray &pid_array = persistent_id.persistent_id_;
+  for (int index = 0; index < PersistentID::array_length_ && pid_array[index] < INT_MAX; ++index) {
+    if (index > 0) {
+      os << "-";
+    }
+    os << pid_array[index];
+  }
+  return os;
+}
+
+}  // namespace blender::io