QAnimationGroup

The QAnimationGroup class is an abstract base class for groups of animations. More…

Inheritance diagram of PySide6.QtCore.QAnimationGroup

Inherited by: QSequentialAnimationGroup, QParallelAnimationGroup

New in version 4.6.

Synopsis

Functions

Detailed Description

An animation group is a container for animations (subclasses of QAbstractAnimation ). A group is usually responsible for managing the state of its animations, i.e., it decides when to start, stop, resume, and pause them. Currently, Qt provides two such groups: QParallelAnimationGroup and QSequentialAnimationGroup . Look up their class descriptions for details.

Since QAnimationGroup inherits from QAbstractAnimation , you can combine groups, and easily construct complex animation graphs. You can query QAbstractAnimation for the group it belongs to (using the group() function).

To start a top-level animation group, you simply use the start() function from QAbstractAnimation . By a top-level animation group, we think of a group that itself is not contained within another group. Starting sub groups directly is not supported, and may lead to unexpected behavior.

QAnimationGroup provides methods for adding and retrieving animations. Besides that, you can remove animations by calling removeAnimation() , and clear the animation group by calling clear() . You may keep track of changes in the group’s animations by listening to ChildAdded and ChildRemoved events.

QAnimationGroup takes ownership of the animations it manages, and ensures that they are deleted when the animation group is deleted.

class PySide6.QtCore.QAnimationGroup([parent=None])
Parameters

parent – PySide6.QtCore.QObject

Constructs a QAnimationGroup . parent is passed to QObject ‘s constructor.

PySide6.QtCore.QAnimationGroup.addAnimation(animation)
Parameters

animation – PySide6.QtCore.QAbstractAnimation

Adds animation to this group. This will call insertAnimation with index equals to animationCount() .

Note

The group takes ownership of the animation.

See also

removeAnimation()

PySide6.QtCore.QAnimationGroup.animationAt(index)
Parameters

index – int

Return type

PySide6.QtCore.QAbstractAnimation

Returns a pointer to the animation at index in this group. This function is useful when you need access to a particular animation. index is between 0 and animationCount() - 1.

PySide6.QtCore.QAnimationGroup.animationCount()
Return type

int

Returns the number of animations managed by this group.

PySide6.QtCore.QAnimationGroup.clear()

Removes and deletes all animations in this animation group, and resets the current time to 0.

PySide6.QtCore.QAnimationGroup.indexOfAnimation(animation)
Parameters

animation – PySide6.QtCore.QAbstractAnimation

Return type

int

Returns the index of animation. The returned index can be passed to the other functions that take an index as an argument.

PySide6.QtCore.QAnimationGroup.insertAnimation(index, animation)
Parameters

Inserts animation into this animation group at index. If index is 0 the animation is inserted at the beginning. If index is animationCount() , the animation is inserted at the end.

Note

The group takes ownership of the animation.

See also

takeAnimation() addAnimation() indexOfAnimation() removeAnimation()

PySide6.QtCore.QAnimationGroup.removeAnimation(animation)
Parameters

animation – PySide6.QtCore.QAbstractAnimation

Removes animation from this group. The ownership of animation is transferred to the caller.

PySide6.QtCore.QAnimationGroup.takeAnimation(index)
Parameters

index – int

Return type

PySide6.QtCore.QAbstractAnimation

Returns the animation at index and removes it from the animation group.

Note

The ownership of the animation is transferred to the caller.

See also

removeAnimation() addAnimation() insertAnimation() indexOfAnimation()