QKeyframeAnimation

A class implementing simple keyframe animation to a QTransform . More

Synopsis

Functions

Slots

Signals

Detailed Description

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.

class PySide2.Qt3DAnimation.QKeyframeAnimation([parent=None])
param parent

PySide2.QtCore.QObject

Constructs an QKeyframeAnimation with parent .

PySide2.Qt3DAnimation.QKeyframeAnimation.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.

PySide2.Qt3DAnimation.QKeyframeAnimation.addKeyframe(keyframe)
Parameters

keyframePySide2.Qt3DCore.QTransform

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

PySide2.Qt3DAnimation.QKeyframeAnimation.easing()
Return type

PySide2.QtCore.QEasingCurve

Holds the easing curve of the interpolator between keyframes.

PySide2.Qt3DAnimation.QKeyframeAnimation.easingChanged(easing)
Parameters

easingPySide2.QtCore.QEasingCurve

PySide2.Qt3DAnimation.QKeyframeAnimation.endMode()
Return type

RepeatMode

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

PySide2.Qt3DAnimation.QKeyframeAnimation.endModeChanged(endMode)
Parameters

endModeRepeatMode

PySide2.Qt3DAnimation.QKeyframeAnimation.framePositions()
Return type

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.

PySide2.Qt3DAnimation.QKeyframeAnimation.framePositionsChanged(positions)
Parameters

positions

PySide2.Qt3DAnimation.QKeyframeAnimation.keyframeList()
Return type

Returns the list of keyframes.

PySide2.Qt3DAnimation.QKeyframeAnimation.removeKeyframe(keyframe)
Parameters

keyframePySide2.Qt3DCore.QTransform

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

PySide2.Qt3DAnimation.QKeyframeAnimation.setEasing(easing)
Parameters

easingPySide2.QtCore.QEasingCurve

Holds the easing curve of the interpolator between keyframes.

PySide2.Qt3DAnimation.QKeyframeAnimation.setEndMode(mode)
Parameters

modeRepeatMode

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

PySide2.Qt3DAnimation.QKeyframeAnimation.setFramePositions(positions)
Parameters

positions

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.

PySide2.Qt3DAnimation.QKeyframeAnimation.setKeyframes(keyframes)
Parameters

keyframes

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

PySide2.Qt3DAnimation.QKeyframeAnimation.setStartMode(mode)
Parameters

modeRepeatMode

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

PySide2.Qt3DAnimation.QKeyframeAnimation.setTarget(target)
Parameters

targetPySide2.Qt3DCore.QTransform

Holds the target QTransform the animation is applied to.

PySide2.Qt3DAnimation.QKeyframeAnimation.setTargetName(name)
Parameters

name – 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.

PySide2.Qt3DAnimation.QKeyframeAnimation.startMode()
Return type

RepeatMode

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

PySide2.Qt3DAnimation.QKeyframeAnimation.startModeChanged(startMode)
Parameters

startModeRepeatMode

PySide2.Qt3DAnimation.QKeyframeAnimation.target()
Return type

PySide2.Qt3DCore.QTransform

Holds the target QTransform the animation is applied to.

PySide2.Qt3DAnimation.QKeyframeAnimation.targetChanged(target)
Parameters

targetPySide2.Qt3DCore.QTransform

PySide2.Qt3DAnimation.QKeyframeAnimation.targetName()
Return type

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.

PySide2.Qt3DAnimation.QKeyframeAnimation.targetNameChanged(name)
Parameters

name – str