QPropertyAnimation Class

The QPropertyAnimation class animates Qt properties. More...

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


Public Functions

QPropertyAnimation(QObject *parent = nullptr)
QPropertyAnimation(QObject *target, const QByteArray &propertyName, QObject *parent = nullptr)
virtual ~QPropertyAnimation()
QBindable<QByteArray> bindablePropertyName()
QBindable<QObject *> bindableTargetObject()
QByteArray propertyName() const
void setPropertyName(const QByteArray &propertyName)
void setTargetObject(QObject *target)
QObject *targetObject() const

Reimplemented Protected Functions

virtual bool event(QEvent *event) override
virtual void updateCurrentValue(const QVariant &value) override
virtual void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) override

Detailed Description

QPropertyAnimation interpolates over Qt properties. As property values are stored in QVariants, the class inherits QVariantAnimation, and supports animation of the same meta types as its super class.

A class declaring properties must be a QObject. To make it possible to animate a property, it must provide a setter (so that QPropertyAnimation can set the property's value). Note that this makes it possible to animate many of Qt's widgets. Let's look at an example:

#include <QApplication>
#include <QPushButton>
#include <QPropertyAnimation>

class MyButtonWidget : public QWidget
    MyButtonWidget(QWidget *parent = nullptr);

MyButtonWidget::MyButtonWidget(QWidget *parent) : QWidget(parent)
    QPushButton *button = new QPushButton(tr("Animated Button"), this);
    QPropertyAnimation *anim = new QPropertyAnimation(button, "pos", this);
    anim->setStartValue(QPoint(0, 0));
    anim->setEndValue(QPoint(100, 250));

int main(int argc, char *argv[])
    QApplication a(argc, argv);
    MyButtonWidget buttonAnimWidget;
    buttonAnimWidget.resize(QSize(800, 600));
    return a.exec();

Note: You can also control an animation's lifespan by choosing a delete policy while starting the animation.

The property name and the QObject instance of which property should be animated are passed to the constructor. You can then specify the start and end value of the property. The procedure is equal for properties in classes you have implemented yourself–just check with QVariantAnimation that your QVariant type is supported.

The QVariantAnimation class description explains how to set up the animation in detail. Note, however, that if a start value is not set, the property will start at the value it had when the QPropertyAnimation instance was created.

QPropertyAnimation works like a charm on its own. For complex animations that, for instance, contain several objects, QAnimationGroup is provided. An animation group is an animation that can contain other animations, and that can manage when its animations are played. Look at QParallelAnimationGroup for an example.

See also QVariantAnimation, QAnimationGroup, and The Animation Framework.

Property Documentation

[bindable] propertyName : QByteArray

Note: This property supports QProperty bindings.

This property holds the target property name for this animation

This property defines the target property name for this animation. The property name is required for the animation to operate.

[bindable] targetObject : QObject*

Note: This property supports QProperty bindings.

This property holds the target QObject for this animation.

This property defines the target QObject for this animation.

Member Function Documentation

QPropertyAnimation::QPropertyAnimation(QObject *parent = nullptr)

Construct a QPropertyAnimation object. parent is passed to QObject's constructor.

QPropertyAnimation::QPropertyAnimation(QObject *target, const QByteArray &propertyName, QObject *parent = nullptr)

Construct a QPropertyAnimation object. parent is passed to QObject's constructor. The animation changes the property propertyName on target. The default duration is 250ms.

See also targetObject and propertyName.

[virtual] QPropertyAnimation::~QPropertyAnimation()

Destroys the QPropertyAnimation instance.

[override virtual protected] bool QPropertyAnimation::event(QEvent *event)

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

[override virtual protected] void QPropertyAnimation::updateCurrentValue(const QVariant &value)

Reimplements: QVariantAnimation::updateCurrentValue(const QVariant &value).

This virtual function is called by QVariantAnimation whenever the current value changes. value is the new, updated value. It updates the current value of the property on the target object.

See also currentValue and currentTime.

[override virtual protected] void QPropertyAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

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

If the startValue is not defined when the state of the animation changes from Stopped to Running, the current property value is used as the initial value for the animation.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.