QAbstractAnimation¶

The QAbstractAnimation class is the base of all animations. More…

Inherited by: QVariantAnimation, QPropertyAnimation, QPauseAnimation, QAnimationGroup, QSequentialAnimationGroup, QParallelAnimationGroup

New in version 4.6.

Synopsis¶

Functions¶

def currentLoop ()
def currentLoopTime ()
def currentTime ()
def direction ()
def group ()
def loopCount ()
def setDirection (direction)
def setLoopCount (loopCount)
def state ()
def totalDuration ()

Virtual functions¶

def duration ()
def updateCurrentTime (currentTime)
def updateDirection (direction)
def updateState (newState, oldState)

Slots¶

def pause ()
def resume ()
def setCurrentTime (msecs)
def setPaused (arg__1)
def start ([policy=QAbstractAnimation.DeletionPolicy.KeepWhenStopped])
def stop ()

Signals¶

def currentLoopChanged (currentLoop)
def directionChanged (arg__1)
def finished ()
def stateChanged (newState, oldState)

Detailed Description¶

The class defines the functions for the functionality shared by all animations. By inheriting this class, you can create custom animations that plug into the rest of the animation framework.

The progress of an animation is given by its current time ( currentLoopTime() ), which is measured in milliseconds from the start of the animation (0) to its end ( duration() ). The value is updated automatically while the animation is running. It can also be set directly with setCurrentTime() .

At any point an animation is in one of three states: Running , Stopped , or Paused –as defined by the State enum. The current state can be changed by calling start() , stop() , pause() , or resume() . An animation will always reset its current time when it is started. If paused, it will continue with the same current time when resumed. When an animation is stopped, it cannot be resumed, but will keep its current time (until started again). QAbstractAnimation will emit stateChanged() whenever its state changes.

An animation can loop any number of times by setting the loopCount property. When an animation’s current time reaches its duration() , it will reset the current time and keep running. A loop count of 1 (the default value) means that the animation will run one time. Note that a duration of -1 means that the animation will run until stopped; the current time will increase indefinitely. When the current time equals duration() and the animation is in its final loop, the Stopped state is entered, and the finished() signal is emitted.

QAbstractAnimation provides pure virtual functions used by subclasses to track the progress of the animation: duration() and updateCurrentTime() . The duration() function lets you report a duration for the animation (as discussed above). The animation framework calls updateCurrentTime() when current time has changed. By reimplementing this function, you can track the animation progress. Note that neither the interval between calls nor the number of calls to this function are defined; though, it will normally be 60 updates per second.

By reimplementing updateState() , you can track the animation’s state changes, which is particularly useful for animations that are not driven by time.

See also

QVariantAnimation QPropertyAnimation QAnimationGroup The Animation Framework

class PySide6.QtCore.QAbstractAnimation([parent=None])¶

Parameters: parent – PySide6.QtCore.QObject

Constructs the QAbstractAnimation base class, and passes parent to QObject ‘s constructor.

See also

QVariantAnimation QAnimationGroup

PySide6.QtCore.QAbstractAnimation.Direction¶

This enum describes the direction of the animation when in Running state.

Constant

Description

QAbstractAnimation.Forward

The current time of the animation increases with time (i.e., moves from 0 and towards the end / duration).

QAbstractAnimation.Backward

The current time of the animation decreases with time (i.e., moves from the end / duration and towards 0).

See also

direction

PySide6.QtCore.QAbstractAnimation.State¶

This enum describes the state of the animation.

Constant

Description

QAbstractAnimation.Stopped

The animation is not running. This is the initial state of QAbstractAnimation , and the state QAbstractAnimation reenters when finished. The current time remain unchanged until either setCurrentTime() is called, or the animation is started by calling start() .

QAbstractAnimation.Paused

The animation is paused (i.e., temporarily suspended). Calling resume() will resume animation activity.

QAbstractAnimation.Running

The animation is running. While control is in the event loop, QAbstractAnimation will update its current time at regular intervals, calling updateCurrentTime() when appropriate.

See also

state() stateChanged()

PySide6.QtCore.QAbstractAnimation.DeletionPolicy¶

Constant	Description
QAbstractAnimation.KeepWhenStopped	The animation will not be deleted when stopped.
QAbstractAnimation.DeleteWhenStopped	The animation will be automatically deleted when stopped.

PySide6.QtCore.QAbstractAnimation.currentLoop()¶

Return type: int

This property holds the current loop of the animation.

This property describes the current loop of the animation. By default, the animation’s loop count is 1, and so the current loop will always be 0. If the loop count is 2 and the animation runs past its duration, it will automatically rewind and restart at current time 0, and current loop 1, and so on.

When the current loop changes, QAbstractAnimation emits the currentLoopChanged() signal.

PySide6.QtCore.QAbstractAnimation.currentLoopChanged(currentLoop)¶

Parameters: currentLoop – int

PySide6.QtCore.QAbstractAnimation.currentLoopTime()¶

Return type: int

Returns the current time inside the current loop. It can go from 0 to duration() .

See also

duration() currentTime

PySide6.QtCore.QAbstractAnimation.currentTime()¶

Return type: int

This property holds the current time and progress of the animation.

This property describes the animation’s current time. You can change the current time by calling , or you can call start() and let the animation run, setting the current time automatically as the animation progresses.

The animation’s current time starts at 0, and ends at totalDuration() .

Note

You can bind other properties to , but it is not recommended setting bindings to it. As animation progresses, the is updated automatically, which cancels its bindings.

Table of Contents

Previous topic

Next topic

QAbstractAnimation¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶

Constant	Description
QAbstractAnimation.Forward	The current time of the animation increases with time (i.e., moves from 0 and towards the end / duration).
QAbstractAnimation.Backward	The current time of the animation decreases with time (i.e., moves from the end / duration and towards 0).

Constant	Description
QAbstractAnimation.Stopped	The animation is not running. This is the initial state of `QAbstractAnimation` , and the state `QAbstractAnimation` reenters when finished. The current time remain unchanged until either `setCurrentTime()` is called, or the animation is started by calling `start()` .
QAbstractAnimation.Paused	The animation is paused (i.e., temporarily suspended). Calling `resume()` will resume animation activity.
QAbstractAnimation.Running	The animation is running. While control is in the event loop, `QAbstractAnimation` will update its current time at regular intervals, calling `updateCurrentTime()` when appropriate.