PySide6.Qt3DAnimation.Qt3DAnimation.QAbstractClipAnimator

class QAbstractClipAnimator

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

Inherited by: QClipAnimator, QBlendedClipAnimator

Synopsis

Properties

• channelMapperᅟ

• clockᅟ

• loopsᅟ

• normalizedTimeᅟ

• runningᅟ

Methods

• def __init__()

• def channelMapper()

• def clock()

• def isRunning()

• def loopCount()

• def normalizedTime()

Slots

• def setChannelMapper()

• def setClock()

• def setLoopCount()

• def setNormalizedTime()

• def setRunning()

• def start()

• def stop()

Signals

• def channelMapperChanged()

• def clockChanged()

• def loopCountChanged()

• def normalizedTimeChanged()

• def runningChanged()

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

Note

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

property channelMapperᅟ: 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:

• channelMapper()

• setChannelMapper()

• Signal channelMapperChanged()

property clockᅟ: QClock

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

Access functions:

• clock()

• setClock()

• Signal clockChanged()

property 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:

• loopCount()

• setLoopCount()

• Signal loopCountChanged()

property normalizedTimeᅟ: float

This property holds the clips normalized time.

Access functions:

• normalizedTime()

• setNormalizedTime()

• Signal normalizedTimeChanged()

property runningᅟ: bool

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

Access functions:

• isRunning()

• setRunning()

• Signal runningChanged()

__init__([parent=None])

Parameters:

parent – QNode

channelMapper()

Return type:

QChannelMapper

See also

setChannelMapper()

Getter of property channelMapperᅟ .

channelMapperChanged(channelMapper)

Parameters:

channelMapper – QChannelMapper

Notification signal of property channelMapperᅟ .

clock()

Return type:

QClock

See also

setClock()

Getter of property clockᅟ .

clockChanged(clock)

Parameters:

clock – QClock

Notification signal of property clockᅟ .

isRunning()

Return type:

bool

Returns a boolean indicating whether the animation is currently running.

Getter of property runningᅟ .

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ᅟ .

loopCountChanged(loops)

Parameters:

loops – int

Notification signal of property loopsᅟ .

normalizedTime()

Return type:

float

See also

setNormalizedTime()

Getter of property normalizedTimeᅟ .

normalizedTimeChanged(index)

Parameters:

index – float

Notification signal of property normalizedTimeᅟ .

runningChanged(running)

Parameters:

running – bool

Notification signal of property runningᅟ .

setChannelMapper(channelMapper)

Parameters:

channelMapper – QChannelMapper

See also

channelMapper()

Setter of property channelMapperᅟ .

setClock(clock)

Parameters:

clock – QClock

See also

clock()

Setter of property clockᅟ .

setLoopCount(loops)

Parameters:

loops – int

See also

loopCount()

Setter of property loopsᅟ .

setNormalizedTime(timeFraction)

Parameters:

timeFraction – float

See also

normalizedTime()

Setter of property normalizedTimeᅟ .

setRunning(running)

Parameters:

running – bool

See also

isRunning()

Setter of property runningᅟ .

start()

Starts the animation.

stop()

Stops the animation.