The QAbstractAnimation class is the base of all animations. More...

#include <qabstractanimation.h>

Inheritance diagram for QAbstractAnimation:

Collaboration diagram for QAbstractAnimation:

Public Types
enum	Direction { Forward , Backward }

enum	State { Stopped , Paused , Running }

enum	DeletionPolicy { KeepWhenStopped = 0 , DeleteWhenStopped }

Public Slots
void	start (QAbstractAnimation::DeletionPolicy policy=KeepWhenStopped)

void	pause ()

void	resume ()

void	setPaused (bool)

void	stop ()

void	setCurrentTime (int msecs)

Public Slots inherited from QObject
void	deleteLater ()

Signals
void	finished ()

void	stateChanged (QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

void	currentLoopChanged (int currentLoop)

void	directionChanged (QAbstractAnimation::Direction)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QAbstractAnimation (QObject *parent=nullptr)

virtual	~QAbstractAnimation ()

State	state () const

QBindable< QAbstractAnimation::State >	bindableState () const

QAnimationGroup *	group () const

Direction	direction () const

void	setDirection (Direction direction)

QBindable< Direction >	bindableDirection ()

int	currentTime () const

QBindable< int >	bindableCurrentTime ()

int	currentLoopTime () const

int	loopCount () const

void	setLoopCount (int loopCount)

QBindable< int >	bindableLoopCount ()

int	currentLoop () const

QBindable< int >	bindableCurrentLoop () const

virtual int	duration () const =0

int	totalDuration () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

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

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

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Protected Member Functions
	QAbstractAnimation (QAbstractAnimationPrivate &dd, QObject *parent=nullptr)

bool	event (QEvent *event) override

virtual void	updateCurrentTime (int currentTime)=0

virtual void	updateState (QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

virtual void	updateDirection (QAbstractAnimation::Direction direction)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

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

Properties
State	state
	state of the animation. More...

int	loopCount
	the loop count of the animation More...

int	currentTime
	the current time and progress of the animation More...

int	currentLoop
	the current loop of the animation More...

Direction	direction
	the direction of the animation when it is in \l Running state. More...

int	duration
	the duration of the animation. More...

Properties inherited from QObject
QString	objectName
	the name of this object More...

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

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

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

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

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

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

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

	QObjectList

Detailed Description

The QAbstractAnimation class is the base of all animations.

\inmodule QtCore

Since: 4.6

The class defines the functions for the functionality shared by all animations. By inheriting this class, you can create custom animations that plug into the rest of the animation framework.

The progress of an animation is given by its current time (currentLoopTime()), which is measured in milliseconds from the start of the animation (0) to its end (duration()). The value is updated automatically while the animation is running. It can also be set directly with setCurrentTime().

At any point an animation is in one of three states: \l{QAbstractAnimation::}{Running}, \l{QAbstractAnimation::}{Stopped}, or \l{QAbstractAnimation::}{Paused}–as defined by the \l{QAbstractAnimation::}{State} enum. The current state can be changed by calling start(), stop(), pause(), or resume(). An animation will always reset its \l{currentTime()}{current time} when it is started. If paused, it will continue with the same current time when resumed. When an animation is stopped, it cannot be resumed, but will keep its current time (until started again). QAbstractAnimation will emit stateChanged() whenever its state changes.

An animation can loop any number of times by setting the loopCount property. When an animation's current time reaches its duration(), it will reset the current time and keep running. A loop count of 1 (the default value) means that the animation will run one time. Note that a duration of -1 means that the animation will run until stopped; the current time will increase indefinitely. When the current time equals duration() and the animation is in its final loop, the \l{QAbstractAnimation::}{Stopped} state is entered, and the finished() signal is emitted.

QAbstractAnimation provides pure virtual functions used by subclasses to track the progress of the animation: duration() and updateCurrentTime(). The duration() function lets you report a duration for the animation (as discussed above). The animation framework calls updateCurrentTime() when current time has changed. By reimplementing this function, you can track the animation progress. Note that neither the interval between calls nor the number of calls to this function are defined; though, it will normally be 60 updates per second.

By reimplementing updateState(), you can track the animation's state changes, which is particularly useful for animations that are not driven by time.

See also: QVariantAnimation, QPropertyAnimation, QAnimationGroup, {The Animation Framework}

Definition at line 55 of file qabstractanimation.h.

Member Enumeration Documentation

◆ DeletionPolicy

enum QAbstractAnimation::DeletionPolicy

\value KeepWhenStopped The animation will not be deleted when stopped. \value DeleteWhenStopped The animation will be automatically deleted when stopped.

Enumerator
KeepWhenStopped
DeleteWhenStopped

Definition at line 82 of file qabstractanimation.h.

◆ Direction

enum QAbstractAnimation::Direction

This enum describes the direction of the animation when in \l Running state.

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

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

See also: direction

Enumerator
Forward
Backward

Definition at line 69 of file qabstractanimation.h.

◆ State

enum QAbstractAnimation::State

This enum describes the state of the animation.

\value Stopped The animation is not running. This is the initial state of QAbstractAnimation, and the state QAbstractAnimation reenters when finished. The current time remain unchanged until either setCurrentTime() is called, or the animation is started by calling start().

\value Paused The animation is paused (i.e., temporarily suspended). Calling resume() will resume animation activity.

\value Running The animation is running. While control is in the event loop, QAbstractAnimation will update its current time at regular intervals, calling updateCurrentTime() when appropriate.

See also: state(), stateChanged()

Enumerator
Stopped
Paused
Running

Definition at line 75 of file qabstractanimation.h.

Constructor & Destructor Documentation

◆ QAbstractAnimation() [1/2]

QAbstractAnimation::QAbstractAnimation ( QObject * parent = nullptr )

Constructs the QAbstractAnimation base class, and passes parent to QObject's constructor.

See also: QVariantAnimation, QAnimationGroup

Definition at line 1009 of file qabstractanimation.cpp.

Here is the call graph for this function:

◆ ~QAbstractAnimation()

QAbstractAnimation::~QAbstractAnimation ( )

virtual

Stops the animation if it's running, then destroys the QAbstractAnimation. If the animation is part of a QAnimationGroup, it is automatically removed before it's destroyed.

Definition at line 1031 of file qabstractanimation.cpp.

Here is the call graph for this function:

◆ QAbstractAnimation() [2/2]

QAbstractAnimation::QAbstractAnimation	(	QAbstractAnimationPrivate &	dd,
		QObject *	parent = `nullptr`
	)

protected

Definition at line 1019 of file qabstractanimation.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ bindableCurrentLoop()

QBindable< int > QAbstractAnimation::bindableCurrentLoop ( ) const

Definition at line 1235 of file qabstractanimation.cpp.

◆ bindableCurrentTime()

QBindable< int > QAbstractAnimation::bindableCurrentTime ( )

Definition at line 1311 of file qabstractanimation.cpp.

◆ bindableDirection()

QBindable< QAbstractAnimation::Direction > QAbstractAnimation::bindableDirection ( )

Definition at line 1172 of file qabstractanimation.cpp.

◆ bindableLoopCount()

QBindable< int > QAbstractAnimation::bindableLoopCount ( )

Definition at line 1210 of file qabstractanimation.cpp.

◆ bindableState()

QBindable< QAbstractAnimation::State > QAbstractAnimation::bindableState ( ) const

Definition at line 1066 of file qabstractanimation.cpp.

◆ currentLoop()

int QAbstractAnimation::currentLoop ( ) const

Definition at line 1229 of file qabstractanimation.cpp.

◆ currentLoopChanged

void QAbstractAnimation::currentLoopChanged ( int currentLoop )

signal

QAbstractAnimation emits this signal whenever the current loop changes. currentLoop is the current loop.

See also: currentLoop(), loopCount()

◆ currentLoopTime()

int QAbstractAnimation::currentLoopTime ( ) const

Returns the current time inside the current loop. It can go from 0 to duration().

See also: duration(), currentTime

Definition at line 1282 of file qabstractanimation.cpp.

◆ currentTime()

int QAbstractAnimation::currentTime ( ) const

Definition at line 1305 of file qabstractanimation.cpp.

◆ direction()

QAbstractAnimation::Direction QAbstractAnimation::direction ( ) const

Definition at line 1129 of file qabstractanimation.cpp.

◆ directionChanged

void QAbstractAnimation::directionChanged ( QAbstractAnimation::Direction newDirection )

signal

QAbstractAnimation emits this signal whenever the direction has been changed. newDirection is the new direction.

See also: direction

◆ duration()

int QAbstractAnimation::duration ( ) const

pure virtual

This pure virtual function returns the duration of the animation, and defines for how long QAbstractAnimation should update the current time. This duration is local, and does not include the loop count.

A return value of -1 indicates that the animation has no defined duration; the animation should run forever until stopped. This is useful for animations that are not time driven, or where you cannot easily predict its duration (e.g., event driven audio playback in a game).

If the animation is a parallel QAnimationGroup, the duration will be the longest duration of all its animations. If the animation is a sequential QAnimationGroup, the duration will be the sum of the duration of all its animations.

See also: loopCount

Implemented in RectAnimation, UncontrolledAnimation, UncontrolledAnimation, UncontrolledAnimation, TestAnimation2, UncontrolledAnimation, DummyQAnimationGroup, TestableQAbstractAnimation, QStyleAnimation, QVariantAnimation, QSequentialAnimationGroup, QPauseAnimation, and QParallelAnimationGroup.

◆ event()

bool QAbstractAnimation::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Reimplemented in QVariantAnimation, QSequentialAnimationGroup, QPropertyAnimation, QParallelAnimationGroup, QAnimationGroup, and QPauseAnimation.

Definition at line 1467 of file qabstractanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finished

void QAbstractAnimation::finished ( )

signal

QAbstractAnimation emits this signal after the animation has stopped and has reached the end.

This signal is emitted after stateChanged().

See also: stateChanged()

Here is the caller graph for this function:

◆ group()

QAnimationGroup * QAbstractAnimation::group ( ) const

If this animation is part of a QAnimationGroup, this function returns a pointer to the group; otherwise, it returns \nullptr.

See also: QAnimationGroup::addAnimation()

Definition at line 1078 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ loopCount()

int QAbstractAnimation::loopCount ( ) const

Definition at line 1199 of file qabstractanimation.cpp.

◆ pause

void QAbstractAnimation::pause ( )

slot

Pauses the animation. When the animation is paused, state() returns Paused. The value of currentTime will remain unchanged until resume() or start() is called. If you want to continue from the current time, call resume().

See also: start(), state(), resume()

Definition at line 1419 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ resume

void QAbstractAnimation::resume ( )

slot

Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and stateChanged() signals. The currenttime is not changed.

See also: start(), pause(), state()

Definition at line 1437 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ setCurrentTime

void QAbstractAnimation::setCurrentTime ( int msecs )

slot

Definition at line 1317 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ setDirection()

void QAbstractAnimation::setDirection ( Direction direction )

Definition at line 1134 of file qabstractanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLoopCount()

void QAbstractAnimation::setLoopCount ( int loopCount )

Definition at line 1204 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ setPaused

void QAbstractAnimation::setPaused ( bool paused )

slot

If paused is true, the animation is paused. If paused is false, the animation is resumed.

See also: state(), pause(), resume()

Definition at line 1455 of file qabstractanimation.cpp.

Here is the call graph for this function:

◆ start

void QAbstractAnimation::start ( QAbstractAnimation::DeletionPolicy policy = KeepWhenStopped )

slot

Starts the animation. The policy argument says whether or not the animation should be deleted when it's done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.

If the animation is currently stopped or has already reached the end, calling start() will rewind the animation and start again from the beginning. When the animation reaches the end, the animation will either stop, or if the loop level is more than 1, it will rewind and continue from the beginning.

If the animation is already running, this function does nothing.

See also: stop(), state()

Definition at line 1383 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ state()

QAbstractAnimation::State QAbstractAnimation::state ( ) const

Definition at line 1060 of file qabstractanimation.cpp.

◆ stateChanged

void QAbstractAnimation::stateChanged	(	QAbstractAnimation::State	newState,
		QAbstractAnimation::State	oldState
	)

signal

QAbstractAnimation emits this signal whenever the state of the animation has changed from oldState to newState. This signal is emitted after the virtual updateState() function is called.

See also: updateState()

Here is the caller graph for this function:

◆ stop

void QAbstractAnimation::stop ( )

slot

Stops the animation. When the animation is stopped, it emits the stateChanged() signal, and state() returns Stopped. The current time is not changed.

If the animation stops by itself after reaching the end (i.e., currentLoopTime() == duration() and currentLoop() > loopCount() - 1), the finished() signal is emitted.

See also: start(), state()

Definition at line 1402 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ totalDuration()

int QAbstractAnimation::totalDuration ( ) const

Returns the total and effective duration of the animation, including the loop count.

See also: duration(), currentTime

Definition at line 1265 of file qabstractanimation.cpp.

Here is the caller graph for this function:

◆ updateCurrentTime()

void QAbstractAnimation::updateCurrentTime ( int currentTime )

protectedpure virtual

This pure virtual function is called every time the animation's currentTime changes.

See also: updateState()

Implemented in DummyQAnimationGroup, TestableQAbstractAnimation, QVariantAnimation, QSequentialAnimationGroup, QPauseAnimation, QBlendStyleAnimation, QStyleAnimation, RectAnimation, UncontrolledAnimation, UncontrolledAnimation, TestablePauseAnimation, QParallelAnimationGroup, and Animation.

◆ updateDirection()

void QAbstractAnimation::updateDirection ( QAbstractAnimation::Direction direction )

protectedvirtual

This virtual function is called by QAbstractAnimation when the direction of the animation is changed. The direction argument is the new direction.

See also: setDirection(), direction()

Reimplemented in QSequentialAnimationGroup, and QParallelAnimationGroup.

Definition at line 1500 of file qabstractanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateState()

void QAbstractAnimation::updateState	(	QAbstractAnimation::State	newState,
		QAbstractAnimation::State	oldState
	)

protectedvirtual

This virtual function is called by QAbstractAnimation when the state of the animation is changed from oldState to newState.

See also: start(), stop(), pause(), resume()

Reimplemented in TestAnimation, TestAnimation, MyComposedAnimation, TestAnimation2, TestAnimation, QVariantAnimation, QSequentialAnimationGroup, QPropertyAnimation, and QParallelAnimationGroup.

Definition at line 1487 of file qabstractanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

◆ currentLoop

QAbstractAnimation::currentLoop

read

the current loop of the animation

This property describes the current loop of the animation. By default, the animation's loop count is 1, and so the current loop will always be 0. If the loop count is 2 and the animation runs past its duration, it will automatically rewind and restart at current time 0, and current loop 1, and so on.

When the current loop changes, QAbstractAnimation emits the currentLoopChanged() signal.

Definition at line 176 of file qabstractanimation.h.

◆ currentTime

QAbstractAnimation::currentTime

readwrite

the current time and progress of the animation

This property describes the animation's current time. You can change the current time by calling setCurrentTime, or you can call start() and let the animation run, setting the current time automatically as the animation progresses.

The animation's current time starts at 0, and ends at totalDuration().

Note: You can bind other properties to currentTime, but it is not recommended setting bindings to it. As animation progresses, the currentTime is updated automatically, which cancels its bindings.

See also: loopCount, currentLoopTime()

Definition at line 176 of file qabstractanimation.h.

◆ direction

QAbstractAnimation::direction

readwrite

the direction of the animation when it is in \l Running state.

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

By default, this property is set to \l Forward.

Definition at line 176 of file qabstractanimation.h.

◆ duration

QAbstractAnimation::duration

read

the duration of the animation.

If the duration is -1, it means that the duration is undefined. In this case, loopCount is ignored.

Definition at line 176 of file qabstractanimation.h.

◆ loopCount

QAbstractAnimation::loopCount

readwrite

the loop count of the animation

This property describes the loop count of the animation as an integer. By default this value is 1, indicating that the animation should run once only, and then stop. By changing it you can let the animation loop several times. With a value of 0, the animation will not run at all, and with a value of -1, the animation will loop forever until stopped. It is not supported to have loop on an animation that has an undefined duration. It will only run once.

Definition at line 176 of file qabstractanimation.h.

◆ state

QAbstractAnimation::state

read

state of the animation.

This property describes the current state of the animation. When the animation state changes, QAbstractAnimation emits the stateChanged() signal.

Note: State updates might cause updates of the currentTime property, which, in turn, can cancel its bindings. So be careful when setting bindings to the currentTime property, when you expect the state of the animation to change.

Definition at line 176 of file qabstractanimation.h.

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

src/corelib/animation/qabstractanimation.h
src/corelib/animation/qabstractanimation.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DeletionPolicy

◆ Direction

◆ State

Constructor & Destructor Documentation

◆ QAbstractAnimation() [1/2]

◆ ~QAbstractAnimation()

◆ QAbstractAnimation() [2/2]

Member Function Documentation

◆ bindableCurrentLoop()

◆ bindableCurrentTime()

◆ bindableDirection()

◆ bindableLoopCount()

◆ bindableState()

◆ currentLoop()

◆ currentLoopChanged

◆ currentLoopTime()

◆ currentTime()

◆ direction()

◆ directionChanged

◆ duration()

◆ event()

◆ finished

◆ group()

◆ loopCount()

◆ pause

◆ resume

◆ setCurrentTime

◆ setDirection()

◆ setLoopCount()

◆ setPaused

◆ start

◆ state()

◆ stateChanged

◆ stop

◆ totalDuration()

◆ updateCurrentTime()

◆ updateDirection()

◆ updateState()

Property Documentation

◆ currentLoop

◆ currentTime

◆ direction

◆ duration

◆ loopCount

◆ state