Add QNoPicking FrameGraph node

Allows to disable execution of picking computations for a
specific FrameGraph branch.

[ChangeLog][Qt3DRender] QNoPicking: control picking execution in the FrameGraph

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

3 files changed, 183 insertions, 0 deletions

diff --git a/tests/auto/render/pickboundingvolumejob/pickboundingvolumejob.qrc b/tests/auto/render/pickboundingvolumejob/pickboundingvolumejob.qrc
index e1506de86..76150da31 100644
--- a/tests/auto/render/pickboundingvolumejob/pickboundingvolumejob.qrc
+++ b/tests/auto/render/pickboundingvolumejob/pickboundingvolumejob.qrc
@@ -11,5 +11,6 @@
         <file>testscene_viewports.qml</file>
         <file>testscene_cameraposition.qml</file>
         <file>testscene_priorityoverlapping.qml</file>
+        <file>testscene_nopicking.qml</file>
     </qresource>
 </RCC>
diff --git a/tests/auto/render/pickboundingvolumejob/testscene_nopicking.qml b/tests/auto/render/pickboundingvolumejob/testscene_nopicking.qml
new file mode 100644
index 000000000..86471f8b2
--- /dev/null
+++ b/tests/auto/render/pickboundingvolumejob/testscene_nopicking.qml
@@ -0,0 +1,134 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 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.14
+import Qt3D.Extras 2.0
+import QtQuick.Window 2.0
+
+Entity {
+    id: sceneRoot
+
+    Window {
+        id: win
+        width: 600
+        height: 600
+        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
+                        NoPicking {
+
+                        }
+                    }
+                }
+            }
+        }
+    ]
+
+    CuboidMesh { id: cubeMesh }
+    PhongMaterial { id: material }
+
+    // Entity 1
+    Entity {
+        property ObjectPicker picker: ObjectPicker {
+            objectName: "Picker1"
+            dragEnabled: true
+        }
+
+        property Transform transform: Transform {
+            translation: Qt.vector3d(5, 0, 0)
+            scale: 2.0
+        }
+
+        components: [cubeMesh, material, picker, transform]
+    }
+
+    // Entity 2
+    Entity {
+        property ObjectPicker picker: ObjectPicker {
+            objectName: "Picker2"
+            dragEnabled: true
+        }
+
+        property Transform transform: Transform {
+            translation: Qt.vector3d(-5, 0, 0)
+            scale: 2.0
+        }
+
+        components: [cubeMesh, material, picker, transform]
+    }
+}
diff --git a/tests/auto/render/pickboundingvolumejob/tst_pickboundingvolumejob.cpp b/tests/auto/render/pickboundingvolumejob/tst_pickboundingvolumejob.cpp
index ad4d69d04..bbc6fa3b5 100644
--- a/tests/auto/render/pickboundingvolumejob/tst_pickboundingvolumejob.cpp
+++ b/tests/auto/render/pickboundingvolumejob/tst_pickboundingvolumejob.cpp
@@ -38,6 +38,7 @@
 
 #include <Qt3DRender/QCamera>
 #include <Qt3DRender/QObjectPicker>
+#include <Qt3DRender/QNoPicking>
 #include <Qt3DRender/QPickEvent>
 #include <Qt3DRender/QPickTriangleEvent>
 #include <Qt3DRender/private/nodemanagers_p.h>
@@ -57,6 +58,7 @@
 #include <Qt3DRender/private/buffermanager_p.h>
 #include <Qt3DRender/private/geometryrenderermanager_p.h>
 #include <Qt3DRender/private/qobjectpicker_p.h>
+#include <Qt3DRender/private/nopicking_p.h>
 
 #include <private/qpickevent_p.h>
 
@@ -1579,6 +1581,52 @@ private Q_SLOTS:
         }
     }
 
+    void checkNoPickingFGPicking()
+    {
+        // GIVEN
+        QmlSceneReader sceneReader(QUrl("qrc:/testscene_nopicking.qml"));
+        QScopedPointer<Qt3DCore::QNode> root(qobject_cast<Qt3DCore::QNode *>(sceneReader.root()));
+        QVERIFY(root);
+        QScopedPointer<Qt3DRender::TestAspect> test(new Qt3DRender::TestAspect(root.data()));
+
+        // THEN
+        QVERIFY(test->frameGraphRoot() != nullptr);
+        Qt3DRender::QNoPicking *noPicking = root->findChild<Qt3DRender::QNoPicking *>();
+        QVERIFY(noPicking != nullptr);
+        Qt3DRender::QCamera *camera = root->findChild<Qt3DRender::QCamera *>();
+        QVERIFY(camera != nullptr);
+        QQuickWindow *window = root->findChild<QQuickWindow *>();
+        QVERIFY(camera != nullptr);
+        QCOMPARE(window->size(), QSize(600, 600));
+
+        // WHEN
+        Qt3DRender::Render::PickingUtils::ViewportCameraAreaGatherer gatherer;
+        QVector<Qt3DRender::Render::PickingUtils::ViewportCameraAreaDetails> results = gatherer.gather(test->frameGraphRoot());
+
+        // THEN
+        QCOMPARE(results.size(), 0);
+
+        // WHEN
+        Qt3DRender::Render::FrameGraphNode *backendFGNode = test->nodeManagers()->frameGraphManager()->lookupNode(noPicking->id());
+        QVERIFY(backendFGNode);
+        QCOMPARE(backendFGNode->nodeType(), Qt3DRender::Render::FrameGraphNode::NoPicking);
+        Qt3DRender::Render::NoPicking * backendNoPicking = static_cast<Qt3DRender::Render::NoPicking *>(backendFGNode);
+        backendNoPicking->setEnabled(false);
+
+        // THEN
+        QVERIFY(!backendNoPicking->isEnabled());
+
+        // WHEN
+        results = gatherer.gather(test->frameGraphRoot());
+
+        // THEN
+        QCOMPARE(results.size(), 1);
+        auto vca = results.first();
+        QCOMPARE(vca.area, QSize(600, 600));
+        QCOMPARE(vca.cameraId, camera->id());
+        QCOMPARE(vca.viewport, QRectF(0.0f, 0.0f, 1.0f, 1.0f));
+    }
+
 };
 
 QTEST_MAIN(tst_PickBoundingVolumeJob)