1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QVARIANTANIMATION_H
41#define QVARIANTANIMATION_H
42
43#include <QtCore/qeasingcurve.h>
44#include <QtCore/qabstractanimation.h>
45#include <QtCore/qvector.h>
46#include <QtCore/qvariant.h>
47#include <QtCore/qpair.h>
48
49QT_REQUIRE_CONFIG(animation);
50
51QT_BEGIN_NAMESPACE
52
53class QVariantAnimationPrivate;
54class Q_CORE_EXPORT QVariantAnimation : public QAbstractAnimation
55{
56 Q_OBJECT
57 Q_PROPERTY(QVariant startValue READ startValue WRITE setStartValue)
58 Q_PROPERTY(QVariant endValue READ endValue WRITE setEndValue)
59 Q_PROPERTY(QVariant currentValue READ currentValue NOTIFY valueChanged)
60 Q_PROPERTY(int duration READ duration WRITE setDuration)
61 Q_PROPERTY(QEasingCurve easingCurve READ easingCurve WRITE setEasingCurve)
62
63public:
64 typedef QPair<qreal, QVariant> KeyValue;
65 typedef QVector<KeyValue> KeyValues;
66
67 QVariantAnimation(QObject *parent = nullptr);
68 ~QVariantAnimation();
69
70 QVariant startValue() const;
71 void setStartValue(const QVariant &value);
72
73 QVariant endValue() const;
74 void setEndValue(const QVariant &value);
75
76 QVariant keyValueAt(qreal step) const;
77 void setKeyValueAt(qreal step, const QVariant &value);
78
79 KeyValues keyValues() const;
80 void setKeyValues(const KeyValues &values);
81
82 QVariant currentValue() const;
83
84 int duration() const override;
85 void setDuration(int msecs);
86
87 QEasingCurve easingCurve() const;
88 void setEasingCurve(const QEasingCurve &easing);
89
90 typedef QVariant (*Interpolator)(const void *from, const void *to, qreal progress);
91
92Q_SIGNALS:
93 void valueChanged(const QVariant &value);
94
95protected:
96 QVariantAnimation(QVariantAnimationPrivate &dd, QObject *parent = nullptr);
97 bool event(QEvent *event) override;
98
99 void updateCurrentTime(int) override;
100 void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) override;
101
102 virtual void updateCurrentValue(const QVariant &value);
103 virtual QVariant interpolated(const QVariant &from, const QVariant &to, qreal progress) const;
104
105private:
106 template <typename T> friend void qRegisterAnimationInterpolator(QVariant (*func)(const T &, const T &, qreal));
107 static void registerInterpolator(Interpolator func, int interpolationType);
108
109 Q_DISABLE_COPY(QVariantAnimation)
110 Q_DECLARE_PRIVATE(QVariantAnimation)
111};
112
113template <typename T>
114void qRegisterAnimationInterpolator(QVariant (*func)(const T &from, const T &to, qreal progress)) {
115 QVariantAnimation::registerInterpolator(reinterpret_cast<QVariantAnimation::Interpolator>(reinterpret_cast<void(*)()>(func)), qMetaTypeId<T>());
116}
117
118QT_END_NAMESPACE
119
120#endif //QVARIANTANIMATION_H
121