1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQUICKSPRITESEQUENCE_P_H
41#define QQUICKSPRITESEQUENCE_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <private/qtquickglobal_p.h>
55
56QT_REQUIRE_CONFIG(quick_sprite);
57
58#include <QtQuick/QQuickItem>
59
60QT_BEGIN_NAMESPACE
61
62class QSGContext;
63class QQuickSprite;
64class QQuickSpriteEngine;
65class QQuickSpriteSequencePrivate;
66class QSGSpriteNode;
67class Q_AUTOTEST_EXPORT QQuickSpriteSequence : public QQuickItem
68{
69 Q_OBJECT
70 Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged)
71 Q_PROPERTY(bool interpolate READ interpolate WRITE setInterpolate NOTIFY interpolateChanged)
72 Q_PROPERTY(QString goalSprite READ goalSprite WRITE setGoalSprite NOTIFY goalSpriteChanged)
73 Q_PROPERTY(QString currentSprite READ currentSprite NOTIFY currentSpriteChanged)
74 //###try to share similar spriteEngines for less overhead?
75 Q_PROPERTY(QQmlListProperty<QQuickSprite> sprites READ sprites)
76 Q_CLASSINFO("DefaultProperty", "sprites")
77 QML_NAMED_ELEMENT(SpriteSequence)
78
79public:
80 explicit QQuickSpriteSequence(QQuickItem *parent = nullptr);
81
82 QQmlListProperty<QQuickSprite> sprites();
83
84 bool running() const;
85 bool interpolate() const;
86 QString goalSprite() const;
87 QString currentSprite() const;
88
89Q_SIGNALS:
90
91 void runningChanged(bool arg);
92 void interpolateChanged(bool arg);
93 void goalSpriteChanged(const QString &arg);
94 void currentSpriteChanged(const QString &arg);
95
96public Q_SLOTS:
97
98 void jumpTo(const QString &sprite);
99 void setGoalSprite(const QString &sprite);
100 void setRunning(bool arg);
101 void setInterpolate(bool arg);
102
103private Q_SLOTS:
104 void createEngine();
105
106protected:
107 void reset();
108 QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *) override;
109private:
110 void prepareNextFrame(QSGSpriteNode *node);
111 QSGSpriteNode* initNode();
112
113
114private:
115 Q_DISABLE_COPY(QQuickSpriteSequence)
116 Q_DECLARE_PRIVATE(QQuickSpriteSequence)
117};
118
119QT_END_NAMESPACE
120
121#endif // QQUICKSPRITESEQUENCE_P_H
122

source code of qtdeclarative/src/quick/items/qquickspritesequence_p.h