QTimeLine Class

The QTimeLine class provides a timeline for controlling animations. More...

Header:	#include <QTimeLine>
CMake:	find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake:	QT += core
Inherits:	QObject

List of all members, including inherited members

Public Types

enum	Direction { Forward, Backward }
enum	State { NotRunning, Paused, Running }

Properties

currentTime : int
direction : Direction
duration : int

easingCurve : QEasingCurve
loopCount : int
updateInterval : int

Public Functions

	QTimeLine(int duration = 1000, QObject *parent = nullptr)
virtual	~QTimeLine()
int	currentFrame() const
int	currentTime() const
qreal	currentValue() const
QTimeLine::Direction	direction() const
int	duration() const
QEasingCurve	easingCurve() const
int	endFrame() const
int	frameForTime(int msec) const
int	loopCount() const
void	setDirection(QTimeLine::Direction direction)
void	setDuration(int duration)
void	setEasingCurve(const QEasingCurve &curve)
void	setEndFrame(int frame)
void	setFrameRange(int startFrame, int endFrame)
void	setLoopCount(int count)
void	setStartFrame(int frame)
void	setUpdateInterval(int interval)
int	startFrame() const
QTimeLine::State	state() const
int	updateInterval() const
virtual qreal	valueForTime(int msec) const

Public Slots

void	resume()
void	setCurrentTime(int msec)
void	setPaused(bool paused)
void	start()
void	stop()
void	toggleDirection()

Signals

void	finished()
void	frameChanged(int frame)
void	stateChanged(QTimeLine::State newState)
void	valueChanged(qreal value)

Reimplemented Protected Functions

virtual void timerEvent(QTimerEvent *event) override

Detailed Description

It's most commonly used to animate a GUI control by calling a slot periodically. You can construct a timeline by passing its duration in milliseconds to QTimeLine's constructor. The timeline's duration describes for how long the animation will run. Then you set a suitable frame range by calling setFrameRange(). Finally connect the frameChanged() signal to a suitable slot in the widget you wish to animate (for example, setValue() in QProgressBar). When you proceed to calling start(), QTimeLine will enter Running state, and start emitting frameChanged() at regular intervals, causing your widget's connected property's value to grow from the lower end to the upper and of your frame range, at a steady rate. You can specify the update interval by calling setUpdateInterval(). When done, QTimeLine enters NotRunning state, and emits finished().

Example:

 ...
 progressBar = new QProgressBar(this);
 progressBar->setRange(0, 100);

 // Construct a 1-second timeline with a frame range of 0 - 100
 QTimeLine *timeLine = new QTimeLine(1000, this);
 timeLine->setFrameRange(0, 100);
 connect(timeLine, &QTimeLine::frameChanged, progressBar, &QProgressBar::setValue);

 // Clicking the push button will start the progress bar animation
 pushButton = new QPushButton(tr("Start animation"), this);
 connect(pushButton, &QPushButton::clicked, timeLine, &QTimeLine::start);
 ...

By default the timeline runs once, from its beginning to its end, upon which you must call start() again to restart from the beginning. To make the timeline loop, you can call setLoopCount(), passing the number of times the timeline should run before finishing. The direction can also be changed, causing the timeline to run backward, by calling setDirection(). You can also pause and unpause the timeline while it's running by calling setPaused(). For interactive control, the setCurrentTime() function is provided, which sets the time position of the time line directly. Although most useful in NotRunning state (e.g., connected to a valueChanged() signal in a QSlider), this function can be called at any time.

The frame interface is useful for standard widgets, but QTimeLine can be used to control any type of animation. The heart of QTimeLine lies in the valueForTime() function, which generates a value between 0 and 1 for a given time. This value is typically used to describe the steps of an animation, where 0 is the first step of an animation, and 1 is the last step. When running, QTimeLine generates values between 0 and 1 by calling valueForTime() and emitting valueChanged(). By default, valueForTime() applies an interpolation algorithm to generate these value. You can choose from a set of predefined timeline algorithms by calling setEasingCurve().

Note that, by default, QTimeLine uses QEasingCurve::InOutSine, which provides a value that grows slowly, then grows steadily, and finally grows slowly. For a custom timeline, you can reimplement valueForTime(), in which case QTimeLine's easingCurve property is ignored.

See also QProgressBar and QProgressDialog.

Member Type Documentation

enum QTimeLine::Direction

This enum describes the direction of the timeline when in Running state.

Constant	Value	Description
`QTimeLine::Forward`	`0`	The current time of the timeline increases with time (i.e., moves from 0 and towards the end / duration).
`QTimeLine::Backward`	`1`	The current time of the timeline decreases with time (i.e., moves from the end / duration and towards 0).

See also setDirection().

enum QTimeLine::State

This enum describes the state of the timeline.

Constant	Value	Description
`QTimeLine::NotRunning`	`0`	The timeline is not running. This is the initial state of QTimeLine, and the state QTimeLine reenters when finished. The current time, frame and value remain unchanged until either setCurrentTime() is called, or the timeline is started by calling start().
`QTimeLine::Paused`	`1`	The timeline is paused (i.e., temporarily suspended). Calling setPaused(false) will resume timeline activity.
`QTimeLine::Running`	`2`	The timeline is running. While control is in the event loop, QTimeLine will update its current time at regular intervals, emitting valueChanged() and frameChanged() when appropriate.

See also state() and stateChanged().