Skip to content

PythonQt.QtCore.QVariantAnimation · declarations 001

Back to PythonQt.QtCore.QVariantAnimation

currentLoopChanged

currentLoopChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QVariantAnimation.currentLoopChanged; argument details are not documented.

currentValue instance-attribute

currentValue: Any

Qt 5 reference:

currentValue : const QVariant

This property holds the current value of the animation.

This property describes the current value; an interpolated value between the start value and the end value, using the current time for progress. The value itself is obtained from interpolated(), which is called repeatedly as the animation is running.

QVariantAnimation calls the virtual updateCurrentValue() function when the current value changes. This is particularly useful for subclasses that need to track updates. For example, QPropertyAnimation uses this function to animate Qt properties.

Access functions:

QVariant currentValue() const

Notifier signal:

void valueChanged(const QVariant \&value)

See also startValue and endValue.

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#currentValue

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QVariantAnimation.destroyed; argument details are not documented.

directionChanged

directionChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QVariantAnimation.directionChanged; argument details are not documented.

duration instance-attribute

duration: int

Qt 5 reference:

duration : int

This property holds the duration of the animation

This property describes the duration in milliseconds of the animation. The default duration is 250 milliseconds.

Access functions:

virtual int duration() const override
void setDuration(int msecs)

See also QAbstractAnimation::duration().

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#duration

easingCurve instance-attribute

easingCurve: QEasingCurve

Qt 5 reference:

easingCurve : QEasingCurve

This property holds the easing curve of the animation

This property defines the easing curve of the animation. By default, a linear easing curve is used, resulting in linear interpolation. Other curves are provided, for instance, QEasingCurve::InCirc, which provides a circular entry curve. Another example is QEasingCurve::InOutElastic, which provides an elastic effect on the values of the interpolated variant.

QVariantAnimation will use the QEasingCurve::valueForProgress() to transform the "normalized progress" (currentTime / totalDuration) of the animation into the effective progress actually used by the animation. It is this effective progress that will be the progress when interpolated() is called. Also, the steps in the keyValues are referring to this effective progress.

The easing curve is used with the interpolator, the interpolated() virtual function, and the animation's duration to control how the current value changes as the animation progresses.

Access functions:

QEasingCurve easingCurve() const
void setEasingCurve(const QEasingCurve \&easing)

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#easingCurve

endValue instance-attribute

endValue: Any

Qt 5 reference:

endValue : QVariant

This property holds the end value of the animation

This property describes the end value of the animation.

Access functions:

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

See also startValue.

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#endValue

event

event(event: Any) -> bool

X.event(event) -> bool

Supplemental documentation: Qt 5 reference:

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

Reimplements: QAbstractAnimation::event(QEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

event(self, event: PySide2.QtCore.QEvent) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#event

finished

finished(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QVariantAnimation.finished; argument details are not documented.

interpolated

interpolated(*args: Any, **kwargs: Any) -> Any

X.interpolated(from, to, progress) -> object

Supplemental documentation: Qt 5 reference:

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

This virtual function returns the linear interpolation between variants from and to, at progress, usually a value between 0 and 1. You can reimplement this function in a subclass of QVariantAnimation to provide your own interpolation algorithm.

Note that in order for the interpolation to work with a QEasingCurve that return a value smaller than 0 or larger than 1 (such as QEasingCurve::InBack) you should make sure that it can extrapolate. If the semantic of the datatype does not allow extrapolation this function should handle that gracefully.

You should call the QVariantAnimation implementation of this function if you want your class to handle the types already supported by Qt (see class QVariantAnimation description for a list of supported types).

See also QEasingCurve.

Upstream PySide2 reference signatures (binding differences may apply):

interpolated(self, from_: typing.Any, to: typing.Any, progress: float) -> typing.Any

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#interpolated

keyValueAt

keyValueAt(step: float) -> Any

X.keyValueAt(step) -> object

Supplemental documentation: Qt 5 reference:

QVariant QVariantAnimation::keyValueAt(qreal step) const

Returns the key frame value for the given step. The given step must be in the range 0 to 1. If there is no KeyValue for step, it returns an invalid QVariant.

See also keyValues() and setKeyValueAt().

Upstream PySide2 reference signatures (binding differences may apply):

keyValueAt(self, step: float) -> typing.Any

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#keyValueAt

keyValues

keyValues() -> tuple

X.keyValues() -> tuple

Supplemental documentation: Qt 5 reference:

QVariantAnimation::KeyValues QVariantAnimation::keyValues() const

Returns the key frames of this animation.

See also keyValueAt() and setKeyValues().

Upstream PySide2 reference signatures (binding differences may apply):

keyValues(self) -> typing.List[typing.Tuple[float, typing.Any]]

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#keyValues

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QVariantAnimation.objectNameChanged; argument details are not documented.

setDuration

setDuration(msecs: int) -> None

X.setDuration(msecs)

Upstream PySide2 reference signatures (binding differences may apply):

setDuration(self, msecs: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#setDuration

setEasingCurve

setEasingCurve(easing: Any) -> None

X.setEasingCurve(easing)

Upstream PySide2 reference signatures (binding differences may apply):

setEasingCurve(self, easing: PySide2.QtCore.QEasingCurve) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#setEasingCurve

setEndValue

setEndValue(value: Any) -> None

X.setEndValue(value)

Upstream PySide2 reference signatures (binding differences may apply):

setEndValue(self, value: typing.Any) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#setEndValue

setKeyValueAt

setKeyValueAt(step: float, value: Any) -> None

X.setKeyValueAt(step, value)

Supplemental documentation: Qt 5 reference:

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

Creates a key frame at the given step with the given value. The given step must be in the range 0 to 1.

See also setKeyValues() and keyValueAt().

Upstream PySide2 reference signatures (binding differences may apply):

setKeyValueAt(self, step: float, value: typing.Any) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#setKeyValueAt

setKeyValues

setKeyValues(values: Any) -> None

X.setKeyValues(values)

Supplemental documentation: Qt 5 reference:

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

Replaces the current set of key frames with the given keyValues. the step of the key frames must be in the range 0 to 1.

See also keyValues() and keyValueAt().

Upstream PySide2 reference signatures (binding differences may apply):

setKeyValues(self, values: typing.List[typing.Tuple[float, typing.Any]]) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#setKeyValues

setStartValue

setStartValue(value: Any) -> None

X.setStartValue(value)

Upstream PySide2 reference signatures (binding differences may apply):

setStartValue(self, value: typing.Any) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#setStartValue

startValue instance-attribute

startValue: Any

Qt 5 reference:

startValue : QVariant

This property holds the optional start value of the animation

This property describes the optional start value of the animation. If omitted, or if a null QVariant is assigned as the start value, the animation will use the current position of the end when the animation is started.

Access functions:

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

See also endValue.

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#startValue

stateChanged

stateChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QVariantAnimation.stateChanged; argument details are not documented.

updateCurrentTime

updateCurrentTime(arg__1: int) -> None

X.updateCurrentTime(arg__1)

Supplemental documentation: Qt 5 reference:

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

Reimplements: QAbstractAnimation::updateCurrentTime(int currentTime).

Upstream PySide2 reference signatures (binding differences may apply):

updateCurrentTime(self, arg__1: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#updateCurrentTime

updateCurrentValue

updateCurrentValue(value: Any) -> None

X.updateCurrentValue(value)

Upstream PySide2 reference signatures (binding differences may apply):

updateCurrentValue(self, value: typing.Any) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#updateCurrentValue

updateState

updateState(newState: Any, oldState: Any) -> None

X.updateState(newState, oldState)

Supplemental documentation: Qt 5 reference:

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

Reimplements: QAbstractAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState).

Upstream PySide2 reference signatures (binding differences may apply):

updateState(self, newState: PySide2.QtCore.QAbstractAnimation.State, oldState: PySide2.QtCore.QAbstractAnimation.State) -> None

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#updateState

valueChanged

valueChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QVariantAnimation.valueChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

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

QVariantAnimation emits this signal whenever the current value changes.

Note: Notifier signal for property currentValue.

See also currentValue, startValue, and endValue.

Source: https://doc.qt.io/archives/qt-5.15/qvariantanimation.html#valueChanged