Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties | List of all members
QQuickAnimatedSprite Class Reference

#include <qquickanimatedsprite_p.h>

+ Inheritance diagram for QQuickAnimatedSprite:
+ Collaboration diagram for QQuickAnimatedSprite:

Public Types

enum  LoopParameters { Infinite = -1 }
 
enum  FinishBehavior { FinishAtInitialFrame , FinishAtFinalFrame }
 
- Public Types inherited from QQuickItem
enum  Flag {
  ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 ,
  ItemIsViewport = 0x20 , ItemObservesViewport = 0x40
}
 \qmltype Item \instantiates QQuickItem \inherits QtObject \inqmlmodule QtQuick More...
 
enum  ItemChange {
  ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged ,
  ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged ,
  ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged
}
 Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...
 
enum  TransformOrigin {
  TopLeft , Top , TopRight , Left ,
  Center , Right , BottomLeft , Bottom ,
  BottomRight
}
 \variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...
 

Public Slots

void start ()
 \qmlmethod QtQuick::AnimatedSprite::start()
 
void stop ()
 \qmlmethod QtQuick::AnimatedSprite::stop()
 
void restart ()
 
void advance (int frames=1)
 \qmlmethod int QtQuick::AnimatedSprite::advance()
 
void pause ()
 \qmlmethod int QtQuick::AnimatedSprite::pause()
 
void resume ()
 \qmlmethod int QtQuick::AnimatedSprite::resume()
 
void setRunning (bool arg)
 
void setPaused (bool arg)
 
void setInterpolate (bool arg)
 
void setSource (const QUrl &arg)
 
void setReverse (bool arg)
 
void setFrameSync (bool arg)
 
void setFrameCount (int arg)
 
void setFrameHeight (int arg)
 
void setFrameWidth (int arg)
 
void setFrameX (int arg)
 
void setFrameY (int arg)
 
void setFrameRate (qreal arg)
 
void setFrameDuration (int arg)
 
void resetFrameRate ()
 
void resetFrameDuration ()
 
void setLoops (int arg)
 
void setCurrentFrame (int arg)
 
- Public Slots inherited from QQuickItem
void update ()
 Schedules a call to updatePaintNode() for this item.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void pausedChanged (bool arg)
 
void runningChanged (bool arg)
 
void interpolateChanged (bool arg)
 
void sourceChanged (const QUrl &arg)
 
void reverseChanged (bool arg)
 
void frameSyncChanged (bool arg)
 
void frameCountChanged (int arg)
 
void frameHeightChanged (int arg)
 
void frameWidthChanged (int arg)
 
void frameXChanged (int arg)
 
void frameYChanged (int arg)
 
void frameRateChanged (qreal arg)
 
void frameDurationChanged (int arg)
 
void loopsChanged (int arg)
 
void currentFrameChanged (int arg)
 
 Q_REVISION (2, 15) void finishBehaviorChanged(FinishBehavior arg)
 
 Q_REVISION (2, 12) void finished()
 
- Signals inherited from QQuickItem
void childrenRectChanged (const QRectF &)
 
void baselineOffsetChanged (qreal)
 
void stateChanged (const QString &)
 
void focusChanged (bool)
 
void activeFocusChanged (bool)
 
Q_REVISION(6, 7) void focusPolicyChanged(Qt Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)
 
void parentChanged (QQuickItem *)
 
void transformOriginChanged (TransformOrigin)
 
void smoothChanged (bool)
 
void antialiasingChanged (bool)
 
void clipChanged (bool)
 
 Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)
 
void childrenChanged ()
 
void opacityChanged ()
 
void enabledChanged ()
 
void visibleChanged ()
 
void visibleChildrenChanged ()
 
void rotationChanged ()
 
void scaleChanged ()
 
void xChanged ()
 
void yChanged ()
 
void widthChanged ()
 
void heightChanged ()
 
void zChanged ()
 
void implicitWidthChanged ()
 
void implicitHeightChanged ()
 
 Q_REVISION (2, 11) void containmentMaskChanged()
 
 Q_REVISION (6, 0) void paletteChanged()
 
 Q_REVISION (6, 0) void paletteCreated()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuickAnimatedSprite (QQuickItem *parent=nullptr)
 \qmltype AnimatedSprite \instantiates QQuickAnimatedSprite \inqmlmodule QtQuick \inherits Item
 
bool running () const
 
bool interpolate () const
 
QUrl source () const
 
bool reverse () const
 
bool frameSync () const
 
int frameCount () const
 
int frameHeight () const
 
int frameWidth () const
 
int frameX () const
 
int frameY () const
 
qreal frameRate () const
 
int frameDuration () const
 
int loops () const
 
bool paused () const
 
int currentFrame () const
 
FinishBehavior finishBehavior () const
 
void setFinishBehavior (FinishBehavior arg)
 
- Public Member Functions inherited from QQuickItem
 QQuickItem (QQuickItem *parent=nullptr)
 Constructs a QQuickItem with the given parent.
 
 ~QQuickItem () override
 Destroys the QQuickItem.
 
QQuickWindow * window () const
 Returns the window in which this item is rendered.
 
QQuickItem * parentItem () const
 
void setParentItem (QQuickItem *parent)
 
void stackBefore (const QQuickItem *)
 Moves the specified sibling item to the index before this item within the list of children.
 
void stackAfter (const QQuickItem *)
 Moves the specified sibling item to the index after this item within the list of children.
 
QRectF childrenRect ()
 \qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly
 
QList< QQuickItem * > childItems () const
 Returns the children of this item.
 
bool clip () const
 \qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled.
 
void setClip (bool)
 
QString state () const
 \qmlproperty string QtQuick::Item::state
 
void setState (const QString &)
 
qreal baselineOffset () const
 \qmlproperty int QtQuick::Item::baselineOffset
 
void setBaselineOffset (qreal)
 
QQmlListProperty< QQuickTransform > transform ()
 
qreal x () const
 
qreal y () const
 
QPointF position () const
 
void setX (qreal)
 
void setY (qreal)
 
void setPosition (const QPointF &)
 
QBindable< qreal > bindableX ()
 
QBindable< qreal > bindableY ()
 
qreal width () const
 
void setWidth (qreal)
 
void resetWidth ()
 
void setImplicitWidth (qreal)
 
qreal implicitWidth () const
 Returns the width of the item that is implied by other properties that determine the content.
 
QBindable< qreal > bindableWidth ()
 
qreal height () const
 
void setHeight (qreal)
 
void resetHeight ()
 
void setImplicitHeight (qreal)
 
qreal implicitHeight () const
 
QBindable< qreal > bindableHeight ()
 
QSizeF size () const
 
void setSize (const QSizeF &size)
 
TransformOrigin transformOrigin () const
 
void setTransformOrigin (TransformOrigin)
 
QPointF transformOriginPoint () const
 
void setTransformOriginPoint (const QPointF &)
 
qreal z () const
 
void setZ (qreal)
 
qreal rotation () const
 
void setRotation (qreal)
 
qreal scale () const
 
void setScale (qreal)
 
qreal opacity () const
 
void setOpacity (qreal)
 
bool isVisible () const
 
void setVisible (bool)
 
bool isEnabled () const
 
void setEnabled (bool)
 
bool smooth () const
 
void setSmooth (bool)
 
bool activeFocusOnTab () const
 \qmlproperty bool QtQuick::Item::activeFocusOnTab
 
void setActiveFocusOnTab (bool)
 
bool antialiasing () const
 
void setAntialiasing (bool)
 
void resetAntialiasing ()
 
Flags flags () const
 Returns the item flags for this item.
 
void setFlag (Flag flag, bool enabled=true)
 Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled.
 
void setFlags (Flags flags)
 Enables the specified flags for this item.
 
virtual QRectF boundingRect () const
 Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
 
virtual QRectF clipRect () const
 Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
 
QQuickItem * viewportItem () const
 If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag.
 
bool hasActiveFocus () const
 
bool hasFocus () const
 
void setFocus (bool)
 
void setFocus (bool focus, Qt::FocusReason reason)
 
bool isFocusScope () const
 Returns true if this item is a focus scope, and false otherwise.
 
QQuickItem * scopedFocusItem () const
 If this item is a focus scope, this returns the item in its focus chain that currently has focus.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 Sets the focus policy of this item to policy.
 
bool isAncestorOf (const QQuickItem *child) const
 Returns true if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).
 
Qt::MouseButtons acceptedMouseButtons () const
 Returns the mouse buttons accepted by this item.
 
void setAcceptedMouseButtons (Qt::MouseButtons buttons)
 Sets the mouse buttons accepted by this item to buttons.
 
bool acceptHoverEvents () const
 Returns whether hover events are accepted by this item.
 
void setAcceptHoverEvents (bool enabled)
 If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item.
 
bool acceptTouchEvents () const
 Returns whether touch events are accepted by this item.
 
void setAcceptTouchEvents (bool accept)
 If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item.
 
bool isUnderMouse () const
 
void grabMouse ()
 
void ungrabMouse ()
 
bool keepMouseGrab () const
 Returns whether mouse input should exclusively remain with this item.
 
void setKeepMouseGrab (bool)
 Sets whether the mouse input should remain exclusively with this item.
 
bool filtersChildMouseEvents () const
 Returns whether pointer events intended for this item's children should be filtered through this item.
 
void setFiltersChildMouseEvents (bool filter)
 Sets whether pointer events intended for this item's children should be filtered through this item.
 
void grabTouchPoints (const QList< int > &ids)
 
void ungrabTouchPoints ()
 
bool keepTouchGrab () const
 Returns whether the touch points grabbed by this item should exclusively remain with this item.
 
void setKeepTouchGrab (bool)
 Sets whether the touch points grabbed by this item should remain exclusively with this item.
 
 Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback
 
QSharedPointer< QQuickItemGrabResult > grabToImage (const QSize &targetSize=QSize())
 Grabs the item into an in-memory image.
 
virtual Q_INVOKABLE bool contains (const QPointF &point) const
 \qmlmethod bool QtQuick::Item::contains(point point)
 
QObject * containmentMask () const
 
void setContainmentMask (QObject *mask)
 
QTransform itemTransform (QQuickItem *, bool *) const
 \qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r)
 
QPointF mapToScene (const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate.
 
QRectF mapRectToItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value.
 
QRectF mapRectToScene (const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value.
 
QPointF mapFromScene (const QPointF &point) const
 Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
 
QRectF mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
 
QRectF mapRectFromScene (const QRectF &rect) const
 Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
 
void polish ()
 Schedules a polish event for this item.
 
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
 
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, qreal x, qreal y)
 
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, const QRectF &rect) const
 
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
 
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate.
 
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, qreal x, qreal y)
 
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, const QRectF &rect) const
 
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const
 
Q_INVOKABLE void forceActiveFocus ()
 \qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r)
 
Q_INVOKABLE void forceActiveFocus (Qt::FocusReason reason)
 \qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason.
 
 Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward
 
Q_INVOKABLE QQuickItem * childAt (qreal x, qreal y) const
 \qmlmethod QtQuick::Item::childAt(real x, real y)
 
 Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()
 
 Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const
 
virtual bool isTextureProvider () const
 Returns true if this item is a texture provider.
 
virtual QSGTextureProvider * textureProvider () const
 Returns the texture provider for an item.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Slots

void reset ()
 

Protected Member Functions

void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
QSGNode * updatePaintNode (QSGNode *, UpdatePaintNodeData *) override
 Called on the render thread when it is time to sync the state of the item with the scene graph.
 
void itemChange (ItemChange, const ItemChangeData &) override
 Called when change occurs for this item.
 
- Protected Member Functions inherited from QQuickItem
bool event (QEvent *) override
 \reimp
 
bool isComponentComplete () const
 Returns true if construction of the QML component is complete; otherwise returns false.
 
virtual void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry)
 
bool widthValid () const
 Returns whether the width property has been set explicitly.
 
bool heightValid () const
 Returns whether the height property has been set explicitly.
 
void setImplicitSize (qreal, qreal)
 
void classBegin () override
 \reimp Derived classes should call the base class method before adding their own action to perform at classBegin.
 
void componentComplete () override
 \reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.
 
virtual void keyPressEvent (QKeyEvent *event)
 This event handler can be reimplemented in a subclass to receive key press events for an item.
 
virtual void keyReleaseEvent (QKeyEvent *event)
 This event handler can be reimplemented in a subclass to receive key release events for an item.
 
virtual void focusInEvent (QFocusEvent *)
 This event handler can be reimplemented in a subclass to receive focus-in events for an item.
 
virtual void focusOutEvent (QFocusEvent *)
 This event handler can be reimplemented in a subclass to receive focus-out events for an item.
 
virtual void mousePressEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse press events for an item.
 
virtual void mouseMoveEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse move events for an item.
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse release events for an item.
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.
 
virtual void mouseUngrabEvent ()
 This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.
 
virtual void touchUngrabEvent ()
 This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.
 
virtual void touchEvent (QTouchEvent *event)
 This event handler can be reimplemented in a subclass to receive touch events for an item.
 
virtual void hoverEnterEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-enter events for an item.
 
virtual void hoverMoveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-move events for an item.
 
virtual void hoverLeaveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-leave events for an item.
 
virtual bool childMouseEventFilter (QQuickItem *, QEvent *)
 Reimplement this method to filter the pointer events that are received by this item's children.
 
virtual void releaseResources ()
 This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().
 
virtual void updatePolish ()
 This function should perform any layout as required for this item.
 
 QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Properties

bool running
 
bool interpolate
 
QUrl source
 
bool reverse
 
bool frameSync
 
int frameCount
 
int frameHeight
 
int frameWidth
 
int frameX
 
int frameY
 
qreal frameRate
 
int frameDuration
 
int loops
 
bool paused
 
int currentFrame
 
FinishBehavior finishBehavior
 
- Properties inherited from QQuickItem
QQuickItem * parent
 \qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item.
 
qreal x
 \qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height
 
qreal y
 Defines the item's y position relative to its parent.
 
qreal z
 \qmlproperty real QtQuick::Item::z
 
qreal width
 This property holds the width of this item.
 
qreal height
 This property holds the height of this item.
 
qreal opacity
 \qmlproperty real QtQuick::Item::opacity
 
bool enabled
 \qmlproperty bool QtQuick::Item::enabled
 
bool visible
 \qmlproperty bool QtQuick::Item::visible
 
Qt::FocusPolicy focusPolicy
 \qmlproperty enumeration QtQuick::Item::focusPolicy
 
qreal rotation
 \qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin.
 
qreal scale
 \qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item.
 
TransformOrigin transformOrigin
 \qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform.
 
QPointF transformOriginPoint
 
QQmlListProperty< QQuickTransform > transform
 \qmlproperty list<Transform> QtQuick::Item::transform This property holds the list of transformations to apply.
 
bool smooth
 \qmlproperty bool QtQuick::Item::smooth
 
bool antialiasing
 \qmlproperty bool QtQuick::Item::antialiasing
 
qreal implicitWidth
 
qreal implicitHeight
 
QObject * containmentMask
 \qmlproperty QObject* QtQuick::Item::containmentMask
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Public Attributes inherited from QQuickItem
const QSize & targetSize = QSize())
 
qreal y const
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 34 of file qquickanimatedsprite_p.h.

Member Enumeration Documentation

◆ FinishBehavior

enum QQuickAnimatedSprite::FinishBehavior
Enumerator
FinishAtInitialFrame 
FinishAtFinalFrame 

Definition at line 69 of file qquickanimatedsprite_p.h.

◆ LoopParameters

enum QQuickAnimatedSprite::LoopParameters
Enumerator
Infinite 

Definition at line 64 of file qquickanimatedsprite_p.h.

Constructor & Destructor Documentation

◆ QQuickAnimatedSprite()

QT_BEGIN_NAMESPACE QQuickAnimatedSprite::QQuickAnimatedSprite ( QQuickItem * parent = nullptr)
explicit

\qmltype AnimatedSprite \instantiates QQuickAnimatedSprite \inqmlmodule QtQuick \inherits Item

Draws a sprite animation.

AnimatedSprite provides rendering and control over animations which are provided as multiple frames in the same image file. You can play it at a fixed speed, at the frame rate of your display, or manually advance and control the progress.

Consider the following sprite sheet:

It can be divided up into four frames:

To play each of these frames at a speed of 500 milliseconds per frame, the following code can be used:

\table \header

By default, the frames are interpolated (blended together) to make the animation appear smoother. To disable this, set \l interpolate to false:

\table \header

To control how AnimatedSprite responds to being scaled, use the \l {Item::}{smooth} property.

Note that unlike \l SpriteSequence, the AnimatedSprite type does not use \l Sprite to define multiple animations, but instead encapsulates a single animation itself.

See also
{Sprite Animations}

\qmlproperty bool QtQuick::AnimatedSprite::running

Whether the sprite is animating or not.

Default is true

\qmlproperty bool QtQuick::AnimatedSprite::interpolate

If true, interpolation will occur between sprite frames to make the animation appear smoother.

Default is true.

\qmlproperty qreal QtQuick::AnimatedSprite::frameRate

Frames per second to show in the animation. Values less than or equal to 0 are invalid.

If frameRate is valid, it will be used to calculate the duration of the frames. If not, and \l frameDuration is valid, frameDuration will be used.

Changing this parameter will restart the animation.

\qmlproperty int QtQuick::AnimatedSprite::frameDuration

Duration of each frame of the animation in milliseconds. Values less than or equal to 0 are invalid.

If frameRate is valid, it will be used to calculate the duration of the frames. If not, and \l frameDuration is valid, frameDuration will be used.

Changing this parameter will restart the animation.

\qmlproperty int QtQuick::AnimatedSprite::frameCount

Number of frames in this AnimatedSprite.

\qmlproperty int QtQuick::AnimatedSprite::frameHeight

Height of a single frame in this AnimatedSprite.

May be omitted if it is the only sprite in the file.

\qmlproperty int QtQuick::AnimatedSprite::frameWidth

Width of a single frame in this AnimatedSprite.

May be omitted if it is the only sprite in the file.

\qmlproperty int QtQuick::AnimatedSprite::frameX

The X coordinate in the image file of the first frame of the AnimatedSprite.

May be omitted if the first frame starts in the upper left corner of the file.

\qmlproperty int QtQuick::AnimatedSprite::frameY

The Y coordinate in the image file of the first frame of the AnimatedSprite.

May be omitted if the first frame starts in the upper left corner of the file.

\qmlproperty url QtQuick::AnimatedSprite::source

The image source for the animation.

If frameHeight and frameWidth are not specified, it is assumed to be a single long row of square frames. Otherwise, it can be multiple contiguous rows or rectangluar frames, when one row runs out the next will be used.

If frameX and frameY are specified, the row of frames will be taken with that x/y coordinate as the upper left corner.

\qmlproperty bool QtQuick::AnimatedSprite::reverse

If true, the animation will be played in reverse.

Default is false.

\qmlproperty bool QtQuick::AnimatedSprite::frameSync

If true, the animation will have no duration. Instead, the animation will advance one frame each time a frame is rendered to the screen. This synchronizes it with the painting rate as opposed to elapsed time.

If frameSync is set to true, it overrides both frameRate and frameDuration.

Default is false.

Changing this parameter will restart the animation.

\qmlproperty int QtQuick::AnimatedSprite::loops

After playing the animation this many times, the animation will automatically stop. Negative values are invalid.

If this is set to AnimatedSprite.Infinite the animation will not stop playing on its own.

Default is AnimatedSprite.Infinite

\qmlproperty bool QtQuick::AnimatedSprite::paused

When paused, the current frame can be advanced manually.

Default is false.

\qmlproperty int QtQuick::AnimatedSprite::currentFrame

When paused, the current frame can be advanced manually by setting this property or calling \l advance().

\qmlproperty enumeration QtQuick::AnimatedSprite::finishBehavior

The behavior when the animation finishes on its own.

\value FinishAtInitialFrame When the animation finishes it returns to the initial frame. This is the default behavior.

\value FinishAtFinalFrame When the animation finishes it stays on the final frame.

\qmlmethod int QtQuick::AnimatedSprite::restart()

Stops, then starts the sprite animation.

\qmlsignal QtQuick::AnimatedSprite::finished()

Since
5.12

This signal is emitted when the sprite has finished animating.

It is not emitted when running is set to false, nor for sprites whose \l loops property is set to AnimatedSprite.Infinite.

Definition at line 258 of file qquickanimatedsprite.cpp.

References QObject::connect(), d, QQuickItem::heightChanged(), QQuickItem::ItemHasContents, reset(), QQuickItem::setFlag(), SIGNAL, SLOT, and QQuickItem::widthChanged().

+ Here is the call graph for this function:

Member Function Documentation

◆ advance

void QQuickAnimatedSprite::advance ( int frames = 1)
slot

\qmlmethod int QtQuick::AnimatedSprite::advance()

Advances the sprite animation by one frame.

Definition at line 447 of file qquickanimatedsprite.cpp.

References currentFrameChanged(), d, and emit.

+ Here is the call graph for this function:

◆ componentComplete()

void QQuickAnimatedSprite::componentComplete ( )
overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 379 of file qquickanimatedsprite.cpp.

References QQuickItem::componentComplete(), d, and start().

+ Here is the call graph for this function:

◆ currentFrame()

int QQuickAnimatedSprite::currentFrame ( ) const

Definition at line 355 of file qquickanimatedsprite.cpp.

References d.

◆ currentFrameChanged

void QQuickAnimatedSprite::currentFrameChanged ( int arg)
signal

Referenced by advance(), setCurrentFrame(), and start().

+ Here is the caller graph for this function:

◆ finishBehavior()

QQuickAnimatedSprite::FinishBehavior QQuickAnimatedSprite::finishBehavior ( ) const

Definition at line 361 of file qquickanimatedsprite.cpp.

References d.

◆ frameCount()

int QQuickAnimatedSprite::frameCount ( ) const

Definition at line 301 of file qquickanimatedsprite.cpp.

References d.

◆ frameCountChanged

void QQuickAnimatedSprite::frameCountChanged ( int arg)
signal

Referenced by setFrameCount().

+ Here is the caller graph for this function:

◆ frameDuration()

int QQuickAnimatedSprite::frameDuration ( ) const

Definition at line 337 of file qquickanimatedsprite.cpp.

References d.

◆ frameDurationChanged

void QQuickAnimatedSprite::frameDurationChanged ( int arg)
signal

Referenced by setFrameDuration().

+ Here is the caller graph for this function:

◆ frameHeight()

int QQuickAnimatedSprite::frameHeight ( ) const

Definition at line 307 of file qquickanimatedsprite.cpp.

References d.

◆ frameHeightChanged

void QQuickAnimatedSprite::frameHeightChanged ( int arg)
signal

Referenced by setFrameHeight().

+ Here is the caller graph for this function:

◆ frameRate()

qreal QQuickAnimatedSprite::frameRate ( ) const

Definition at line 331 of file qquickanimatedsprite.cpp.

References d.

◆ frameRateChanged

void QQuickAnimatedSprite::frameRateChanged ( qreal arg)
signal

Referenced by setFrameRate().

+ Here is the caller graph for this function:

◆ frameSync()

bool QQuickAnimatedSprite::frameSync ( ) const

Definition at line 295 of file qquickanimatedsprite.cpp.

References d.

◆ frameSyncChanged

void QQuickAnimatedSprite::frameSyncChanged ( bool arg)
signal

Referenced by setFrameSync().

+ Here is the caller graph for this function:

◆ frameWidth()

int QQuickAnimatedSprite::frameWidth ( ) const

Definition at line 313 of file qquickanimatedsprite.cpp.

References d.

◆ frameWidthChanged

void QQuickAnimatedSprite::frameWidthChanged ( int arg)
signal

Referenced by setFrameWidth().

+ Here is the caller graph for this function:

◆ frameX()

int QQuickAnimatedSprite::frameX ( ) const

Definition at line 319 of file qquickanimatedsprite.cpp.

References d.

◆ frameXChanged

void QQuickAnimatedSprite::frameXChanged ( int arg)
signal

Referenced by setFrameX().

+ Here is the caller graph for this function:

◆ frameY()

int QQuickAnimatedSprite::frameY ( ) const

Definition at line 325 of file qquickanimatedsprite.cpp.

References d.

◆ frameYChanged

void QQuickAnimatedSprite::frameYChanged ( int arg)
signal

Referenced by setFrameY().

+ Here is the caller graph for this function:

◆ interpolate()

bool QQuickAnimatedSprite::interpolate ( ) const

Definition at line 277 of file qquickanimatedsprite.cpp.

References d.

◆ interpolateChanged

void QQuickAnimatedSprite::interpolateChanged ( bool arg)
signal

Referenced by setInterpolate().

+ Here is the caller graph for this function:

◆ itemChange()

void QQuickAnimatedSprite::itemChange ( ItemChange change,
const ItemChangeData & value )
overrideprotectedvirtual

Called when change occurs for this item.

value contains extra information relating to the change, when applicable.

If you re-implement this method in a subclass, be sure to call

QQuickItem::itemChange(change, value);
QQuickItem::itemChange
virtual void itemChange(ItemChange, const ItemChangeData &)
Called when change occurs for this item.
Definition qquickitem.cpp:5800
value
EGLOutputLayerEXT EGLint EGLAttrib value
[5]
Definition qeglstreamconvenience_p.h:46

typically at the end of your implementation, to ensure the \l windowChanged() signal will be emitted.

Reimplemented from QQuickItem.

Definition at line 469 of file qquickanimatedsprite.cpp.

References d, QQuickItem::itemChange(), and QQuickItem::ItemVisibleHasChanged.

+ Here is the call graph for this function:

◆ loops()

int QQuickAnimatedSprite::loops ( ) const

Definition at line 343 of file qquickanimatedsprite.cpp.

References d.

◆ loopsChanged

void QQuickAnimatedSprite::loopsChanged ( int arg)
signal

Referenced by setLoops().

+ Here is the caller graph for this function:

◆ pause

void QQuickAnimatedSprite::pause ( )
slot

\qmlmethod int QtQuick::AnimatedSprite::pause()

Pauses the sprite animation. This does nothing if \l paused is true.

See also
resume()

Definition at line 485 of file qquickanimatedsprite.cpp.

References d, emit, and pausedChanged().

Referenced by setPaused().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ paused()

bool QQuickAnimatedSprite::paused ( ) const

Definition at line 349 of file qquickanimatedsprite.cpp.

References d.

◆ pausedChanged

void QQuickAnimatedSprite::pausedChanged ( bool arg)
signal

Referenced by pause(), and resume().

+ Here is the caller graph for this function:

◆ Q_REVISION [1/2]

QQuickAnimatedSprite::Q_REVISION ( 2 ,
12  )
signal

◆ Q_REVISION [2/2]

QQuickAnimatedSprite::Q_REVISION ( 2 ,
15  )
signal

◆ reset

void QQuickAnimatedSprite::reset ( )
protectedslot

Definition at line 766 of file qquickanimatedsprite.cpp.

References d.

Referenced by QQuickAnimatedSprite().

+ Here is the caller graph for this function:

◆ resetFrameDuration

void QQuickAnimatedSprite::resetFrameDuration ( )
slot

Definition at line 672 of file qquickanimatedsprite.cpp.

References setFrameDuration().

+ Here is the call graph for this function:

◆ resetFrameRate

void QQuickAnimatedSprite::resetFrameRate ( )
slot

Definition at line 667 of file qquickanimatedsprite.cpp.

References setFrameRate().

+ Here is the call graph for this function:

◆ restart

void QQuickAnimatedSprite::restart ( )
inlineslot

Definition at line 118 of file qquickanimatedsprite_p.h.

Referenced by setFrameDuration(), setFrameRate(), and setFrameSync().

+ Here is the caller graph for this function:

◆ resume

void QQuickAnimatedSprite::resume ( )
slot

\qmlmethod int QtQuick::AnimatedSprite::resume()

Resumes the sprite animation if \l paused is true; otherwise, this does nothing.

See also
pause()

Definition at line 505 of file qquickanimatedsprite.cpp.

References d, emit, and pausedChanged().

Referenced by setPaused().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ reverse()

bool QQuickAnimatedSprite::reverse ( ) const

Definition at line 289 of file qquickanimatedsprite.cpp.

References d.

◆ reverseChanged

void QQuickAnimatedSprite::reverseChanged ( bool arg)
signal

Referenced by setReverse().

+ Here is the caller graph for this function:

◆ running()

bool QQuickAnimatedSprite::running ( ) const

Definition at line 271 of file qquickanimatedsprite.cpp.

References d.

◆ runningChanged

void QQuickAnimatedSprite::runningChanged ( bool arg)
signal

Referenced by start(), and stop().

+ Here is the caller graph for this function:

◆ setCurrentFrame

void QQuickAnimatedSprite::setCurrentFrame ( int arg)
slot

Definition at line 687 of file qquickanimatedsprite.cpp.

References arg, currentFrameChanged(), d, Q_EMIT, and QQuickItem::update().

+ Here is the call graph for this function:

◆ setFinishBehavior()

void QQuickAnimatedSprite::setFinishBehavior ( FinishBehavior arg)

Definition at line 698 of file qquickanimatedsprite.cpp.

References arg, d, and Q_EMIT.

◆ setFrameCount

void QQuickAnimatedSprite::setFrameCount ( int arg)
slot

Definition at line 586 of file qquickanimatedsprite.cpp.

References arg, d, frameCountChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setFrameDuration

void QQuickAnimatedSprite::setFrameDuration ( int arg)
slot

Definition at line 655 of file qquickanimatedsprite.cpp.

References arg, d, frameDurationChanged(), Q_EMIT, and restart().

Referenced by resetFrameDuration().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFrameHeight

void QQuickAnimatedSprite::setFrameHeight ( int arg)
slot

Definition at line 597 of file qquickanimatedsprite.cpp.

References arg, d, frameHeight, frameHeightChanged(), Q_EMIT, and QQuickItem::setImplicitHeight().

+ Here is the call graph for this function:

◆ setFrameRate

void QQuickAnimatedSprite::setFrameRate ( qreal arg)
slot

Definition at line 643 of file qquickanimatedsprite.cpp.

References arg, d, frameRateChanged(), Q_EMIT, and restart().

Referenced by resetFrameRate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFrameSync

void QQuickAnimatedSprite::setFrameSync ( bool arg)
slot

Definition at line 574 of file qquickanimatedsprite.cpp.

References arg, d, frameSyncChanged(), Q_EMIT, and restart().

+ Here is the call graph for this function:

◆ setFrameWidth

void QQuickAnimatedSprite::setFrameWidth ( int arg)
slot

Definition at line 609 of file qquickanimatedsprite.cpp.

References arg, d, frameWidth, frameWidthChanged(), Q_EMIT, and QQuickItem::setImplicitWidth().

+ Here is the call graph for this function:

◆ setFrameX

void QQuickAnimatedSprite::setFrameX ( int arg)
slot

Definition at line 621 of file qquickanimatedsprite.cpp.

References arg, d, frameXChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setFrameY

void QQuickAnimatedSprite::setFrameY ( int arg)
slot

Definition at line 632 of file qquickanimatedsprite.cpp.

References arg, d, frameYChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setInterpolate

void QQuickAnimatedSprite::setInterpolate ( bool arg)
slot

Definition at line 541 of file qquickanimatedsprite.cpp.

References arg, d, interpolateChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setLoops

void QQuickAnimatedSprite::setLoops ( int arg)
slot

Definition at line 677 of file qquickanimatedsprite.cpp.

References arg, d, loopsChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setPaused

void QQuickAnimatedSprite::setPaused ( bool arg)
slot

Definition at line 529 of file qquickanimatedsprite.cpp.

References arg, d, pause(), and resume().

+ Here is the call graph for this function:

◆ setReverse

void QQuickAnimatedSprite::setReverse ( bool arg)
slot

Definition at line 564 of file qquickanimatedsprite.cpp.

References arg, d, Q_EMIT, and reverseChanged().

+ Here is the call graph for this function:

◆ setRunning

void QQuickAnimatedSprite::setRunning ( bool arg)
slot

Definition at line 517 of file qquickanimatedsprite.cpp.

References arg, d, start(), and stop().

+ Here is the call graph for this function:

◆ setSource

void QQuickAnimatedSprite::setSource ( const QUrl & arg)
slot

Definition at line 551 of file qquickanimatedsprite.cpp.

References arg, d, Q_EMIT, qApp, sourceChanged(), and QQuickItem::window().

+ Here is the call graph for this function:

◆ source()

QUrl QQuickAnimatedSprite::source ( ) const

Definition at line 283 of file qquickanimatedsprite.cpp.

References d.

◆ sourceChanged

void QQuickAnimatedSprite::sourceChanged ( const QUrl & arg)
signal

Referenced by setSource().

+ Here is the caller graph for this function:

◆ start

void QQuickAnimatedSprite::start ( )
slot

\qmlmethod QtQuick::AnimatedSprite::start()

Since
5.15

Starts the sprite animation. If the animation is already running, calling this method has no effect.

See also
stop()

Definition at line 399 of file qquickanimatedsprite.cpp.

References currentFrameChanged(), d, emit, QQuickItem::isComponentComplete(), and runningChanged().

Referenced by componentComplete(), and setRunning().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stop

void QQuickAnimatedSprite::stop ( )
slot

\qmlmethod QtQuick::AnimatedSprite::stop()

Since
5.15

Stops the sprite animation. If the animation is not running, calling this method has no effect.

See also
start()

Definition at line 429 of file qquickanimatedsprite.cpp.

References d, emit, QQuickItem::isComponentComplete(), and runningChanged().

Referenced by setRunning().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ updatePaintNode()

QSGNode * QQuickAnimatedSprite::updatePaintNode ( QSGNode * oldNode,
UpdatePaintNodeData * updatePaintNodeData )
overrideprotectedvirtual

Called on the render thread when it is time to sync the state of the item with the scene graph.

The function is called as a result of QQuickItem::update(), if the user has set the QQuickItem::ItemHasContents flag on the item.

The function should return the root of the scene graph subtree for this item. Most implementations will return a single QSGGeometryNode containing the visual representation of this item. oldNode is the node that was returned the last time the function was called. updatePaintNodeData provides a pointer to the QSGTransformNode associated with this QQuickItem.

QSGNode *MyItem::updatePaintNode(QSGNode *node, UpdatePaintNodeData *)
{
QSGSimpleRectNode *n = static_cast<QSGSimpleRectNode *>(node);
if (!n) {
n = new QSGSimpleRectNode();
n->setColor(Qt::red);
}
n->setRect(boundingRect());
return n;
}
QQuickItem::boundingRect
virtual QRectF boundingRect() const
Returns the extents of the item in its own coordinate system: a rectangle from {0,...
Definition qquickitem.cpp:5822
QSGNode
\group qtquick-scenegraph-nodes \title Qt Quick Scene Graph Node classes
Definition qsgnode.h:37
QSGSimpleRectNode
The QSGSimpleRectNode class is a convenience class for drawing solid filled rectangles using scenegra...
Definition qsgsimplerectnode.h:13
Qt::red
@ red
Definition qnamespace.h:35
n
GLfloat n
Definition qopengles2ext.h:795

The main thread is blocked while this function is executed so it is safe to read values from the QQuickItem instance and other objects in the main thread.

If no call to QQuickItem::updatePaintNode() result in actual scene graph changes, like QSGNode::markDirty() or adding and removing nodes, then the underlying implementation may decide to not render the scene again as the visual outcome is identical.

Warning
It is crucial that graphics operations and interaction with the scene graph happens exclusively on the render thread, primarily during the QQuickItem::updatePaintNode() call. The best rule of thumb is to only use classes with the "QSG" prefix inside the QQuickItem::updatePaintNode() function.
This function is called on the render thread. This means any QObjects or thread local storage that is created will have affinity to the render thread, so apply caution when doing anything other than rendering in this function. Similarly for signals, these will be emitted on the render thread and will thus often be delivered via queued connections.
Note
All classes with QSG prefix should be used solely on the scene graph's rendering thread. See \l {Scene Graph and Rendering} for more information.
See also
QSGMaterial, QSGGeometryNode, QSGGeometry, QSGFlatColorMaterial, QSGTextureMaterial, QSGNode::markDirty(), {Graphics Resource Handling}

Reimplemented from QQuickItem.

Definition at line 773 of file qquickanimatedsprite.cpp.

References d.

Property Documentation

◆ currentFrame

int QQuickAnimatedSprite::currentFrame
readwrite

Definition at line 57 of file qquickanimatedsprite_p.h.

◆ finishBehavior

FinishBehavior QQuickAnimatedSprite::finishBehavior
readwrite

Definition at line 58 of file qquickanimatedsprite_p.h.

◆ frameCount

int QQuickAnimatedSprite::frameCount
readwrite

Definition at line 44 of file qquickanimatedsprite_p.h.

◆ frameDuration

int QQuickAnimatedSprite::frameDuration
readwrite

Definition at line 53 of file qquickanimatedsprite_p.h.

◆ frameHeight

int QQuickAnimatedSprite::frameHeight
readwrite

Definition at line 47 of file qquickanimatedsprite_p.h.

Referenced by setFrameHeight().

◆ frameRate

qreal QQuickAnimatedSprite::frameRate
readwrite

Definition at line 52 of file qquickanimatedsprite_p.h.

◆ frameSync

bool QQuickAnimatedSprite::frameSync
readwrite

Definition at line 43 of file qquickanimatedsprite_p.h.

◆ frameWidth

int QQuickAnimatedSprite::frameWidth
readwrite

Definition at line 48 of file qquickanimatedsprite_p.h.

Referenced by setFrameWidth().

◆ frameX

int QQuickAnimatedSprite::frameX
readwrite

Definition at line 49 of file qquickanimatedsprite_p.h.

◆ frameY

int QQuickAnimatedSprite::frameY
readwrite

Definition at line 50 of file qquickanimatedsprite_p.h.

◆ interpolate

bool QQuickAnimatedSprite::interpolate
readwrite

Definition at line 38 of file qquickanimatedsprite_p.h.

◆ loops

int QQuickAnimatedSprite::loops
readwrite

Definition at line 55 of file qquickanimatedsprite_p.h.

◆ paused

bool QQuickAnimatedSprite::paused
readwrite

Definition at line 56 of file qquickanimatedsprite_p.h.

◆ reverse

bool QQuickAnimatedSprite::reverse
readwrite

Definition at line 42 of file qquickanimatedsprite_p.h.

◆ running

bool QQuickAnimatedSprite::running
readwrite

Definition at line 37 of file qquickanimatedsprite_p.h.

◆ source

QUrl QQuickAnimatedSprite::source
readwrite

Definition at line 41 of file qquickanimatedsprite_p.h.

The documentation for this class was generated from the following files: