summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qmleasefollow.cpp
blob: b326f63f8f0f3dd7dcba65258379451e4f4f872b (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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (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 Technology Preview License Agreement accompanying
** this package.
**
** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmleasefollow_p.h"
#include <qmlmetaproperty.h>
#include <math.h>
#include <QtCore/qdebug.h>
#include <private/qmlanimation_p_p.h>

QT_BEGIN_NAMESPACE

QML_DEFINE_TYPE(Qt,4,6,EaseFollow,QmlEaseFollow);

class QmlEaseFollowPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlEaseFollow)
public:
    QmlEaseFollowPrivate()
        : source(0), velocity(200), duration(-1), maximumEasingTime(-1),
          reversingMode(QmlEaseFollow::Eased), initialVelocity(0), 
          initialValue(0), invert(false), enabled(true), trackVelocity(0), clockOffset(0),
          lastTick(0), clock(this)
    {} 

    qreal source;
    qreal velocity;
    qreal duration;
    qreal maximumEasingTime;
    QmlEaseFollow::ReversingMode reversingMode;

    qreal initialVelocity;
    qreal initialValue;
    bool invert;
    bool enabled;

    qreal trackVelocity;

    QmlMetaProperty target;

    int clockOffset;
    int lastTick;
    void tick(int);
    void clockStart();
    void clockStop();
    QTickAnimationProxy<QmlEaseFollowPrivate, &QmlEaseFollowPrivate::tick> clock;

    void restart();

    // Parameters for use in tick()
    qreal a;  // Acceleration
    qreal d;  // Deceleration
    qreal tf; // Total time
    qreal tp; // Time at which peak velocity occurs
    qreal td; // Time at which decelleration begins
    qreal vp; // Velocity at tp
    qreal sp; // Displacement at tp
    qreal sd; // Displacement at td
    qreal vi; // "Normalized" initialvelocity
    bool recalc();
};

bool QmlEaseFollowPrivate::recalc()
{
    qreal s = source - initialValue;
    vi = initialVelocity;

    s = (invert?-1.0:1.0) * s;
    vi = (invert?-1.0:1.0) * vi;

    if (duration > 0 && velocity > 0) {
        tf = s / velocity;
        if (tf > (duration / 1000.)) tf = (duration / 1000.);
    } else if (duration > 0) {
        tf = duration / 1000.;
    } else if (velocity > 0) {
        tf = s / velocity;
    } else {
        return false;
    }

    if (maximumEasingTime == 0) {
        a = 0;
        d = 0;
        tp = 0;
        td = tf;
        vp = velocity;
        sp = 0;
        sd = s;
    } else if (tf > (maximumEasingTime / 1000.)) {

        qreal met = maximumEasingTime / 1000.;
        td = tf - met;

        qreal c1 = td;
        qreal c2 = (tf - td) * vi - tf * velocity;
        qreal c3 = -0.5 * (tf - td) * vi * vi;

        qreal vp1 = (-c2 + sqrt(c2 * c2 - 4 * c1 * c3)) / (2. * c1);
        // qreal vp2 = (-c2 - sqrt(c2 * c2 - 4 * c1 * c3)) / (2. * c1);

        vp = vp1;
        a = vp / met;
        d = a;
        tp = (vp - vi) / a;
        sp = vi * tp + 0.5 * a * tp * tp;
        sd = sp + (td - tp) * vp;
    } else {

        qreal c1 = 0.25 * tf * tf;
        qreal c2 = 0.5 * vi * tf - s;
        qreal c3 = -0.25 * vi * vi;

        qreal a1 = (-c2 + sqrt(c2 * c2 - 4 * c1 * c3)) / (2. * c1);
        //qreal a2 = (-c2 - sqrt(c2 * c2 - 4 * c1 * c3)) / (2. * c1);

        qreal tp1 = 0.5 * tf - 0.5 * vi / a1;
        //qreal tp2 = 0.5 * tf - 0.5 * vi / a2;
        qreal vp1 = a1 * tp1 + vi;
        //qreal vp2 = a2 * tp2 + vi;

        qreal sp1 = 0.5 * a1 * tp1 * tp1 + vi * tp1;
        //qreal sp2 = 0.5 * a2 * tp2 * tp2 + vi * tp2;

        a = a1;
        d = a1;
        tp = tp1;
        td = tp1;
        vp = vp1;
        sp = sp1;
        sd = sp1;
    }

    /*
    qWarning() << "a:" << a << "tf:" << tf << "tp:" << tp << "vp:" 
               << vp << "sp:" << sp << "vi:" << vi << "invert:" << invert;
    */
    return true;
}

void QmlEaseFollowPrivate::clockStart()
{
    if (clock.state() == QAbstractAnimation::Running) {
        clockOffset = lastTick;
        return;
    } else {
        clockOffset = 0;
        lastTick = 0;
        clock.start();
    }
}

void QmlEaseFollowPrivate::clockStop()
{
    clockOffset = 0;
    lastTick = 0;
    clock.stop();
}

void QmlEaseFollowPrivate::tick(int t)
{
    lastTick = t;
    t -= clockOffset;

    qreal time_seconds = qreal(t) / 1000.;

    qreal out = 0;
    if (time_seconds < tp) {

        trackVelocity = vi + time_seconds * a;
        trackVelocity = (invert?-1.0:1.0) * trackVelocity;

        qreal value = 0.5 * a * time_seconds * time_seconds + vi * time_seconds;
        value = (invert?-1.0:1.0) * value;
        target.write(initialValue + value);
        out = initialValue + value;
    } else if (time_seconds < td) {

        time_seconds -= tp;
        trackVelocity = (invert?-1.0:1.0) * vp;
        qreal value = sp + time_seconds * vp;
        value = (invert?-1.0:1.0) * value;

        target.write(initialValue + value);

        out = initialValue + value;
    } else if (time_seconds < tf) {

        time_seconds -= td;

        trackVelocity = vp - time_seconds * a;
        trackVelocity = (invert?-1.0:1.0) * trackVelocity;

        qreal value = sd - 0.5 * d * time_seconds * time_seconds + vp * time_seconds;
        value = (invert?-1.0:1.0) * value;

        target.write(initialValue + value);

        out = initialValue + value;
    } else {

        clock.stop();

        trackVelocity = 0;
        target.write(source);
    }

    //qWarning() << out << trackVelocity << t << a;
}

/*!
    \qmlclass EaseFollow QmlEaseFollow
    \brief The EaseFollow element allows a property to smoothly track a value.

    The EaseFollow smoothly animates a property's value to a set target value 
    using an ease in/out quad easing curve.  If the target value changes while
    the animation is in progress, the easing curves used to animate to the old 
    and the new target values are spliced together to avoid any obvious visual
    glitches.

    The property animation is configured by setting the velocity at which the
    animation should occur, or the duration that the animation should take.  
    If both a velocity and a duration are specified, the one that results in
    the quickest animation is chosen for each change in the target value.

    For example, animating from 0 to 800 will take 4 seconds if a velocity
    of 200 is set, will take 8 seconds with a duration of 8000 set, and will 
    take 4 seconds with both a velocity of 200 and a duration of 8000 set.
    Animating from 0 to 20000 will take 10 seconds if a velocity of 200 is set,
    will take 8 seconds with a duration of 8000 set, and will take 8 seconds
    with both a velocity of 200 and a duration of 8000 set.

    The follow example shows one rectangle tracking the position of another.
\code
import Qt 4.6

Rectangle {
    width: 800; height: 600; color: "blue"

    Rectangle {
        color: "green"
        width: 60; height: 60;
        x: -5; y: -5;
        x: EaseFollow { source: rect1.x - 5; velocity: 200 }
        y: EaseFollow { source: rect1.y - 5; velocity: 200 }
    }

    Rectangle {
        id: rect1
        color: "red"
        width: 50; height: 50;
    }

    focus: true
    Keys.onRightPressed: rect1.x = rect1.x + 100
    Keys.onLeftPressed: rect1.x = rect1.x - 100
    Keys.onUpPressed: rect1.y = rect1.y - 100
    Keys.onDownPressed: rect1.y = rect1.y + 100
}
\endcode

    \sa SpringFollow
*/

QmlEaseFollow::QmlEaseFollow(QObject *parent)
: QObject(*(new QmlEaseFollowPrivate), parent)
{
}

QmlEaseFollow::~QmlEaseFollow()
{
}

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

    Bind to a property in order to track its changes.
*/
qreal QmlEaseFollow::sourceValue() const
{
    Q_D(const QmlEaseFollow);
    return d->source;
}

/*!
    \qmlproperty enumeration EaseFollow::reversingMode

    Sets how the EaseFollow behaves if an animation direction is reversed.

    If reversing mode is \c Eased, the animation will smoothly decelerate, and
    then reverse direction.  If the reversing mode is \c Immediate, the 
    animation will immediately begin accelerating in the reverse direction, 
    begining with a velocity of 0.  If the reversing mode is \c Sync, the
    property is immediately set to the target value.
*/
QmlEaseFollow::ReversingMode QmlEaseFollow::reversingMode() const
{
    Q_D(const QmlEaseFollow);
    return d->reversingMode;
}

void QmlEaseFollow::setReversingMode(ReversingMode m)
{
    Q_D(QmlEaseFollow);
    if (d->reversingMode == m)
        return;

    d->reversingMode = m;
    emit reversingModeChanged();
}

void QmlEaseFollowPrivate::restart()
{
    if (!enabled || velocity == 0) {
        clockStop();
        return;
    }

    initialValue = target.read().toReal();

    if (source == initialValue) {
        clockStop();
        return;
    }

    bool hasReversed = trackVelocity != 0. && 
                      ((trackVelocity > 0) == ((initialValue - source) > 0));

    if (hasReversed) {
        switch (reversingMode) {
            default:
            case QmlEaseFollow::Eased:
                break;
            case QmlEaseFollow::Sync:
                target.write(source);
                return;
            case QmlEaseFollow::Immediate:
                initialVelocity = 0;
                clockStop();
                break;
        }
    }

    trackVelocity = initialVelocity;

    invert = (source < initialValue);

    if (!recalc()) {
        target.write(source);
        clockStop();
        return;
    }

    clockStart();
}

void QmlEaseFollow::setSourceValue(qreal s)
{
    Q_D(QmlEaseFollow);

    if (d->clock.state() == QAbstractAnimation::Running && d->source == s)
        return;

    d->source = s;
    d->initialVelocity = d->trackVelocity;
    d->restart();

    emit sourceChanged();
}

/*!
    \qmlproperty qreal EaseFollow::duration

    This property holds the animation duration used when tracking the source.

    Setting this to -1 disables the duration value.
*/
qreal QmlEaseFollow::duration() const
{
    Q_D(const QmlEaseFollow);
    return d->duration;
}

void QmlEaseFollow::setDuration(qreal v)
{
    Q_D(QmlEaseFollow);
    if (d->duration == v)
        return;

    d->duration = v;
    d->trackVelocity = 0;

    if (d->clock.state() == QAbstractAnimation::Running) 
        d->restart();

    emit durationChanged();
}

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

/*!
    \qmlproperty qreal EaseFollow::velocity

    This property holds the average velocity allowed when tracking the source.

    Setting this to -1 disables the velocity value.
*/
void QmlEaseFollow::setVelocity(qreal v)
{
    Q_D(QmlEaseFollow);
    if (d->velocity == v)
        return;

    d->velocity = v;
    d->trackVelocity = 0;

    if (d->clock.state() == QAbstractAnimation::Running) 
        d->restart();

    emit velocityChanged();
}

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

void QmlEaseFollow::setEnabled(bool enabled)
{
    Q_D(QmlEaseFollow);
    if (d->enabled == enabled)
        return;

    d->enabled = enabled;
    if (enabled)
        d->restart();
    else
        d->clockStop();

    emit enabledChanged();
}

void QmlEaseFollow::setTarget(const QmlMetaProperty &t)
{
    Q_D(QmlEaseFollow);
    d->target = t;
}

/*!
\qmlproperty qreal EaseFollow::maximumEasingTime

This property specifies the maximum time an "eases" during the follow should take.
Setting this property causes the velocity to "level out" after at a time.  Setting 
a negative value reverts to the normal mode of easing over the entire animation 
duration.

The default value is -1.
*/
qreal QmlEaseFollow::maximumEasingTime() const
{
    Q_D(const QmlEaseFollow);
    return d->maximumEasingTime;
}

void QmlEaseFollow::setMaximumEasingTime(qreal v)
{
    Q_D(QmlEaseFollow);
    d->maximumEasingTime = v;

    if (d->clock.state() == QAbstractAnimation::Running) 
        d->restart();

    emit maximumEasingTimeChanged();
}

QT_END_NAMESPACE