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#include <QtCore/qobjectdefs.h>
45#include <QtCore/qvector.h>
46#if QT_DEPRECATED_SINCE(5, 0)
47# include <QtCore/qlist.h>
48# include <QtCore/qpoint.h>
49#endif
50
51QT_BEGIN_NAMESPACE
52
53
54class QEasingCurvePrivate;
55class QPointF;
56class Q_CORE_EXPORT QEasingCurve
57{
58 Q_GADGET
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 BezierSpline, TCBSpline, Custom, NCurveTypes
74 };
75 Q_ENUM(Type)
76
77 QEasingCurve(Type type = Linear);
78 QEasingCurve(const QEasingCurve &other);
79 ~QEasingCurve();
80
81 QEasingCurve &operator=(const QEasingCurve &other)
82 { if ( this != &other ) { QEasingCurve copy(other); swap(copy); } return *this; }
83 QEasingCurve(QEasingCurve &&other) noexcept : d_ptr(other.d_ptr) { other.d_ptr = nullptr; }
84 QEasingCurve &operator=(QEasingCurve &&other) noexcept
85 { qSwap(d_ptr, other.d_ptr); return *this; }
86
87 void swap(QEasingCurve &other) noexcept { qSwap(d_ptr, other.d_ptr); }
88
89 bool operator==(const QEasingCurve &other) const;
90 inline bool operator!=(const QEasingCurve &other) const
91 { return !(this->operator==(other)); }
92
93 qreal amplitude() const;
94 void setAmplitude(qreal amplitude);
95
96 qreal period() const;
97 void setPeriod(qreal period);
98
99 qreal overshoot() const;
100 void setOvershoot(qreal overshoot);
101
102 void addCubicBezierSegment(const QPointF & c1, const QPointF & c2, const QPointF & endPoint);
103 void addTCBSegment(const QPointF &nextPoint, qreal t, qreal c, qreal b);
104 QVector<QPointF> toCubicSpline() const;
105#if QT_DEPRECATED_SINCE(5, 0)
106 QT_DEPRECATED QList<QPointF> cubicBezierSpline() const { return toCubicSpline().toList(); }
107#endif
108
109 Type type() const;
110 void setType(Type type);
111 typedef qreal (*EasingFunction)(qreal progress);
112 void setCustomType(EasingFunction func);
113 EasingFunction customType() const;
114
115 qreal valueForProgress(qreal progress) const;
116private:
117 QEasingCurvePrivate *d_ptr;
118#ifndef QT_NO_DEBUG_STREAM
119 friend Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
120#endif
121#ifndef QT_NO_DATASTREAM
122 friend Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve&);
123 friend Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
124#endif
125};
126Q_DECLARE_SHARED(QEasingCurve)
127
128#ifndef QT_NO_DEBUG_STREAM
129Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
130#endif
131
132#ifndef QT_NO_DATASTREAM
133Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve&);
134Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
135#endif
136
137QT_END_NAMESPACE
138
139#endif
140