1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file. Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QEASINGCURVE_H
43 #define QEASINGCURVE_H
44
45 #include <QtCore/qglobal.h>
46 #include <QtCore/qobjectdefs.h>
47
48 QT_BEGIN_HEADER
49
50 QT_BEGIN_NAMESPACE
51
QT_MODULE(Core)52 QT_MODULE(Core)
53
54 class QEasingCurvePrivate;
55 class Q_CORE_EXPORT QEasingCurve
56 {
57 Q_GADGET
58 Q_ENUMS(Type)
59 public:
60 enum Type {
61 Linear,
62 InQuad, OutQuad, InOutQuad, OutInQuad,
63 InCubic, OutCubic, InOutCubic, OutInCubic,
64 InQuart, OutQuart, InOutQuart, OutInQuart,
65 InQuint, OutQuint, InOutQuint, OutInQuint,
66 InSine, OutSine, InOutSine, OutInSine,
67 InExpo, OutExpo, InOutExpo, OutInExpo,
68 InCirc, OutCirc, InOutCirc, OutInCirc,
69 InElastic, OutElastic, InOutElastic, OutInElastic,
70 InBack, OutBack, InOutBack, OutInBack,
71 InBounce, OutBounce, InOutBounce, OutInBounce,
72 InCurve, OutCurve, SineCurve, CosineCurve,
73 Custom, NCurveTypes
74 };
75
76 QEasingCurve(Type type = Linear);
77 QEasingCurve(const QEasingCurve &other);
78 ~QEasingCurve();
79
80 QEasingCurve &operator=(const QEasingCurve &other);
81 bool operator==(const QEasingCurve &other) const;
82 inline bool operator!=(const QEasingCurve &other) const
83 { return !(this->operator==(other)); }
84
85 qreal amplitude() const;
86 void setAmplitude(qreal amplitude);
87
88 qreal period() const;
89 void setPeriod(qreal period);
90
91 qreal overshoot() const;
92 void setOvershoot(qreal overshoot);
93
94 Type type() const;
95 void setType(Type type);
96 typedef qreal (*EasingFunction)(qreal progress);
97 void setCustomType(EasingFunction func);
98 EasingFunction customType() const;
99
100 qreal valueForProgress(qreal progress) const;
101 private:
102 QEasingCurvePrivate *d_ptr;
103 #ifndef QT_NO_DEBUG_STREAM
104 friend Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
105 #endif
106 #ifndef QT_NO_DATASTREAM
107 friend Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve&);
108 friend Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
109 #endif
110 };
111
112 #ifndef QT_NO_DEBUG_STREAM
113 Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
114 #endif
115
116 #ifndef QT_NO_DATASTREAM
117 Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve&);
118 Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
119 #endif
120
121 QT_END_NAMESPACE
122
123 QT_END_HEADER
124
125 #endif
126