Added tool for combining index arrays.

14 years ago · 56299bed37
4 changed files with 235 additions and 0 deletions
--- a/src/MeshTools/CombineIndexedArrays.h
+++ b/src/MeshTools/CombineIndexedArrays.h
@ -0,0 +1,141 @@
+#ifndef Magnum_MeshTools_CombineIndexedArrays_h
+#define Magnum_MeshTools_CombineIndexedArrays_h
+/*
+    Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
+
+    This file is part of Magnum.
+
+    Magnum is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License version 3
+    only, as published by the Free Software Foundation.
+
+    Magnum 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 Lesser General Public License version 3 for more details.
+*/
+
+/** @file
+ * @brief Function Magnum::MeshTools::combineIndexedArrays()
+ */
+
+#include <cassert>
+#include <vector>
+#include <numeric>
+#include <tuple>
+
+#include "Math/Vector.h"
+#include "MeshTools/Clean.h"
+
+namespace Magnum { namespace MeshTools {
+
+#ifndef DOXYGEN_GENERATING_OUTPUT
+namespace Implementation {
+
+class CombineIndexedArrays {
+    public:
+        template<class ...T> std::vector<unsigned int> operator()(const std::tuple<const std::vector<unsigned int>&, std::vector<T>&>&... indexedArrays) {
+            /* Compute index count */
+            size_t _indexCount = indexCount(std::get<0>(indexedArrays)...);
+
+            /* Resulting index array */
+            std::vector<unsigned int> result;
+            result.resize(_indexCount);
+            std::iota(result.begin(), result.end(), 0);
+
+            /* All index combinations */
+            std::vector<Math::Vector<unsigned int, sizeof...(indexedArrays)> > indexCombinations(_indexCount);
+            writeCombinedIndices(indexCombinations, std::get<0>(indexedArrays)...);
+
+            /* Make the combinations unique */
+            MeshTools::clean(result, indexCombinations);
+
+            /* Write combined arrays */
+            writeCombinedArrays(indexCombinations, std::get<1>(indexedArrays)...);
+
+            return result;
+        }
+
+    private:
+        template<class ...T> inline static size_t indexCount(const std::vector<unsigned int>& first, const std::vector<T>&... next) {
+            size_t count = indexCount(next...);
+            if(sizeof...(next) != 0 && count != first.size()) {
+                Corrade::Utility::Error() << "MeshTools::combineIndexedArrays(): index arrays don't have the same length, nothing done.";
+                assert(0);
+                return 0;
+            }
+            return first.size();
+        }
+
+        template<size_t size, class ...T> static void writeCombinedIndices(std::vector<Math::Vector<unsigned int, size>>& output, const std::vector<unsigned int>& first, const std::vector<T>&... next) {
+            /* Copy the data to output */
+            for(size_t i = 0; i != output.size(); ++i)
+                output[i][size-sizeof...(next)-1] = first[i];
+
+            writeCombinedIndices(output, next...);
+        }
+
+        template<size_t size, class T, class ...U> static void writeCombinedArrays(const std::vector<Math::Vector<unsigned int, size>>& combinedIndices, std::vector<T>& first, std::vector<U>&... next) {
+            /* Rewrite output array */
+            std::vector<T> output;
+            for(size_t i = 0; i != combinedIndices.size(); ++i)
+                output.push_back(first[combinedIndices[i][size-sizeof...(next)-1]]);
+            std::swap(output, first);
+
+            writeCombinedArrays(combinedIndices, next...);
+        }
+
+        /* Terminator functions for recursive calls */
+        inline static size_t indexCount() { return 0; }
+        template<size_t size> inline static void writeCombinedIndices(std::vector<Math::Vector<unsigned int, size>>&) {}
+        template<size_t size> inline static void writeCombinedArrays(const std::vector<Math::Vector<unsigned int, size>>&) {}
+};
+
+}
+#endif
+
+/**
+@brief Combine indexed arrays
+@param indexedArrays Index and attribute arrays
+@return Array with resulting indices
+
+When you have e.g. vertex, normal and texture array, each indexed with
+different indices, you can use this function to combine them to use the same
+indices. The function returns array with resulting indices and replaces
+original attribute arrays with combined ones.
+
+The index array must be passed as const reference (to avoid copying) and
+attribute array as reference, so it can be replaced with combined data. To
+avoid explicit verbose specification of tuple type, you can write it with help
+of some STL functions like shown below. Also if one index array is shader by
+more than one attribute array, just pass the index array more times. Example:
+@code
+std::vector<unsigned int> vertexIndices;
+std::vector<Vector4> vertices;
+std::vector<unsigned int> normalTextureIndices;
+std::vector<Vector3> normals;
+std::vector<Vector2> textureCoordinates;
+
+std::vector<unsigned int> indices = MeshTools::combineIndexedArrays(
+    std::make_tuple(std::cref(vertexIndices), std::ref(vertices)),
+    std::make_tuple(std::cref(normaTextureIndices), std::ref(normals)),
+    std::make_tuple(std::cref(normaTextureIndices), std::ref(textureCoordinates))
+);
+@endcode
+`vertices`, `normals` and `textureCoordinates` will then contain combined
+attributes indexed with `indices`.
+
+@attention All index arrays should have the same size, otherwise zero-length
+    output is generated.
+
+@internal Implementation note: It's done using tuples because it is more clear
+    which parameter is index array and which is attribute array, mainly when
+    both are of the same type.
+*/
+template<class ...T> std::vector<unsigned int> combineIndexedArrays(const std::tuple<const std::vector<unsigned int>&, std::vector<T>&>&... indexedArrays) {
+    return Implementation::CombineIndexedArrays()(indexedArrays...);
+}
+
+}}
+
+#endif
--- a/src/MeshTools/Test/CMakeLists.txt
+++ b/src/MeshTools/Test/CMakeLists.txt
@ -1,4 +1,5 @@
 corrade_add_test(CleanTest CleanTest.h CleanTest.cpp ${CORRADE_UTILITY_LIBRARY})
+corrade_add_test(CombineIndexedArraysTest CombineIndexedArraysTest.h CombineIndexedArraysTest.cpp ${CORRADE_UTILITY_LIBRARY})
 corrade_add_test(CompressIndicesTest CompressIndicesTest.h CompressIndicesTest.cpp ${CORRADE_UTILITY_LIBRARY} ${MAGNUM_LIBRARY})
 corrade_add_test(InterleaveTest InterleaveTest.h InterleaveTest.cpp ${CORRADE_UTILITY_LIBRARY})
 corrade_add_test(SubdivideTest SubdivideTest.h SubdivideTest.cpp ${CORRADE_UTILITY_LIBRARY})
--- a/src/MeshTools/Test/CombineIndexedArraysTest.cpp
+++ b/src/MeshTools/Test/CombineIndexedArraysTest.cpp
@ -0,0 +1,61 @@
+/*
+    Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
+
+    This file is part of Magnum.
+
+    Magnum is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License version 3
+    only, as published by the Free Software Foundation.
+
+    Magnum 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 Lesser General Public License version 3 for more details.
+*/
+
+#include "CombineIndexedArraysTest.h"
+
+#define NDEBUG
+
+#include <sstream>
+#include <QtTest/QTest>
+
+#include "MeshTools/CombineIndexedArrays.h"
+
+QTEST_APPLESS_MAIN(Magnum::MeshTools::Test::CombineIndexedArraysTest)
+
+using namespace std;
+using namespace Corrade::Utility;
+
+namespace Magnum { namespace MeshTools { namespace Test {
+
+void CombineIndexedArraysTest::wrongIndexCount() {
+    stringstream ss;
+    Error::setOutput(&ss);
+    vector<unsigned int> array;
+    vector<unsigned int> result = MeshTools::combineIndexedArrays(
+        tuple<const vector<unsigned int>&, vector<unsigned int>&>(vector<unsigned int>{0, 1, 0}, array),
+        tuple<const vector<unsigned int>&, vector<unsigned int>&>(vector<unsigned int>{3, 4}, array));
+
+    QVERIFY(result.size() == 0);
+    QVERIFY(ss.str() == "MeshTools::combineIndexedArrays(): index arrays don't have the same length, nothing done.\n");
+}
+
+void CombineIndexedArraysTest::combine() {
+    vector<unsigned int> array1{ 0, 1 };
+    vector<unsigned int> array2{ 0, 1, 2, 3, 4 };
+    vector<unsigned int> array3{ 0, 1, 2, 3, 4, 5, 6, 7 };
+
+    vector<unsigned int> result = MeshTools::combineIndexedArrays(
+        tuple<const vector<unsigned int>&, vector<unsigned int>&>(vector<unsigned int>{0, 1, 0}, array1),
+        tuple<const vector<unsigned int>&, vector<unsigned int>&>(vector<unsigned int>{3, 4, 3}, array2),
+        tuple<const vector<unsigned int>&, vector<unsigned int>&>(vector<unsigned int>{6, 7, 6}, array3));
+
+    QVERIFY((result == vector<unsigned int>{0, 1, 0}));
+    QVERIFY((array1 == vector<unsigned int>{0, 1}));
+    QVERIFY((array2 == vector<unsigned int>{3, 4}));
+    QVERIFY((array3 == vector<unsigned int>{6, 7}));
+}
+
+
+}}}
--- a/src/MeshTools/Test/CombineIndexedArraysTest.h
+++ b/src/MeshTools/Test/CombineIndexedArraysTest.h
@ -0,0 +1,32 @@
+#ifndef Magnum_MeshTools_Test_CombineIndexedArraysTest_h
+#define Magnum_MeshTools_Test_CombineIndexedArraysTest_h
+/*
+    Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
+
+    This file is part of Magnum.
+
+    Magnum is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License version 3
+    only, as published by the Free Software Foundation.
+
+    Magnum 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 Lesser General Public License version 3 for more details.
+*/
+
+#include <QtCore/QObject>
+
+namespace Magnum { namespace MeshTools { namespace Test {
+
+class CombineIndexedArraysTest: public QObject {
+    Q_OBJECT
+
+    private slots:
+        void wrongIndexCount();
+        void combine();
+};
+
+}}}
+
+#endif