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#include "qaction.h"
41#include "qaction_p.h"
42
43#include <Qt3DInput/qabstractactioninput.h>
44#include <Qt3DCore/qnodecreatedchange.h>
45
46#include <Qt3DCore/private/qnode_p.h>
47
48QT_BEGIN_NAMESPACE
49
50namespace Qt3DInput {
51
52/*!
53 \class Qt3DInput::QAction
54 \inmodule Qt3DInput
55 \inherits Qt3DCore::QNode
56 \brief Links a set of QAbstractActionInput that trigger the same event.
57 \since 5.7
58*/
59
60/*!
61 \qmltype Action
62 \inqmlmodule Qt3D.Input
63 \instantiates Qt3DInput::QAction
64 \brief QML frontend for the Qt3DInput::QAction C++ class.
65
66 Links a set of AbstractActionInput that trigger the same event.
67 \since 5.7
68*/
69
70/*!
71 Constructs a new QAction instance with parent \a parent.
72 */
73QAction::QAction(Qt3DCore::QNode *parent)
74 : Qt3DCore::QNode(*new QActionPrivate(), parent)
75{
76}
77
78/*! \internal */
79QAction::~QAction()
80{
81}
82
83/*!
84 \qmlproperty bool Qt3D.Input::Action::action
85*/
86
87/*!
88 \property QAction::active
89
90 Holds \c true if the action is active.
91
92 Note this property is not updated when the action is disabled.
93 */
94bool QAction::isActive() const
95{
96 Q_D(const QAction);
97 return d->m_active;
98}
99
100/*!
101 \qmlproperty list<AbstractActionInput> Qt3D.Input::Action::inputs
102
103 The list of AbstractActionInput that must be triggered to trigger this Action.
104*/
105
106/*!
107 Append QAbstractActionInput \a input to the list of inputs that can trigger this action.
108 */
109void QAction::addInput(QAbstractActionInput *input)
110{
111 Q_D(QAction);
112 if (!d->m_inputs.contains(t: input)) {
113 d->m_inputs.push_back(t: input);
114
115 if (!input->parent())
116 input->setParent(this);
117
118 // Ensures proper bookkeeping
119 d->registerDestructionHelper(node: input, func: &QAction::removeInput, d->m_inputs);
120
121 d->updateNode(node: input, property: "inputs", change: Qt3DCore::PropertyValueAdded);
122 }
123}
124
125/*!
126 Remove QAbstractActionInput \a input to the list of inputs that can trigger this action.
127 */
128void QAction::removeInput(QAbstractActionInput *input)
129{
130 Q_D(QAction);
131 if (d->m_inputs.contains(t: input)) {
132
133 d->updateNode(node: input, property: "inputs", change: Qt3DCore::PropertyValueRemoved);
134
135 d->m_inputs.removeOne(t: input);
136
137 // Remove bookkeeping connection
138 d->unregisterDestructionHelper(node: input);
139 }
140}
141
142/*!
143 Returns the list of inputs that can trigger this action.
144 */
145QVector<QAbstractActionInput *> QAction::inputs() const
146{
147 Q_D(const QAction);
148 return d->m_inputs;
149}
150
151// TODO Unused remove in Qt6
152void QAction::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &)
153{
154}
155
156Qt3DCore::QNodeCreatedChangeBasePtr QAction::createNodeCreationChange() const
157{
158 auto creationChange = Qt3DCore::QNodeCreatedChangePtr<QActionData>::create(arguments: this);
159 auto &data = creationChange->data;
160 data.inputIds = qIdsForNodes(nodes: inputs());
161 return creationChange;
162}
163
164} // Qt3DInput
165
166QT_END_NAMESPACE
167

source code of qt3d/src/input/frontend/qaction.cpp