1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QANIMATION_H
43#define QANIMATION_H
44
45#include <QtCore/qeasingcurve.h>
46#include <QtCore/qabstractanimation.h>
47#include <QtCore/qvector.h>
48#include <QtCore/qvariant.h>
49#include <QtCore/qpair.h>
50
51QT_BEGIN_HEADER
52
53QT_BEGIN_NAMESPACE
54
55QT_MODULE(Core)
56
57#ifndef QT_NO_ANIMATION
58
59class QVariantAnimationPrivate;
60class Q_CORE_EXPORT QVariantAnimation : public QAbstractAnimation
61{
62 Q_OBJECT
63 Q_PROPERTY(QVariant startValue READ startValue WRITE setStartValue)
64 Q_PROPERTY(QVariant endValue READ endValue WRITE setEndValue)
65 Q_PROPERTY(QVariant currentValue READ currentValue NOTIFY valueChanged)
66 Q_PROPERTY(int duration READ duration WRITE setDuration)
67 Q_PROPERTY(QEasingCurve easingCurve READ easingCurve WRITE setEasingCurve)
68
69public:
70 typedef QPair<qreal, QVariant> KeyValue;
71 typedef QVector<KeyValue> KeyValues;
72
73 QVariantAnimation(QObject *parent = 0);
74 ~QVariantAnimation();
75
76 QVariant startValue() const;
77 void setStartValue(const QVariant &value);
78
79 QVariant endValue() const;
80 void setEndValue(const QVariant &value);
81
82 QVariant keyValueAt(qreal step) const;
83 void setKeyValueAt(qreal step, const QVariant &value);
84
85 KeyValues keyValues() const;
86 void setKeyValues(const KeyValues &values);
87
88 QVariant currentValue() const;
89
90 int duration() const;
91 void setDuration(int msecs);
92
93 QEasingCurve easingCurve() const;
94 void setEasingCurve(const QEasingCurve &easing);
95
96 typedef QVariant (*Interpolator)(const void *from, const void *to, qreal progress);
97
98Q_SIGNALS:
99 void valueChanged(const QVariant &value);
100
101protected:
102 QVariantAnimation(QVariantAnimationPrivate &dd, QObject *parent = 0);
103 bool event(QEvent *event);
104
105 void updateCurrentTime(int);
106 void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState);
107
108 virtual void updateCurrentValue(const QVariant &value) = 0;
109 virtual QVariant interpolated(const QVariant &from, const QVariant &to, qreal progress) const;
110
111private:
112 template <typename T> friend void qRegisterAnimationInterpolator(QVariant (*func)(const T &, const T &, qreal));
113 static void registerInterpolator(Interpolator func, int interpolationType);
114
115 Q_DISABLE_COPY(QVariantAnimation)
116 Q_DECLARE_PRIVATE(QVariantAnimation)
117};
118
119template <typename T>
120void qRegisterAnimationInterpolator(QVariant (*func)(const T &from, const T &to, qreal progress)) {
121 QVariantAnimation::registerInterpolator(reinterpret_cast<QVariantAnimation::Interpolator>(func), qMetaTypeId<T>());
122}
123
124#endif //QT_NO_ANIMATION
125
126QT_END_NAMESPACE
127
128QT_END_HEADER
129
130#endif //QANIMATION_H
131