summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qmlanimation_p.h
blob: 1f52fcd8b9235f1fb369834486287ed8508c18f7 (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
/****************************************************************************
**
** 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$
**
****************************************************************************/

#ifndef QMLANIMATION_P_H
#define QMLANIMATION_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <private/qobject_p.h>
#include <private/qmlnullablevalue_p.h>
#include <private/qvariantanimation_p.h>
#include <QtCore/QPauseAnimation>
#include <QtCore/QVariantAnimation>
#include <QtCore/QAnimationGroup>
#include <QtGui/QColor>
#include <QtDeclarative/qmlanimation.h>
#include <QtDeclarative/qml.h>
#include <QtDeclarative/qmlcontext.h>
#include <private/qmltimeline_p.h>

QT_BEGIN_NAMESPACE

//interface for classes that provide animation actions for QActionAnimation
class QAbstractAnimationAction
{
public:
    virtual ~QAbstractAnimationAction() {}
    virtual void doAction() = 0;
};

//templated animation action
//allows us to specify an action that calls a function of a class.
//(so that class doesn't have to inherit QmlAbstractAnimationAction)
template<class T, void (T::*method)()>
class QAnimationActionProxy : public QAbstractAnimationAction
{
public:
    QAnimationActionProxy(T *p) : m_p(p) {}
    virtual void doAction() { (m_p->*method)(); }

private:
    T *m_p;
};

//performs an action of type QAbstractAnimationAction
class QActionAnimation : public QAbstractAnimation
{
    Q_OBJECT
public:
    QActionAnimation(QObject *parent = 0) : QAbstractAnimation(parent), animAction(0), policy(KeepWhenStopped) {}
    QActionAnimation(QAbstractAnimationAction *action, QObject *parent = 0)
        : QAbstractAnimation(parent), animAction(action), policy(KeepWhenStopped) {}
    virtual int duration() const { return 0; }
    void setAnimAction(QAbstractAnimationAction *action, DeletionPolicy p)
    {
        if (state() == Running)
            stop();
        animAction = action;
        policy = p;
    }
protected:
    virtual void updateCurrentTime(int) {}

    virtual void updateState(State /*oldState*/, State newState)
    {
        if (newState == Running) {
            if (animAction)
                animAction->doAction();
        } else if (newState == Stopped && policy == DeleteWhenStopped) {
            delete animAction;
            animAction = 0;
        }
    }

private:
    QAbstractAnimationAction *animAction;
    DeletionPolicy policy;
};

//animates QmlTimeLineValue (assumes start and end values will be reals or compatible)
class QmlTimeLineValueAnimator : public QVariantAnimation
{
    Q_OBJECT
public:
    QmlTimeLineValueAnimator(QObject *parent = 0) : QVariantAnimation(parent), animValue(0), fromSourced(0), policy(KeepWhenStopped) {}
    void setAnimValue(QmlTimeLineValue *value, DeletionPolicy p)
    {
        if (state() == Running)
            stop();
        animValue = value;
        policy = p;
    }
    void setFromSourcedValue(bool *value)
    {
        fromSourced = value;
    }
protected:
    virtual void updateCurrentValue(const QVariant &value)
    {
        if (animValue)
            animValue->setValue(value.toDouble());
    }
    virtual void updateState(State oldState, State newState)
    {
        QVariantAnimation::updateState(oldState, newState);
        if (newState == Running) {
            //check for new from every loop
            if (fromSourced)
                *fromSourced = false;
        } else if (newState == Stopped && policy == DeleteWhenStopped) {
            delete animValue;
            animValue = 0;
        }
    }

private:
    QmlTimeLineValue *animValue;
    bool *fromSourced;
    DeletionPolicy policy;
};

//an animation that just gives a tick
template<class T, void (T::*method)(int)>
class QTickAnimationProxy : public QAbstractAnimation
{
    //Q_OBJECT //doesn't work with templating
public:
    QTickAnimationProxy(T *p, QObject *parent = 0) : QAbstractAnimation(parent), m_p(p) {}
    virtual int duration() const { return -1; }
protected:
    virtual void updateCurrentTime(int msec) { (m_p->*method)(msec); }

private:
    T *m_p;
};

class QmlAbstractAnimationPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlAbstractAnimation)
public:
    QmlAbstractAnimationPrivate()
    : running(false), paused(false), alwaysRunToEnd(false), repeat(false),
      connectedTimeLine(false), componentComplete(true), startOnCompletion(false),
      target(0), group(0) {}

    bool running;
    bool paused;
    bool alwaysRunToEnd;
    bool repeat;
    bool connectedTimeLine;

    bool componentComplete;
    bool startOnCompletion;

    void commence();

    QmlNullableValue<QmlMetaProperty> userProperty;
    QObject *target;
    QString propertyName;

    QmlMetaProperty property;
    QmlAnimationGroup *group;

    QmlMetaProperty createProperty(QObject *obj, const QString &str);
};

class QmlPauseAnimationPrivate : public QmlAbstractAnimationPrivate
{
    Q_DECLARE_PUBLIC(QmlPauseAnimation)
public:
    QmlPauseAnimationPrivate()
    : QmlAbstractAnimationPrivate(), pa(0) {}

    void init();

    QPauseAnimation *pa;
};

class QmlScriptActionPrivate : public QmlAbstractAnimationPrivate
{
    Q_DECLARE_PUBLIC(QmlScriptAction)
public:
    QmlScriptActionPrivate()
        : QmlAbstractAnimationPrivate(), hasRunScriptScript(false), proxy(this), rsa(0) {}

    void init();

    QmlScriptString script;
    QString name;
    QmlScriptString runScriptScript;
    bool hasRunScriptScript;

    void execute();

    QAnimationActionProxy<QmlScriptActionPrivate,
                  &QmlScriptActionPrivate::execute> proxy;
    QActionAnimation *rsa;
};

class QmlPropertyActionPrivate : public QmlAbstractAnimationPrivate
{
    Q_DECLARE_PUBLIC(QmlPropertyAction)
public:
    QmlPropertyActionPrivate()
    : QmlAbstractAnimationPrivate(), proxy(this), spa(0) {}

    void init();

    QString properties;
    QList<QObject *> targets;
    QList<QObject *> exclude;

    QmlNullableValue<QVariant> value;

    void doAction();

    QAnimationActionProxy<QmlPropertyActionPrivate,
                  &QmlPropertyActionPrivate::doAction> proxy;
    QActionAnimation *spa;
};

class QmlParentActionPrivate : public QmlAbstractAnimationPrivate
{
    Q_DECLARE_PUBLIC(QmlParentAction)
public:
    QmlParentActionPrivate()
    : QmlAbstractAnimationPrivate(), pcTarget(0), pcParent(0) {}

    void init();

    QFxItem *pcTarget;
    QFxItem *pcParent;

    void doAction();
    QActionAnimation *cpa;
};

class QmlAnimationGroupPrivate : public QmlAbstractAnimationPrivate
{
    Q_DECLARE_PUBLIC(QmlAnimationGroup)
public:
    QmlAnimationGroupPrivate()
    : QmlAbstractAnimationPrivate(), animations(this), ag(0) {}

    struct AnimationList : public QmlConcreteList<QmlAbstractAnimation *>
    {
        AnimationList(QmlAnimationGroupPrivate *p)
        : anim(p) {}
        virtual void append(QmlAbstractAnimation *a) {
            QmlConcreteList<QmlAbstractAnimation *>::append(a);
            a->setGroup(anim->q_func());
        }
        virtual void clear()
        {
            for (int i = 0; i < count(); ++i)
                at(i)->setGroup(0);
            QmlConcreteList<QmlAbstractAnimation *>::clear();
        }
        virtual void removeAt(int i)
        {
            at(i)->setGroup(0);
            QmlConcreteList<QmlAbstractAnimation *>::removeAt(i);
        }
        virtual void insert(int i, QmlAbstractAnimation *a)
        {
            QmlConcreteList<QmlAbstractAnimation *>::insert(i, a);
            a->setGroup(anim->q_func());
        }

        QmlAnimationGroupPrivate *anim;
    };

    AnimationList animations;
    QAnimationGroup *ag;
};

class QmlPropertyAnimationPrivate : public QmlAbstractAnimationPrivate
{
    Q_DECLARE_PUBLIC(QmlPropertyAnimation)
public:
    QmlPropertyAnimationPrivate()
    : QmlAbstractAnimationPrivate(), fromSourced(false), fromIsDefined(false), toIsDefined(false),
      defaultToInterpolatorType(0), interpolatorType(0), interpolator(0), va(0),
      value(this, &QmlPropertyAnimationPrivate::valueChanged) {}

    void init();

    QVariant from;
    QVariant to;

    QString easing;

    QString properties;
    QList<QObject *> targets;
    QList<QObject *> exclude;

    bool fromSourced;
    bool fromIsDefined;
    bool toIsDefined;
    bool defaultToInterpolatorType;
    int interpolatorType;
    QVariantAnimation::Interpolator interpolator;

    QmlTimeLineValueAnimator *va;
    virtual void valueChanged(qreal);

    QmlTimeLineValueProxy<QmlPropertyAnimationPrivate> value;

    static QVariant interpolateVariant(const QVariant &from, const QVariant &to, qreal progress);
    static void convertVariant(QVariant &variant, int type);
};

QT_END_NAMESPACE

#endif // QMLANIMATION_P_H