QAbstractAnimation Class

Member Function Documentation

QAbstractAnimation::QAbstractAnimation(QObject *parent = Q_NULLPTR)

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

See also QVariantAnimation and QAnimationGroup.

[virtual] QAbstractAnimation::~QAbstractAnimation()

Stops the animation if it's running, then destroys the QAbstractAnimation. If the animation is part of a QAnimationGroup, it is automatically removed before it's destroyed.

[signal] void QAbstractAnimation::currentLoopChanged(int currentLoop)

QAbstractAnimation emits this signal whenever the current loop changes. currentLoop is the current loop.

Note: Notifier signal for property currentLoop.

See also currentLoop() and loopCount().

int QAbstractAnimation::currentLoopTime() const

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

See also duration() and currentTime.

[signal] void QAbstractAnimation::directionChanged(QAbstractAnimation::Direction newDirection)

QAbstractAnimation emits this signal whenever the direction has been changed. newDirection is the new direction.

Note: Notifier signal for property direction.

See also direction.

[pure virtual] int QAbstractAnimation::duration() const

This pure virtual function returns the duration of the animation, and defines for how long QAbstractAnimation should update the current time. This duration is local, and does not include the loop count.

A return value of -1 indicates that the animation has no defined duration; the animation should run forever until stopped. This is useful for animations that are not time driven, or where you cannot easily predict its duration (e.g., event driven audio playback in a game).

If the animation is a parallel QAnimationGroup, the duration will be the longest duration of all its animations. If the animation is a sequential QAnimationGroup, the duration will be the sum of the duration of all its animations.

Note: Getter function for property duration.

See also loopCount.

[virtual protected] bool QAbstractAnimation::event(QEvent *event)

Reimplemented from QObject::event().

[signal] void QAbstractAnimation::finished()

QAbstractAnimation emits this signal after the animation has stopped and has reached the end.

This signal is emitted after stateChanged().

See also stateChanged().

QAnimationGroup *QAbstractAnimation::group() const

If this animation is part of a QAnimationGroup, this function returns a pointer to the group; otherwise, it returns 0.

See also QAnimationGroup::addAnimation().

[slot] void QAbstractAnimation::pause()

Pauses the animation. When the animation is paused, state() returns Paused. The value of currentTime will remain unchanged until resume() or start() is called. If you want to continue from the current time, call resume().

See also start(), state(), and resume().

[slot] void QAbstractAnimation::resume()

Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and stateChanged() signals. The currenttime is not changed.

See also start(), pause(), and state().

[slot] void QAbstractAnimation::setPaused(bool paused)

If paused is true, the animation is paused. If paused is false, the animation is resumed.

See also state(), pause(), and resume().

[slot] void QAbstractAnimation::start(QAbstractAnimation::DeletionPolicy policy = KeepWhenStopped)

Starts the animation. The policy argument says whether or not the animation should be deleted when it's done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.

If the animation is currently stopped or has already reached the end, calling start() will rewind the animation and start again from the beginning. When the animation reaches the end, the animation will either stop, or if the loop level is more than 1, it will rewind and continue from the beginning.

If the animation is already running, this function does nothing.

See also stop() and state().

[signal] void QAbstractAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

QAbstractAnimation emits this signal whenever the state of the animation has changed from oldState to newState. This signal is emitted after the virtual updateState() function is called.

Note: Notifier signal for property state.

See also updateState().

[slot] void QAbstractAnimation::stop()

Stops the animation. When the animation is stopped, it emits the stateChanged() signal, and state() returns Stopped. The current time is not changed.

If the animation stops by itself after reaching the end (i.e., currentLoopTime() == duration() and currentLoop() > loopCount() - 1), the finished() signal is emitted.

See also start() and state().

int QAbstractAnimation::totalDuration() const

Returns the total and effective duration of the animation, including the loop count.

See also duration() and currentTime.

[pure virtual protected] void QAbstractAnimation::updateCurrentTime(int currentTime)

This pure virtual function is called every time the animation's currentTime changes.

See also updateState().

[virtual protected] void QAbstractAnimation::updateDirection(QAbstractAnimation::Direction direction)

This virtual function is called by QAbstractAnimation when the direction of the animation is changed. The direction argument is the new direction.

See also setDirection() and direction().

[virtual protected] void QAbstractAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

This virtual function is called by QAbstractAnimation when the state of the animation is changed from oldState to newState.

See also start(), stop(), pause(), and resume().