1/****************************************************************************
2**
3** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "keyboardhandler_p.h"
41
42#include <Qt3DInput/qkeyboarddevice.h>
43#include <Qt3DInput/qkeyboardhandler.h>
44#include <Qt3DCore/qpropertyupdatedchange.h>
45#include <QtCore/QVariant>
46
47#include <Qt3DInput/private/inputhandler_p.h>
48#include <Qt3DInput/private/inputmanagers_p.h>
49#include <Qt3DInput/private/qkeyboardhandler_p.h>
50
51QT_BEGIN_NAMESPACE
52
53using namespace Qt3DCore;
54
55namespace Qt3DInput {
56namespace Input {
57
58KeyboardHandler::KeyboardHandler()
59 : QBackendNode(QBackendNode::ReadWrite)
60 , m_inputHandler(nullptr)
61 , m_focus(false)
62{
63}
64
65void KeyboardHandler::initializeFromPeer(const Qt3DCore::QNodeCreatedChangeBasePtr &change)
66{
67 const auto typedChange = qSharedPointerCast<Qt3DCore::QNodeCreatedChange<QKeyboardHandlerData>>(change);
68 const auto &data = typedChange->data;
69 setSourcerDevice(data.keyboardDeviceId);
70 m_focus = false;
71 if (data.focus)
72 requestFocus();
73}
74
75Qt3DCore::QNodeId KeyboardHandler::keyboardDevice() const
76{
77 return m_keyboardDevice;
78}
79
80void KeyboardHandler::setInputHandler(InputHandler *handler)
81{
82 m_inputHandler = handler;
83}
84
85// Called by the KeyboadDevice when the focus for the KeyboardHandler has changed
86// Sends a change notification so that the frontend can update itself
87void KeyboardHandler::setFocus(bool focus)
88{
89 if (focus != m_focus) {
90 m_focus = focus;
91 auto e = Qt3DCore::QPropertyUpdatedChangePtr::create(peerId());
92 e->setDeliveryFlags(Qt3DCore::QSceneChange::DeliverToAll);
93 e->setPropertyName("focus");
94 e->setValue(m_focus);
95 notifyObservers(e);
96 }
97}
98
99void KeyboardHandler::keyEvent(const QKeyEventPtr &event)
100{
101 auto e = Qt3DCore::QPropertyUpdatedChangePtr::create(peerId());
102 e->setDeliveryFlags(Qt3DCore::QSceneChange::DeliverToAll);
103 e->setPropertyName("event");
104 e->setValue(QVariant::fromValue(event));
105 notifyObservers(e);
106}
107
108void KeyboardHandler::sceneChangeEvent(const QSceneChangePtr &e)
109{
110 bool focusRequest = false;
111 if (e->type() == PropertyUpdated) {
112 QPropertyUpdatedChangePtr propertyChange = qSharedPointerCast<QPropertyUpdatedChange>(e);
113 if (propertyChange->propertyName() == QByteArrayLiteral("sourceDevice")) {
114 const QNodeId newId = propertyChange->value().value<QNodeId>();
115 if (m_keyboardDevice != newId) {
116 setSourcerDevice(newId);
117 focusRequest = m_focus;
118 }
119 } else if (propertyChange->propertyName() == QByteArrayLiteral("focus")) {
120 focusRequest = propertyChange->value().toBool();
121 }
122 }
123 if (focusRequest)
124 requestFocus();
125 QBackendNode::sceneChangeEvent(e);
126}
127
128void KeyboardHandler::requestFocus()
129{
130 KeyboardDevice *keyboardDevice = m_inputHandler->keyboardDeviceManager()->lookupResource(m_keyboardDevice);
131 if (keyboardDevice && isEnabled())
132 keyboardDevice->requestFocusForInput(peerId());
133}
134
135void KeyboardHandler::setSourcerDevice(QNodeId device)
136{
137 m_keyboardDevice = device;
138}
139
140KeyboardHandlerFunctor::KeyboardHandlerFunctor(InputHandler *handler)
141 : m_handler(handler)
142{
143}
144
145Qt3DCore::QBackendNode *KeyboardHandlerFunctor::create(const Qt3DCore::QNodeCreatedChangeBasePtr &change) const
146{
147 KeyboardHandler *input = m_handler->keyboardInputManager()->getOrCreateResource(change->subjectId());
148 input->setInputHandler(m_handler);
149 return input;
150}
151
152QBackendNode *KeyboardHandlerFunctor::get(QNodeId id) const
153{
154 return m_handler->keyboardInputManager()->lookupResource(id);
155}
156
157void KeyboardHandlerFunctor::destroy(QNodeId id) const
158{
159 m_handler->keyboardInputManager()->releaseResource(id);
160}
161
162} // namespace Input
163} // namespace Qt3DInput
164
165QT_END_NAMESPACE
166