ObjectPicker backend class added

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

3 files changed, 206 insertions, 2 deletions

diff --git a/src/render/backend/objectpicker.cpp b/src/render/backend/objectpicker.cpp
new file mode 100644
index 000000000..d7e04319a
--- /dev/null
+++ b/src/render/backend/objectpicker.cpp
@@ -0,0 +1,117 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Paul Lemire paul.lemire350@gmail.com
+** 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 "objectpicker_p.h"
+#include <Qt3DRender/qobjectpicker.h>
+#include <Qt3DRender/qattribute.h>
+#include <Qt3DCore/qscenepropertychange.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+namespace Render {
+
+ObjectPicker::ObjectPicker()
+    : QBackendNode(QBackendNode::ReadWrite)
+    , m_isDirty(false)
+    , m_hoverEnabled(false)
+{
+}
+
+ObjectPicker::~ObjectPicker()
+{
+}
+
+void ObjectPicker::cleanup()
+{
+    m_isDirty = false;
+    m_hoverEnabled = false;
+    m_pickAttributeId = Qt3DCore::QNodeId();
+}
+
+void ObjectPicker::updateFromPeer(Qt3DCore::QNode *peer)
+{
+    QObjectPicker *picker = static_cast<QObjectPicker *>(peer);
+    if (picker) {
+        if (picker->pickAttribute())
+            m_pickAttributeId = picker->pickAttribute()->id();
+        m_hoverEnabled = picker->hoverEnabled();
+        m_isDirty = true;
+    }
+}
+
+void ObjectPicker::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &e)
+{
+    const Qt3DCore::QScenePropertyChangePtr propertyChange = qSharedPointerCast<Qt3DCore::QScenePropertyChange>(e);
+    const QByteArray propertyName = propertyChange->propertyName();
+
+    if (propertyChange->type() == Qt3DCore::NodeUpdated) {
+        if (propertyName == QByteArrayLiteral("pickAttribute")) {
+            m_pickAttributeId = propertyChange->value().value<Qt3DCore::QNodeId>();
+            m_isDirty = true;
+        } else if (propertyName == QByteArrayLiteral("hoverEnabled")) {
+            m_hoverEnabled = propertyChange->value().toBool();
+            m_isDirty = true;
+        }
+    }
+}
+
+Qt3DCore::QNodeId ObjectPicker::pickAttributeId() const
+{
+    return m_pickAttributeId;
+}
+
+bool ObjectPicker::isDirty() const
+{
+    return m_isDirty;
+}
+
+void ObjectPicker::unsetDirty()
+{
+    m_isDirty = false;
+}
+
+bool ObjectPicker::hoverEnabled() const
+{
+    return m_hoverEnabled;
+}
+
+} // Render
+
+} // Qt3DRender
+
+QT_END_NAMESPACE
diff --git a/src/render/backend/objectpicker_p.h b/src/render/backend/objectpicker_p.h
new file mode 100644
index 000000000..f38b89062
--- /dev/null
+++ b/src/render/backend/objectpicker_p.h
@@ -0,0 +1,85 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Paul Lemire paul.lemire350@gmail.com
+** 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_RENDER_OBJECTPICKER_P_H
+#define QT3DRENDER_RENDER_OBJECTPICKER_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists for the convenience
+// of other Qt classes.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <Qt3DCore/qbackendnode.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+namespace Render {
+
+class Q_AUTOTEST_EXPORT ObjectPicker : public Qt3DCore::QBackendNode
+{
+public:
+    ObjectPicker();
+    ~ObjectPicker();
+
+    void cleanup();
+    void updateFromPeer(Qt3DCore::QNode *peer) Q_DECL_FINAL;
+    void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &e) Q_DECL_FINAL;
+    Qt3DCore::QNodeId pickAttributeId() const;
+    bool isDirty() const;
+    void unsetDirty();
+    bool hoverEnabled() const;
+
+private:
+    Qt3DCore::QNodeId m_pickAttributeId;
+    bool m_isDirty;
+    bool m_hoverEnabled;
+};
+
+} // Render
+
+} // Qt3DRender
+
+QT_END_NAMESPACE
+
+#endif // QT3DRENDER_RENDER_OBJECTPICKER_H
diff --git a/src/render/backend/render-backend.pri b/src/render/backend/render-backend.pri
index a69f1d450..8066aa006 100644
--- a/src/render/backend/render-backend.pri
+++ b/src/render/backend/render-backend.pri
@@ -21,7 +21,8 @@ HEADERS += \
     $$PWD/entity_p.h \
     $$PWD/layer_p.h \
     $$PWD/nodefunctor_p.h \
-    $$PWD/transform_p.h
+    $$PWD/transform_p.h \
+    $$PWD/objectpicker_p.h
 
 SOURCES += \
     $$PWD/renderthread.cpp \
@@ -39,4 +40,5 @@ SOURCES += \
     $$PWD/cameralens.cpp \
     $$PWD/entity.cpp \
     $$PWD/layer.cpp \
-    $$PWD/transform.cpp
+    $$PWD/transform.cpp \
+    $$PWD/objectpicker.cpp