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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) 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.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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "q3dsdatainput_p.h"
#include "q3dspresentation.h"
QT_BEGIN_NAMESPACE
/*!
\class Q3DSDataInput
\inmodule 3dstudioruntime2
\since Qt 3D Studio 2.0
\brief Controls a data input entry in a Qt 3D Studio presentation.
This class is a convenience class for controlling a data input in a presentation.
\sa Q3DSPresentation
*/
/*!
\internal
*/
Q3DSDataInput::Q3DSDataInput(QObject *parent)
: QObject(*new Q3DSDataInputPrivate, parent)
{
}
/*!
Constructs a Q3DSDataInput instance and initializes the \a name. The
constructed instance is automatically associated with the specified \a
presentation. An optional \a parent object can be specified.
*/
Q3DSDataInput::Q3DSDataInput(Q3DSPresentation *presentation, const QString &name, QObject *parent)
: QObject(*new Q3DSDataInputPrivate, parent)
{
Q_D(Q3DSDataInput);
d->name = name;
d->presentation = presentation;
}
/*!
\internal
*/
Q3DSDataInput::Q3DSDataInput(Q3DSDataInputPrivate &dd, QObject *parent)
: QObject(dd, parent)
{
}
/*!
Destructor.
*/
Q3DSDataInput::~Q3DSDataInput()
{
}
/*!
\property Q3DSDataInput::name
Specifies the name of the controlled data input element in the
presentation. This property must be set before setting the value property.
The initial value is provided via the constructor in practice, but the name
can also be changed later on, if desired.
*/
QString Q3DSDataInput::name() const
{
Q_D(const Q3DSDataInput);
return d->name;
}
void Q3DSDataInput::setName(const QString &name)
{
Q_D(Q3DSDataInput);
if (d->name != name) {
d->name = name;
emit nameChanged();
}
}
/*!
\property Q3DSDataInput::value
Specifies the value of the controlled data input element in the
presentation.
The value of this property only accounts for changes done via the same
Q3DSDataInput instance. If the value of the same data input in the
presentation is changed elsewhere, for example via animations or
Q3DSPresentation::setAttribute(), those changes are not reflected in the
value of this property. Due to this uncertainty, this property treats all
value sets as changes even if the newly set value is the same value as the
previous value.
*/
QVariant Q3DSDataInput::value() const
{
Q_D(const Q3DSDataInput);
return d->value;
}
void Q3DSDataInput::setValue(const QVariant &value)
{
Q_D(Q3DSDataInput);
// Since properties controlled by data inputs can change without the
// current value being reflected on the value of the DataInput element, we
// allow setting the value to the same one it was previously and still
// consider it a change. For example, when controlling timeline, the value
// set to DataInput will only be the current value for one frame if
// presentation has a running animation.
d->value = value;
d->sendValue();
emit valueChanged();
}
void Q3DSDataInputPrivate::sendValue()
{
if (!presentation || name.isEmpty())
return;
presentation->setDataInputValue(name, value);
}
/*!
\qmltype DataInput
\instantiates Q3DSDataInput
\inqmlmodule QtStudio3D
\ingroup 3dstudioruntime2
\brief Controls a data input entry in a Qt 3D Studio presentation.
This type is a convenience for controlling a data input in a presentation.
Its functionality is equivalent to Presentation::setDataInputValue(),
however it has a big advantage of being able to use QML property bindings,
thus avoiding the need to having to resort to a JavaScript function call
for every value change.
As an example, compare the following two approaches:
\qml
Studio3D {
...
Presentation {
id: presentation
...
}
}
Button {
onClicked: presentation.setAttribute("SomeTextNode", "textstring", "Hello World")
}
\endqml
\qml
Studio3D {
...
Presentation {
id: presentation
...
property string text: ""
DataInput {
name: "inputForSomeTextNode"
value: presentation.text
}
}
}
Button {
onClicked: presentation.text = "Hello World"
}
\endqml
The latter assumes that a data input connection was made in Qt 3D Studio
between the \c textstring property of \c SomeTextNode and a data input name
\c inputForSomeTextNode. As the value is now set via a property, the full
set of QML property bindings techniques are available.
\sa Studio3D, Presentation
*/
/*!
\qmlproperty string DataInput::name
Specifies the name of the controlled data input element in the
presentation. This property must be set as part of DataInput declaration,
although it is changeable afterwards, if desired.
*/
/*!
\qmlproperty variant DataInput::value
Specifies the value of the controlled data input element in the presentation.
The value of this property only accounts for changes done via the same
DataInput instance. If the value of the underlying attribute in the
presentation is changed elsewhere, for example via animations or
Presentation::setAttribute(), those changes are not reflected in the value
of this property. Due to this uncertainty, this property treats all value
sets as changes even if the newly set value is the same value as the
previous value.
*/
QT_END_NAMESPACE
|
