QPropertyAnimation

The QPropertyAnimation class animates Qt properties. More

Inheritance diagram of PySide2.QtCore.QPropertyAnimation

New in version 4.6.

Synopsis

Functions

Detailed Description

QPropertyAnimation interpolates over Qt properties . As property values are stored in QVariant s, 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:

QPropertyAnimation *animation = new QPropertyAnimation(myWidget, "geometry");
animation->setDuration(10000);
animation->setStartValue(QRect(0, 0, 100, 30));
animation->setEndValue(QRect(250, 250, 100, 30));

animation->start();

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.

class PySide2.QtCore.QPropertyAnimation([parent=None])

PySide2.QtCore.QPropertyAnimation(target, propertyName[, parent=None])

param parent

PySide2.QtCore.QObject

param target

PySide2.QtCore.QObject

param propertyName

PySide2.QtCore.QByteArray

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

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

PySide2.QtCore.QPropertyAnimation.propertyName()
Return type

PySide2.QtCore.QByteArray

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.

PySide2.QtCore.QPropertyAnimation.setPropertyName(propertyName)
Parameters

propertyNamePySide2.QtCore.QByteArray

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.

PySide2.QtCore.QPropertyAnimation.setTargetObject(target)
Parameters

targetPySide2.QtCore.QObject

This property holds the target QObject for this animation..

This property defines the target QObject for this animation.

PySide2.QtCore.QPropertyAnimation.targetObject()
Return type

PySide2.QtCore.QObject

This property holds the target QObject for this animation..

This property defines the target QObject for this animation.