Класс QAbstractAnimation

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

Этот класс был представлен в Qt 4.6.

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

Типы Public

Свойства

Функции Public

Слот Public

Сигналы

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

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

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

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

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

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

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

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

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

См. также QVariantAnimation, QPropertyAnimation, QAnimationGroup и The Animation Framework.

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

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)

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

См. также 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().