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