QVariantAnimation Class | Qt Core | Qt 6.11.2
Description: The QVariantAnimation class provides a base class for animations.

- Qt 6.11
- Qt Core
- C++ Classes
- QVariantAnimation
- Qt 6.11.2 Reference Documentation

# QVariantAnimation Class

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

Header: | `#include <QVariantAnimation>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Core)` `target_link_libraries(mytarget PRIVATE Qt6::Core)`
qmake: | `QT += core`
Inherits: | QAbstractAnimation
Inherited By: | QPropertyAnimation

- List of all members, including inherited members
- QVariantAnimation is part of Animation Framework.

## Public Types

| KeyValue
| KeyValues

## Properties

currentValue : QVariant duration : int easingCurve : QEasingCurve | endValue : QVariant startValue : QVariant

## Public Functions

| QVariantAnimation(QObject *parent = nullptr)
virtual | ~QVariantAnimation()
QBindable<int> | bindableDuration()
QBindable<QEasingCurve> | bindableEasingCurve()
QVariant | currentValue() const
virtual int | duration() const override
QEasingCurve | easingCurve() const
QVariant | endValue() const
QVariant | keyValueAt(qreal step) const
QVariantAnimation::KeyValues | keyValues() const
void | setDuration(int msecs)
void | setEasingCurve(const QEasingCurve &easing)
void | setEndValue(const QVariant &value)
void | setKeyValueAt(qreal step, const QVariant &value)
void | setKeyValues(const QVariantAnimation::KeyValues &keyValues)
void | setStartValue(const QVariant &value)
QVariant | startValue() const

## Signals

void | valueChanged(const QVariant &value)

## Protected Functions

virtual QVariant | interpolated(const QVariant &from, const QVariant &to, qreal progress) const
virtual void | updateCurrentValue(const QVariant &value)

## Reimplemented Protected Functions

virtual bool | event(QEvent *event) override
virtual void | updateCurrentTime(int) override
virtual void | updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) override

## Related Non-Members

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

## Detailed Description

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

The class performs interpolation over QVariants, but leaves using the interpolated values to its subclasses. Currently, Qt provides QPropertyAnimation, which animates Qt 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 QVariants are interpolated by creating a subclass of QVariantAnimation, and reimplementing the virtual interpolated() function.

Subclassing QVariantAnimation can be an alternative if you have QVariants 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:

- Int
- UInt
- Double
- Float
- QLine
- QLineF
- QPoint
- QPointF
- QSize
- QSizeF
- QRect
- QRectF
- QColor

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:

     QVariant myColorInterpolator(const QColor &start, const QColor &end, qreal progress)
     {
         // ...
         return QColor(/*...*/);
     }
     // ...
     void someFunc()
     {
         // ...
         qRegisterAnimationInterpolator<QColor>(myColorInterpolator);
         // ...
     }

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

See also QPropertyAnimation, QAbstractAnimation, and The Animation Framework.

## Member Type Documentation

### `[alias]` QVariantAnimation::KeyValue

This is a typedef for std::pair<qreal, QVariant>.

### QVariantAnimation::KeyValues

This is a typedef for QList<KeyValue>

## Property Documentation

### `[read-only]` currentValue : QVariant

This property holds the current value of the animation.

This property describes the current value; an interpolated value between the start value and the 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 properties.

Access functions:

QVariant | currentValue() const

Notifier signal:

void | valueChanged(const QVariant &value)

See also startValue and endValue.

### `[bindable]` duration : int

Note: This property supports QProperty bindings.

This property holds the duration of the animation

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

Access functions:

virtual int | duration() const override
void | setDuration(int msecs)

See also QAbstractAnimation::duration().

### `[bindable]` easingCurve : QEasingCurve

Note: This property supports QProperty bindings.

This property holds 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.

Access functions:

QEasingCurve | easingCurve() const
void | setEasingCurve(const QEasingCurve &easing)

### endValue : QVariant

This property holds the end value of the animation

This property describes the end value of the animation.

Access functions:

QVariant | endValue() const
void | setEndValue(const QVariant &value)

See also startValue.

### startValue : QVariant

This property holds 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.

Access functions:

QVariant | startValue() const
void | setStartValue(const QVariant &value)

See also endValue.

## Member Function Documentation

### QVariantAnimation::QVariantAnimation(QObject *parent = nullptr)

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

### `[virtual noexcept]` QVariantAnimation::~QVariantAnimation()

Destroys the animation.

### `[override virtual protected]` bool QVariantAnimation::event(QEvent *event)

Reimplements: QAbstractAnimation::event(QEvent *event).

### `[virtual protected]` QVariant QVariantAnimation::interpolated(const QVariant &from, const QVariant &to, qreal progress) const

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.

### 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() and setKeyValueAt().

### QVariantAnimation::KeyValues QVariantAnimation::keyValues() const

Returns the key frames of this animation.

See also keyValueAt() and setKeyValues().

### 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() and keyValueAt().

### void QVariantAnimation::setKeyValues(const QVariantAnimation::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() and keyValueAt().

### `[override virtual protected]` void QVariantAnimation::updateCurrentTime(int)

Reimplements: QAbstractAnimation::updateCurrentTime(int currentTime).

### `[virtual protected]` void QVariantAnimation::updateCurrentValue(const QVariant &value)

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.

### `[override virtual protected]` void QVariantAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

Reimplements: QAbstractAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState).

### `[signal]` void QVariantAnimation::valueChanged(const QVariant &value)

QVariantAnimation emits this signal whenever the current value changes.

Note: Notifier signal for property currentValue.

See also currentValue, startValue, and endValue.

## Related Non-Members

### template <typename T> void qRegisterAnimationInterpolator(QVariant (*)(const T &, const T &, qreal) 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`.

Warning: Registering a custom interpolator for one of the Qt built-in types (e.g. `int`) will affect all animations on this type that will be created later. This might be an undesired behavior. It is therefore recommended to reset the interpolator to the default value after the desired animations have been created.

Note: This function is thread-safe.