The QVariantAnimation class provides a base class for animations. More...

#include <qvariantanimation.h>

Inheritance diagram for QVariantAnimation:

Collaboration diagram for QVariantAnimation:

Public Types
typedef QPair< qreal, QVariant >	KeyValue

typedef QList< KeyValue >	KeyValues

typedef QVariant(*	Interpolator) (const void from, const void to, qreal progress)

Public Types inherited from QAbstractAnimation
enum	Direction { Forward , Backward }

enum	State { Stopped , Paused , Running }

enum	DeletionPolicy { KeepWhenStopped = 0 , DeleteWhenStopped }

Signals
void	valueChanged (const QVariant &value)

Signals inherited from QAbstractAnimation
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
	QVariantAnimation (QObject *parent=nullptr)

	~QVariantAnimation ()

QVariant	startValue () const

void	setStartValue (const QVariant &value)

QVariant	endValue () const

void	setEndValue (const QVariant &value)

QVariant	keyValueAt (qreal step) const

void	setKeyValueAt (qreal step, const QVariant &value)

KeyValues	keyValues () const

void	setKeyValues (const KeyValues &values)

QVariant	currentValue () const

int	duration () const override

void	setDuration (int msecs)

QBindable< int >	bindableDuration ()

QEasingCurve	easingCurve () const

void	setEasingCurve (const QEasingCurve &easing)

QBindable< QEasingCurve >	bindableEasingCurve ()

Public Member Functions inherited from QAbstractAnimation
	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

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
	QVariantAnimation (QVariantAnimationPrivate &dd, QObject *parent=nullptr)

bool	event (QEvent *event) override

void	updateCurrentTime (int) override

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

virtual void	updateCurrentValue (const QVariant &value)

virtual QVariant	interpolated (const QVariant &from, const QVariant &to, qreal progress) const

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

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
QVariant	startValue
	the optional start value of the animation More...

QVariant	endValue
	the end value of the animation More...

QVariant	currentValue
	the current value of the animation. More...

int	duration
	the duration of the animation More...

QEasingCurve	easingCurve
	the easing curve of the animation More...

Properties inherited from QAbstractAnimation
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...

Friends
template<typename T >
void	qRegisterAnimationInterpolator (QVariant(*func)(const T &, const T &, qreal))

Related Functions
(Note that these are not member functions.)
template< typename T > void	qRegisterAnimationInterpolator (QVariant(*func)(const T &from, const T &to, qreal progress))

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

Additional Inherited Members
Public Slots inherited from QAbstractAnimation
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 ()

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

Detailed Description

The QVariantAnimation class provides a base class for animations.

\inmodule QtCore

Since: 4.6

This class is part of \l{The Animation Framework}. It serves as a base class for property and item animations, with functions for shared functionality.

The class performs interpolation over \l{QVariant}s, but leaves using the interpolated values to its subclasses. Currently, Qt provides QPropertyAnimation, which animates Qt \l{Qt's Property System}{properties}. See the QPropertyAnimation class description if you wish to animate such properties.

You can then set start and end values for the property by calling setStartValue() and setEndValue(), and finally call start() to start the animation. QVariantAnimation will interpolate the property of the target object and emit valueChanged(). To react to a change in the current value you have to reimplement the updateCurrentValue() virtual function or connect to said signal.

It is also possible to set values at specified steps situated between the start and end value. The interpolation will then touch these points at the specified steps. Note that the start and end values are defined as the key values at 0.0 and 1.0.

There are two ways to affect how QVariantAnimation interpolates the values. You can set an easing curve by calling setEasingCurve(), and configure the duration by calling setDuration(). You can change how the \l{QVariant}s are interpolated by creating a subclass of QVariantAnimation, and reimplementing the virtual interpolated() function.

Subclassing QVariantAnimation can be an alternative if you have \l{QVariant}s that you do not wish to declare as Qt properties. Note, however, that you in most cases will be better off declaring your QVariant as a property.

Not all QVariant types are supported. Below is a list of currently supported QVariant types:

\list

\l{QMetaType::}{Int}
\l{QMetaType::}{UInt}
\l{QMetaType::}{Double}
\l{QMetaType::}{Float}
\l{QMetaType::}{QLine}
\l{QMetaType::}{QLineF}
\l{QMetaType::}{QPoint}
\l{QMetaType::}{QPointF}
\l{QMetaType::}{QSize}
\l{QMetaType::}{QSizeF}
\l{QMetaType::}{QRect}
\l{QMetaType::}{QRectF}
\l{QMetaType::}{QColor} \endlist

If you need to interpolate other variant types, including custom types, you have to implement interpolation for these yourself. To do this, you can register an interpolator function for a given type. This function takes 3 parameters: the start value, the end value, and the current progress.

Example:

Another option is to reimplement interpolated(), which returns interpolation values for the value being interpolated.

\omit We need some snippets around here. \endomit

See also: QPropertyAnimation, QAbstractAnimation, {The Animation Framework}

Definition at line 54 of file qvariantanimation.h.

Member Typedef Documentation

◆ Interpolator

typedef QVariant(* QVariantAnimation::Interpolator) (const void *from, const void *to, qreal progress)

Definition at line 93 of file qvariantanimation.h.

◆ KeyValue

QVariantAnimation::KeyValue

This is a typedef for QPair<qreal, QVariant>.

Definition at line 65 of file qvariantanimation.h.

◆ KeyValues

QVariantAnimation::KeyValues

This is a typedef for QList<KeyValue>

Definition at line 66 of file qvariantanimation.h.

Constructor & Destructor Documentation

◆ QVariantAnimation() [1/2]

QVariantAnimation::QVariantAnimation ( QObject * parent = nullptr )

Construct a QVariantAnimation object. parent is passed to QAbstractAnimation's constructor.

Definition at line 343 of file qvariantanimation.cpp.

◆ ~QVariantAnimation()

QVariantAnimation::~QVariantAnimation ( )

Destroys the animation.

Definition at line 357 of file qvariantanimation.cpp.

◆ QVariantAnimation() [2/2]

QVariantAnimation::QVariantAnimation	(	QVariantAnimationPrivate &	dd,
		QObject *	parent = `nullptr`
	)

protected

Definition at line 350 of file qvariantanimation.cpp.

Member Function Documentation

◆ bindableDuration()

QBindable< int > QVariantAnimation::bindableDuration ( )

Definition at line 530 of file qvariantanimation.cpp.

◆ bindableEasingCurve()

QBindable< QEasingCurve > QVariantAnimation::bindableEasingCurve ( )

Definition at line 399 of file qvariantanimation.cpp.

◆ currentValue()

QVariant QVariantAnimation::currentValue ( ) const

Definition at line 652 of file qvariantanimation.cpp.

◆ duration()

int QVariantAnimation::duration ( ) const

overridevirtual

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

Implements QAbstractAnimation.

Reimplemented in UncontrolledAnimation, UncontrolledAnimation, UncontrolledAnimation, TestAnimation2, and UncontrolledAnimation.

Definition at line 508 of file qvariantanimation.cpp.

◆ easingCurve()

QEasingCurve QVariantAnimation::easingCurve ( ) const

Definition at line 383 of file qvariantanimation.cpp.

◆ endValue()

QVariant QVariantAnimation::endValue ( ) const

Definition at line 565 of file qvariantanimation.cpp.

Here is the call graph for this function:

◆ event()

bool QVariantAnimation::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractAnimation.

Definition at line 663 of file qvariantanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolated()

QVariant QVariantAnimation::interpolated	(	const QVariant &	from,
		const QVariant &	to,
		qreal	progress
	)		const

protectedvirtual

This virtual function returns the linear interpolation between variants from and to, at progress, usually a value between 0 and 1. You can reimplement this function in a subclass of QVariantAnimation to provide your own interpolation algorithm.

Note that in order for the interpolation to work with a QEasingCurve that return a value smaller than 0 or larger than 1 (such as QEasingCurve::InBack) you should make sure that it can extrapolate. If the semantic of the datatype does not allow extrapolation this function should handle that gracefully.

You should call the QVariantAnimation implementation of this function if you want your class to handle the types already supported by Qt (see class QVariantAnimation description for a list of supported types).

See also: QEasingCurve

Definition at line 698 of file qvariantanimation.cpp.

Here is the call graph for this function:

◆ keyValueAt()

QVariant QVariantAnimation::keyValueAt ( qreal step ) const

Returns the key frame value for the given step. The given step must be in the range 0 to 1. If there is no KeyValue for step, it returns an invalid QVariant.

See also: keyValues(), setKeyValueAt()

Definition at line 583 of file qvariantanimation.cpp.

Here is the caller graph for this function:

◆ keyValues()

QVariantAnimation::KeyValues QVariantAnimation::keyValues ( ) const

Returns the key frames of this animation.

See also: keyValueAt(), setKeyValues()

Definition at line 615 of file qvariantanimation.cpp.

Here is the caller graph for this function:

◆ setDuration()

void QVariantAnimation::setDuration ( int msecs )

Definition at line 514 of file qvariantanimation.cpp.

Here is the caller graph for this function:

◆ setEasingCurve()

void QVariantAnimation::setEasingCurve ( const QEasingCurve & easing )

Definition at line 389 of file qvariantanimation.cpp.

Here is the caller graph for this function:

◆ setEndValue()

void QVariantAnimation::setEndValue ( const QVariant & value )

Definition at line 570 of file qvariantanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setKeyValueAt()

void QVariantAnimation::setKeyValueAt	(	qreal	step,
		const QVariant &	value
	)

Creates a key frame at the given step with the given value. The given step must be in the range 0 to 1.

See also: setKeyValues(), keyValueAt()

Definition at line 605 of file qvariantanimation.cpp.

Here is the caller graph for this function:

◆ setKeyValues()

void QVariantAnimation::setKeyValues ( const KeyValues & keyValues )

Replaces the current set of key frames with the given keyValues. the step of the key frames must be in the range 0 to 1.

See also: keyValues(), keyValueAt()

Definition at line 626 of file qvariantanimation.cpp.

Here is the call graph for this function:

◆ setStartValue()

void QVariantAnimation::setStartValue ( const QVariant & value )

Definition at line 552 of file qvariantanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startValue()

QVariant QVariantAnimation::startValue ( ) const

Definition at line 547 of file qvariantanimation.cpp.

Here is the call graph for this function:

◆ updateCurrentTime()

void QVariantAnimation::updateCurrentTime ( int )

overrideprotectedvirtual

\reimp

Implements QAbstractAnimation.

Reimplemented in UncontrolledAnimation, and UncontrolledAnimation.

Definition at line 706 of file qvariantanimation.cpp.

Here is the caller graph for this function:

◆ updateCurrentValue()

void QVariantAnimation::updateCurrentValue ( const QVariant & value )

protectedvirtual

This virtual function is called every time the animation's current value changes. The value argument is the new current value.

The base class implementation does nothing.

See also: currentValue

Reimplemented in DummyAnimation, TestAnimation, TestAnimation2, TestAnimation, TestAnimation, QPropertyAnimation, and TestableQVariantAnimation.

Definition at line 146 of file qvariantanimation.cpp.

◆ updateState()

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

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractAnimation.

Reimplemented in TestAnimation, TestAnimation, MyComposedAnimation, TestAnimation2, and TestAnimation.

Definition at line 671 of file qvariantanimation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueChanged

void QVariantAnimation::valueChanged ( const QVariant & value )

signal

QVariantAnimation emits this signal whenever the current value changes.

See also: currentValue, startValue, endValue

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ qRegisterAnimationInterpolator [1/2]

template<typename T >

void qRegisterAnimationInterpolator ( QVariant(*)(const T &, const T &, qreal) func )

friend

◆ qRegisterAnimationInterpolator() [2/2]

template< typename T > void qRegisterAnimationInterpolator ( QVariant(*)(const T &from, const T &to, qreal progress) func )

Registers a custom interpolator func for the template type {T}. The interpolator has to be registered before the animation is constructed. To unregister (and use the default interpolator) set func to \nullptr.

Definition at line 117 of file qvariantanimation.h.

Property Documentation

◆ currentValue

QVariantAnimation::currentValue

read

the current value of the animation.

This property describes the current value; an interpolated value between the \l{startValue}{start value} and the \l{endValue}{end value}, using the current time for progress. The value itself is obtained from interpolated(), which is called repeatedly as the animation is running.

QVariantAnimation calls the virtual updateCurrentValue() function when the current value changes. This is particularly useful for subclasses that need to track updates. For example, QPropertyAnimation uses this function to animate Qt \l{Qt's Property System}{properties}.

See also: startValue, endValue

Definition at line 121 of file qvariantanimation.h.

◆ duration

QVariantAnimation::duration

readwrite

the duration of the animation

This property describes the duration in milliseconds of the animation. The default duration is 250 milliseconds.

See also: QAbstractAnimation::duration()

Definition at line 121 of file qvariantanimation.h.

◆ easingCurve

QVariantAnimation::easingCurve

readwrite

the easing curve of the animation

This property defines the easing curve of the animation. By default, a linear easing curve is used, resulting in linear interpolation. Other curves are provided, for instance, QEasingCurve::InCirc, which provides a circular entry curve. Another example is QEasingCurve::InOutElastic, which provides an elastic effect on the values of the interpolated variant.

QVariantAnimation will use the QEasingCurve::valueForProgress() to transform the "normalized progress" (currentTime / totalDuration) of the animation into the effective progress actually used by the animation. It is this effective progress that will be the progress when interpolated() is called. Also, the steps in the keyValues are referring to this effective progress.

The easing curve is used with the interpolator, the interpolated() virtual function, and the animation's duration to control how the current value changes as the animation progresses.

Definition at line 121 of file qvariantanimation.h.

◆ endValue

QVariantAnimation::endValue

readwrite

the end value of the animation

This property describes the end value of the animation.

See also: startValue

Definition at line 121 of file qvariantanimation.h.

◆ startValue

QVariantAnimation::startValue

readwrite

the optional start value of the animation

This property describes the optional start value of the animation. If omitted, or if a null QVariant is assigned as the start value, the animation will use the current position of the end when the animation is started.

See also: endValue

Definition at line 121 of file qvariantanimation.h.

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

src/corelib/animation/qvariantanimation.h
src/corelib/animation/qvariantanimation.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Related Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Interpolator

◆ KeyValue

◆ KeyValues

Constructor & Destructor Documentation

◆ QVariantAnimation() [1/2]

◆ ~QVariantAnimation()

◆ QVariantAnimation() [2/2]

Member Function Documentation

◆ bindableDuration()

◆ bindableEasingCurve()

◆ currentValue()

◆ duration()

◆ easingCurve()

◆ endValue()

◆ event()

◆ interpolated()

◆ keyValueAt()

◆ keyValues()

◆ setDuration()

◆ setEasingCurve()

◆ setEndValue()

◆ setKeyValueAt()

◆ setKeyValues()

◆ setStartValue()

◆ startValue()

◆ updateCurrentTime()

◆ updateCurrentValue()

◆ updateState()

◆ valueChanged

Friends And Related Function Documentation

◆ qRegisterAnimationInterpolator [1/2]

◆ qRegisterAnimationInterpolator() [2/2]

Property Documentation

◆ currentValue

◆ duration

◆ easingCurve

◆ endValue

◆ startValue