Rename to QMouseInput to QMouseHandler

also:
- rename property controller to sourceDevice
- remove protected ctor
- move other protected methods to dpointer

Change-Id: Ibce97ec4ab7927ec2bb758f3e872691d52e3c785
Task-Id: QTBUG-51443
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

1 files changed, 203 insertions, 0 deletions

diff --git a/src/input/frontend/qmousehandler.cpp b/src/input/frontend/qmousehandler.cpp
new file mode 100644
index 000000000..5a72359ad
--- /dev/null
+++ b/src/input/frontend/qmousehandler.cpp
@@ -0,0 +1,203 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 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$
+**
+****************************************************************************/
+
+#include "qmousehandler.h"
+#include "qmousehandler_p.h"
+#include "qmousecontroller.h"
+#include "qmouseevent.h"
+#include <Qt3DCore/qbackendscenepropertychange.h>
+
+QT_BEGIN_NAMESPACE
+
+using namespace Qt3DCore;
+
+namespace Qt3DInput {
+/*! \internal */
+QMouseHandlerPrivate::QMouseHandlerPrivate()
+    : QComponentPrivate()
+    , m_sourceDevice(Q_NULLPTR)
+    , m_containsMouse(false)
+{
+    m_shareable = false;
+}
+
+void QMouseHandlerPrivate::mouseEvent(QMouseEvent *event)
+{
+    Q_Q(QMouseHandler);
+    switch (event->type()) {
+    case QEvent::MouseButtonPress:
+        if (event->wasHeld())
+            emit q->pressAndHold(event);
+        else
+            emit q->pressed(event);
+        break;
+    case QEvent::MouseButtonRelease:
+        emit q->released(event);
+        break;
+    case Qt::TapGesture:
+        emit q->clicked(event);
+        break;
+    case QEvent::MouseButtonDblClick:
+        emit q->doubleClicked(event);
+        break;
+    case QEvent::MouseMove:
+        emit q->positionChanged(event);
+        break;
+    default:
+        break;
+    }
+}
+
+/*!
+ * \qmltype MouseHandler
+ * \instantiates Qt3DInput::QMouseHandler
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \brief Provides mouse event notification
+ *
+ * \TODO
+ * \sa MouseController
+ */
+
+/*!
+ * \class Qt3DInput::QMouseHandler
+ * \inmodule Qt3DInput
+ *
+ * \brief Provides a means of being notified about mouse events when attached to
+ * a QMouseController instance.
+ *
+ * \since 5.5
+ *
+ * \note QMouseHandler components shouldn't be shared, not respecting that
+ * condition will most likely result in undefined behaviors.
+ *
+ * \sa QMouseController
+ */
+
+/*!
+ * Constructs a new QMouseHandler instance with parent \a parent.
+ */
+QMouseHandler::QMouseHandler(QNode *parent)
+    : QComponent(*new QMouseHandlerPrivate, parent)
+{
+}
+
+/*!
+   Destroys this QMouseHandler object
+*/
+QMouseHandler::~QMouseHandler()
+{
+    QNode::cleanup();
+}
+
+/*!
+ * Sets the mouse source device of the QMouseHandler instance to \a sourceDevice.
+ */
+void QMouseHandler::setSourceDevice(QMouseController *sourceDevice)
+{
+    Q_D(QMouseHandler);
+    if (d->m_sourceDevice != sourceDevice) {
+        d->m_sourceDevice = sourceDevice;
+        emit sourceDeviceChanged(sourceDevice);
+    }
+}
+
+/*!
+ * Returns the current mouse source device of the QMouseHandler instance.
+ */
+QMouseController *QMouseHandler::sourceDevice() const
+{
+    Q_D(const QMouseHandler);
+    return d->m_sourceDevice;
+}
+
+/*!
+ * Returns \c true if the QMouseHandler currently contains the mouse.
+ *
+ * \note In this context, contains mean that the ray originating from the
+ * mouse is intersecting with the Qt3DCore::QEntity that aggregates the current
+ * QMouseHandler instance component.
+ */
+bool QMouseHandler::containsMouse() const
+{
+    Q_D(const QMouseHandler);
+    return d->m_containsMouse;
+}
+
+void QMouseHandler::setContainsMouse(bool contains)
+{
+    Q_D(QMouseHandler);
+    if (contains != d->m_containsMouse) {
+        d->m_containsMouse = contains;
+        emit containsMouseChanged(contains);
+    }
+}
+
+void QMouseHandler::copy(const QNode *ref)
+{
+    Q_D(QMouseHandler);
+    const QMouseHandler *refInput = static_cast<const QMouseHandler *>(ref);
+    d->m_containsMouse = refInput->containsMouse();
+
+    // TODO: We may want to store the controller id and only send a clone when we are the parent
+    // of the controller.
+    // Perhaps it's time to investigate sending a "kernel" or "seed" over to the backend rather
+    // than a complete clone.
+    if (refInput && refInput->sourceDevice() && refInput->sourceDevice()->parent() == ref)
+        d->m_sourceDevice = static_cast<QMouseController *>(QNode::clone(refInput->sourceDevice()));
+}
+
+void QMouseHandler::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change)
+{
+    Q_D(QMouseHandler);
+    QBackendScenePropertyChangePtr e = qSharedPointerCast<QBackendScenePropertyChange>(change);
+    if (e->type() == NodeUpdated) {
+        if (e->propertyName() == QByteArrayLiteral("mouse")) {
+            QMouseEventPtr ev = e->value().value<QMouseEventPtr>();
+            d->mouseEvent(ev.data());
+        } else if (e->propertyName() == QByteArrayLiteral("wheel")) {
+            QWheelEventPtr ev = e->value().value<QWheelEventPtr>();
+            emit wheel(ev.data());
+        }
+    }
+}
+
+} // namespace Qt3DInput
+
+QT_END_NAMESPACE