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 QEASINGCURVE_H
43#define QEASINGCURVE_H
44
45#include <QtCore/qglobal.h>
46#include <QtCore/qobjectdefs.h>
47
48QT_BEGIN_HEADER
49
50QT_BEGIN_NAMESPACE
51
52QT_MODULE(Core)
53
54class QEasingCurvePrivate;
55class Q_CORE_EXPORT QEasingCurve
56{
57 Q_GADGET
58 Q_ENUMS(Type)
59public:
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;
101private:
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
113Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
114#endif
115
116#ifndef QT_NO_DATASTREAM
117Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve&);
118Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
119#endif
120
121QT_END_NAMESPACE
122
123QT_END_HEADER
124
125#endif
126