Add function to generate component indices for blend tree format

This generates the format indices required by the
formatClipResults() function which performs the gather to reorder
the raw results from an animation clip to the format used by
the blend tree/animator.

Change-Id: I5cd8fbe366792ae9d8317f098699c413450b9b87
Reviewed-by: Mike Krus <mike.krus@kdab.com>

3 files changed, 577 insertions, 0 deletions

diff --git a/tests/auto/animation/animationutils/animationutils.qrc b/tests/auto/animation/animationutils/animationutils.qrc
index aeb8112f3..bbcd96524 100644
--- a/tests/auto/animation/animationutils/animationutils.qrc
+++ b/tests/auto/animation/animationutils/animationutils.qrc
@@ -2,5 +2,6 @@
     <qresource prefix="/">
         <file>clip1.json</file>
         <file>clip2.json</file>
+        <file>clip3.json</file>
     </qresource>
 </RCC>
diff --git a/tests/auto/animation/animationutils/clip3.json b/tests/auto/animation/animationutils/clip3.json
new file mode 100644
index 000000000..ae390590e
--- /dev/null
+++ b/tests/auto/animation/animationutils/clip3.json
@@ -0,0 +1,430 @@
+{
+  "animations": [
+    {
+      "animationName": "CubeAction",
+      "channels": [
+        {
+          "channelComponents": [
+            {
+              "channelComponentName": "Rotation W",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    1.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    1.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    1.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    -4.371138828673793e-08
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    -4.371138828673793e-08
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    -4.371138828673793e-08
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Rotation X",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Rotation Z",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    -0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    -0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    -0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    -1.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    -1.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    -1.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Rotation Y",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            }
+          ],
+          "channelName": "Rotation"
+        },
+        {
+          "channelComponents": [
+            {
+              "channelComponentName": "Location X",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    5.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    5.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    5.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Location Z",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Location Y",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            }
+          ],
+          "channelName": "Location"
+        },
+        {
+          "channelComponents": [
+            {
+              "channelComponentName": "Base Color X",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    5.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    5.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    5.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Base Color Y",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Base Color Z",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            }
+          ],
+          "channelName": "Base Color"
+        },
+        {
+          "channelComponents": [
+            {
+              "channelComponentName": "Metalness X",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    5.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    5.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    5.0
+                  ]
+                }
+              ]
+            }
+          ],
+          "channelName": "Metalness"
+        },
+        {
+          "channelComponents": [
+            {
+              "channelComponentName": "Roughness X",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    5.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    5.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    5.0
+                  ]
+                }
+              ]
+            }
+          ],
+          "channelName": "Roughness"
+        }
+      ]
+    }
+  ]
+}
diff --git a/tests/auto/animation/animationutils/tst_animationutils.cpp b/tests/auto/animation/animationutils/tst_animationutils.cpp
index 0d758d3d3..e1f8adb0c 100644
--- a/tests/auto/animation/animationutils/tst_animationutils.cpp
+++ b/tests/auto/animation/animationutils/tst_animationutils.cpp
@@ -2145,6 +2145,152 @@ private Q_SLOTS:
                 QCOMPARE(actualResult[j], expectedResult[j]);
         }
     }
+
+    void checkGenerateClipFormatIndices_data()
+    {
+        QTest::addColumn<QVector<ChannelNameAndType>>("targetChannels");
+        QTest::addColumn<QVector<ComponentIndices>>("targetIndices");
+        QTest::addColumn<AnimationClipLoader *>("clip");
+        QTest::addColumn<ComponentIndices>("expectedResults");
+
+        {
+            QVector<ChannelNameAndType> targetChannels;
+            targetChannels.push_back({ QLatin1String("Rotation"), static_cast<int>(QVariant::Quaternion) });
+            targetChannels.push_back({ QLatin1String("Location"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Base Color"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Metalness"), static_cast<int>(QVariant::Double) });
+            targetChannels.push_back({ QLatin1String("Roughness"), static_cast<int>(QVariant::Double) });
+
+            QVector<ComponentIndices> targetIndices;
+            targetIndices.push_back({ 0, 1, 2, 3 });
+            targetIndices.push_back({ 4, 5, 6 });
+            targetIndices.push_back({ 7, 8, 9 });
+            targetIndices.push_back({ 10 });
+            targetIndices.push_back({ 11 });
+
+            auto *clip = new AnimationClipLoader();
+            clip->setSource(QUrl("qrc:/clip3.json"));
+            clip->loadAnimation();
+
+            ComponentIndices expectedResults = { 0, 1, 2, 3,    // Rotation
+                                                 4, 5, 6,       // Location
+                                                 7, 8, 9,       // Base Color
+                                                 10,            // Metalness
+                                                 11 };          // Roughness
+
+            QTest::newRow("rotation, location, pbr metal-rough")
+                    << targetChannels << targetIndices << clip << expectedResults;
+        }
+
+        {
+            QVector<ChannelNameAndType> targetChannels;
+            targetChannels.push_back({ QLatin1String("Location"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Rotation"), static_cast<int>(QVariant::Quaternion) });
+            targetChannels.push_back({ QLatin1String("Base Color"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Metalness"), static_cast<int>(QVariant::Double) });
+            targetChannels.push_back({ QLatin1String("Roughness"), static_cast<int>(QVariant::Double) });
+
+            QVector<ComponentIndices> targetIndices;
+            targetIndices.push_back({ 0, 1, 2 });
+            targetIndices.push_back({ 3, 4, 5, 6 });
+            targetIndices.push_back({ 7, 8, 9 });
+            targetIndices.push_back({ 10 });
+            targetIndices.push_back({ 11 });
+
+            auto *clip = new AnimationClipLoader();
+            clip->setSource(QUrl("qrc:/clip3.json"));
+            clip->loadAnimation();
+
+            ComponentIndices expectedResults = { 4, 5, 6,       // Location
+                                                 0, 1, 2, 3,    // Rotation
+                                                 7, 8, 9,       // Base Color
+                                                 10,            // Metalness
+                                                 11 };          // Roughness
+
+            QTest::newRow("location, rotation, pbr metal-rough")
+                    << targetChannels << targetIndices << clip << expectedResults;
+        }
+
+        {
+            QVector<ChannelNameAndType> targetChannels;
+            targetChannels.push_back({ QLatin1String("Rotation"), static_cast<int>(QVariant::Quaternion) });
+            targetChannels.push_back({ QLatin1String("Location"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Albedo"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Metalness"), static_cast<int>(QVariant::Double) });
+            targetChannels.push_back({ QLatin1String("Roughness"), static_cast<int>(QVariant::Double) });
+
+            QVector<ComponentIndices> targetIndices;
+            targetIndices.push_back({ 0, 1, 2, 3 });
+            targetIndices.push_back({ 4, 5, 6 });
+            targetIndices.push_back({ 7, 8, 9 });
+            targetIndices.push_back({ 10 });
+            targetIndices.push_back({ 11 });
+
+            auto *clip = new AnimationClipLoader();
+            clip->setSource(QUrl("qrc:/clip3.json"));
+            clip->loadAnimation();
+
+            ComponentIndices expectedResults = { 0, 1, 2, 3,    // Rotation
+                                                 4, 5, 6,       // Location
+                                                 -1, -1, -1,    // Albedo (missing from clip)
+                                                 10,            // Metalness
+                                                 11 };          // Roughness
+
+            QTest::newRow("rotation, location, albedo (missing), metal-rough")
+                    << targetChannels << targetIndices << clip << expectedResults;
+        }
+
+        {
+            QVector<ChannelNameAndType> targetChannels;
+            targetChannels.push_back({ QLatin1String("Location"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Rotation"), static_cast<int>(QVariant::Quaternion) });
+            targetChannels.push_back({ QLatin1String("Albedo"), static_cast<int>(QVariant::Vector3D) });
+            targetChannels.push_back({ QLatin1String("Metalness"), static_cast<int>(QVariant::Double) });
+            targetChannels.push_back({ QLatin1String("Roughness"), static_cast<int>(QVariant::Double) });
+
+            QVector<ComponentIndices> targetIndices;
+            targetIndices.push_back({ 0, 1, 2 });
+            targetIndices.push_back({ 3, 4, 5, 6 });
+            targetIndices.push_back({ 7, 8, 9 });
+            targetIndices.push_back({ 10 });
+            targetIndices.push_back({ 11 });
+
+            auto *clip = new AnimationClipLoader();
+            clip->setSource(QUrl("qrc:/clip3.json"));
+            clip->loadAnimation();
+
+            ComponentIndices expectedResults = { 4, 5, 6,       // Location
+                                                 0, 1, 2, 3,    // Rotation
+                                                 -1, -1, -1,    // Albedo (missing from clip)
+                                                 10,            // Metalness
+                                                 11 };          // Roughness
+
+            QTest::newRow("location, rotation, albedo (missing), metal-rough")
+                    << targetChannels << targetIndices << clip << expectedResults;
+        }
+    }
+
+    void checkGenerateClipFormatIndices()
+    {
+        // GIVEN
+        QFETCH(QVector<ChannelNameAndType>, targetChannels);
+        QFETCH(QVector<ComponentIndices>, targetIndices);
+        QFETCH(AnimationClipLoader *, clip);
+        QFETCH(ComponentIndices, expectedResults);
+
+        // WHEN
+        const ComponentIndices actualResults = generateClipFormatIndices(targetChannels,
+                                                                         targetIndices,
+                                                                         clip);
+
+        // THEN
+        QCOMPARE(actualResults.size(), expectedResults.size());
+        for (int i = 0; i < actualResults.size(); ++i)
+            QCOMPARE(actualResults[i], expectedResults[i]);
+
+        // Cleanup
+        delete clip;
+    }
 };
 
 QTEST_MAIN(tst_AnimationUtils)