Move last remaining pieces of examples-common to Qt3DExtras

Also created a Quick3DExtras for QML related extras (Qt3DQuickWindow)

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

4 files changed, 479 insertions, 0 deletions

diff --git a/src/quick3d/quick3dextras/qt3dquickextras_global.h b/src/quick3d/quick3dextras/qt3dquickextras_global.h
new file mode 100644
index 000000000..d9277baee
--- /dev/null
+++ b/src/quick3d/quick3dextras/qt3dquickextras_global.h
@@ -0,0 +1,59 @@
+/****************************************************************************
+**
+** 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:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** 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-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QT3DQUICKEXTRAS_GLOBAL_H
+#define QT3DQUICKEXTRAS_GLOBAL_H
+
+#include <QtCore/qglobal.h>
+
+QT_BEGIN_NAMESPACE
+
+#if defined(QT_SHARED) || !defined(QT_STATIC)
+#  if defined(QT_BUILD_3DQUICKEXTRAS_LIB)
+#    define QT3DQUICKEXTRASSHARED_EXPORT Q_DECL_EXPORT
+#  else
+#    define QT3DQUICKEXTRASSHARED_EXPORT Q_DECL_IMPORT
+#  endif
+#else
+#  define QT3DQUICKEXTRASSHARED_EXPORT
+#endif
+
+QT_END_NAMESPACE
+
+#endif // QT3DQUICKEXTRAS_GLOBAL_H
diff --git a/src/quick3d/quick3dextras/qt3dquickwindow.cpp b/src/quick3d/quick3dextras/qt3dquickwindow.cpp
new file mode 100644
index 000000000..96c4bff6a
--- /dev/null
+++ b/src/quick3d/quick3dextras/qt3dquickwindow.cpp
@@ -0,0 +1,254 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+#include <Qt3DQuickExtras/qt3dquickwindow.h>
+#include <Qt3DQuick/QQmlAspectEngine>
+#include <Qt3DRender/qcamera.h>
+#include <Qt3DRender/qrenderaspect.h>
+#include <Qt3DRender/qrendersettings.h>
+#include <Qt3DRender/qrendersurfaceselector.h>
+#include <Qt3DInput/qinputaspect.h>
+#include <Qt3DInput/qinputsettings.h>
+#include <Qt3DLogic/qlogicaspect.h>
+
+#include <QQmlContext>
+
+#include <QtGui/qopenglcontext.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DExtras {
+
+namespace Quick {
+
+Qt3DQuickWindow::Qt3DQuickWindow(QWindow *parent)
+    : QQuickWindow(parent)
+    , m_engine(Q_NULLPTR)
+    , m_renderAspect(Q_NULLPTR)
+    , m_inputAspect(Q_NULLPTR)
+    , m_logicAspect(Q_NULLPTR)
+    , m_initialized(false)
+    , m_cameraAspectRatioMode(AutomaticAspectRatio)
+{
+    setSurfaceType(QSurface::OpenGLSurface);
+
+    resize(1024, 768);
+
+    QSurfaceFormat format;
+#ifdef QT_OPENGL_ES_2
+    format.setRenderableType(QSurfaceFormat::OpenGLES);
+#else
+    if (QOpenGLContext::openGLModuleType() == QOpenGLContext::LibGL) {
+        format.setVersion(4, 3);
+        format.setProfile(QSurfaceFormat::CoreProfile);
+    }
+#endif
+    format.setDepthBufferSize(24);
+    format.setSamples(4);
+    format.setStencilBufferSize(8);
+    setFormat(format);
+    QSurfaceFormat::setDefaultFormat(format);
+    create();
+
+    m_engine.reset(new Qt3DCore::Quick::QQmlAspectEngine);
+    m_renderAspect = new Qt3DRender::QRenderAspect;
+    m_inputAspect = new Qt3DInput::QInputAspect;
+    m_logicAspect = new Qt3DLogic::QLogicAspect;
+
+    m_engine->aspectEngine()->registerAspect(m_renderAspect);
+    m_engine->aspectEngine()->registerAspect(m_inputAspect);
+    m_engine->aspectEngine()->registerAspect(m_logicAspect);
+}
+
+Qt3DQuickWindow::~Qt3DQuickWindow()
+{
+}
+
+void Qt3DQuickWindow::registerAspect(Qt3DCore::QAbstractAspect *aspect)
+{
+    Q_ASSERT(!isVisible());
+    m_engine->aspectEngine()->registerAspect(aspect);
+}
+
+void Qt3DQuickWindow::registerAspect(const QString &name)
+{
+    Q_ASSERT(!isVisible());
+    m_engine->aspectEngine()->registerAspect(name);
+}
+
+void Qt3DQuickWindow::setSource(const QUrl &source)
+{
+    m_source = source;
+}
+
+Qt3DCore::Quick::QQmlAspectEngine *Qt3DQuickWindow::engine() const
+{
+    return m_engine.data();
+}
+
+void Qt3DQuickWindow::setCameraAspectRatioMode(CameraAspectRatioMode mode)
+{
+    if (m_cameraAspectRatioMode == mode)
+        return;
+
+    m_cameraAspectRatioMode = mode;
+    setCameraAspectModeHelper();
+    emit cameraAspectRatioModeChanged(mode);
+}
+
+Qt3DQuickWindow::CameraAspectRatioMode Qt3DQuickWindow::cameraAspectRatioMode() const
+{
+    return m_cameraAspectRatioMode;
+}
+
+void Qt3DQuickWindow::showEvent(QShowEvent *e)
+{
+    if (!m_initialized) {
+
+        // Connect to the QQmlAspectEngine's statusChanged signal so that when the QML is loaded
+        // and th eobjects hav ebeen instantiated, but before we set them on the QAspectEngine we
+        // can swoop in and set the window surface and camera on the framegraph and ensure the camera
+        // respects the window's aspect ratio
+        connect(m_engine.data(), &Qt3DCore::Quick::QQmlAspectEngine::sceneCreated,
+                this, &Qt3DQuickWindow::onSceneCreated);
+
+        m_engine->setSource(m_source);
+
+        // Set the QQmlIncubationController on the window
+        // to benefit from asynchronous incubation
+        m_engine->qmlEngine()->setIncubationController(QQuickWindow::incubationController());
+
+        m_initialized = true;
+    }
+    QQuickWindow::showEvent(e);
+}
+
+void Qt3DQuickWindow::onSceneCreated(QObject *rootObject)
+{
+    Q_ASSERT(rootObject);
+
+    setWindowSurface(rootObject);
+
+    if (m_cameraAspectRatioMode == AutomaticAspectRatio) {
+        // Set aspect ratio of first camera to match the window
+        QList<Qt3DRender::QCamera *> cameras
+            = rootObject->findChildren<Qt3DRender::QCamera *>();
+        if (cameras.isEmpty()) {
+            qWarning() << "No camera found";
+        } else {
+            m_camera = cameras.first();
+            setCameraAspectModeHelper();
+        }
+    }
+
+    // Set ourselves up as a source of input events for the input aspect
+    Qt3DInput::QInputSettings *inputSettings = rootObject->findChild<Qt3DInput::QInputSettings *>();
+    if (inputSettings) {
+        inputSettings->setEventSource(this);
+    } else {
+        qWarning() << "No Input Settings found, keyboard and mouse events won't be handled";
+    }
+}
+
+void Qt3DQuickWindow::setWindowSurface(QObject *rootObject)
+{
+    // Find surface selector in framegraph and set ourselves up as the
+    // render surface there
+    Qt3DRender::QRenderSettings *rendererSettings
+        = rootObject->findChild<Qt3DRender::QRenderSettings *>();
+    if (!rendererSettings) {
+        qWarning() << "No renderer settings component found";
+        return;
+    }
+
+    Qt3DCore::QNode *frameGraphRoot = rendererSettings->activeFrameGraph();
+    if (!frameGraphRoot) {
+        qWarning() << "No active frame graph found";
+        return;
+    }
+
+    Qt3DRender::QRenderSurfaceSelector *surfaceSelector = qobject_cast<Qt3DRender::QRenderSurfaceSelector *>(frameGraphRoot);
+    if (!surfaceSelector)
+        surfaceSelector = frameGraphRoot->findChild<Qt3DRender::QRenderSurfaceSelector *>();
+    if (!surfaceSelector) {
+        qWarning() << "No render surface selector found in frame graph";
+        return;
+    }
+
+    surfaceSelector->setSurface(this);
+}
+
+void Qt3DQuickWindow::setCameraAspectModeHelper()
+{
+    switch (m_cameraAspectRatioMode) {
+    case AutomaticAspectRatio:
+        connect(this, &QWindow::widthChanged, this, &Qt3DQuickWindow::updateCameraAspectRatio);
+        connect(this, &QWindow::heightChanged, this, &Qt3DQuickWindow::updateCameraAspectRatio);
+        break;
+    case UserAspectRatio:
+        disconnect(this, &QWindow::widthChanged, this, &Qt3DQuickWindow::updateCameraAspectRatio);
+        disconnect(this, &QWindow::heightChanged, this, &Qt3DQuickWindow::updateCameraAspectRatio);
+        break;
+    }
+}
+
+void Qt3DQuickWindow::updateCameraAspectRatio()
+{
+    if (m_camera) {
+        m_camera->setAspectRatio(static_cast<float>(width()) /
+                                 static_cast<float>(height()));
+    }
+}
+
+} // Quick
+
+} // Qt3DExtras
+
+QT_END_NAMESPACE
diff --git a/src/quick3d/quick3dextras/qt3dquickwindow.h b/src/quick3d/quick3dextras/qt3dquickwindow.h
new file mode 100644
index 000000000..83d31dbc9
--- /dev/null
+++ b/src/quick3d/quick3dextras/qt3dquickwindow.h
@@ -0,0 +1,140 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+#ifndef QT3DEXTRAS_QUICK_QT3DQUICKWINDOW_H
+#define QT3DEXTRAS_QUICK_QT3DQUICKWINDOW_H
+
+#include <Qt3DQuickExtras/qt3dquickextras_global.h>
+#include <QQuickWindow>
+#include <QtCore/qpointer.h>
+#include <QUrl>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DCore {
+class QAbstractAspect;
+namespace Quick {
+class QQmlAspectEngine;
+}
+}
+
+namespace Qt3DRender {
+class QRenderAspect;
+class QCamera;
+}
+
+namespace Qt3DInput {
+class QInputAspect;
+}
+
+namespace Qt3DLogic {
+class QLogicAspect;
+}
+
+namespace Qt3DExtras {
+
+namespace Quick {
+
+class QT3DQUICKEXTRASSHARED_EXPORT Qt3DQuickWindow : public QQuickWindow
+{
+    Q_OBJECT
+    Q_PROPERTY(CameraAspectRatioMode cameraAspectRatioMode READ cameraAspectRatioMode WRITE setCameraAspectRatioMode NOTIFY cameraAspectRatioModeChanged)
+
+public:
+    Qt3DQuickWindow(QWindow *parent = Q_NULLPTR);
+    ~Qt3DQuickWindow();
+
+    void registerAspect(Qt3DCore::QAbstractAspect *aspect);
+    void registerAspect(const QString &name);
+
+    void setSource(const QUrl &source);
+    Qt3DCore::Quick::QQmlAspectEngine *engine() const;
+
+    enum CameraAspectRatioMode {
+        AutomaticAspectRatio,
+        UserAspectRatio
+    };
+    Q_ENUM(CameraAspectRatioMode);
+
+    void setCameraAspectRatioMode(CameraAspectRatioMode mode);
+    CameraAspectRatioMode cameraAspectRatioMode() const;
+
+Q_SIGNALS:
+    void cameraAspectRatioModeChanged(CameraAspectRatioMode mode);
+
+protected:
+    void showEvent(QShowEvent *e) Q_DECL_OVERRIDE;
+
+private:
+    void onSceneCreated(QObject *rootObject);
+    void setWindowSurface(QObject *rootObject);
+    void setCameraAspectModeHelper();
+    void updateCameraAspectRatio();
+
+    QScopedPointer<Qt3DCore::Quick::QQmlAspectEngine> m_engine;
+
+    // Aspects
+    Qt3DRender::QRenderAspect *m_renderAspect;
+    Qt3DInput::QInputAspect *m_inputAspect;
+    Qt3DLogic::QLogicAspect *m_logicAspect;
+
+    QUrl m_source;
+    bool m_initialized;
+    QPointer<Qt3DRender::QCamera> m_camera;
+    CameraAspectRatioMode m_cameraAspectRatioMode;
+};
+
+} // Quick
+
+} // Qt3DExtras
+
+QT_END_NAMESPACE
+
+#endif // QT3DEXTRAS_QUICK_QT3DQUICKWINDOW_H
diff --git a/src/quick3d/quick3dextras/quick3dextras.pro b/src/quick3d/quick3dextras/quick3dextras.pro
new file mode 100644
index 000000000..aa3b485e7
--- /dev/null
+++ b/src/quick3d/quick3dextras/quick3dextras.pro
@@ -0,0 +1,26 @@
+TARGET   = Qt3DQuickExtras
+MODULE   = 3dquickextras
+
+QT      += core core-private qml qml-private 3dcore 3dinput 3dquick 3drender 3dlogic
+CONFIG -= precompile_header
+
+gcov {
+    CONFIG += static
+    QMAKE_CXXFLAGS += -fprofile-arcs -ftest-coverage
+    QMAKE_LFLAGS += -fprofile-arcs -ftest-coverage
+}
+
+SOURCES += \
+    qt3dquickwindow.cpp
+
+
+HEADERS += \
+    qt3dquickextras_global.h \
+    qt3dquickwindow.h
+
+!contains(QT_CONFIG, egl):DEFINES += QT_NO_EGL
+
+# otherwise mingw headers do not declare common functions like ::strcasecmp
+win32-g++*:QMAKE_CXXFLAGS_CXX11 = -std=gnu++0x
+
+load(qt_module)