summaryrefslogtreecommitdiffstats
path: root/src/input/frontend/qactioninput.cpp
blob: 90f3e4548ca43898dfc4844094f5970482aa6867 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
// Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qactioninput.h"
#include "qactioninput_p.h"

#include <Qt3DInput/qabstractphysicaldevice.h>
#include <Qt3DInput/qabstractactioninput.h>

QT_BEGIN_NAMESPACE

namespace Qt3DInput {

QActionInputPrivate::QActionInputPrivate()
    : QAbstractActionInputPrivate(),
      m_sourceDevice(nullptr)
{
}

/*!
    \class Qt3DInput::QActionInput
    \inmodule Qt3DInput
    \inherits Qt3DInput::QAbstractActionInput
    \brief QActionInput stores Device and Buttons used to trigger an input event.

    \since 5.7
*/

/*!
    \qmltype ActionInput
    \inqmlmodule Qt3D.Input
    \inherits QAbstractActionInput
    \instantiates Qt3DInput::QActionInput
    \brief QML frontend for the Qt3DInput::QActionInput C++ class.

    Links a physical device and selected buttons on it which can trigger this action.

    Each Action input can be triggered by one or many buttons on a source device
    \qml
    ActionInput {
      sourceDevice: keyboardSourceDevice
      buttons: [Qt.Key_A]
    }
    \endqml
   \qml
    ActionInput {
      sourceDevice: keyboardSourceDevice
      buttons: [Qt.Key_A,Qt.Key_B]
    }
    \endqml
    \since 5.7
*/

/*!
    Constructs a new QActionInput instance with \a parent.
 */
QActionInput::QActionInput(Qt3DCore::QNode *parent)
    : Qt3DInput::QAbstractActionInput(*new QActionInputPrivate(), parent)
{

}

/*! \internal */
QActionInput::~QActionInput()
{
}

/*!
    \property Qt3DInput::QActionInput::buttons

    Holds the buttons that can trigger this Action.
 */
QList<int> QActionInput::buttons() const
{
    Q_D(const QActionInput);
    return d->m_buttons;
}

/*!
    \property Qt3DInput::QActionInput::sourceDevice

    The current source device of the QActionInput.
*/
/*!
  \fn Qt3DInput::QActionInput::sourceDeviceChanged(QAbstractPhysicalDevice *sourceDevice)

  This signal is emitted when the source device associated with the action input is changed to \a sourceDevice.
*/

/*!
  \qmlproperty AbstractPhysicalDevice Qt3D.Input::ActionInput::sourceDevice

  The current source device of the ActionInput
*/

/*!
    \qmlsignal Qt3D.Input::ActionInput::sourceDeviceChanged()

    This signal is emitted when the source device associated with the action input is changed.

    The corresponding handler is \c onSourceDeviceChanged
*/
void QActionInput::setSourceDevice(QAbstractPhysicalDevice *sourceDevice)
{
    Q_D(QActionInput);
    if (d->m_sourceDevice != sourceDevice) {

        if (d->m_sourceDevice)
            d->unregisterDestructionHelper(d->m_sourceDevice);

        // Check and set parent if needed
        // to force creation in the backend
        if (sourceDevice && !sourceDevice->parent())
            sourceDevice->setParent(this);

        d->m_sourceDevice = sourceDevice;

        // Ensures proper bookkeeping
        if (d->m_sourceDevice)
            d->registerDestructionHelper(sourceDevice, &QActionInput::setSourceDevice, d->m_sourceDevice);

        emit sourceDeviceChanged(sourceDevice);
    }
}

QAbstractPhysicalDevice *QActionInput::sourceDevice() const
{
    Q_D(const QActionInput);
    return d->m_sourceDevice;
}

/*!
  \fn Qt3DInput::QActionInput::buttonsChanged(const QList<int> &buttons)

  This signal is emitted when the buttons associated with the action input is changed.
  The buttons changed are \a buttons
*/

/*!
    \qmlproperty list<int> Qt3D.Input::ActionInput::buttons

    The Buttons that can trigger this Action.
*/

/*!
    \qmlsignal Qt3D.Input::ActionInput::buttonsChanged(const QList<int> &buttons)

    This signal is emitted when the \a buttons associated with the action input is changed.

    The corresponding handler is \c onbuttonsChanged
*/

/*!
    Set the buttons to trigger the QActionInput instance to \a buttons.
 */
void QActionInput::setButtons(const QList<int> &buttons)
{
    Q_D(QActionInput);
    if (buttons != d->m_buttons) {
        d->m_buttons = buttons;
        emit buttonsChanged(buttons);
    }
}

} // Qt3DInput

QT_END_NAMESPACE

#include "moc_qactioninput.cpp"