Класс QAbstractAnimation

Класс QAbstractAnimation является базой для всех анимаций. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Свойства

Открытые функции

Открытые слоты

Сигналы

Защищенные функции

Переопределенные защищенные функции

Подробное описание

Этот класс определяет функции, общие для всех анимаций. Наследуя этот класс, вы можете создавать пользовательские анимации, которые подключаются к остальной части фреймворка анимации.

Прогресс анимации определяется текущим временем (currentLoopTime()), которое измеряется в миллисекундах от начала анимации (0) до её конца (duration()). Значение обновляется автоматически во время выполнения анимации. Его также можно задать напрямую с помощью setCurrentTime().

В любой момент анимация находится в одном из трёх состояний: Запущен, Остановлен или Приостановлен — как определено в перечислении State. Текущее состояние можно изменить, вызвав start(), stop(), pause() или resume(). Анимация всегда сбрасывает текущее время при запуске. Если приостановлена, она продолжит с тем же текущим временем при возобновлении. Когда анимация остановлена, её нельзя возобновить, но она сохранит своё текущее время (пока не будет запущена снова). QAbstractAnimation будет излучать stateChanged() всякий раз, когда её состояние изменится.

Анимация может повторяться любое количество раз, установив свойство loopCount. Когда текущее время анимации достигает duration(), она сбрасывает текущее время и продолжает работать. Значение loopCount 1 (значение по умолчанию) означает, что анимация будет выполнена один раз. Обратите внимание, что duration -1 означает, что анимация будет выполняться до остановки; текущее время будет неограниченно увеличиваться. Когда текущее время равно duration() и анимация находится в последнем цикле, вводится состояние Остановлен, и излучается сигнал finished().

QAbstractAnimation предоставляет чистые виртуальные функции, используемые подклассами для отслеживания прогресса анимации: duration() и updateCurrentTime(). Функция duration() позволяет сообщить продолжительность анимации (как описано выше). Фреймворк анимации вызывает updateCurrentTime() при изменении текущего времени. Переопределив эту функцию, вы можете отслеживать прогресс анимации. Обратите внимание, что интервал между вызовами или количество вызовов этой функции не определены; однако обычно это 60 обновлений в секунду.

Переопределив updateState(), вы можете отслеживать изменения состояния анимации, что особенно полезно для анимаций, которые не управляются временем.

См. также QVariantAnimation, QPropertyAnimation, QAnimationGroup и Фреймворк анимации.

Документация типов членов

enum QAbstractAnimation::DeletionPolicy

enum QAbstractAnimation::Direction

Этот перечисление описывает направление анимации, когда она находится в состоянии Running.

См. также direction.

enum QAbstractAnimation::State

Этот перечисление описывает состояние анимации.

См. также state() и stateChanged().

Документация функций-членов

QAbstractAnimation::QAbstractAnimation(QObject *parent = nullptr)

Конструктор базового класса QAbstractAnimation, передавая parent в конструктор QObject.

См. также QVariantAnimation и QAnimationGroup.

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

QAbstractAnimation излучает этот сигнал всякий раз, когда текущая итерация меняется. currentLoop — текущая итерация.

Примечание: Сигнал уведомления для свойства currentLoop.

См. также currentLoop() и loopCount().

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

QAbstractAnimation излучает этот сигнал всякий раз, когда направление было изменено. newDirection — новое направление.

Примечание: Сигнал уведомления для свойства direction.

См. также direction.

[signal] void QAbstractAnimation::finished()

QAbstractAnimation испускает этот сигнал после того, как анимация остановилась и достигла конца.

Этот сигнал испускается после stateChanged().

См. также stateChanged().

[slot] void QAbstractAnimation::pause()

Приостанавливает анимацию. Когда анимация приостановлена, state() возвращает Paused. Значение currentTime останется неизменным до тех пор, пока не будет вызван resume() или start(). Если вы хотите продолжить с текущего времени, вызовите resume().

См. также start(), state() и resume().

[slot] void QAbstractAnimation::resume()

Возобновляет анимацию после её приостановки. Когда анимация возобновляется, она испускает сигналы resumed() и stateChanged(). Текущее время не меняется.

См. также start(), pause() и state().

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

Если paused равно true, анимация приостанавливается. Если paused равно false, анимация возобновляется.

См. также state(), pause() и resume().

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

Запускает анимацию. Аргумент policy указывает, следует ли удалять анимацию по завершении. При запуске анимации испускается сигнал stateChanged(), а state() возвращает Running. Когда управление достигает цикла событий, анимация выполняется сама по себе, периодически вызывая updateCurrentTime() по мере её выполнения.

Если анимация в настоящее время остановлена или уже достигла конца, вызов start() перемотает анимацию и начнёт её с начала. Когда анимация достигает конца, она либо останавливается, либо, если уровень цикла больше 1, перематывается и продолжается с начала.

Если анимация уже запущена, эта функция ничего не делает.

См. также stop() и state().

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

QAbstractAnimation испускает этот сигнал всякий раз, когда состояние анимации изменяется с oldState на newState. Этот сигнал испускается после вызова виртуальной функции updateState().

Примечание: Сигнал-уведомление для свойства state.

См. также updateState().

[slot] void QAbstractAnimation::stop()

Останавливает анимацию. Когда анимация останавливается, испускается сигнал stateChanged(), а state() возвращает Stopped. Текущее время не меняется.

Если анимация останавливается сама по себе после достижения конца (т. е. currentLoopTime() == duration() и currentLoop() > loopCount() - 1), испускается сигнал finished().

См. также start() и state().

[virtual] QAbstractAnimation::~QAbstractAnimation()

Останавливает анимацию, если она запущена, затем уничтожает QAbstractAnimation. Если анимация является частью QAnimationGroup, она автоматически удаляется перед уничтожением.

int QAbstractAnimation::currentLoopTime() const

Возвращает текущее время внутри текущего цикла. Может принимать значения от 0 до duration().

См. также duration() и currentTime.

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

Эта чисто виртуальная функция возвращает продолжительность анимации и определяет, как долго QAbstractAnimation должен обновлять текущее время. Эта продолжительность локальна и не включает счётчик циклов.

Возвращаемое значение -1 указывает, что у анимации нет определённой продолжительности; анимация должна работать вечно до её остановки. Это полезно для анимаций, которые не зависят от времени, или когда трудно предсказать её продолжительность (например, управляемое событиями аудиовоспроизведение в игре).

Если анимация является параллельной QAnimationGroup, продолжительность будет максимальной продолжительностью всех её анимаций. Если анимация является последовательной QAnimationGroup, продолжительность будет суммой продолжительности всех её анимаций.

Примечание: Функция-геттер для свойства duration.

См. также loopCount.

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

Переопределяет: QObject::event(QEvent *e).

QAnimationGroup *QAbstractAnimation::group() const

Если эта анимация является частью QAnimationGroup, эта функция возвращает указатель на группу; в противном случае возвращает nullptr.

См. также QAnimationGroup::addAnimation().

int QAbstractAnimation::totalDuration() const

Возвращает общую и эффективную продолжительность анимации, включая счётчик циклов.

См. также duration() и currentTime.

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

Эта чисто виртуальная функция вызывается каждый раз, когда изменяется currentTime анимации.

См. также updateState().

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

Эта виртуальная функция вызывается QAbstractAnimation, когда меняется направление анимации. Аргумент direction — новое направление.

См. также setDirection() и direction().

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

Эта виртуальная функция вызывается QAbstractAnimation, когда состояние анимации изменяется с oldState на newState.

См. также start(), stop(), pause() и resume().