QAbstractClipAnimator#

QAbstractClipAnimator is the base class for types providing animation playback capabilities. More

Inheritance diagram of PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator

Inherited by: QClipAnimator, QBlendedClipAnimator

Synopsis#

Properties#

Functions#

Slots#

Signals#

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

Detailed Description#

Subclasses of QAbstractClipAnimator can be aggregated by a QEntity to provide animation capabilities. The animator components provide an interface for controlling the animation (e.g. start, stop). Each animator type requires some form of animation data such as a QAbstractAnimationClip as well as a QChannelMapper which describes how the channels in the animation clip should be mapped onto the properties of the objects you wish to animate.

The following subclasses are available:

  • QClipAnimator

  • QBlendedClipAnimator

class PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator([parent=None])#
Parameters:

parentPySide6.Qt3DCore.Qt3DCore.QNode

Note

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

property PᅟySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.channelMapper: PySide6.Qt3DAnimation.Qt3DAnimation.QChannelMapper#

This property holds the ChannelMapper that controls how the channels in the animation clip map onto the properties of the target objects.

Access functions:
property PᅟySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.clock: PySide6.Qt3DAnimation.Qt3DAnimation.QClock#

The clock controls the speed with which an animation is played.

Access functions:
property PᅟySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.loops: int#

Holds the number of times the animation should play.

The value is 1 by default: the animation will be played once and then stop.

If set to Infinite , the animation will continuously repeat until it is explicitly stopped.

Access functions:
property PᅟySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.normalizedTime: float#

This property holds the clips normalized time.

Access functions:
property PᅟySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.running: bool#

This property holds a boolean indicating whether the animation is currently running.

Access functions:
PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.Loops#

Holds the number of times the animation should play.

Constant

Description

Qt3DAnimation.QAbstractClipAnimator.Infinite

This will repeat the loop continuously until it is explicitly stopped.

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.channelMapper()#
Return type:

PySide6.Qt3DAnimation.Qt3DAnimation.QChannelMapper

Getter of property channelMapper .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.channelMapperChanged(channelMapper)#
Parameters:

channelMapperPySide6.Qt3DAnimation.Qt3DAnimation.QChannelMapper

Notification signal of property channelMapper .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.clock()#
Return type:

PySide6.Qt3DAnimation.Qt3DAnimation.QClock

See also

setClock()

Getter of property clock .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.clockChanged(clock)#
Parameters:

clockPySide6.Qt3DAnimation.Qt3DAnimation.QClock

Notification signal of property clock .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.isRunning()#
Return type:

bool

Returns a boolean indicating whether the animation is currently running.

Getter of property running .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.loopCount()#
Return type:

int

Returns the number of times the animation should play.

The value is 1 by default: the animation will play through once and then stop.

If set to Infinite , the animation will continuously repeat until it is explicitly stopped.

See also

setLoopCount()

Getter of property loops .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.loopCountChanged(loops)#
Parameters:

loops – int

Notification signal of property loops .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.normalizedTime()#
Return type:

float

Getter of property normalizedTime .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.normalizedTimeChanged(index)#
Parameters:

index – float

Notification signal of property normalizedTime .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.runningChanged(running)#
Parameters:

running – bool

Notification signal of property running .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.setChannelMapper(channelMapper)#
Parameters:

channelMapperPySide6.Qt3DAnimation.Qt3DAnimation.QChannelMapper

See also

channelMapper()

Setter of property channelMapper .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.setClock(clock)#
Parameters:

clockPySide6.Qt3DAnimation.Qt3DAnimation.QClock

See also

clock()

Setter of property clock .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.setLoopCount(loops)#
Parameters:

loops – int

See also

loopCount()

Setter of property loops .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.setNormalizedTime(timeFraction)#
Parameters:

timeFraction – float

See also

normalizedTime()

Setter of property normalizedTime .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.setRunning(running)#
Parameters:

running – bool

See also

isRunning()

Setter of property running .

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.start()#

Starts the animation.

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.stop()#

Stops the animation.