Класс QTimeLine

Класс QTimeLine предоставляет временную шкалу для управления анимациями. Подробнее...

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

Типы

Свойства

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

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

Сигналы

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

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

Чаще всего используется для анимации элемента графического интерфейса, вызывая слот периодически. Вы можете создать таймлайн, передав его длительность в миллисекундах в конструктор QTimeLine. Длительность таймлайна определяет, как долго будет выполняться анимация. Затем вы устанавливаете подходящий диапазон кадров, вызывая setFrameRange(). Наконец, подключите сигнал frameChanged() к подходящему слоту в виджете, который вы хотите анимировать (например, setValue() в QProgressBar). Когда вы вызовете start(), QTimeLine перейдет в состояние Running и начнет излучать frameChanged() с регулярными интервалами, заставляя значение подключенного свойства вашего виджета расти от нижней границы до верхней границы диапазона кадров с постоянной скоростью. Вы можете указать интервал обновления, вызвав setUpdateInterval(). По окончании QTimeLine переходит в состояние NotRunning и излучает finished().

Пример:

...
progressBar = new QProgressBar(this);
progressBar->setRange(0, 100);

// Construct a 1-second timeline with a frame range of 0 - 100
QTimeLine *timeLine = new QTimeLine(1000, this);
timeLine->setFrameRange(0, 100);
connect(timeLine, &QTimeLine::frameChanged, progressBar, &QProgressBar::setValue);

// Clicking the push button will start the progress bar animation
pushButton = new QPushButton(tr("Start animation"), this);
connect(pushButton, &QPushButton::clicked, timeLine, &QTimeLine::start);
...

По умолчанию таймлайн выполняется один раз, от начала до конца, после чего необходимо снова вызвать start() для перезапуска с начала. Чтобы зациклить таймлайн, можно вызвать setLoopCount(), передав количество раз, которое таймлайн должен выполняться перед завершением. Направление также можно изменить, заставив таймлайн выполняться в обратном направлении, вызвав setDirection(). Вы также можете приостановить и возобновить таймлайн во время его выполнения, вызвав setPaused(). Для интерактивного управления предоставляется функция setCurrentTime(), которая устанавливает позицию времени таймлайна напрямую. Хотя она наиболее полезна в состоянии NotRunning (например, подключена к сигналу valueChanged() в QSlider), эту функцию можно вызвать в любое время.

Интерфейс кадров полезен для стандартных виджетов, но QTimeLine можно использовать для управления любым типом анимации. Сердцевина QTimeLine заключается в функции valueForTime(), которая генерирует значение от 0 до 1 для заданного времени. Это значение обычно используется для описания этапов анимации, где 0 — первый этап анимации, а 1 — последний этап. Во время выполнения QTimeLine генерирует значения между 0 и 1, вызывая valueForTime() и излучая valueChanged(). По умолчанию valueForTime() применяет алгоритм интерполяции для генерации этих значений. Вы можете выбрать набор предопределенных алгоритмов таймлайна, вызвав setEasingCurve().

Обратите внимание, что по умолчанию QTimeLine использует QEasingCurve::InOutSine, которая обеспечивает значение, медленно увеличивающееся, затем увеличивающееся равномерно и, наконец, медленно увеличивающееся. Для пользовательской временной шкалы вы можете переопределить valueForTime(), в этом случае свойство easingCurve QTimeLine игнорируется.

См. также QProgressBar и QProgressDialog.

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

перечисление QTimeLine::Direction

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

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

перечисление QTimeLine::State

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

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

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

QTimeLine::QTimeLine(int duration = 1000, QObject *parent = nullptr)

Создаёт временную шкалу с длительностью duration миллисекунд. parent передаётся в конструктор QObject. По умолчанию длительность составляет 1000 миллисекунд.

[private signal] void QTimeLine::finished()

Этот сигнал излучается, когда QTimeLine завершается (т.е. достигает конца своей временной шкалы) и не циклически повторяется.

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

[private signal] void QTimeLine::frameChanged(int frame)

QTimeLine излучает этот сигнал с регулярными интервалами, когда находится в состоянии Running, но только если текущий кадр меняется. frame — текущий номер кадра.

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

См. также QTimeLine::setFrameRange() и QTimeLine::updateInterval.

[slot] void QTimeLine::resume()

Возобновляет временную шкалу с текущего времени. QTimeLine переходит в состояние Running, и, как только оно входит в цикл событий, оно обновляет текущее время, кадр и значение с регулярными интервалами.

В отличие от start(), эта функция не перезапускает временную шкалу перед возобновлением.

См. также start(), updateInterval(), frameChanged() и valueChanged().

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

Если paused равно true, временная шкала приостанавливается, вызывая переход QTimeLine в состояние Paused. Обновления не будут сигнализироваться до тех пор, пока не будет вызван start() или setPaused(false). Если paused равно false, временная шкала возобновляется и продолжает работу с того места, где она остановилась.

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

[slot] void QTimeLine::start()

Запускает временную шкалу. QTimeLine переходит в состояние Running, и, как только она входит в цикл событий, она обновляет текущее время, кадр и значение с регулярными интервалами. По умолчанию интервал составляет 40 мс (т.е. 25 раз в секунду). Вы можете изменить интервал обновления, вызвав setUpdateInterval().

Временная шкала начнется с позиции 0 или с конца, если направление обратное. Если вы хотите возобновить остановленную временную шкалу без перезапуска, вы можете вызвать resume() вместо этого.

См. также resume(), updateInterval(), frameChanged() и valueChanged().

[private signal] void QTimeLine::stateChanged(QTimeLine::State newState)

Этот сигнал излучается всякий раз, когда состояние QTimeLine меняется. Новое состояние равно newState.

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может излучаться пользователем.

[slot] void QTimeLine::stop()

Останавливает временную шкалу, переведя QTimeLine в состояние NotRunning.

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

[slot] void QTimeLine::toggleDirection()

Переключает направление таймлайна. Если направление было Вперёд, оно становится Назад, и наоборот.

Существующие привязки свойства direction удаляются.

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

[private signal] void QTimeLine::valueChanged(qreal value)

QTimeLine испускает этот сигнал через равные промежутки времени, когда находится в состоянии Running, но только если текущее значение изменяется. value — текущее значение. value — число от 0.0 до 1.0

Примечание: Это частный сигнал. Он может использоваться в соединениях сигналов, но не может испускаться пользователем.

См. также QTimeLine::setDuration(), QTimeLine::valueForTime() и QTimeLine::updateInterval.

[virtual] QTimeLine::~QTimeLine()

Уничтожает таймлайн.

int QTimeLine::currentFrame() const

Возвращает кадр, соответствующий текущему времени.

См. также currentTime(), frameForTime() и setFrameRange().

qreal QTimeLine::currentValue() const

Возвращает значение, соответствующее текущему времени.

См. также valueForTime() и currentFrame().

int QTimeLine::endFrame() const

Возвращает конечный кадр, который соответствует концу таймлайна (т.е., кадру, для которого текущее значение равно 1).

См. также setEndFrame() и setFrameRange().

int QTimeLine::frameForTime(int msec) const

Возвращает кадр, соответствующий времени msec. Это значение вычисляется с помощью линейной интерполяции начального и конечного кадров, основанной на значении, возвращаемом valueForTime().

См. также valueForTime() и setFrameRange().

void QTimeLine::setEndFrame(int frame)

Устанавливает конечный кадр, который соответствует концу таймлайна (т.е., кадру, для которого текущее значение равно 1), в frame.

См. также endFrame(), startFrame() и setFrameRange().

void QTimeLine::setFrameRange(int startFrame, int endFrame)

Устанавливает счётчик кадров таймлайна, начиная с startFrame и заканчивая endFrame. Для каждого значения времени QTimeLine найдёт соответствующий кадр при вызове currentFrame() или frameForTime() путём интерполяции, используя возвращаемое значение valueForTime().

Когда находится в состоянии Running, QTimeLine также испускает сигнал frameChanged() при изменении кадра.

См. также startFrame(), endFrame(), start() и currentFrame().

void QTimeLine::setStartFrame(int frame)

Устанавливает начальный кадр, который соответствует началу таймлайна (т.е., кадру, для которого текущее значение равно 0), в frame.

См. также startFrame(), endFrame() и setFrameRange().

int QTimeLine::startFrame() const

Возвращает начальный кадр, который соответствует началу таймлайна (т.е., кадру, для которого текущее значение равно 0).

См. также setStartFrame() и setFrameRange().

QTimeLine::State QTimeLine::state() const

Возвращает состояние таймлайна.

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

[override virtual protected] void QTimeLine::timerEvent(QTimerEvent *event)

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

[virtual] qreal QTimeLine::valueForTime(int msec) const

Возвращает значение таймлайна для времени msec. Возвращаемое значение, зависящее от формы кривой, всегда находится в диапазоне от 0 до 1. Если msec равно 0, реализация по умолчанию всегда возвращает 0.

Переопределите эту функцию, чтобы задать пользовательскую форму кривой для вашего таймлайна.

См. также easingCurve и frameForTime().