QGraphicsItemAnimation

The QGraphicsItemAnimation class provides simple animation support for QGraphicsItem . More

Inheritance diagram of PySide6.QtWidgets.QGraphicsItemAnimation

Synopsis

Functions

Virtual functions

Detailed Description

The QGraphicsItemAnimation class animates a QGraphicsItem . You can schedule changes to the item’s transformation matrix at specified steps. The QGraphicsItemAnimation class has a current step value. When this value changes the transformations scheduled at that step are performed. The current step of the animation is set with the setStep() function.

QGraphicsItemAnimation will do a simple linear interpolation between the nearest adjacent scheduled changes to calculate the matrix. For instance, if you set the position of an item at values 0.0 and 1.0, the animation will show the item moving in a straight line between these positions. The same is true for scaling and rotation.

It is usual to use the class with a QTimeLine . The timeline’s valueChanged() signal is then connected to the setStep() slot. For example, you can set up an item for rotation by calling setRotationAt() for different step values. The animations timeline is set with the setTimeLine() function.

An example animation with a timeline follows:

ball = QGraphicsEllipseItem(0, 0, 20, 20)
timer = QTimeLine(5000)
timer.setFrameRange(0, 100)
animation = QGraphicsItemAnimation()
animation.setItem(ball)
animation.setTimeLine(timer)
for i in range(0, 200):
    animation.setPosAt(i / 200.0, QPointF(i, i))
scene = QGraphicsScene()
scene.setSceneRect(0, 0, 250, 250)
scene.addItem(ball)
view = QGraphicsView(scene)
view.show()
timer.start()

Note that steps lie between 0.0 and 1.0. It may be necessary to use setUpdateInterval() . The default update interval is 40 ms. A scheduled transformation cannot be removed when set, so scheduling several transformations of the same kind (e.g., rotations) at the same step is not recommended.

See also

QTimeLine Graphics View Framework

class PySide6.QtWidgets.QGraphicsItemAnimation([parent=None])
Parameters

parentPySide6.QtCore.QObject

Constructs an animation object with the given parent.

PySide6.QtWidgets.QGraphicsItemAnimation.afterAnimationStep(step)
Parameters

step – float

PySide6.QtWidgets.QGraphicsItemAnimation.beforeAnimationStep(step)
Parameters

step – float

PySide6.QtWidgets.QGraphicsItemAnimation.clear()

Clears the scheduled transformations used for the animation, but retains the item and timeline.

PySide6.QtWidgets.QGraphicsItemAnimation.horizontalScaleAt(step)
Parameters

step – float

Return type

float

Returns the horizontal scale for the item at the specified step value.

See also

setScaleAt()

PySide6.QtWidgets.QGraphicsItemAnimation.horizontalShearAt(step)
Parameters

step – float

Return type

float

Returns the horizontal shear for the item at the specified step value.

See also

setShearAt()

PySide6.QtWidgets.QGraphicsItemAnimation.item()
Return type

PySide6.QtWidgets.QGraphicsItem

Returns the item on which the animation object operates.

See also

setItem()

PySide6.QtWidgets.QGraphicsItemAnimation.posAt(step)
Parameters

step – float

Return type

PySide6.QtCore.QPointF

Returns the position of the item at the given step value.

See also

setPosAt()

PySide6.QtWidgets.QGraphicsItemAnimation.posList()
Return type

Returns all explicitly inserted positions.

See also

posAt() setPosAt()

PySide6.QtWidgets.QGraphicsItemAnimation.rotationAt(step)
Parameters

step – float

Return type

float

Returns the angle at which the item is rotated at the specified step value.

See also

setRotationAt()

PySide6.QtWidgets.QGraphicsItemAnimation.rotationList()
Return type

Returns all explicitly inserted rotations.

PySide6.QtWidgets.QGraphicsItemAnimation.scaleList()
Return type

Returns all explicitly inserted scales.

PySide6.QtWidgets.QGraphicsItemAnimation.setItem(item)
Parameters

itemPySide6.QtWidgets.QGraphicsItem

Sets the specified item to be used in the animation.

See also

item()

PySide6.QtWidgets.QGraphicsItemAnimation.setPosAt(step, pos)
Parameters
PySide6.QtWidgets.QGraphicsItemAnimation.setRotationAt(step, angle)
Parameters
  • step – float

  • angle – float

Sets the rotation of the item at the given step value to the angle specified.

See also

rotationAt()

PySide6.QtWidgets.QGraphicsItemAnimation.setScaleAt(step, sx, sy)
Parameters
  • step – float

  • sx – float

  • sy – float

Sets the scale of the item at the given step value using the horizontal and vertical scale factors specified by sx and sy.

PySide6.QtWidgets.QGraphicsItemAnimation.setShearAt(step, sh, sv)
Parameters
  • step – float

  • sh – float

  • sv – float

Sets the shear of the item at the given step value using the horizontal and vertical shear factors specified by sh and sv.

PySide6.QtWidgets.QGraphicsItemAnimation.setStep(x)
Parameters

x – float

PySide6.QtWidgets.QGraphicsItemAnimation.setTimeLine(timeLine)
Parameters

timeLinePySide6.QtCore.QTimeLine

Sets the timeline object used to control the rate of animation to the timeLine specified.

See also

timeLine()

PySide6.QtWidgets.QGraphicsItemAnimation.setTranslationAt(step, dx, dy)
Parameters
  • step – float

  • dx – float

  • dy – float

Sets the translation of the item at the given step value using the horizontal and vertical coordinates specified by dx and dy.

PySide6.QtWidgets.QGraphicsItemAnimation.shearList()
Return type

Returns all explicitly inserted shears.

PySide6.QtWidgets.QGraphicsItemAnimation.timeLine()
Return type

PySide6.QtCore.QTimeLine

Returns the timeline object used to control the rate at which the animation occurs.

See also

setTimeLine()

PySide6.QtWidgets.QGraphicsItemAnimation.transformAt(step)
Parameters

step – float

Return type

PySide6.QtGui.QTransform

Returns the transform used for the item at the specified step value.

PySide6.QtWidgets.QGraphicsItemAnimation.translationList()
Return type

Returns all explicitly inserted translations.

PySide6.QtWidgets.QGraphicsItemAnimation.verticalScaleAt(step)
Parameters

step – float

Return type

float

Returns the vertical scale for the item at the specified step value.

See also

setScaleAt()

PySide6.QtWidgets.QGraphicsItemAnimation.verticalShearAt(step)
Parameters

step – float

Return type

float

Returns the vertical shear for the item at the specified step value.

See also

setShearAt()

PySide6.QtWidgets.QGraphicsItemAnimation.xTranslationAt(step)
Parameters

step – float

Return type

float

Returns the horizontal translation of the item at the specified step value.

PySide6.QtWidgets.QGraphicsItemAnimation.yTranslationAt(step)
Parameters

step – float

Return type

float

Returns the vertical translation of the item at the specified step value.