src/quick/items/qquickspriteimage_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   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 <QtQuick/QQuickItem>
  46 #include <QTime>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 class QSGContext;
  53 class QQuickSprite;
  54 class QQuickSpriteEngine;
  55 class QSGGeometryNode;
  56 class QQuickSpriteMaterial;
  57 class Q_AUTOTEST_EXPORT QQuickSpriteImage : public QQuickItem
  58 {
  59     Q_OBJECT
  60     Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged)
  61     Q_PROPERTY(bool interpolate READ interpolate WRITE setInterpolate NOTIFY interpolateChanged)
  62     Q_PROPERTY(QString goalSprite READ goalSprite WRITE setGoalSprite NOTIFY goalSpriteChanged)
  63     Q_PROPERTY(QString currentSprite READ currentSprite NOTIFY currentSpriteChanged)
  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     QString goalSprite() const
  84     {
  85         return m_goalState;
  86     }
  87
  88     QString currentSprite() const
  89     {
  90         return m_curState;
  91     }
  92
  93 signals:
  94
  95     void runningChanged(bool arg);
  96     void interpolateChanged(bool arg);
  97     void goalSpriteChanged(QString arg);
  98     void currentSpriteChanged(QString arg);
  99
 100 public slots:
 101
 102     void jumpTo(const QString &sprite);
 103     void setGoalSprite(const QString &sprite);
 104
 105     void setRunning(bool arg)
 106     {
 107         if (m_running != arg) {
 108             m_running = arg;
 109             emit runningChanged(arg);
 110         }
 111     }
 112
 113     void setInterpolate(bool arg)
 114     {
 115         if (m_interpolate != arg) {
 116             m_interpolate = arg;
 117             emit interpolateChanged(arg);
 118         }
 119     }
 120
 121 private slots:
 122     void createEngine();
 123 protected:
 124     void reset();
 125     QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *);
 126 private:
 127     void prepareNextFrame();
 128     QSGGeometryNode* buildNode();
 129     QSGGeometryNode *m_node;
 130     QQuickSpriteMaterial *m_material;
 131     QList<QQuickSprite*> m_sprites;
 132     QQuickSpriteEngine* m_spriteEngine;
 133     QTime m_timestamp;
 134     int m_curFrame;
 135     bool m_pleaseReset;
 136     bool m_running;
 137     bool m_interpolate;
 138     QString m_goalState;
 139     QString m_curState;
 140     int m_curStateIdx;
 141     QSizeF m_sheetSize;
 142 };
 143
 144 QT_END_NAMESPACE
 145
 146 QT_END_HEADER
 147
 148 #endif // QQUICKSPRITEIMAGE_P_H