Qt3DAnimation.QAnimationController

A controller class for animations. More

Inheritance diagram of PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController

Synopsis

Functions

Slots

Signals

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 PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController([parent=None])
param parent

QObject

Constructs a new QAnimationController with parent .

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.activeAnimationGroup()
Return type

int

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.activeAnimationGroupChanged(index)
Parameters

indexint

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.addAnimationGroup(animationGroups)
Parameters

animationGroupsQAnimationGroup

Adds the given animationGroup to the controller.

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.animationGroupList()
Return type

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

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.entity()
Return type

QEntity

See also

setEntity()

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.entityChanged(entity)
Parameters

entityQEntity

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.getAnimationIndex(name)
Parameters

name – unicode

Return type

int

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

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.getGroup(index)
Parameters

indexint

Return type

QAnimationGroup

Returns the AnimationGroup with the given index .

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.position()
Return type

float

See also

setPosition()

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionChanged(position)
Parameters

positionfloat

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionOffset()
Return type

float

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionOffsetChanged(offset)
Parameters

offsetfloat

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionScale()
Return type

float

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.positionScaleChanged(scale)
Parameters

scalefloat

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.recursive()
Return type

bool

See also

setRecursive()

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.recursiveChanged(recursive)
Parameters

recursivebool

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.removeAnimationGroup(animationGroups)
Parameters

animationGroupsQAnimationGroup

Removes the given animationGroup from the controller.

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.setActiveAnimationGroup(index)
Parameters

indexint

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.setAnimationGroups(animationGroups)
Parameters

animationGroups

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

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.setEntity(entity)
Parameters

entityQEntity

See also

entity()

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.setPosition(position)
Parameters

positionfloat

See also

position()

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.setPositionOffset(offset)
Parameters

offsetfloat

See also

positionOffset()

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.setPositionScale(scale)
Parameters

scalefloat

See also

positionScale()

PySide2.Qt3DAnimation.Qt3DAnimation.QAnimationController.setRecursive(recursive)
Parameters

recursivebool

See also

recursive()