1 /****************************************************************************
2 **
3 ** Copyright (C) 2020 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 QTIMELINE_H
41 #define QTIMELINE_H
42 
43 #include <QtCore/qglobal.h>
44 
45 QT_REQUIRE_CONFIG(easingcurve);
46 
47 #include <QtCore/qeasingcurve.h>
48 #include <QtCore/qobject.h>
49 
50 QT_BEGIN_NAMESPACE
51 
52 
53 class QTimeLinePrivate;
54 class Q_CORE_EXPORT QTimeLine : public QObject
55 {
56     Q_OBJECT
57     Q_PROPERTY(int duration READ duration WRITE setDuration)
58     Q_PROPERTY(int updateInterval READ updateInterval WRITE setUpdateInterval)
59     Q_PROPERTY(int currentTime READ currentTime WRITE setCurrentTime)
60     Q_PROPERTY(Direction direction READ direction WRITE setDirection)
61     Q_PROPERTY(int loopCount READ loopCount WRITE setLoopCount)
62 #if QT_DEPRECATED_SINCE(5, 15)
63     Q_PROPERTY(CurveShape curveShape READ curveShape WRITE setCurveShape)
64 #endif
65     Q_PROPERTY(QEasingCurve easingCurve READ easingCurve WRITE setEasingCurve)
66 public:
67     enum State {
68         NotRunning,
69         Paused,
70         Running
71     };
72     enum Direction {
73         Forward,
74         Backward
75     };
76 #if QT_DEPRECATED_SINCE(5, 15)
77     enum CurveShape {
78         EaseInCurve,
79         EaseOutCurve,
80         EaseInOutCurve,
81         LinearCurve,
82         SineCurve,
83         CosineCurve
84     };
85 #endif
86 
87     explicit QTimeLine(int duration = 1000, QObject *parent = nullptr);
88     virtual ~QTimeLine();
89 
90     State state() const;
91 
92     int loopCount() const;
93     void setLoopCount(int count);
94 
95     Direction direction() const;
96     void setDirection(Direction direction);
97 
98     int duration() const;
99     void setDuration(int duration);
100 
101     int startFrame() const;
102     void setStartFrame(int frame);
103     int endFrame() const;
104     void setEndFrame(int frame);
105     void setFrameRange(int startFrame, int endFrame);
106 
107     int updateInterval() const;
108     void setUpdateInterval(int interval);
109 
110 #if QT_DEPRECATED_SINCE(5, 15)
111     QT_DEPRECATED_X("Access easingCurve directly")
112     CurveShape curveShape() const;
113     QT_DEPRECATED_X("Access easingCurve directly")
114     void setCurveShape(CurveShape shape);
115 #endif
116 
117     QEasingCurve easingCurve() const;
118     void setEasingCurve(const QEasingCurve &curve);
119 
120     int currentTime() const;
121     int currentFrame() const;
122     qreal currentValue() const;
123 
124     int frameForTime(int msec) const;
125     virtual qreal valueForTime(int msec) const;
126 
127 public Q_SLOTS:
128     void start();
129     void resume();
130     void stop();
131     void setPaused(bool paused);
132     void setCurrentTime(int msec);
133     void toggleDirection();
134 
135 Q_SIGNALS:
136     void valueChanged(qreal x, QPrivateSignal);
137     void frameChanged(int, QPrivateSignal);
138     void stateChanged(QTimeLine::State newState, QPrivateSignal);
139     void finished(QPrivateSignal);
140 
141 protected:
142     void timerEvent(QTimerEvent *event) override;
143 
144 private:
145     Q_DISABLE_COPY(QTimeLine)
146     Q_DECLARE_PRIVATE(QTimeLine)
147 };
148 
149 QT_END_NAMESPACE
150 
151 #endif
152 
153