Add unit tests for UpdateMeshTriangleListJob

Change-Id: I2b2394bf2420662f5aa183873e213e8b6a558c02
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

5 files changed, 443 insertions, 1 deletions

diff --git a/tests/auto/render/render.pro b/tests/auto/render/render.pro
index 6c5e8b502..f19ee9f65 100644
--- a/tests/auto/render/render.pro
+++ b/tests/auto/render/render.pro
@@ -73,7 +73,8 @@ qtConfig(private_tests) {
         qtextureimage \
         qabstracttexture \
         qabstracttextureimage \
-        qrendersettings
+        qrendersettings \
+        updatemeshtrianglelistjob
 
     !macos: SUBDIRS += graphicshelpergl4
 }
diff --git a/tests/auto/render/updatemeshtrianglelistjob/test_scene.qml b/tests/auto/render/updatemeshtrianglelistjob/test_scene.qml
new file mode 100644
index 000000000..ecf41f9c0
--- /dev/null
+++ b/tests/auto/render/updatemeshtrianglelistjob/test_scene.qml
@@ -0,0 +1,102 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, you may use this file under the terms of the BSD license
+** as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import Qt3D.Core 2.0
+import Qt3D.Render 2.0
+import Qt3D.Extras 2.0
+import QtQuick.Window 2.0
+
+Entity {
+    id: sceneRoot
+
+    Window {
+        id: win
+        width: 800
+        height: 800
+        visible: true
+    }
+
+    Camera {
+        id: camera
+        projectionType: CameraLens.PerspectiveProjection
+        fieldOfView: 45
+        nearPlane : 0.1
+        farPlane : 1000.0
+        position: Qt.vector3d( 0.0, 0.0, -40.0 )
+        upVector: Qt.vector3d( 0.0, 1.0, 0.0 )
+        viewCenter: Qt.vector3d( 0.0, 0.0, 0.0 )
+    }
+
+    components: [
+        RenderSettings {
+            Viewport {
+                normalizedRect: Qt.rect(0.0, 0.0, 1.0, 1.0)
+
+                RenderSurfaceSelector {
+
+                    surface: win
+
+                    ClearBuffers {
+                        buffers : ClearBuffers.ColorDepthBuffer
+                        NoDraw {}
+                    }
+
+                    CameraSelector {
+                        camera: camera
+                    }
+                }
+            }
+        }
+    ]
+
+    Entity {
+        components: CuboidMesh { id: cubeMesh }
+    }
+}
diff --git a/tests/auto/render/updatemeshtrianglelistjob/tst_updatemeshtrianglelistjob.cpp b/tests/auto/render/updatemeshtrianglelistjob/tst_updatemeshtrianglelistjob.cpp
new file mode 100644
index 000000000..f3fc2ad9b
--- /dev/null
+++ b/tests/auto/render/updatemeshtrianglelistjob/tst_updatemeshtrianglelistjob.cpp
@@ -0,0 +1,316 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Paul Lemire <paul.lemire350@gmail.com>
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+#include <QtTest/QTest>
+#include <Qt3DRender/private/updatemeshtrianglelistjob_p.h>
+#include <Qt3DRender/private/nodemanagers_p.h>
+#include <Qt3DRender/private/managers_p.h>
+#include <Qt3DRender/private/geometryrenderermanager_p.h>
+#include <Qt3DRender/private/buffermanager_p.h>
+#include <Qt3DRender/private/loadgeometryjob_p.h>
+#include <Qt3DRender/qrenderaspect.h>
+#include <Qt3DRender/private/qrenderaspect_p.h>
+#include <Qt3DCore/qpropertyupdatedchange.h>
+#include <Qt3DCore/private/qnodecreatedchangegenerator_p.h>
+#include "qmlscenereader.h"
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender { // Needs to be in that namespace to be friend with QRenderAspect
+
+class TestAspect : public Qt3DRender::QRenderAspect
+{
+public:
+    TestAspect(Qt3DCore::QNode *root)
+        : Qt3DRender::QRenderAspect(Qt3DRender::QRenderAspect::Synchronous)
+        , m_sceneRoot(nullptr)
+    {
+        Qt3DRender::QRenderAspect::onRegistered();
+
+        const Qt3DCore::QNodeCreatedChangeGenerator generator(root);
+        const QVector<Qt3DCore::QNodeCreatedChangeBasePtr> creationChanges = generator.creationChanges();
+
+        d_func()->setRootAndCreateNodes(qobject_cast<Qt3DCore::QEntity *>(root), creationChanges);
+
+        Qt3DRender::Render::Entity *rootEntity = nodeManagers()->lookupResource<Qt3DRender::Render::Entity, Render::EntityManager>(rootEntityId());
+        Q_ASSERT(rootEntity);
+        m_sceneRoot = rootEntity;
+    }
+
+    ~TestAspect()
+    {
+        QRenderAspect::onUnregistered();
+    }
+
+    void onRegistered() { Qt3DRender::QRenderAspect::onRegistered(); }
+    void onUnregistered() { Qt3DRender::QRenderAspect::onUnregistered(); }
+
+    Qt3DRender::Render::NodeManagers *nodeManagers() const { return d_func()->m_renderer->nodeManagers(); }
+    Qt3DRender::Render::FrameGraphNode *frameGraphRoot() const { return d_func()->m_renderer->frameGraphRoot(); }
+    Qt3DRender::Render::RenderSettings *renderSettings() const { return d_func()->m_renderer->settings(); }
+    Qt3DRender::Render::Entity *sceneRoot() const { return m_sceneRoot; }
+
+private:
+    Qt3DRender::Render::Entity *m_sceneRoot;
+};
+
+} // Qt3DRender
+
+QT_END_NAMESPACE
+
+namespace {
+
+void runRequiredJobs(Qt3DRender::TestAspect *aspect)
+{
+    Qt3DRender::Render::GeometryRendererManager *geomRendererManager = aspect->nodeManagers()->geometryRendererManager();
+    const QVector<Qt3DCore::QNodeId> dirtyGeometryRenderers = geomRendererManager->dirtyGeometryRenderers();
+    QVector<Qt3DCore::QAspectJobPtr> dirtyGeometryRendererJobs;
+    dirtyGeometryRendererJobs.reserve(dirtyGeometryRenderers.size());
+
+    // Load Geometry
+    for (const Qt3DCore::QNodeId geoRendererId : dirtyGeometryRenderers) {
+        Qt3DRender::Render::HGeometryRenderer geometryRendererHandle = geomRendererManager->lookupHandle(geoRendererId);
+        if (!geometryRendererHandle.isNull()) {
+            auto job = Qt3DRender::Render::LoadGeometryJobPtr::create(geometryRendererHandle);
+            job->setNodeManagers(aspect->nodeManagers());
+            dirtyGeometryRendererJobs.push_back(job);
+        }
+    }
+}
+
+struct NodeCollection
+{
+    explicit NodeCollection(Qt3DRender::TestAspect *aspect, QObject *frontendRoot)
+        : geometryRenderers(frontendRoot->findChildren<Qt3DRender::QGeometryRenderer *>())
+        , attributes(frontendRoot->findChildren<Qt3DRender::QAttribute *>())
+        , buffers(frontendRoot->findChildren<Qt3DRender::QBuffer *>())
+    {
+        // THEN
+        QCOMPARE(aspect->nodeManagers()->geometryManager()->activeHandles().size(), geometryRenderers.size());
+        QCOMPARE(aspect->nodeManagers()->attributeManager()->activeHandles().size(), attributes.size());
+        QCOMPARE(aspect->nodeManagers()->bufferManager()->activeHandles().size(), buffers.size());
+
+        for (const Qt3DRender::QGeometryRenderer *g : qAsConst(geometryRenderers)) {
+            Qt3DRender::Render::GeometryRenderer *backend = aspect->nodeManagers()->geometryRendererManager()->lookupResource(g->id());
+            QVERIFY(backend != nullptr);
+            backendGeometryRenderer.push_back(backend);
+        }
+
+        for (const Qt3DRender::QAttribute *a : qAsConst(attributes)) {
+            Qt3DRender::Render::Attribute *backend = aspect->nodeManagers()->attributeManager()->lookupResource(a->id());
+            QVERIFY(backend != nullptr);
+            backendAttributes.push_back(backend);
+        }
+
+        for (const Qt3DRender::QBuffer *b : qAsConst(buffers)) {
+            Qt3DRender::Render::Buffer *backend = aspect->nodeManagers()->bufferManager()->lookupResource(b->id());
+            QVERIFY(backend != nullptr);
+            backendBuffers.push_back(backend);
+        }
+    }
+
+    QList<Qt3DRender::QGeometryRenderer *> geometryRenderers;
+    QList<Qt3DRender::QAttribute *> attributes;
+    QList<Qt3DRender::QBuffer *> buffers;
+
+    QVector<Qt3DRender::Render::GeometryRenderer *> backendGeometryRenderer;
+    QVector<Qt3DRender::Render::Attribute *> backendAttributes;
+    QVector<Qt3DRender::Render::Buffer *> backendBuffers;
+};
+
+
+} // anonymous
+
+class tst_UpdateMeshTriangleListJob : public QObject
+{
+    Q_OBJECT
+
+private Q_SLOTS:
+
+    void checkInitialState()
+    {
+        // GIVEN
+        Qt3DRender::Render::UpdateMeshTriangleListJob backendUpdateMeshTriangleListJob;
+
+        // THEN
+        QVERIFY(backendUpdateMeshTriangleListJob.managers() == nullptr);
+    }
+
+    void checkInitialize()
+    {
+        // GIVEN
+        Qt3DRender::Render::UpdateMeshTriangleListJob updateMeshTriangleListJob;
+        Qt3DRender::Render::NodeManagers managers;
+
+        // WHEN
+        updateMeshTriangleListJob.setManagers(&managers);
+
+        // THEN
+        QVERIFY(updateMeshTriangleListJob.managers() == &managers);
+    }
+
+    void checkRunNoDirtyGeometryRenderNoDirtyAttributesNoDirtyBuffers()
+    {
+        // GIVEN
+        QmlSceneReader sceneReader(QUrl("qrc:/test_scene.qml"));
+        QScopedPointer<Qt3DCore::QNode> root(qobject_cast<Qt3DCore::QNode *>(sceneReader.root()));
+        QVERIFY(root);
+        QScopedPointer<Qt3DRender::TestAspect> test(new Qt3DRender::TestAspect(root.data()));
+
+        // Run required jobs to load geometries and meshes
+        runRequiredJobs(test.data());
+
+        // WHEN
+        const NodeCollection collection(test.data(), root.data());
+
+        // THEN
+        QCOMPARE(collection.geometryRenderers.size(), 1);
+        QCOMPARE(collection.attributes.size(), 5);
+        QCOMPARE(collection.buffers.size(), 2);
+
+        // WHEN
+        for (Qt3DRender::Render::GeometryRenderer *g : collection.backendGeometryRenderer)
+            g->unsetDirty();
+        for (Qt3DRender::Render::Attribute *a : collection.backendAttributes)
+            a->unsetDirty();
+        for (Qt3DRender::Render::Buffer *b : collection.backendBuffers)
+            b->unsetDirty();
+
+        Qt3DRender::Render::UpdateMeshTriangleListJob backendUpdateMeshTriangleListJob;
+        backendUpdateMeshTriangleListJob.setManagers(test->nodeManagers());
+
+        backendUpdateMeshTriangleListJob.run();
+
+        // THEN
+        QCOMPARE(test->nodeManagers()->geometryRendererManager()->geometryRenderersRequiringTriangleDataRefresh().size(), 0);
+    }
+
+    void checkRunDirtyGeometryRenderNoDirtyAttributesNoDirtyBuffers()
+    {
+        // GIVEN
+        QmlSceneReader sceneReader(QUrl("qrc:/test_scene.qml"));
+        QScopedPointer<Qt3DCore::QNode> root(qobject_cast<Qt3DCore::QNode *>(sceneReader.root()));
+        QVERIFY(root);
+        QScopedPointer<Qt3DRender::TestAspect> test(new Qt3DRender::TestAspect(root.data()));
+
+        // Run required jobs to load geometries and meshes
+        runRequiredJobs(test.data());
+
+        // WHEN
+        const NodeCollection collection(test.data(), root.data());
+
+        // THEN
+        QCOMPARE(collection.geometryRenderers.size(), 1);
+        QCOMPARE(collection.attributes.size(), 5);
+        QCOMPARE(collection.buffers.size(), 2);
+
+        // WHEN
+        for (Qt3DRender::Render::Attribute *a : collection.backendAttributes)
+            a->unsetDirty();
+        for (Qt3DRender::Render::Buffer *b : collection.backendBuffers)
+            b->unsetDirty();
+
+        Qt3DRender::Render::UpdateMeshTriangleListJob backendUpdateMeshTriangleListJob;
+        backendUpdateMeshTriangleListJob.setManagers(test->nodeManagers());
+
+        backendUpdateMeshTriangleListJob.run();
+
+        // THEN
+        QCOMPARE(test->nodeManagers()->geometryRendererManager()->geometryRenderersRequiringTriangleDataRefresh().size(), 1);
+    }
+
+    void checkRunDirtyGeometryRenderDirtyAttributesNoDirtyBuffers()
+    {
+        // GIVEN
+        QmlSceneReader sceneReader(QUrl("qrc:/test_scene.qml"));
+        QScopedPointer<Qt3DCore::QNode> root(qobject_cast<Qt3DCore::QNode *>(sceneReader.root()));
+        QVERIFY(root);
+        QScopedPointer<Qt3DRender::TestAspect> test(new Qt3DRender::TestAspect(root.data()));
+
+        // Run required jobs to load geometries and meshes
+        runRequiredJobs(test.data());
+
+        // WHEN
+        const NodeCollection collection(test.data(), root.data());
+
+        // THEN
+        QCOMPARE(collection.geometryRenderers.size(), 1);
+        QCOMPARE(collection.attributes.size(), 5);
+        QCOMPARE(collection.buffers.size(), 2);
+
+        // WHEN
+        for (Qt3DRender::Render::Buffer *b : collection.backendBuffers)
+            b->unsetDirty();
+
+        Qt3DRender::Render::UpdateMeshTriangleListJob backendUpdateMeshTriangleListJob;
+        backendUpdateMeshTriangleListJob.setManagers(test->nodeManagers());
+
+        backendUpdateMeshTriangleListJob.run();
+
+        // THEN
+        QCOMPARE(test->nodeManagers()->geometryRendererManager()->geometryRenderersRequiringTriangleDataRefresh().size(), 1);
+    }
+
+    void checkRunDirtyGeometryRenderDirtyAttributesDirtyBuffers()
+    {
+        // GIVEN
+        QmlSceneReader sceneReader(QUrl("qrc:/test_scene.qml"));
+        QScopedPointer<Qt3DCore::QNode> root(qobject_cast<Qt3DCore::QNode *>(sceneReader.root()));
+        QVERIFY(root);
+        QScopedPointer<Qt3DRender::TestAspect> test(new Qt3DRender::TestAspect(root.data()));
+
+        // Run required jobs to load geometries and meshes
+        runRequiredJobs(test.data());
+
+        // WHEN
+        const NodeCollection collection(test.data(), root.data());
+
+        // THEN
+        QCOMPARE(collection.geometryRenderers.size(), 1);
+        QCOMPARE(collection.attributes.size(), 5);
+        QCOMPARE(collection.buffers.size(), 2);
+
+        // WHEN
+        for (Qt3DRender::Render::Buffer *b : collection.backendBuffers)
+            b->unsetDirty();
+
+        Qt3DRender::Render::UpdateMeshTriangleListJob backendUpdateMeshTriangleListJob;
+        backendUpdateMeshTriangleListJob.setManagers(test->nodeManagers());
+
+        backendUpdateMeshTriangleListJob.run();
+
+        // THEN
+        QCOMPARE(test->nodeManagers()->geometryRendererManager()->geometryRenderersRequiringTriangleDataRefresh().size(), 1);
+    }
+
+};
+
+QTEST_MAIN(tst_UpdateMeshTriangleListJob)
+
+#include "tst_updatemeshtrianglelistjob.moc"
diff --git a/tests/auto/render/updatemeshtrianglelistjob/updatemeshtrianglelistjob.pro b/tests/auto/render/updatemeshtrianglelistjob/updatemeshtrianglelistjob.pro
new file mode 100644
index 000000000..499f78c72
--- /dev/null
+++ b/tests/auto/render/updatemeshtrianglelistjob/updatemeshtrianglelistjob.pro
@@ -0,0 +1,18 @@
+TEMPLATE = app
+
+TARGET = tst_updatemeshtrianglelistjob
+
+QT += 3dcore 3dcore-private 3drender 3drender-private testlib
+
+CONFIG += testcase
+
+SOURCES += tst_updatemeshtrianglelistjob.cpp
+
+include(../../core/common/common.pri)
+include(../commons/commons.pri)
+include(../qmlscenereader/qmlscenereader.pri)
+# Extra dependencies to build test scenes needed by the tests
+QT += quick 3dquick 3dquick-private 3dextras 3dquickextras
+
+RESOURCES += \
+    updatemeshtrianglelistjob.qrc
diff --git a/tests/auto/render/updatemeshtrianglelistjob/updatemeshtrianglelistjob.qrc b/tests/auto/render/updatemeshtrianglelistjob/updatemeshtrianglelistjob.qrc
new file mode 100644
index 000000000..6a6a0433e
--- /dev/null
+++ b/tests/auto/render/updatemeshtrianglelistjob/updatemeshtrianglelistjob.qrc
@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/">
+        <file>test_scene.qml</file>
+    </qresource>
+</RCC>