Spec-Zone.ru › Qt

Класс QVariantAnimation

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

Заголовок: #include <QVariantAnimation>
CMake: find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
Наследует: QAbstractAnimation
Наследуется от:

QPropertyAnimation

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

Типы публичного доступа

KeyValue
KeyValues

Свойства

  • currentValue : const QVariant
  • duration : int
  • easingCurve : QEasingCurve
  • endValue : QVariant
  • startValue : QVariant

Функции публичного доступа

QVariantAnimation(QObject *parent = nullptr)
virtual ~QVariantAnimation()
QVariant currentValue() const
QEasingCurve easingCurve() const
QVariant endValue() const
QVariant keyValueAt(qreal step) const
QVariantAnimation::KeyValues keyValues() const
void setDuration(int msecs)
void setEasingCurve(const QEasingCurve &easing)
void setEndValue(const QVariant &value)
void setKeyValueAt(qreal step, const QVariant &value)
void setKeyValues(const QVariantAnimation::KeyValues &keyValues)
void setStartValue(const QVariant &value)
QVariant startValue() const

Переопределённые функции публичного доступа

virtual int duration() const override

Сигналы

void valueChanged(const QVariant &value)

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

virtual QVariant interpolated(const QVariant &from, const QVariant &to, qreal progress) const
virtual void updateCurrentValue(const QVariant &value)

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

virtual bool event(QEvent *event) override
virtual void updateCurrentTime(int) override
virtual void updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) override

Связанные нечлены

void qRegisterAnimationInterpolator(QVariant (*)(const T &, const T &, qreal) func)

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

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

Класс выполняет интерполяцию над QVariant, но оставляет использование интерполированных значений своим подклассам. В настоящее время Qt предоставляет QPropertyAnimation, который анимирует Qt свойства. Обратитесь к описанию класса QPropertyAnimation, если вы хотите анимировать такие свойства.

Затем вы можете установить начальные и конечные значения для свойства, вызвав setStartValue() и setEndValue(), и, наконец, вызвать start() для запуска анимации. QVariantAnimation будет интерполировать свойство целевого объекта и излучать valueChanged(). Для реакции на изменение текущего значения необходимо переопределить виртуальную функцию updateCurrentValue() или подключиться к указанному сигналу.

Также можно установить значения в указанные шаги, расположенные между начальным и конечным значением. Интерполяция затем коснётся этих точек в указанных шагах. Обратите внимание, что начальные и конечные значения определяются как ключевые значения в 0,0 и 1,0.

Существует два способа повлиять на то, как QVariantAnimation интерполирует значения. Вы можете установить кривую сглаживания, вызвав setEasingCurve(), и настроить продолжительность, вызвав setDuration(). Вы можете изменить то, как QVariant интерполируются, создав подкласс QVariantAnimation и переопределив виртуальную функцию interpolated().

Наследование от QVariantAnimation может быть альтернативой, если у вас есть QVariant, которые вы не хотите объявлять как свойства Qt. Обратите внимание, однако, что в большинстве случаев вы будете лучше объявлять ваши QVariant как свойство.

Не все типы QVariant поддерживаются. Ниже приведён список поддерживаемых в настоящее время типов QVariant:

  • Int
  • UInt
  • Double
  • Float
  • QLine
  • QLineF
  • QPoint
  • QPointF
  • QSize
  • QSizeF
  • QRect
  • QRectF
  • QColor

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

Пример:

    QVariant myColorInterpolator(const QColor &start, const QColor &end, qreal progress)
    {
        ...
        return QColor(...);
    }
    ...
    qRegisterAnimationInterpolator<QColor>(myColorInterpolator);

Другой вариант — переопределить interpolated(), который возвращает значения интерполяции для интерполируемого значения.

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

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

QVariantAnimation::KeyValue

Это псевдоним для QPair<qreal, QVariant>.

QVariantAnimation::KeyValues

Это псевдоним для QList<KeyValue>

Документация свойств

[read-only] currentValue : const QVariant

Это свойство содержит текущее значение анимации.

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

QVariantAnimation вызывает виртуальную функцию updateCurrentValue() при изменении текущего значения. Это особенно полезно для подклассов, которым нужно отслеживать обновления. Например, QPropertyAnimation использует эту функцию для анимации свойств Qt properties.

Функции доступа:

QVariant currentValue() const

Сигнал уведомления:

void valueChanged(const QVariant &value)

См. также startValue и endValue.

[bindable] duration : int

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство содержит длительность анимации

Это свойство описывает длительность анимации в миллисекундах. По умолчанию длительность составляет 250 миллисекунд.

См. также QAbstractAnimation::duration().

[bindable] easingCurve : QEasingCurve

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство содержит кривую сглаживания анимации

Это свойство определяет кривую сглаживания анимации. По умолчанию используется линейная кривая сглаживания, что приводит к линейной интерполяции. Предлагаются и другие кривые, например, QEasingCurve::InCirc, которая обеспечивает кривую входа по окружности. Другой пример — QEasingCurve::InOutElastic, которая обеспечивает эффекты упругости для значений интерполированного значения.

QVariantAnimation будет использовать QEasingCurve::valueForProgress() для преобразования «нормализованного прогресса» (currentTime / totalDuration) анимации в эффективный прогресс, фактически используемый анимацией. Именно этот эффективный прогресс будет прогрессом при вызове interpolated(). Также этапы в keyValues относятся к этому эффективному прогрессу.

Кривая сглаживания используется с интерполятором, виртуальной функцией interpolated() и длительностью анимации для управления изменением текущего значения по мере продвижения анимации.

endValue : QVariant

Это свойство содержит конечное значение анимации

Это свойство описывает конечное значение анимации.

Функции доступа:

QVariant endValue() const
void setEndValue(const QVariant &value)

См. также startValue.

startValue : QVariant

Это свойство содержит необязательное начальное значение анимации

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

Функции доступа:

QVariant startValue() const
void setStartValue(const QVariant &value)

См. также endValue.

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

QVariantAnimation::QVariantAnimation(QObject *parent = nullptr)

Создаёт объект QVariantAnimation. parent передаётся в конструктор QAbstractAnimation.

[signal] void QVariantAnimation::valueChanged(const QVariant &value)

QVariantAnimation излучает этот сигнал всякий раз, когда меняется текущее значение value.

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

См. также currentValue, startValue и endValue.

[virtual] QVariantAnimation::~QVariantAnimation()

Уничтожает анимацию.

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

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

[virtual protected] QVariant QVariantAnimation::interpolated(const QVariant &from, const QVariant &to, qreal progress) const

Эта виртуальная функция возвращает линейную интерполяцию между значениями from и to при progress, обычно значение между 0 и 1. Вы можете переопределить эту функцию в подклассе QVariantAnimation, чтобы предоставить свой собственный алгоритм интерполяции.

Обратите внимание, что для того, чтобы интерполяция работала с QEasingCurve, возвращающим значение меньше 0 или больше 1 (например, QEasingCurve::InBack), необходимо убедиться, что оно может экстраполировать. Если семантика типа данных не позволяет экстраполяции, эта функция должна обрабатывать это должным образом.

Вы должны вызвать реализацию QVariantAnimation этой функции, если хотите, чтобы ваш класс обрабатывал типы, уже поддерживаемые Qt (см. описание класса QVariantAnimation для списка поддерживаемых типов).

См. также QEasingCurve.

QVariant QVariantAnimation::keyValueAt(qreal step) const

Возвращает значение ключевой кадра для заданного step. Заданный step должен находиться в диапазоне от 0 до 1. Если для step нет KeyValue, возвращается недействительный QVariant.

См. также keyValues() и setKeyValueAt().

QVariantAnimation::KeyValues QVariantAnimation::keyValues() const

Возвращает ключевые кадры этой анимации.

См. также keyValueAt() и setKeyValues().

void QVariantAnimation::setKeyValueAt(qreal step, const QVariant &value)

Создаёт ключевой кадр в заданном step со значением value. Заданный step должен находиться в диапазоне от 0 до 1.

См. также setKeyValues() и keyValueAt().

void QVariantAnimation::setKeyValues(const QVariantAnimation::KeyValues &keyValues)

Заменяет текущий набор ключевых кадров заданными keyValues. Шаг ключевых кадров должен находиться в диапазоне от 0 до 1.

См. также keyValues() и keyValueAt().

[override virtual protected] void QVariantAnimation::updateCurrentTime(int)

Переопределяет: QAbstractAnimation::updateCurrentTime(int currentTime).

[virtual protected] void QVariantAnimation::updateCurrentValue(const QVariant &value)

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

Реализация базового класса ничего не делает.

См. также currentValue.

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

Переопределяет: QAbstractAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState).

Связанные не члены

template <typename T> void qRegisterAnimationInterpolator(QVariant (*)(const T &, const T &, qreal) func)

Регистрирует пользовательский интерполятор func для шаблона типа T. Интерполятор должен быть зарегистрирован перед созданием анимации. Для отмены регистрации (и использования стандартного интерполятора) установите func в nullptr.

Примечание: Эта функция безопасна для потоков.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qvariantanimation.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API