Rename Qt Quick-specific classes to QQuick*
[profile/ivi/qtdeclarative.git] / src / declarative / items / qquickspriteimage_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the Declarative module of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QQUICKSPRITEIMAGE_P_H
43 #define QQUICKSPRITEIMAGE_P_H
44
45 #include <QQuickItem>
46 #include <QTime>
47
48 QT_BEGIN_HEADER
49
50 QT_BEGIN_NAMESPACE
51
52 QT_MODULE(Declarative)
53
54 class QSGContext;
55 class QQuickSprite;
56 class QQuickSpriteEngine;
57 class QSGGeometryNode;
58 class QQuickSpriteMaterial;
59 class QQuickSpriteImage : public QQuickItem
60 {
61     Q_OBJECT
62     Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged)
63     Q_PROPERTY(bool interpolate READ interpolate WRITE setInterpolate NOTIFY interpolateChanged)
64     //###try to share similar spriteEngines for less overhead?
65     Q_PROPERTY(QDeclarativeListProperty<QQuickSprite> sprites READ sprites)
66     Q_CLASSINFO("DefaultProperty", "sprites")
67
68 public:
69     explicit QQuickSpriteImage(QQuickItem *parent = 0);
70
71     QDeclarativeListProperty<QQuickSprite> sprites();
72
73     bool running() const
74     {
75         return m_running;
76     }
77
78     bool interpolate() const
79     {
80         return m_interpolate;
81     }
82
83 signals:
84
85     void runningChanged(bool arg);
86     void interpolateChanged(bool arg);
87
88 public slots:
89
90 void setRunning(bool arg)
91 {
92     if (m_running != arg) {
93         m_running = arg;
94         emit runningChanged(arg);
95     }
96 }
97
98 void setInterpolate(bool arg)
99 {
100     if (m_interpolate != arg) {
101         m_interpolate = arg;
102         emit interpolateChanged(arg);
103     }
104 }
105
106 private slots:
107     void createEngine();
108 protected:
109     void reset();
110     QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *);
111 private:
112     void prepareNextFrame();
113     QSGGeometryNode* buildNode();
114     QSGGeometryNode *m_node;
115     QQuickSpriteMaterial *m_material;
116     QList<QQuickSprite*> m_sprites;
117     QQuickSpriteEngine* m_spriteEngine;
118     QTime m_timestamp;
119     int m_maxFrames;
120     bool m_pleaseReset;
121     bool m_running;
122     bool m_interpolate;
123 };
124
125 QT_END_NAMESPACE
126
127 QT_END_HEADER
128
129 #endif // QQUICKSPRITEIMAGE_P_H