1/****************************************************************************
2**
3** Copyright (C) 2015 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#ifndef QT3DINPUT_QINPUTDEVICEINTEGRATION_P_H
41#define QT3DINPUT_QINPUTDEVICEINTEGRATION_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <Qt3DInput/qt3dinput_global.h>
55#include <Qt3DCore/qaspectjob.h>
56#include <Qt3DCore/qnodeid.h>
57#include <QtCore/QObject>
58
59#include <Qt3DInput/private/qabstractphysicaldevicebackendnode_p.h>
60
61QT_BEGIN_NAMESPACE
62
63namespace Qt3DCore {
64class QBackendNodeMapper;
65typedef QSharedPointer<QBackendNodeMapper> QBackendNodeMapperPtr;
66}
67
68
69namespace Qt3DInput {
70
71class QInputAspect;
72class QAbstractPhysicalDevice;
73class QInputDeviceIntegrationPrivate;
74
75class Q_3DINPUTSHARED_PRIVATE_EXPORT QInputDeviceIntegration : public QObject
76{
77 Q_OBJECT
78protected:
79 explicit QInputDeviceIntegration(QObject *parent = nullptr);
80 explicit QInputDeviceIntegration(QInputDeviceIntegrationPrivate &dd, QObject *parent = nullptr);
81
82 template<class Frontend>
83 void registerBackendType(const Qt3DCore::QBackendNodeMapperPtr &functor)
84 {
85 registerBackendType(Frontend::staticMetaObject, functor);
86 }
87
88 void registerBackendType(const QMetaObject &metaObject, const Qt3DCore::QBackendNodeMapperPtr &functor);
89
90public:
91 void initialize(Qt3DInput::QInputAspect *aspect);
92
93 virtual QVector<Qt3DCore::QAspectJobPtr> jobsToExecute(qint64 time) = 0;
94 virtual QAbstractPhysicalDevice *createPhysicalDevice(const QString &name) = 0;
95 virtual QVector<Qt3DCore::QNodeId> physicalDevices() const = 0;
96 virtual QAbstractPhysicalDeviceBackendNode *physicalDevice(Qt3DCore::QNodeId id) const = 0;
97 virtual QStringList deviceNames() const = 0;
98
99protected:
100 QInputAspect *inputAspect() const;
101
102private:
103 virtual void onInitialize() = 0;
104
105 Q_DECLARE_PRIVATE(QInputDeviceIntegration)
106};
107
108} // namespace Qt3DInput
109
110QT_END_NAMESPACE
111
112#endif // QT3DINPUT_QINPUTDEVICEINTEGRATION_P_H
113