blob: 35b3f468904985f9f40ef046c8ca24353c87daee (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtQuick module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/
#ifndef QQUICKANIMATEDSPRITE_P_H
#define QQUICKANIMATEDSPRITE_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <private/qtquickglobal_p.h>
QT_REQUIRE_CONFIG(quick_sprite);
#include <QtQuick/QQuickItem>
#include <private/qquicksprite_p.h>
#include <QtCore/qelapsedtimer.h>
QT_BEGIN_NAMESPACE
class QSGContext;
class QQuickSprite;
class QQuickSpriteEngine;
class QSGGeometryNode;
class QQuickAnimatedSpriteMaterial;
class QQuickAnimatedSpritePrivate;
class QSGSpriteNode;
class Q_AUTOTEST_EXPORT QQuickAnimatedSprite : public QQuickItem
{
Q_OBJECT
Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged)
Q_PROPERTY(bool interpolate READ interpolate WRITE setInterpolate NOTIFY interpolateChanged)
//###try to share similar spriteEngines for less overhead?
//These properties come out of QQuickSprite, since an AnimatedSprite is a renderer for a single sprite
Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
Q_PROPERTY(bool reverse READ reverse WRITE setReverse NOTIFY reverseChanged)
Q_PROPERTY(bool frameSync READ frameSync WRITE setFrameSync NOTIFY frameSyncChanged)
Q_PROPERTY(int frameCount READ frameCount WRITE setFrameCount NOTIFY frameCountChanged)
//If frame height or width is not specified, it is assumed to be a single long row of square frames.
//Otherwise, it can be multiple contiguous rows, when one row runs out the next will be used.
Q_PROPERTY(int frameHeight READ frameHeight WRITE setFrameHeight NOTIFY frameHeightChanged)
Q_PROPERTY(int frameWidth READ frameWidth WRITE setFrameWidth NOTIFY frameWidthChanged)
Q_PROPERTY(int frameX READ frameX WRITE setFrameX NOTIFY frameXChanged)
Q_PROPERTY(int frameY READ frameY WRITE setFrameY NOTIFY frameYChanged)
//Precedence order: frameRate, frameDuration
Q_PROPERTY(qreal frameRate READ frameRate WRITE setFrameRate NOTIFY frameRateChanged RESET resetFrameRate)
Q_PROPERTY(int frameDuration READ frameDuration WRITE setFrameDuration NOTIFY frameDurationChanged RESET resetFrameDuration)
//Extra Simple Sprite Stuff
Q_PROPERTY(int loops READ loops WRITE setLoops NOTIFY loopsChanged)
Q_PROPERTY(bool paused READ paused WRITE setPaused NOTIFY pausedChanged)
Q_PROPERTY(int currentFrame READ currentFrame WRITE setCurrentFrame NOTIFY currentFrameChanged)
Q_PROPERTY(FinishBehavior finishBehavior READ finishBehavior WRITE setFinishBehavior NOTIFY finishBehaviorChanged REVISION 15)
QML_NAMED_ELEMENT(AnimatedSprite)
public:
explicit QQuickAnimatedSprite(QQuickItem *parent = nullptr);
enum LoopParameters {
Infinite = -1
};
Q_ENUM(LoopParameters)
enum FinishBehavior {
FinishAtInitialFrame,
FinishAtFinalFrame
};
Q_ENUM(FinishBehavior)
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);
Q_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(15) void finishBehaviorChanged(FinishBehavior arg);
Q_REVISION(12) void finished();
public Q_SLOTS:
void start();
void stop();
void restart() {stop(); start();}
void advance(int frames=1);
void pause();
void 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);
private Q_SLOTS:
void createEngine();
protected Q_SLOTS:
void reset();
protected:
void componentComplete() override;
QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *) override;
void itemChange(ItemChange, const ItemChangeData &) override;
private:
void maybeUpdate();
bool isCurrentFrameChangedConnected();
void prepareNextFrame(QSGSpriteNode *node);
void reloadImage();
QSGSpriteNode* initNode();
private:
Q_DISABLE_COPY(QQuickAnimatedSprite)
Q_DECLARE_PRIVATE(QQuickAnimatedSprite)
};
QT_END_NAMESPACE
#endif // QQUICKANIMATEDSPRITE_P_H
|
