summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qmlfollow.cpp
blob: 01d8962dab2d2b6e1a0a0f98176a5983e959d7c1 (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
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, 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.0, 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#include <limits.h>
#include <QtCore/qdebug.h>
#include <gfxtimeline.h>
#include "private/qobject_p.h"
#include "qmlfollow.h"
#include "private/qmlanimation_p.h"


QT_BEGIN_NAMESPACE
QML_DEFINE_TYPE(QmlFollow,Follow);

class QmlFollowPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlFollow)
public:
    QmlFollowPrivate()
        : sourceValue(0), maxVelocity(0), lastTime(0)
        , mass(1.0), spring(0.), damping(0.), velocity(0), enabled(true), mode(Track), clock(this) {}

    QmlMetaProperty property;
    qreal currentValue;
    qreal sourceValue;
    qreal maxVelocity;
    qreal velocityms;
    int lastTime;
    qreal mass;
    qreal spring;
    qreal damping;
    qreal velocity;
    bool enabled;

    enum Mode {
        Track,
        Velocity,
        Spring
    };
    Mode mode;

    void tick(int);
    void updateMode();
    void start();
    void stop();

    QTickAnimationProxy<QmlFollowPrivate, &QmlFollowPrivate::tick> clock;
};

void QmlFollowPrivate::tick(int time)
{
    Q_Q(QmlFollow);

    int elapsed = time - lastTime;
    if (!elapsed)
        return;
    if (mode == Spring) {
        if (elapsed < 10) // capped at 100fps.
            return;
        // Real men solve the spring DEs using RK4.
        // We'll do something much simpler which gives a result that looks fine.
        int count = (elapsed+5) / 10;
        for (int i = 0; i < count; ++i) {
            qreal diff = sourceValue - currentValue;
            velocity = velocity + spring * diff - damping * velocity;
            // The following line supports mass.  Not sure its worth the extra divisions.
            // velocity = velocity + spring / mass * diff - damping / mass * velocity;
            if (maxVelocity > 0.) {
                // limit velocity
                if (velocity > maxVelocity)
                    velocity = maxVelocity;
                else if (velocity < -maxVelocity)
                    velocity = -maxVelocity;
            }
            currentValue += velocity * 10.0 / 1000.0;
        }
        if (qAbs(velocity) < 0.5 && qAbs(sourceValue - currentValue) < 0.5) {
            velocity = 0.0;
            currentValue = sourceValue;
            clock.stop();
        }
        lastTime = time - (elapsed - count * 10);
    } else {
        qreal moveBy = elapsed * velocityms;
        qreal diff = sourceValue - currentValue;
        if (diff > 0) {
            currentValue += moveBy;
            if (currentValue > sourceValue) {
                currentValue = sourceValue;
                clock.stop();
            }
        } else {
            currentValue -= moveBy;
            if (currentValue < sourceValue) {
                currentValue = sourceValue;
                clock.stop();
            }
        }
        lastTime = time;
    }
    emit q->valueChanged(currentValue);
    property.write(currentValue);
}

void QmlFollowPrivate::updateMode()
{
    if (spring == 0. && maxVelocity == 0.)
        mode = Track;
    else if (spring > 0.)
        mode = Spring;
    else
        mode = Velocity;
}

void QmlFollowPrivate::start()
{
    if (!enabled)
        return;

    if (mode == QmlFollowPrivate::Track) {
        currentValue = sourceValue;
        property.write(currentValue);
    } else if (sourceValue != currentValue && clock.state() != QAbstractAnimation::Running) {
        lastTime = 0;
        clock.start(); // infinity??
    }
}

void QmlFollowPrivate::stop()
{
    clock.stop();
}

/*!
    \qmlclass Follow QmlFollow
    \brief The Follow element allows a property to track a value.

    In example below, Rect2 will follow Rect1 moving with a velocity of up to 200:
    \code
    <Rect id="Rect1" y="{200}" width="20" height="20" color="#00ff00">
        <y>
            <SequentialAnimation running="true" repeat="true">
                <NumericAnimation to="{200}" easing="easeOutBounce(amplitude:100)" duration="2000" />
                <PauseAnimation duration="1000" />
            </SequentialAnimation>
        </y>
    </Rect>
    <Rect id="Rect2" x="{Rect1.width}" width="20" height="20" color="#ff0000">
        <y>
            <Follow source="{Rect1.y}" velocity="200"/>
        </y>
    </Rect>
    \endcode
*/

QmlFollow::QmlFollow(QObject *parent)
: QmlPropertyValueSource(*(new QmlFollowPrivate),parent)
{
}

QmlFollow::~QmlFollow()
{
}

void QmlFollow::setTarget(const QmlMetaProperty &property)
{
    Q_D(QmlFollow);
    d->property = property;
    d->currentValue = property.read().toDouble();
}

qreal QmlFollow::sourceValue() const
{
    Q_D(const QmlFollow);
    return d->sourceValue;
}

/*!
    \qmlproperty qreal Follow::source
    This property holds the source value which will be tracked.

    Bind to a property in order to track its changes.
*/

void QmlFollow::setSourceValue(qreal value)
{
    Q_D(QmlFollow);
    d->sourceValue = value;
    d->start();
}

/*!
    \qmlproperty qreal Follow::velocity
    This property holds the maximum velocity allowed when tracking the source.
*/

qreal QmlFollow::velocity() const
{
    Q_D(const QmlFollow);
    return d->maxVelocity;
}

void QmlFollow::setVelocity(qreal velocity)
{
    Q_D(QmlFollow);
    d->maxVelocity = velocity;
    d->velocityms = velocity / 1000.0;
    d->updateMode();
}

/*!
    \qmlproperty qreal Follow::spring
    This property holds the spring constant

    The spring constant describes how strongly the target is pulled towards the
    source.  Setting spring to 0 turns off spring tracking.  Useful values 0 - 5.0

    When a spring constant is set and the velocity property is greater than 0,
    velocity limits the maximum speed.
*/
qreal QmlFollow::spring() const
{
    Q_D(const QmlFollow);
    return d->spring;
}

void QmlFollow::setSpring(qreal spring)
{
    Q_D(QmlFollow);
    d->spring = spring;
    d->updateMode();
}

/*!
    \qmlproperty qreal Follow::damping
    This property holds the spring damping constant

    The damping constant describes how quickly a sprung follower comes to rest.
    Useful range is 0 - 1.0
*/
qreal QmlFollow::damping() const
{
    Q_D(const QmlFollow);
    return d->damping;
}

void QmlFollow::setDamping(qreal damping)
{
    Q_D(QmlFollow);
    if (damping > 1.)
        damping = 1.;

    d->damping = damping;
}

/*!
    \qmlproperty qreal Follow::followValue
    The current value.
*/

/*!
    \qmlproperty bool Follow::enabled
    This property holds whether the target will track the source.
*/
bool QmlFollow::enabled() const
{
    Q_D(const QmlFollow);
    return d->enabled;
}

void QmlFollow::setEnabled(bool enabled)
{
    Q_D(QmlFollow);
    d->enabled = enabled;
    if (enabled)
        d->start();
    else
        d->stop();
}

qreal QmlFollow::value() const
{
    Q_D(const QmlFollow);
    return d->currentValue;
}

QT_END_NAMESPACE