Add QBoundingVolumeDebug component

Change-Id: Id37ab84a89403c9dc0f3728639e4d85b9db1a1a1
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Reviewed-by: Andy Nichols <andy.nichols@theqtcompany.com>

3 files changed, 274 insertions, 2 deletions

diff --git a/src/render/frontend/qboundingvolumedebug.cpp b/src/render/frontend/qboundingvolumedebug.cpp
new file mode 100644
index 000000000..029f42272
--- /dev/null
+++ b/src/render/frontend/qboundingvolumedebug.cpp
@@ -0,0 +1,192 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qboundingvolumedebug.h"
+#include <Qt3DCore/qentity.h>
+#include <Qt3DCore/private/qcomponent_p.h>
+#include <Qt3DCore/qbackendscenepropertychange.h>
+#include <Qt3DRender/qspheremesh.h>
+#include <Qt3DCore/qtransform.h>
+#include <Qt3DCore/qtranslatetransform.h>
+#include <Qt3DCore/qscaletransform.h>
+#include <Qt3DRender/qphongalphamaterial.h>
+#include <Qt3DRender/qlayer.h>
+
+#include <QThread>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+class QBoundingVolumeDebugPrivate : public Qt3DCore::QComponentPrivate
+{
+public:
+    QBoundingVolumeDebugPrivate()
+        : QComponentPrivate()
+        , m_recursive(false)
+        , m_debugSubtree(Q_NULLPTR)
+        , m_sphereMesh(Q_NULLPTR)
+        , m_transform(Q_NULLPTR)
+        , m_translate(Q_NULLPTR)
+        , m_material(Q_NULLPTR)
+        , m_layer(Q_NULLPTR)
+        , m_bvRadius(0.0f)
+    {
+        m_shareable = false;
+    }
+
+    Q_DECLARE_PUBLIC(QBoundingVolumeDebug)
+
+    bool m_recursive;
+    Qt3DCore::QEntity *m_debugSubtree;
+    Qt3DRender::QSphereMesh *m_sphereMesh;
+    Qt3DCore::QTransform *m_transform;
+    Qt3DCore::QTranslateTransform *m_translate;
+    Qt3DCore::QScaleTransform *m_scale;
+    Qt3DRender::QMaterial *m_material;
+    Qt3DRender::QLayer *m_layer;
+
+    float m_bvRadius;
+    QVector3D m_bvCenter;
+
+    Qt3DCore::QEntity *findRootEntity(Qt3DCore::QEntity *e);
+    void updateSubtree();
+};
+
+QBoundingVolumeDebug::QBoundingVolumeDebug(Qt3DCore::QNode *parent)
+    : QComponent(*new QBoundingVolumeDebugPrivate(), parent)
+{
+}
+
+QBoundingVolumeDebug::~QBoundingVolumeDebug()
+{
+    QComponent::cleanup();
+}
+
+void QBoundingVolumeDebug::setRecursive(bool recursive)
+{
+    Q_D(QBoundingVolumeDebug);
+    if (d->m_recursive != recursive) {
+        d->m_recursive = recursive;
+        emit recursiveChanged();
+    }
+}
+
+bool QBoundingVolumeDebug::recursive() const
+{
+    Q_D(const QBoundingVolumeDebug);
+    return d->m_recursive;
+}
+
+void QBoundingVolumeDebug::copy(const Qt3DCore::QNode *ref)
+{
+    QComponent::copy(ref);
+    const QBoundingVolumeDebug *debugVolume = static_cast<const QBoundingVolumeDebug *>(ref);
+    d_func()->m_recursive = debugVolume->d_func()->m_recursive;
+}
+
+void QBoundingVolumeDebug::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change)
+{
+    Q_D(QBoundingVolumeDebug);
+    Qt3DCore::QBackendScenePropertyChangePtr e = qSharedPointerCast<Qt3DCore::QBackendScenePropertyChange>(change);
+    if (e->type() == Qt3DCore::NodeUpdated) {
+        if (e->propertyName() == QByteArrayLiteral("center")) {
+            d->m_bvCenter = e->value().value<QVector3D>();
+            d->updateSubtree();
+        } else if (e->propertyName() == QByteArrayLiteral("radius")) {
+            d->m_bvRadius = e->value().toFloat();
+            d->updateSubtree();
+        }
+    }
+}
+
+// Executed in the frontend thread
+Qt3DCore::QEntity *QBoundingVolumeDebugPrivate::findRootEntity(Qt3DCore::QEntity *e)
+{
+    Qt3DCore::QEntity *tmp = Q_NULLPTR;
+    Qt3DCore::QEntity *parentEntity = Q_NULLPTR;
+    while (e && (tmp = e->parentEntity()) != Q_NULLPTR) {
+        parentEntity = tmp;
+        e = parentEntity;
+    }
+    return parentEntity;
+}
+
+void QBoundingVolumeDebugPrivate::updateSubtree()
+{
+    Q_Q(QBoundingVolumeDebug);
+    if (m_debugSubtree == Q_NULLPTR) {
+        m_debugSubtree = new Qt3DCore::QEntity();
+        m_sphereMesh = new Qt3DRender::QSphereMesh();
+        m_transform = new Qt3DCore::QTransform();
+        m_translate = new Qt3DCore::QTranslateTransform();
+        m_material = new Qt3DRender::QPhongAlphaMaterial();
+        m_scale = new Qt3DCore::QScaleTransform();
+        m_layer = new Qt3DRender::QLayer();
+
+        static_cast<QPhongAlphaMaterial *>(m_material)->setAlpha(0.3);
+        static_cast<QPhongAlphaMaterial *>(m_material)->setDiffuse(QColor::fromRgb(255, 153, 0));
+
+        m_layer->setNames(QStringList() << QStringLiteral("debug"));
+
+        m_transform->addTransform(m_scale);
+        m_transform->addTransform(m_translate);
+        m_debugSubtree->addComponent(m_sphereMesh);
+        m_debugSubtree->addComponent(m_transform);
+        m_debugSubtree->addComponent(m_material);
+        m_debugSubtree->addComponent(m_layer);
+
+        m_translate->setTranslation(m_bvCenter);
+        m_scale->setScale(m_bvRadius * 2.0f);
+        m_sphereMesh->setRadius(0.5f);
+        m_sphereMesh->setRings(100);
+        m_sphereMesh->setSlices(100);
+
+        // Insert into scene
+        if (q->entities().size() > 0) {
+            Qt3DCore::QEntity *rootEntity = findRootEntity(q->entities().first());
+            m_debugSubtree->setParent(rootEntity ? rootEntity : q->entities().first());
+        }
+    } else {
+        // Just update the mesh
+        m_translate->setTranslation(m_bvCenter);
+        m_scale->setScale(m_bvRadius * 2.0f);
+    }
+}
+
+} // Qt3DRender
+
+QT_END_NAMESPACE
diff --git a/src/render/frontend/qboundingvolumedebug.h b/src/render/frontend/qboundingvolumedebug.h
new file mode 100644
index 000000000..b50d8d8ca
--- /dev/null
+++ b/src/render/frontend/qboundingvolumedebug.h
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QT3DRENDER_QBOUNDINGVOLUMEDEBUG_H
+#define QT3DRENDER_QBOUNDINGVOLUMEDEBUG_H
+
+#include <Qt3DCore/qcomponent.h>
+#include <Qt3DRender/qt3drender_global.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+class QGeometry;
+class QBoundingVolumeDebugPrivate;
+
+class QT3DRENDERSHARED_EXPORT QBoundingVolumeDebug : public Qt3DCore::QComponent
+{
+    Q_OBJECT
+    Q_PROPERTY(bool recursive READ recursive WRITE setRecursive NOTIFY recursiveChanged)
+
+public:
+    explicit QBoundingVolumeDebug(Qt3DCore::QNode *parent = Q_NULLPTR);
+    ~QBoundingVolumeDebug();
+
+    void setRecursive(bool recursive);
+    bool recursive() const;
+
+Q_SIGNALS:
+    void recursiveChanged();
+
+protected:
+    void copy(const Qt3DCore::QNode *ref) Q_DECL_OVERRIDE;
+    void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) Q_DECL_OVERRIDE;
+
+private:
+    Q_DECLARE_PRIVATE(QBoundingVolumeDebug)
+    QT3D_CLONEABLE(QBoundingVolumeDebug)
+};
+
+} // Qt3DRender
+
+QT_END_NAMESPACE
+
+#endif // QT3DRENDER_QBOUNDINGVOLUMEDEBUG_H
diff --git a/src/render/frontend/render-frontend.pri b/src/render/frontend/render-frontend.pri
index e354c5600..de8f41a68 100644
--- a/src/render/frontend/render-frontend.pri
+++ b/src/render/frontend/render-frontend.pri
@@ -12,7 +12,8 @@ HEADERS += \
     $$PWD/qrendertarget_p.h \
     $$PWD/qwindow.h \
     $$PWD/qwindow_p.h \
-    $$PWD/sphere_p.h
+    $$PWD/sphere_p.h \
+    $$PWD/qboundingvolumedebug.h
 
 SOURCES += \
     $$PWD/qrenderaspect.cpp \
@@ -21,4 +22,5 @@ SOURCES += \
     $$PWD/qlayer.cpp \
     $$PWD/qrenderattachment.cpp \
     $$PWD/qrendertarget.cpp \
-    $$PWD/qwindow.cpp
+    $$PWD/qwindow.cpp \
+    $$PWD/qboundingvolumedebug.cpp