QAbstractAnimation¶
Synopsis¶
Functions¶
| def currentLoop () |
| def currentLoopChanged (currentLoop) |
| def currentLoopTime () |
| def currentTime () |
| def direction () |
| def directionChanged (arg__1) |
| def duration () |
| def finished () |
| def group () |
| def loopCount () |
| def operator= (arg__1) |
| def pause () |
| def resume () |
| def setCurrentTime (msecs) |
| def setDirection (direction) |
| def setLoopCount (loopCount) |
| def setPaused (arg__1) |
| def start ([policy=KeepWhenStopped]) |
| def state () |
| def stateChanged (newState,oldState) |
| def stop () |
| def totalDuration () |
| def updateCurrentTime (currentTime) |
| def updateDirection (direction) |
| def updateState (newState,oldState) |
Detailed 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 ( QAbstractAnimation.currentLoopTime() ), which is measured in milliseconds from the start of the animation (0) to its end ( QAbstractAnimation.duration() ). The value is updated automatically while the animation is running. It can also be set directly with QAbstractAnimation.setCurrentTime() .
At any point an animation is in one of three states: Running , Stopped , or Paused –as defined by the QAbstractAnimation.State enum. The current state can be changed by calling QAbstractAnimation.start() , QAbstractAnimation.stop() , QAbstractAnimation.pause() , or QAbstractAnimation.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 QAbstractAnimation.stateChanged() whenever its state changes.
An animation can loop any number of times by setting the QAbstractAnimation.loopCount() property. When an animation’s current time reaches its QAbstractAnimation.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 QAbstractAnimation.duration() and the animation is in its final loop, the Stopped state is entered, and the QAbstractAnimation.finished() signal is emitted.
QAbstractAnimation provides pure virtual functions used by subclasses to track the progress of the animation: QAbstractAnimation.duration() and QAbstractAnimation.updateCurrentTime() . The QAbstractAnimation.duration() function lets you report a duration for the animation (as discussed above). The animation framework calls QAbstractAnimation.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 QAbstractAnimation.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 PySide.QtCore.QAbstractAnimation([parent=0])¶
Parameter: parent – QObject Constructs the QAbstractAnimation base class, and passes parent to QObject ‘s constructor.
See also
- 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
- QAbstractAnimation.DeletionPolicy¶
Constant Description QAbstractAnimation.KeepWhenStopped The animation will not be deleted when stopped. QAbstractAnimation.DeleteWhenStopped The animation will be automatically deleted when stopped.
- 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 QAbstractAnimation.setCurrentTime() is called, or the animation is started by calling QAbstractAnimation.start() . QAbstractAnimation.Paused The animation is paused (i.e., temporarily suspended). Calling QAbstractAnimation.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 QAbstractAnimation.updateCurrentTime() when appropriate.
- 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 QAbstractAnimation.currentLoopChanged() signal.
- QAbstractAnimation.currentLoopChanged(currentLoop)¶
Parameter: currentLoop – int
- QAbstractAnimation.currentLoopTime()¶
Return type: int Returns the current time inside the current loop. It can go from 0 to QAbstractAnimation.duration() .
- 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 setCurrentTime, or you can call QAbstractAnimation.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 QAbstractAnimation.totalDuration() .
- QAbstractAnimation.direction()¶
Return type: Direction This property holds the direction of the animation when it is in Running state..
This direction indicates whether the time moves from 0 towards the animation duration, or from the value of the duration and towards 0 after QAbstractAnimation.start() has been called.
By default, this property is set to Forward .
- QAbstractAnimation.directionChanged(arg__1)¶
Parameter: arg__1 – Direction
- QAbstractAnimation.duration()¶
Return type: int This property holds the duration of the animation..
If the duration is -1, it means that the duration is undefined. In this case, QAbstractAnimation.loopCount() is ignored.
- QAbstractAnimation.finished()¶
- QAbstractAnimation.group()¶
Return type: QAnimationGroup If this animation is part of a QAnimationGroup , this function returns a pointer to the group; otherwise, it returns 0.
See also
- QAbstractAnimation.loopCount()¶
Return type: int This property holds the loop count of the animation.
This property describes the loop count of the animation as an integer. By default this value is 1, indicating that the animation should run once only, and then stop. By changing it you can let the animation loop several times. With a value of 0, the animation will not run at all, and with a value of -1, the animation will loop forever until stopped. It is not supported to have loop on an animation that has an undefined duration. It will only run once.
- QAbstractAnimation.operator=(arg__1)
Parameter: arg__1 – QAbstractAnimation Return type: QAbstractAnimation
- QAbstractAnimation.pause()¶
Pauses the animation. When the animation is paused, QAbstractAnimation.state() returns Paused. The value of QAbstractAnimation.currentTime() will remain unchanged until QAbstractAnimation.resume() or QAbstractAnimation.start() is called. If you want to continue from the current time, call QAbstractAnimation.resume() .
- QAbstractAnimation.resume()¶
Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and QAbstractAnimation.stateChanged() signals. The currenttime is not changed.
- QAbstractAnimation.setCurrentTime(msecs)¶
Parameter: msecs – 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 setCurrentTime, or you can call QAbstractAnimation.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 QAbstractAnimation.totalDuration() .
- QAbstractAnimation.setDirection(direction)¶
Parameter: direction – Direction This property holds the direction of the animation when it is in Running state..
This direction indicates whether the time moves from 0 towards the animation duration, or from the value of the duration and towards 0 after QAbstractAnimation.start() has been called.
By default, this property is set to Forward .
- QAbstractAnimation.setLoopCount(loopCount)¶
Parameter: loopCount – int This property holds the loop count of the animation.
This property describes the loop count of the animation as an integer. By default this value is 1, indicating that the animation should run once only, and then stop. By changing it you can let the animation loop several times. With a value of 0, the animation will not run at all, and with a value of -1, the animation will loop forever until stopped. It is not supported to have loop on an animation that has an undefined duration. It will only run once.
- QAbstractAnimation.setPaused(arg__1)¶
Parameter: arg__1 – bool If paused is true, the animation is paused. If paused is false, the animation is resumed.
- QAbstractAnimation.start([policy=KeepWhenStopped])¶
Parameter: policy – DeletionPolicy
- QAbstractAnimation.state()¶
Return type: State This property holds state of the animation..
This property describes the current state of the animation. When the animation state changes, QAbstractAnimation emits the QAbstractAnimation.stateChanged() signal.
- QAbstractAnimation.stateChanged(newState, oldState)¶
Parameters: - newState – State
- oldState – State
- QAbstractAnimation.stop()¶
Stops the animation. When the animation is stopped, it emits the QAbstractAnimation.stateChanged() signal, and QAbstractAnimation.state() returns Stopped. The current time is not changed.
If the animation stops by itself after reaching the end (i.e., QAbstractAnimation.currentLoopTime() == QAbstractAnimation.duration() and QAbstractAnimation.currentLoop() > QAbstractAnimation.loopCount() - 1), the QAbstractAnimation.finished() signal is emitted.
- QAbstractAnimation.totalDuration()¶
Return type: int Returns the total and effective duration of the animation, including the loop count.
- QAbstractAnimation.updateCurrentTime(currentTime)¶
Parameter: currentTime – int This pure virtual function is called every time the animation’s currentTime changes.
See also
- QAbstractAnimation.updateDirection(direction)¶
Parameter: direction – Direction
- QAbstractAnimation.updateState(newState, oldState)¶
Parameters: - newState – State
- oldState – State
