QAnimationController

A controller class for animations. More…

Synopsis

Functions

• def activeAnimationGroup ()

• def addAnimationGroup (animationGroups)

• def animationGroupList ()

• def entity ()

• def getAnimationIndex (name)

• def getGroup (index)

• def position ()

• def positionOffset ()

• def positionScale ()

• def recursive ()

• def removeAnimationGroup (animationGroups)

• def setAnimationGroups (animationGroups)

Slots

• def setActiveAnimationGroup (index)

• def setEntity (entity)

• def setPosition (position)

• def setPositionOffset (offset)

• def setPositionScale (scale)

• def setRecursive (recursive)

Signals

• def activeAnimationGroupChanged (index)

• def entityChanged (entity)

• def positionChanged (position)

• def positionOffsetChanged (offset)

• def positionScaleChanged (scale)

• def recursiveChanged (recursive)

Detailed Description

QAnimationController class controls the selection and playback of animations. The class can be used to find all animations from QEntity tree and create QAnimationGroups from the animations with the same name. The user can select which animation group is currently controlled with the animation controller by setting the active animation. The animation position is then propagated to that group after scaling and offsetting the provided position value with the positionScale and positionOffset values.

Note

that the animation controller doesn’t have internal timer, but instead the user is responsible for updating the position property in timely manner.

class PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController([parent=None])

Parameters

parent – PySide6.QtCore.QObject

Constructs a new QAnimationController with parent.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.activeAnimationGroup()

Return type

int

Holds the currectly active animation group.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.activeAnimationGroupChanged(index)

Parameters

index – int

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.addAnimationGroup(animationGroups)

Parameters

animationGroups – PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationGroup

Adds the given animationGroup to the controller.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.animationGroupList()

Return type

Returns the list of animation groups the conroller is currently holding.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.entity()

Return type

PySide6.Qt3DCore.Qt3DCore.QEntity

Holds the entity animations are gathered and grouped from. If the controller already holds animations, they are cleared.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.entityChanged(entity)

Parameters

entity – PySide6.Qt3DCore.Qt3DCore.QEntity

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.getAnimationIndex(name)

Parameters

name – str

Return type

int

Returns the index of the animation with name. Returns -1 if no AnimationGroup with the given name is found.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.getGroup(index)

Parameters

index – int

Return type

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationGroup

Returns the AnimationGroup with the given index.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.position()

Return type

float

Holds the current position of the animation. When the position is set, it is scaled and offset with positionScale / positionOffset and propagated to the active animation group.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionChanged(position)

Parameters

position – float

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionOffset()

Return type

float

Holds the position offset of the animation.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionOffsetChanged(offset)

Parameters

offset – float

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionScale()

Return type

float

Holds the position scale of the animation.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionScaleChanged(scale)

Parameters

scale – float

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.recursive()

Return type

bool

Holds whether the recursively search the entity tree when gathering animations from the entity. If set to true, the animations are searched also from the child entities of the entity. If set to false, only the entity passed to the controller is searched.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.recursiveChanged(recursive)

Parameters

recursive – bool

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.removeAnimationGroup(animationGroups)

Parameters

animationGroups – PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationGroup

Removes the given animationGroup from the controller.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.setActiveAnimationGroup(index)

Parameters

index – int

Holds the currectly active animation group.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.setAnimationGroups(animationGroups)

Parameters

animationGroups –

Sets the animationGroups for the controller. Old groups are cleared.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.setEntity(entity)

Parameters

entity – PySide6.Qt3DCore.Qt3DCore.QEntity

Holds the entity animations are gathered and grouped from. If the controller already holds animations, they are cleared.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.setPosition(position)

Parameters

position – float

Holds the current position of the animation. When the position is set, it is scaled and offset with positionScale / positionOffset and propagated to the active animation group.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.setPositionOffset(offset)

Parameters

offset – float

Holds the position offset of the animation.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.setPositionScale(scale)

Parameters

scale – float

Holds the position scale of the animation.

PySide6.Qt3DAnimation.Qt3DAnimation.QAnimationController.setRecursive(recursive)

Parameters

recursive – bool

Holds whether the recursively search the entity tree when gathering animations from the entity. If set to true, the animations are searched also from the child entities of the entity. If set to false, only the entity passed to the controller is searched.