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

#include <qtimeline.h>

Inheritance diagram for QTimeLine:

Public Types
enum	CurveShape { EaseInCurve, EaseOutCurve, EaseInOutCurve, LinearCurve, SineCurve, CosineCurve }
	This enum describes the default shape of QTimeLine's value curve. More...

enum	Direction { Forward, Backward }
	This enum describes the direction of the timeline when in Running state. More...

enum	State { NotRunning, Paused, Running }
	This enum describes the state of the timeline. More...

Public Slots
void	resume ()
	Resumes the timeline from the current time. More...

void	setCurrentTime (int msec)

void	setPaused (bool paused)
	If paused is true, the timeline is paused, causing QTimeLine to enter Paused state. More...

void	start ()
	Starts the timeline. More...

void	stop ()
	Stops the timeline, causing QTimeLine to enter NotRunning state. More...

void	toggleDirection ()
	Toggles the direction of the timeline. More...

Public Slots inherited from QObject
void	deleteLater ()
	Schedules this object for deletion. More...

Signals
void	finished ()
	This signal is emitted when QTimeLine finishes (i. More...

void	frameChanged (int)
	QTimeLine emits this signal at regular intervals when in Running state, but only if the current frame changes. More...

void	stateChanged (QTimeLine::State newState)
	This signal is emitted whenever QTimeLine's state changes. More...

void	valueChanged (qreal x)
	QTimeLine emits this signal at regular intervals when in Running state, but only if the current value changes. More...

Signals inherited from QObject
void	destroyed (QObject *=0)
	This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...

Public Functions
int	currentFrame () const
	Returns the frame corresponding to the current time. More...

int	currentTime () const

qreal	currentValue () const
	Returns the value corresponding to the current time. More...

CurveShape	curveShape () const

Direction	direction () const

int	duration () const

QEasingCurve	easingCurve () const

int	endFrame () const
	Returns the end frame, which is the frame corresponding to the end of the timeline (i.e., the frame for which the current value is 1). More...

int	frameForTime (int msec) const
	Returns the frame corresponding to the time msec. More...

int	loopCount () const

	QTimeLine (int duration=1000, QObject *parent=0)
	Constructs a timeline with a duration of duration milliseconds. More...

void	setCurveShape (CurveShape shape)

void	setDirection (Direction direction)

void	setDuration (int duration)

void	setEasingCurve (const QEasingCurve &curve)

void	setEndFrame (int frame)
	Sets the end frame, which is the frame corresponding to the end of the timeline (i.e., the frame for which the current value is 1), to frame. More...

void	setFrameRange (int startFrame, int endFrame)
	Sets the timeline's frame counter to start at startFrame, and end and endFrame. More...

void	setLoopCount (int count)

void	setStartFrame (int frame)
	Sets the start frame, which is the frame corresponding to the start of the timeline (i.e., the frame for which the current value is 0), to frame. More...

void	setUpdateInterval (int interval)

int	startFrame () const
	Returns the start frame, which is the frame corresponding to the start of the timeline (i.e., the frame for which the current value is 0). More...

State	state () const
	Returns the state of the timeline. More...

int	updateInterval () const

virtual qreal	valueForTime (int msec) const
	Returns the timeline value for the time msec. More...

virtual	~QTimeLine ()
	Destroys the timeline. More...

Public Functions inherited from QObject
bool	blockSignals (bool b)
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...

const QObjectList &	children () const
	Returns a list of child objects. More...

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectInfo ()
	Dumps information about signal connections, etc. More...

void	dumpObjectTree ()
	Dumps a tree of children to the debug output. More...

QList< QByteArray >	dynamicPropertyNames () const
	Returns the names of all properties that were dynamically added to the object using setProperty(). More...

virtual bool	event (QEvent *)
	This virtual function receives events to an object and should return true if the event e was recognized and processed. More...

virtual bool	eventFilter (QObject , QEvent )
	Filters events if this object has been installed as an event filter for the watched object. More...

template<typename T >
T	findChild (const QString &aName=QString()) const
	Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...

void	installEventFilter (QObject *)
	Installs an event filter filterObj on this object. More...

bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false. More...

void	killTimer (int id)
	Kills the timer with timer identifier, id. More...

virtual const QMetaObject *	metaObject () const
	Returns a pointer to the meta-object of this object. More...

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children. More...

QString	objectName () const

QObject *	parent () const
	Returns a pointer to the parent object. More...

QVariant	property (const char *name) const
	Returns the value of the object's name property. More...

Q_INVOKABLE	QObject (QObject *parent=0)
	Constructs an object with parent object parent. More...

void	removeEventFilter (QObject *)
	Removes an event filter object obj from this object. More...

void	setObjectName (const QString &name)

void	setParent (QObject *)
	Makes the object a child of parent. More...

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value. More...

void	setUserData (uint id, QObjectUserData *data)

bool	signalsBlocked () const
	Returns true if signals are blocked; otherwise returns false. More...

int	startTimer (int interval)
	Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...

QThread *	thread () const
	Returns the thread in which the object lives. More...

QObjectUserData *	userData (uint id) const

virtual	~QObject ()
	Destroys the object, deleting all its child objects. More...

Protected Functions
void	timerEvent (QTimerEvent *event)
	Reimplemented Function More...

Protected Functions inherited from QObject
virtual void	childEvent (QChildEvent *)
	This event handler can be reimplemented in a subclass to receive child events. More...

virtual void	connectNotify (const char *signal)
	This virtual function is called when something has been connected to signal in this object. More...

virtual void	customEvent (QEvent *)
	This event handler can be reimplemented in a subclass to receive custom events. More...

virtual void	disconnectNotify (const char *signal)
	This virtual function is called when something has been disconnected from signal in this object. More...

	QObject (QObjectPrivate &dd, QObject *parent=0)

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal. More...

QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...

int	senderSignalIndex () const

Properties
int	currentTime
	the current time of the time line. More...

CurveShape	curveShape
	the shape of the timeline curve. More...

Direction	direction
	the direction of the timeline when QTimeLine is in Running state. More...

int	duration
	the total duration of the timeline in milliseconds. More...

QEasingCurve	easingCurve
	Specifies the easing curve that the timeline will use. More...

int	loopCount
	the number of times the timeline should loop before it's finished. More...

int	updateInterval
	the time in milliseconds between each time QTimeLine updates its current time. More...

Additional Inherited Members
Static Public Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	Disconnects signal in object sender from method in object receiver. More...

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

static QString	tr (const char sourceText, const char comment=0, int n=-1)

static QString	trUtf8 (const char sourceText, const char comment=0, int n=-1)

Static Public Variables inherited from QObject
static const QMetaObject	staticMetaObject
	This variable stores the meta-object for the class. More...

Protected Variables inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Static Protected Variables inherited from QObject
static const QMetaObject	staticQtMetaObject

Related Functions inherited from QObject
T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()

T *	qobject_cast (QObject *object)

	QObjectList

void *	qt_find_obj_child (QObject parent, const char type, const QString &name)
	Returns a pointer to the object named name that inherits type and with a given parent. More...

Detailed Description

The QTimeLine class provides a timeline for controlling animations.

Since: 4.2

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 (e.g., 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, SIGNAL(frameChanged(int)), progressBar, SLOT(setValue(int)));
// Clicking the push button will start the progress bar animation
pushButton = new QPushButton(tr("Start animation"), this);
connect(pushButton, SIGNAL(clicked()), timeLine, SLOT(start()));
...

You can also use QTimeLine with the Graphics View{Graphics View framework} for animations. The QGraphicsItemAnimation class implements animation of QGraphicsItems with a timeline.

By default the timeline runs once, from the beginning and towards the 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 setCurveShape().

Note that by default, QTimeLine uses the EaseInOut curve shape, 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 curveShape property is ignored.

See also: QProgressBar, QProgressDialog, QGraphicsItemAnimation

Definition at line 55 of file qtimeline.h.

Enumerations

◆ CurveShape

enum QTimeLine::CurveShape

This enum describes the default shape of QTimeLine's value curve.

The default, shape is EaseInOutCurve. The curve defines the relation between the value and the timeline.

EaseInCurve The value starts growing slowly, then increases in speed.
EaseOutCurve The value starts growing steadily, then ends slowly.
EaseInOutCurve The value starts growing slowly, then runs steadily, then grows slowly again.
LinearCurve The value grows linearly (e.g., if the duration is 1000 ms, the value at time 500 ms is 0.5).
SineCurve The value grows sinusoidally.
CosineCurve The value grows cosinusoidally.

See also: setCurveShape()

Enumerator
EaseInCurve
EaseOutCurve
EaseInOutCurve
LinearCurve
SineCurve
CosineCurve

Definition at line 75 of file qtimeline.h.

                     {
         EaseInCurve,
         EaseOutCurve,
         EaseInOutCurve,
         LinearCurve,
         SineCurve,
         CosineCurve
     };

◆ Direction

enum QTimeLine::Direction

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

Forward The current time of the timeline increases with time (i.e., moves from 0 and towards the end / duration).

Backward The current time of the timeline decreases with time (i.e., moves from the end / duration and towards 0).

See also: setDirection()

Enumerator
Forward
Backward

Definition at line 71 of file qtimeline.h.

                    {
         Forward,
         Backward
     };

◆ State

enum QTimeLine::State

This enum describes the state of the timeline.

NotRunning 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().

Paused The timeline is paused (i.e., temporarily suspended). Calling setPaused(false) will resume timeline activity.

Running 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(), stateChanged()

Enumerator
NotRunning
Paused
Running

Definition at line 66 of file qtimeline.h.

                {
         NotRunning,
         Paused,
         Running
     };

Constructors and Destructors

◆ QTimeLine()

QTimeLine::QTimeLine	(	int	duration = `1000`,
		QObject *	parent = `0`
	)

explicit

Constructs a timeline with a duration of duration milliseconds.

parent is passed to QObject's constructor. The default duration is 1000 milliseconds.

Definition at line 337 of file qtimeline.cpp.

     : QObject(*new QTimeLinePrivate, parent)
 {
     setDuration(duration);
 }

◆ ~QTimeLine()

QTimeLine::~QTimeLine ( )

virtual

Destroys the timeline.

Definition at line 346 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
 
     if (d->state == Running)
         stop();
 }

Functions

◆ currentFrame()

int QTimeLine::currentFrame ( ) const

Returns the frame corresponding to the current time.

See also: currentTime(), frameForTime(), setFrameRange()

Definition at line 656 of file qtimeline.cpp.

 {
     Q_D(const QTimeLine);
     return frameForTime(d->currentTime);
 }

◆ currentTime()

int QTimeLine::currentTime ( ) const

Referenced by setEasingCurve().

◆ currentValue()

qreal QTimeLine::currentValue ( ) const

Returns the value corresponding to the current time.

See also: valueForTime(), currentFrame()

Definition at line 667 of file qtimeline.cpp.

 {
     Q_D(const QTimeLine);
     return valueForTime(d->currentTime);
 }

◆ curveShape()

CurveShape QTimeLine::curveShape ( ) const

Referenced by setUpdateInterval().

◆ direction()

Direction QTimeLine::direction ( ) const

Referenced by setDirection(), and setLoopCount().

◆ duration()

int QTimeLine::duration ( ) const

Referenced by setDirection(), and setDuration().

◆ easingCurve()

QEasingCurve QTimeLine::easingCurve ( ) const

Referenced by setCurveShape().

◆ endFrame()

int QTimeLine::endFrame ( ) const

Returns the end frame, which is the frame corresponding to the end of the timeline (i.e., the frame for which the current value is 1).

See also: setEndFrame(), setFrameRange()

Definition at line 474 of file qtimeline.cpp.

Referenced by setFrameRange().

 {
     Q_D(const QTimeLine);
     return d->endFrame;
 }

◆ finished

QTimeLine::finished ( )

signal

This signal is emitted when QTimeLine finishes (i.

e., reaches the end of its time line), and does not loop.

◆ frameChanged

QTimeLine::frameChanged ( int frame )

signal

QTimeLine emits this signal at regular intervals when in Running state, but only if the current frame changes.

frame is the current frame number.

See also: QTimeLine::setFrameRange(), QTimeLine::updateInterval

◆ frameForTime()

int QTimeLine::frameForTime ( int msec ) const

Returns the frame corresponding to the time msec.

This value is calculated using a linear interpolation of the start and end frame, based on the value returned by valueForTime().

See also: valueForTime(), setFrameRange()

Definition at line 680 of file qtimeline.cpp.

Referenced by currentFrame().

 {
     Q_D(const QTimeLine);
     if (d->direction == Forward)
         return d->startFrame + int((d->endFrame - d->startFrame) * valueForTime(msec));
     return d->startFrame + qCeil((d->endFrame - d->startFrame) * valueForTime(msec));
 }

◆ loopCount()

int QTimeLine::loopCount ( ) const

Referenced by state().

◆ resume

void QTimeLine::resume ( )

slot

Resumes the timeline from the current time.

QTimeLine will reenter Running state, and once it enters the event loop, it will update its current time, frame and value at regular intervals.

In contrast to start(), this function does not restart the timeline before it resumes.

See also: start(), updateInterval(), frameChanged(), valueChanged()

Definition at line 748 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     if (d->timerId) {
         qWarning("QTimeLine::resume: already running");
         return;
     }
     d->timerId = startTimer(d->updateInterval);
     d->startTime = d->currentTime;
     d->timer.start();
     d->setState(Running);
 }

◆ setCurrentTime

void QTimeLine::setCurrentTime ( int msec )

slot

Definition at line 642 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     d->startTime = 0;
     d->currentLoopCount = 0;
     d->timer.restart();
     d->setCurrentTime(msec);
 }

◆ setCurveShape()

void QTimeLine::setCurveShape ( CurveShape shape )

Definition at line 572 of file qtimeline.cpp.

 {
     switch (shape) {
     default:
     case EaseInOutCurve:
         setEasingCurve(QEasingCurve(QEasingCurve::InOutSine));
         break;
     case EaseInCurve:
         setEasingCurve(QEasingCurve(QEasingCurve::InCurve));
         break;
     case EaseOutCurve:
         setEasingCurve(QEasingCurve(QEasingCurve::OutCurve));
         break;
     case LinearCurve:
         setEasingCurve(QEasingCurve(QEasingCurve::Linear));
         break;
     case SineCurve:
         setEasingCurve(QEasingCurve(QEasingCurve::SineCurve));
         break;
     case CosineCurve:
         setEasingCurve(QEasingCurve(QEasingCurve::CosineCurve));
         break;
     }
 }

◆ setDirection()

void QTimeLine::setDirection ( Direction direction )

Definition at line 406 of file qtimeline.cpp.

Referenced by toggleDirection().

 {
     Q_D(QTimeLine);
     d->direction = direction;
     d->startTime = d->currentTime;
     d->timer.start();
 }

◆ setDuration()

void QTimeLine::setDuration ( int duration )

Definition at line 434 of file qtimeline.cpp.

Referenced by QTimeLine().

 {
     Q_D(QTimeLine);
     if (duration <= 0) {
         qWarning("QTimeLine::setDuration: cannot set duration <= 0");
         return;
     }
     d->duration = duration;
 }

◆ setEasingCurve()

void QTimeLine::setEasingCurve ( const QEasingCurve & curve )

Definition at line 617 of file qtimeline.cpp.

Referenced by setCurveShape().

 {
     Q_D(QTimeLine);
     d->easingCurve = curve;
 }

◆ setEndFrame()

void QTimeLine::setEndFrame ( int frame )

Sets the end frame, which is the frame corresponding to the end of the timeline (i.e., the frame for which the current value is 1), to frame.

See also: endFrame(), startFrame(), setFrameRange()

Definition at line 486 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     d->endFrame = frame;
 }

◆ setFrameRange()

void QTimeLine::setFrameRange	(	int	startFrame,
		int	endFrame
	)

Sets the timeline's frame counter to start at startFrame, and end and endFrame.

For each time value, QTimeLine will find the corresponding frame when you call currentFrame() or frameForTime() by interpolating, using the return value of valueForTime().

When in Running state, QTimeLine also emits the frameChanged() signal when the frame changes.

See also: startFrame(), endFrame(), start(), currentFrame()

Definition at line 503 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     d->startFrame = startFrame;
     d->endFrame = endFrame;
 }

◆ setLoopCount()

void QTimeLine::setLoopCount ( int count )

Definition at line 381 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     d->totalLoopCount = count;
 }

◆ setPaused

void QTimeLine::setPaused ( bool paused )

slot

If paused is true, the timeline is paused, causing QTimeLine to enter Paused state.

No updates will be signaled until either start() or setPaused(false) is called. If paused is false, the timeline is resumed and continues where it left.

See also: state(), start()

Definition at line 783 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     if (d->state == NotRunning) {
         qWarning("QTimeLine::setPaused: Not running");
         return;
     }
     if (paused && d->state != Paused) {
         d->startTime = d->currentTime;
         killTimer(d->timerId);
         d->timerId = 0;
         d->setState(Paused);
     } else if (!paused && d->state == Paused) {
         // Same as resume()
         d->timerId = startTimer(d->updateInterval);
         d->startTime = d->currentTime;
         d->timer.start();
         d->setState(Running);
     }
 }

◆ setStartFrame()

void QTimeLine::setStartFrame ( int frame )

Sets the start frame, which is the frame corresponding to the start of the timeline (i.e., the frame for which the current value is 0), to frame.

See also: startFrame(), endFrame(), setFrameRange()

Definition at line 462 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     d->startFrame = frame;
 }

◆ setUpdateInterval()

void QTimeLine::setUpdateInterval ( int interval )

Definition at line 529 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     d->updateInterval = interval;
 }

◆ start

void QTimeLine::start ( )

slot

Starts the timeline.

QTimeLine will enter Running state, and once it enters the event loop, it will update its current time, frame and value at regular intervals. The default interval is 40 ms (i.e., 25 times per second). You can change the update interval by calling setUpdateInterval().

The timeline will start from position 0, or the end if going backward. If you want to resume a stopped timeline without restarting, you can call resume() instead.

See also: resume(), updateInterval(), frameChanged(), valueChanged()

Definition at line 720 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     if (d->timerId) {
         qWarning("QTimeLine::start: already running");
         return;
     }
     int curTime = 0;
     if (d->direction == Backward)
         curTime = d->duration;
     d->timerId = startTimer(d->updateInterval);
     d->startTime = curTime;
     d->currentLoopCount = 0;
     d->timer.start();
     d->setState(Running);
     d->setCurrentTime(curTime);
 }

◆ startFrame()

int QTimeLine::startFrame ( ) const

Returns the start frame, which is the frame corresponding to the start of the timeline (i.e., the frame for which the current value is 0).

See also: setStartFrame(), setFrameRange()

Definition at line 450 of file qtimeline.cpp.

Referenced by setFrameRange().

 {
     Q_D(const QTimeLine);
     return d->startFrame;
 }

◆ state()

QTimeLine::State QTimeLine::state ( ) const

Returns the state of the timeline.

See also: start(), setPaused(), stop()

Definition at line 359 of file qtimeline.cpp.

 {
     Q_D(const QTimeLine);
     return d->state;
 }

◆ stateChanged

QTimeLine::stateChanged ( QTimeLine::State newState )

signal

This signal is emitted whenever QTimeLine's state changes.

The new state is newState.

◆ stop

void QTimeLine::stop ( )

slot

Stops the timeline, causing QTimeLine to enter NotRunning state.

See also: start()

Definition at line 766 of file qtimeline.cpp.

Referenced by ~QTimeLine().

 {
     Q_D(QTimeLine);
     if (d->timerId)
         killTimer(d->timerId);
     d->setState(NotRunning);
     d->timerId = 0;
 }

◆ timerEvent()

void QTimeLine::timerEvent ( QTimerEvent * event )

protectedvirtual

Reimplemented Function

Reimplemented from QObject.

Definition at line 819 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     if (event->timerId() != d->timerId) {
         event->ignore();
         return;
     }
     event->accept();
 
     if (d->direction == Forward) {
         d->setCurrentTime(d->startTime + d->timer.elapsed());
     } else {
         d->setCurrentTime(d->startTime - d->timer.elapsed());
     }
 }

◆ toggleDirection

void QTimeLine::toggleDirection ( )

slot

Toggles the direction of the timeline.

If the direction was Forward, it becomes Backward, and vice verca.

See also: setDirection()

Definition at line 810 of file qtimeline.cpp.

 {
     Q_D(QTimeLine);
     setDirection(d->direction == Forward ? Backward : Forward);
 }

◆ updateInterval()

int QTimeLine::updateInterval ( ) const

Referenced by setFrameRange().

◆ valueChanged

QTimeLine::valueChanged ( qreal value )

signal

QTimeLine emits this signal at regular intervals when in Running state, but only if the current value changes.

value is the current value. value is a number between 0.0 and 1.0

See also: QTimeLine::setDuration(), QTimeLine::valueForTime(), QTimeLine::updateInterval

◆ valueForTime()

qreal QTimeLine::valueForTime ( int msec ) const

virtual

Returns the timeline value for the time msec.

The returned value, which varies depending on the curve shape, is always between 0 and 1. If msec is 0, the default implementation always returns 0.

Reimplement this function to provide a custom curve shape for your timeline.

See also: CurveShape, frameForTime()

Definition at line 698 of file qtimeline.cpp.

Referenced by currentValue(), and frameForTime().

 {
     Q_D(const QTimeLine);
     msec = qMin(qMax(msec, 0), d->duration);
 
     qreal value = msec / qreal(d->duration);
     return d->easingCurve.valueForProgress(value);
 }

Properties

◆ currentTime

int QTimeLine::currentTime

private

the current time of the time line.

When QTimeLine is in Running state, this value is updated continuously as a function of the duration and direction of the timeline. Otherwise, it is value that was current when stop() was called last, or the value set by setCurrentTime().

By default, this property contains a value of 0.

Definition at line 60 of file qtimeline.h.

◆ curveShape

QTimeLine::CurveShape QTimeLine::curveShape

private

the shape of the timeline curve.

The curve shape describes the relation between the time and value for the base implementation of valueForTime().

If you have reimplemented valueForTime(), this value is ignored.

By default, this property is set to EaseInOutCurve .

See also: valueForTime()

Definition at line 63 of file qtimeline.h.

◆ direction

QTimeLine::Direction QTimeLine::direction

private

the direction of the timeline when QTimeLine is in Running state.

This direction indicates whether the time moves from 0 towards the timeline duration, or from the value of the duration and towards 0 after start() has been called.

By default, this property is set to Forward .

Definition at line 61 of file qtimeline.h.

◆ duration

int QTimeLine::duration

private

the total duration of the timeline in milliseconds.

By default, this value is 1000 (i.e., 1 second), but you can change this by either passing a duration to QTimeLine's constructor, or by calling setDuration(). The duration must be larger than 0.

Note: Changing the duration does not cause the current time to be reset to zero or the new duration. You also need to call setCurrentTime() with the desired value.

Definition at line 58 of file qtimeline.h.

◆ easingCurve

QEasingCurve QTimeLine::easingCurve

private

Specifies the easing curve that the timeline will use.

Since: 4.6

If both easing curve and curveShape are set, the last set property will override the previous one. (If valueForTime() is reimplemented it will override both)

Definition at line 64 of file qtimeline.h.

◆ loopCount

int QTimeLine::loopCount

private

the number of times the timeline should loop before it's finished.

A loop count of of 0 means that the timeline will loop forever.

By default, this property contains a value of 1.

Definition at line 62 of file qtimeline.h.

◆ updateInterval

int QTimeLine::updateInterval

private

the time in milliseconds between each time QTimeLine updates its current time.

When updating the current time, QTimeLine will emit valueChanged() if the current value changed, and frameChanged() if the frame changed.

By default, the interval is 40 ms, which corresponds to a rate of 25 updates per second.

Definition at line 59 of file qtimeline.h.

The documentation for this class was generated from the following files:

/src/corelib/tools/qtimeline.h
/src/corelib/tools/qtimeline.cpp

Public Types

Public Slots

Signals

Public Functions

Protected Functions

Properties

Additional Inherited Members

Detailed Description

Enumerations

◆ CurveShape

◆ Direction

◆ State

Constructors and Destructors

◆ QTimeLine()

◆ ~QTimeLine()

Functions

◆ currentFrame()

◆ currentTime()

◆ currentValue()

◆ curveShape()

◆ direction()

◆ duration()

◆ easingCurve()

◆ endFrame()

◆ finished

◆ frameChanged

◆ frameForTime()

◆ loopCount()

◆ resume

◆ setCurrentTime

◆ setCurveShape()

◆ setDirection()

◆ setDuration()

◆ setEasingCurve()

◆ setEndFrame()

◆ setFrameRange()

◆ setLoopCount()

◆ setPaused

◆ setStartFrame()

◆ setUpdateInterval()

◆ start

◆ startFrame()

◆ state()

◆ stateChanged

◆ stop

◆ timerEvent()

◆ toggleDirection

◆ updateInterval()

◆ valueChanged

◆ valueForTime()

Properties

◆ currentTime

◆ curveShape

◆ direction

◆ duration

◆ easingCurve

◆ loopCount

◆ updateInterval