|  | Home · All Classes · Modules

# QAnimationGroup Class Reference
[QtCore module]

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

Inherits QAbstractAnimation.

Inherited by QParallelAnimationGroup and QSequentialAnimationGroup.

### Methods

- __init__ (self, QObject parent = None)
- addAnimation (self, QAbstractAnimation animation)
- QAbstractAnimation animationAt (self, int index)
- int animationCount (self)
- clear (self)
- bool event (self, QEvent event)
- int indexOfAnimation (self, QAbstractAnimation animation)
- insertAnimation (self, int index, QAbstractAnimation animation)
- removeAnimation (self, QAbstractAnimation animation)
- QAbstractAnimation takeAnimation (self, int index)

## Detailed Description

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

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 remove(), and clear the animation group by calling clear(). You may keep track of changes in the group's animations by listening to QEvent.ChildAdded and QEvent.ChildRemoved events.

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

## Method Documentation

### QAnimationGroup.__init__ (self, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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

### QAnimationGroup.addAnimation (self, QAbstractAnimation animation)

The animation argument has it's ownership transferred to Qt.

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().

### QAbstractAnimation QAnimationGroup.animationAt (self, int index)

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.

See also animationCount() and indexOfAnimation().

### int QAnimationGroup.animationCount (self)

Returns the number of animations managed by this group.

See also indexOfAnimation(), addAnimation(), and animationAt().

### QAnimationGroup.clear (self)

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

See also addAnimation() and removeAnimation().

### bool QAnimationGroup.event (self, QEvent event)

Reimplemented from QObject.event().

### int QAnimationGroup.indexOfAnimation (self, QAbstractAnimation animation)

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

See also insertAnimation(), animationAt(), and takeAnimation().

### QAnimationGroup.insertAnimation (self, int index, QAbstractAnimation animation)

The animation argument has it's ownership transferred to Qt.

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(), and removeAnimation().

### QAnimationGroup.removeAnimation (self, QAbstractAnimation animation)

The animation argument

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

See also takeAnimation(), insertAnimation(), and addAnimation().

### QAbstractAnimation QAnimationGroup.takeAnimation (self, int index)

The QAbstractAnimation result

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(), and indexOfAnimation().