QAbstractClipAnimator#

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

Inherited by: QClipAnimator, QBlendedClipAnimator

Synopsis#

Functions#

def channelMapper ()
def clock ()
def isRunning ()
def loopCount ()
def normalizedTime ()

Slots#

def setChannelMapper (channelMapper)
def setClock (clock)
def setLoopCount (loops)
def setNormalizedTime (timeFraction)
def setRunning (running)
def start ()
def stop ()

Signals#

def channelMapperChanged (channelMapper)
def clockChanged (clock)
def loopCountChanged (loops)
def normalizedTimeChanged (index)
def runningChanged (running)

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: parent – PySide6.Qt3DCore.Qt3DCore.QNode

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.

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

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

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

Parameters: channelMapper – PySide6.Qt3DAnimation.Qt3DAnimation.QChannelMapper

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.clock()#

Return type: PySide6.Qt3DAnimation.Qt3DAnimation.QClock

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

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

Parameters: clock – PySide6.Qt3DAnimation.Qt3DAnimation.QClock

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.isRunning()#

Return type: bool

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

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.loopCount()#

Return type: 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.

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

Parameters: loops – int

PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator.normalizedTime()#

Return type: float

This property holds the clips normalized time.

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

Parameters: index – float

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

Parameters: running – bool

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

Parameters: 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.

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

Parameters: clock – PySide6.Qt3DAnimation.Qt3DAnimation.QClock

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

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

Parameters: 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.

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

Parameters: timeFraction – float

This property holds the clips normalized time.

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

Parameters: running – bool

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

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

Starts the animation.

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

Stops the animation.