Класс QTimeLine

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

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

Типы

Свойства

• 1 свойство унаследовано от QObject

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

• 32 открытых функции унаследованы от QObject

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

• 1 public slot inherited from QObject

Сигналы

• 2 signals inherited from QObject

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

• 9 protected functions inherited from QObject

Дополнительные унаследованные члены

• 11 static public members inherited from QObject
• 9 protected functions inherited from QObject

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

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

Он чаще всего используется для анимации элемента графического интерфейса, вызывая слот периодически. Вы можете создать временную шкалу, передав её продолжительность в миллисекундах в конструктор QTimeLine. Продолжительность временной шкалы определяет, как долго будет выполняться анимация. Затем вы задаёте подходящий диапазон кадров, вызвав setFrameRange(). Наконец, подключите сигнал frameChanged() к соответствующему слоту в виджете, который вы хотите анимировать (например, setValue() в QProgressBar). Когда вы вызовете start(), QTimeLine перейдет в состояние «Запуск» и начнёт излучать frameChanged() с регулярными интервалами, заставляя значение подключенного свойства вашего виджета увеличиваться от нижнего до верхнего предела диапазона кадров с постоянной скоростью. Вы можете указать интервал обновления, вызвав setUpdateInterval(). Когда работа завершена, QTimeLine переходит в состояние НеЗапущен и излучает 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, SIGNAL(frameChanged(int)), progressBar, SLOT(setValue(int)));

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

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

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

Обратите внимание, что по умолчанию QTimeLine использует форму кривой EaseInOut, которая обеспечивает значение, медленно возрастающее, затем увеличивающееся равномерно и, наконец, медленно возрастающее. Для пользовательского таймлайна можно переопределить valueForTime(), в этом случае свойство QTimeLine's curveShape игнорируется.

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

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

enum QTimeLine::CurveShape

Этот перечисление описывает форму кривой значений QTimeLine по умолчанию. Значение по умолчанию — EaseInOutCurve. Кривая определяет взаимосвязь между значением и таймлайном.

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

enum QTimeLine::Direction

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

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

enum QTimeLine::State

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

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

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

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

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

[virtual] QTimeLine::~QTimeLine()

Уничтожает временную шкалу.

int QTimeLine::currentFrame() const

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

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

qreal QTimeLine::currentValue() const

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

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

int QTimeLine::endFrame() const

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

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

[signal] void QTimeLine::finished()

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

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

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

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

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

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

int QTimeLine::frameForTime(int msec) const

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

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

[slot] void QTimeLine::resume()

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

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

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

void QTimeLine::setEndFrame(int frame)

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

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

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

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

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

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

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

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

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

void QTimeLine::setStartFrame(int frame)

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

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

[slot] void QTimeLine::start()

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

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

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

int QTimeLine::startFrame() const

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

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

QTimeLine::State QTimeLine::state() const

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

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

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

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

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

[slot] void QTimeLine::stop()

Останавливает таймлайн, переводя QTimeLine в состояние NotRunning.

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

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

Переопределён из QObject::timerEvent().

[slot] void QTimeLine::toggleDirection()

Переключает направление таймлайна. Если направление было Forward, оно станет Backward, и наоборот.

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

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

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

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

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

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

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

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

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