PySide6.Qt3DAnimation.Qt3DAnimation.QKeyframeAnimation

class QKeyframeAnimation

A class implementing simple keyframe animation to a QTransform.

Details

A QKeyframeAnimation class implements simple keyframe animation that can be used to animate QTransform. The keyframes consists of multiple timed QTransforms, which are interpolated and applied to the target QTransform. QEasingCurve is used between keyframes to control the interpolator. RepeatMode can be set for when the position set to the QKeyframeAnimation is below or above the values defined in the keyframe positions.

Synopsis

Properties

• easingᅟ

• endModeᅟ

• framePositionsᅟ

• startModeᅟ

• targetᅟ

• targetNameᅟ

Methods

• def __init__()

• def addKeyframe()

• def easing()

• def endMode()

• def framePositions()

• def keyframeList()

• def removeKeyframe()

• def setKeyframes()

• def startMode()

• def target()

• def targetName()

Slots

• def setEasing()

• def setEndMode()

• def setFramePositions()

• def setStartMode()

• def setTarget()

• def setTargetName()

Signals

• def easingChanged()

• def endModeChanged()

• def framePositionsChanged()

• def startModeChanged()

• def targetChanged()

• def targetNameChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class RepeatMode

This enumeration specifies how position values outside keyframe values are handled.

Constant	Description
Qt3DAnimation.QKeyframeAnimation.None_	The animation is not applied to the target transform.
Qt3DAnimation.QKeyframeAnimation.Constant	The edge keyframe value is used.
Qt3DAnimation.QKeyframeAnimation.Repeat	The animation is repeated.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property easingᅟ: QEasingCurve

Holds the easing curve of the interpolator between keyframes.

Access functions:

• easing()

• setEasing()

• Signal easingChanged()

property endModeᅟ: Qt3DAnimation.QKeyframeAnimation.RepeatMode

Holds the repeat mode for the position values greater than the last frame position.

Access functions:

• endMode()

• setEndMode()

• Signal endModeChanged()

property framePositionsᅟ: list of float

Holds the positions of the keyframes. Each position in the list specifies the position of the corresponding keyframe with the same index. The values must be in an ascending order. Values can be positive or negative and do not have any predefined unit.

Access functions:

• framePositions()

• setFramePositions()

• Signal framePositionsChanged()

property startModeᅟ: Qt3DAnimation.QKeyframeAnimation.RepeatMode

Holds the repeat mode for the position values less than the first frame position.

Access functions:

• startMode()

• setStartMode()

• Signal startModeChanged()

property targetᅟ: QTransform

Holds the target QTransform the animation is applied to.

Access functions:

• target()

• setTarget()

• Signal targetChanged()

property targetNameᅟ: str

Holds the name of the target transform. This is a convenience property making it easier to match the target transform to the keyframe animation. The name is usually same as the name of the parent entity of the target transform, but does not have to be.

Access functions:

• targetName()

• setTargetName()

• Signal targetNameChanged()

__init__([parent=None])

Parameters:

parent – QObject

Constructs an QKeyframeAnimation with parent.

addKeyframe(keyframe)

Parameters:

keyframe – QTransform

Adds new keyframe at the end of the animation. The QTransform can be added to the animation multiple times.

easing()

Return type:

QEasingCurve

See also

setEasing()

Getter of property easingᅟ .

easingChanged(easing)

Parameters:

easing – QEasingCurve

Notification signal of property easingᅟ .

endMode()

Return type:

RepeatMode

See also

setEndMode()

Getter of property endModeᅟ .

endModeChanged(endMode)

Parameters:

endMode – RepeatMode

Notification signal of property endModeᅟ .

framePositions()

Return type:

.list of float

See also

setFramePositions()

Getter of property framePositionsᅟ .

framePositionsChanged(positions)

Parameters:

positions – .list of float

Notification signal of property framePositionsᅟ .

keyframeList()

Return type:

.list of Qt3DCore.QTransform

Returns the list of keyframes.

removeKeyframe(keyframe)

Parameters:

keyframe – QTransform

Removes a keyframe from the animation. If the same QTransform is set as keyframe multiple times, all occurrences are removed.

setEasing(easing)

Parameters:

easing – QEasingCurve

See also

easing()

Setter of property easingᅟ .

setEndMode(mode)

Parameters:

mode – RepeatMode

See also

endMode()

Setter of property endModeᅟ .

setFramePositions(positions)

Parameters:

positions – .list of float

See also

framePositions()

Setter of property framePositionsᅟ .

setKeyframes(keyframes)

Parameters:

keyframes – .list of Qt3DCore.QTransform

Sets the keyframes of the animation. Old keyframes are cleared.

setStartMode(mode)

Parameters:

mode – RepeatMode

See also

startMode()

Setter of property startModeᅟ .

setTarget(target)

Parameters:

target – QTransform

See also

target()

Setter of property targetᅟ .

setTargetName(name)

Parameters:

name – str

See also

targetName()

Setter of property targetNameᅟ .

startMode()

Return type:

RepeatMode

See also

setStartMode()

Getter of property startModeᅟ .

startModeChanged(startMode)

Parameters:

startMode – RepeatMode

Notification signal of property startModeᅟ .

target()

Return type:

QTransform

See also

setTarget()

Getter of property targetᅟ .

targetChanged(target)

Parameters:

target – QTransform

Notification signal of property targetᅟ .

targetName()

Return type:

str

See also

setTargetName()

Getter of property targetNameᅟ .

targetNameChanged(name)

Parameters:

name – str

Notification signal of property targetNameᅟ .