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 QEASINGCURVE_H
41#define QEASINGCURVE_H
42
43#include <QtCore/qglobal.h>
44
45QT_REQUIRE_CONFIG(easingcurve);
46
47#include <QtCore/qlist.h>
48#include <QtCore/qobjectdefs.h>
49
50QT_BEGIN_NAMESPACE
51
52class QEasingCurvePrivate;
53class QPointF;
54class Q_CORE_EXPORT QEasingCurve
55{
56 Q_GADGET
57public:
58 enum Type {
59 Linear,
60 InQuad, OutQuad, InOutQuad, OutInQuad,
61 InCubic, OutCubic, InOutCubic, OutInCubic,
62 InQuart, OutQuart, InOutQuart, OutInQuart,
63 InQuint, OutQuint, InOutQuint, OutInQuint,
64 InSine, OutSine, InOutSine, OutInSine,
65 InExpo, OutExpo, InOutExpo, OutInExpo,
66 InCirc, OutCirc, InOutCirc, OutInCirc,
67 InElastic, OutElastic, InOutElastic, OutInElastic,
68 InBack, OutBack, InOutBack, OutInBack,
69 InBounce, OutBounce, InOutBounce, OutInBounce,
70 InCurve, OutCurve, SineCurve, CosineCurve,
71 BezierSpline, TCBSpline, Custom, NCurveTypes
72 };
73 Q_ENUM(Type)
74
75 QEasingCurve(Type type = Linear);
76 QEasingCurve(const QEasingCurve &other);
77 ~QEasingCurve();
78
79 QEasingCurve &operator=(const QEasingCurve &other)
80 { if ( this != &other ) { QEasingCurve copy(other); swap(copy); } return *this; }
81 QEasingCurve(QEasingCurve &&other) noexcept : d_ptr(other.d_ptr) { other.d_ptr = nullptr; }
82 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QEasingCurve)
83
84 void swap(QEasingCurve &other) noexcept { qSwap(d_ptr, other.d_ptr); }
85
86 bool operator==(const QEasingCurve &other) const;
87 inline bool operator!=(const QEasingCurve &other) const
88 { return !(this->operator==(other)); }
89
90 qreal amplitude() const;
91 void setAmplitude(qreal amplitude);
92
93 qreal period() const;
94 void setPeriod(qreal period);
95
96 qreal overshoot() const;
97 void setOvershoot(qreal overshoot);
98
99 void addCubicBezierSegment(const QPointF &c1, const QPointF &c2, const QPointF &endPoint);
100 void addTCBSegment(const QPointF &nextPoint, qreal t, qreal c, qreal b);
101 QList<QPointF> toCubicSpline() const;
102
103 Type type() const;
104 void setType(Type type);
105 typedef qreal (*EasingFunction)(qreal progress);
106 void setCustomType(EasingFunction func);
107 EasingFunction customType() const;
108
109 qreal valueForProgress(qreal progress) const;
110
111private:
112 QEasingCurvePrivate *d_ptr;
113#ifndef QT_NO_DEBUG_STREAM
114 friend Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
115#endif
116#ifndef QT_NO_DATASTREAM
117 friend Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve &);
118 friend Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
119#endif
120};
121Q_DECLARE_SHARED(QEasingCurve)
122
123#ifndef QT_NO_DEBUG_STREAM
124Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
125#endif
126
127#ifndef QT_NO_DATASTREAM
128Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve &);
129Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
130#endif
131
132QT_END_NAMESPACE
133
134#endif
135