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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtFeedback module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qdeclarativefeedbackeffect_p.h"
/*!
\qmltype FeedbackEffect
\instantiates QDeclarativeFeedbackEffect
\brief The FeedbackEffect element is the base class for all feedback effects.
\ingroup qml-feedback-api
You can't create one of these elements directly, but several other elements
inherit the methods and properties of these elements.
There are several predefined enumerations and constants provided in this class:
1. Duration
This enum describes the possible predefined duration types. Generally a specific
value in milliseconds can be supplied instead of one of these values.
\list
\li Feedback.Infinite - Infinite effect duration
\endlist
2. State
This enum describes the state of the effect. An effect will be in one of these states.
\list
\li Feedback.Stopped - The effect is not running. This is the initial state.
\li Feedback.Paused - The effect is paused.
\li Feedback.Running - The effect is running.
\li Feedback.Loading - The effect is loading.
\endlist
3. ErrorType
This enum describes the possible errors happening on the effect.
\list
\li Feedback.UnknownError - An unknown error occurred.
\li Feedback.DeviceBusy - The feedback could not start because the device is busy,
the device could be busy if a higher-priority client is using the haptics/actuator device.
\endlist
\sa FileEffect, ThemeEffect, HapticsEffect, {QFeedbackEffect}
*/
QDeclarativeFeedbackEffect::QDeclarativeFeedbackEffect(QObject *parent)
: QObject(parent), m_running(false), m_paused(false), m_error(UnknownError)
{
}
void QDeclarativeFeedbackEffect::setFeedbackEffect(QFeedbackEffect* effect)
{
m_effect = effect;
QObject::connect(m_effect, SIGNAL(stateChanged()), this, SLOT(updateState()));
QObject::connect(m_effect, SIGNAL(error(QFeedbackEffect::ErrorType)), this, SLOT(_error(QFeedbackEffect::ErrorType)));
}
QFeedbackEffect* QDeclarativeFeedbackEffect::feedbackEffect()
{
return m_effect;
}
/*!
\qmlproperty bool FeedbackEffect::running
This property is true if this feedback effect is running.
*/
bool QDeclarativeFeedbackEffect::isRunning() const
{
return m_running;
}
void QDeclarativeFeedbackEffect::setRunning(bool running)
{
QDeclarativeFeedbackEffect::State currentState = static_cast<QDeclarativeFeedbackEffect::State>(m_effect->state());
if (currentState != QDeclarativeFeedbackEffect::Running && running) {
m_running = true;
m_effect->start();
emit runningChanged();
} else if (currentState != QDeclarativeFeedbackEffect::Stopped && !running) {
m_running = false;
m_effect->stop();
emit runningChanged();
}
}
/*!
\qmlproperty bool FeedbackEffect::paused
This property is true if this feedback effect is paused.
*/
bool QDeclarativeFeedbackEffect::isPaused() const
{
return m_paused;
}
void QDeclarativeFeedbackEffect::setPaused(bool paused)
{
QDeclarativeFeedbackEffect::State currentState = static_cast<QDeclarativeFeedbackEffect::State>(m_effect->state());
if (currentState == QDeclarativeFeedbackEffect::Paused && !paused) {
m_paused = true;
m_effect->start();
emit pausedChanged();
} else if (currentState == QDeclarativeFeedbackEffect::Running && paused) {
paused = false;
m_effect->pause();
emit pausedChanged();
}
}
/*!
\qmlproperty int FeedbackEffect::duration
The duration of the effect, in milliseconds. This is 0 for effects of unknown
duration, or Feedback.Infinite for effects that don't stop.
\sa Feedback
*/
int QDeclarativeFeedbackEffect::duration() const
{
return m_effect->duration();
}
void QDeclarativeFeedbackEffect::setDuration(int newDuration)
{
Q_UNUSED(newDuration)
//default do nothing
}
/*!
\qmlproperty FeedbackEffect::State FeedbackEffect::state
This is the current state of the effect. It is one of:
\list
\li Feedback.Stopped - the effect is not playing.
\li Feedback.Loading - the effect is being loaded.
\li Feedback.Running - the effect is playing.
\li Feedback.Paused - the effect was being played, but is now paused.
\endlist
\sa Feedback
*/
QDeclarativeFeedbackEffect::State QDeclarativeFeedbackEffect::state() const
{
return static_cast<QDeclarativeFeedbackEffect::State>(m_effect->state());
}
void QDeclarativeFeedbackEffect::setState(QDeclarativeFeedbackEffect::State newState)
{
Q_UNUSED(newState)
//default do nothing
}
/*!
\qmlproperty Feedback::ErrorType FeedbackEffect::error
This property holds the error status of the FeedbackEffect.
The error is one of the following values:
\list
\li Feedback.UnknownError - An unknown error occurred.
\li Feedback.DeviceBusy - The device resource is already being used.
\endlist
\sa Feedback, QFeedbackEffect::ErrorType
*/
QDeclarativeFeedbackEffect::ErrorType QDeclarativeFeedbackEffect::error() const
{
return m_error;
}
/*!
\qmlmethod Feedback::updateState()
updates the state of the effect.
*/
void QDeclarativeFeedbackEffect::updateState() {
bool running = m_effect->state() == QFeedbackEffect::Running;
bool paused = m_effect->state() == QFeedbackEffect::Paused;
if (running != m_running) {
m_running = running;
emit runningChanged();
}
if (paused != m_paused) {
m_paused = paused;
emit pausedChanged();
}
emit stateChanged();
}
/*!
\qmlmethod Feedback::start()
makes sure that the effect associated with the feedback object is started.
\sa QFeedbackEffect::start()
*/
void QDeclarativeFeedbackEffect::start() {
m_effect->start();
}
/*!
\qmlmethod Feedback::stop()
makes sure that the effect associated with the feedback object is stoped.
\sa QFeedbackEffect::stop()
*/
void QDeclarativeFeedbackEffect::stop() {
m_effect->stop();
}
/*!
\qmlmethod Feedback::pause()
makes sure that the effect associated with the feedback object is paused.
\sa QFeedbackEffect::pause()
*/
void QDeclarativeFeedbackEffect::pause() {
m_effect->pause();
}
void QDeclarativeFeedbackEffect::_error(QFeedbackEffect::ErrorType err)
{
if (static_cast<ErrorType>(err) != m_error) {
m_error = static_cast<ErrorType>(err);
emit errorChanged();
}
}
|
