QAbstractAnimation¶
- PyQt5.QtCore.QAbstractAnimation
Inherits from QObject.
Inherited by QAnimationGroup, QPauseAnimation, QVariantAnimation.
Description¶
The QAbstractAnimation class is the base of all animations.
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 currentTime() 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.
Enums¶
- DeletionPolicy
TODO
Member
Value
Description
DeleteWhenStopped TODO
TODO
KeepWhenStopped TODO
TODO
- Direction
This enum describes the direction of the animation when in Running state.
See also
Member
Value
Description
Backward 1
The current time of the animation decreases with time (i.e., moves from the end / duration and towards 0).
Forward 0
The current time of the animation increases with time (i.e., moves from 0 and towards the end / duration).
- State
TODO
Member
Value
Description
Paused TODO
TODO
Running TODO
TODO
Stopped TODO
TODO
Methods¶
- __init__(parent: QObject = None)
TODO
- currentLoop() → int
TODO
- currentLoopTime() → int
TODO
- currentTime() → int
See also
- direction() → Direction
See also
- duration() → int
TODO
- event(QEvent) → bool
TODO
- group() → QAnimationGroup
TODO
- loopCount() → int
See also
- pause()
TODO
- resume()
TODO
- setCurrentTime(int)
See also
- setDirection(Direction)
See also
- setLoopCount(int)
See also
- setPaused(bool)
TODO
- start(policy: DeletionPolicy = KeepWhenStopped)
TODO
- state() → State
TODO
- stop()
TODO
- totalDuration() → int
TODO
- updateCurrentTime(int)
TODO
- updateDirection(Direction)
TODO
