PySide6.QtCore.QAnimationGroup¶
- class QAnimationGroup¶
The
QAnimationGroup
class is an abstract base class for groups of animations. More…Inherited by:
QSequentialAnimationGroup
,QParallelAnimationGroup
Added in version 4.6.
Synopsis¶
Methods¶
def
__init__()
def
addAnimation()
def
animationAt()
def
animationCount()
def
clear()
def
takeAnimation()
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description¶
An animation group is a container for animations (subclasses of
QAbstractAnimation
). A group is usually responsible for managing thestate
of its animations, i.e., it decides when to start, stop, resume, and pause them. Currently, Qt provides two such groups:QParallelAnimationGroup
andQSequentialAnimationGroup
. Look up their class descriptions for details.Since
QAnimationGroup
inherits fromQAbstractAnimation
, you can combine groups, and easily construct complex animation graphs. You can queryQAbstractAnimation
for the group it belongs to (using thegroup()
function).To start a top-level animation group, you simply use the
start()
function fromQAbstractAnimation
. 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 callingremoveAnimation()
, and clear the animation group by callingclear()
. You may keep track of changes in the group’s animations by listening toChildAdded
andChildRemoved
events.QAnimationGroup
takes ownership of the animations it manages, and ensures that they are deleted when the animation group is deleted.Constructs a
QAnimationGroup
.parent
is passed toQObject
‘s constructor.- addAnimation(animation)¶
- Parameters:
animation –
QAbstractAnimation
Adds
animation
to this group. This will callinsertAnimation
with index equals toanimationCount()
.- animationAt(index)¶
- Parameters:
index – int
- Return type:
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 andanimationCount()
- 1.See also
- animationCount()¶
- Return type:
int
Returns the number of animations managed by this group.
- clear()¶
Removes and deletes all animations in this animation group, and resets the current time to 0.
See also
- indexOfAnimation(animation)¶
- Parameters:
animation –
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.- insertAnimation(index, animation)¶
- Parameters:
index – int
animation –
QAbstractAnimation
Inserts
animation
into this animation group atindex
. Ifindex
is 0 the animation is inserted at the beginning. Ifindex
isanimationCount()
, the animation is inserted at the end.Note
The group takes ownership of the animation.
- removeAnimation(animation)¶
- Parameters:
animation –
QAbstractAnimation
Removes
animation
from this group. The ownership ofanimation
is transferred to the caller.- takeAnimation(index)¶
- Parameters:
index – int
- Return type:
Returns the animation at
index
and removes it from the animation group.Note
The ownership of the animation is transferred to the caller.