Rename SpriteImage to SpriteSequence

Also rename Sprite::frames->Sprite::frameCount

Change-Id: I2e7a71adc37044fd696ffda2a5da4835725ba3a8
Reviewed-by: Alan Alpert <alan.alpert@nokia.com>

6 files changed, 65 insertions, 51 deletions

diff --git a/src/quick/items/items.pri b/src/quick/items/items.pri
index bdd1692e85..21bf7cc8c1 100644
--- a/src/quick/items/items.pri
+++ b/src/quick/items/items.pri
@@ -65,7 +65,7 @@ HEADERS += \
     $$PWD/qquickimplicitsizeitem_p_p.h \
     $$PWD/qquickspriteengine_p.h \
     $$PWD/qquicksprite_p.h \
-    $$PWD/qquickspriteimage_p.h \
+    $$PWD/qquickspritesequence_p.h \
     $$PWD/qquickanimatedsprite_p.h \
     $$PWD/qquickdrag_p.h \
     $$PWD/qquickdroparea_p.h \
@@ -117,7 +117,7 @@ SOURCES += \
     $$PWD/qquickimplicitsizeitem.cpp \
     $$PWD/qquickspriteengine.cpp \
     $$PWD/qquicksprite.cpp \
-    $$PWD/qquickspriteimage.cpp \
+    $$PWD/qquickspritesequence.cpp \
     $$PWD/qquickanimatedsprite.cpp \
     $$PWD/qquickaccessibleattached.cpp \
     $$PWD/qquickdrag.cpp \
diff --git a/src/quick/items/qquickitemsmodule.cpp b/src/quick/items/qquickitemsmodule.cpp
index 2c74e3c91c..b9e401a231 100644
--- a/src/quick/items/qquickitemsmodule.cpp
+++ b/src/quick/items/qquickitemsmodule.cpp
@@ -77,7 +77,7 @@
 #include <QtQuick/private/qquickcanvasitem_p.h>
 #include <QtQuick/private/qquickcontext2d_p.h>
 #include "qquicksprite_p.h"
-#include "qquickspriteimage_p.h"
+#include "qquickspritesequence_p.h"
 #include "qquickanimatedsprite_p.h"
 #include "qquickdrag_p.h"
 #include "qquickdroparea_p.h"
@@ -202,7 +202,8 @@ static void qt_quickitems_defineModule(const char *uri, int major, int minor)
 
     qmlRegisterType<QQuickSprite>("QtQuick", 2, 0, "Sprite");
     qmlRegisterType<QQuickAnimatedSprite>("QtQuick", 2, 0, "AnimatedSprite");
-    qmlRegisterType<QQuickSpriteImage>("QtQuick", 2, 0, "SpriteImage");
+    qmlRegisterType<QQuickSpriteSequence>("QtQuick", 2, 0, "SpriteSequence");
+    qmlRegisterType<QQuickSpriteSequence>("QtQuick", 2, 0, "SpriteImage");//Deprecation in progress
 
     qmlRegisterType<QQuickParentChange>(uri, major, minor,"ParentChange");
     qmlRegisterType<QQuickAnchorChanges>(uri, major, minor,"AnchorChanges");
diff --git a/src/quick/items/qquicksprite.cpp b/src/quick/items/qquicksprite.cpp
index 4de7880916..2a1bd08d59 100644
--- a/src/quick/items/qquicksprite.cpp
+++ b/src/quick/items/qquicksprite.cpp
@@ -145,7 +145,7 @@ QT_BEGIN_NAMESPACE
     will repeat itself after completing.
 */
 /*!
-    \qmlproperty int QtQuick2::Sprite::frames
+    \qmlproperty int QtQuick2::Sprite::frameCount
 
     Number of frames in this sprite.
 */
diff --git a/src/quick/items/qquicksprite_p.h b/src/quick/items/qquicksprite_p.h
index 98cc90ad8c..dd6560f5ab 100644
--- a/src/quick/items/qquicksprite_p.h
+++ b/src/quick/items/qquicksprite_p.h
@@ -48,6 +48,7 @@
 #include <QDeclarativeListProperty>
 #include <QtQuick/private/qdeclarativepixmapcache_p.h>
 #include "qquickspriteengine_p.h"
+#include <QDebug>
 
 QT_BEGIN_HEADER
 
@@ -60,7 +61,8 @@ class QQuickSprite : public QQuickStochasticState
     //Renderers have to query this hint when advancing frames
     Q_PROPERTY(bool reverse READ reverse WRITE setReverse NOTIFY reverseChanged)
     Q_PROPERTY(bool frameSync READ frameSync WRITE setFrameSync NOTIFY frameSyncChanged)
-    Q_PROPERTY(int frames READ frames WRITE setFrames NOTIFY framesChanged)
+    Q_PROPERTY(int frames READ frames WRITE setFrames NOTIFY frameCountChanged)
+    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)
@@ -101,6 +103,11 @@ public:
         return m_frames;
     }
 
+    int frameCount() const
+    {
+        return m_frames;
+    }
+
     int frameX() const
     {
         return m_frameX;
@@ -158,7 +165,7 @@ signals:
 
     void reverseChanged(bool arg);
 
-    void framesChanged(int arg);
+    void frameCountChanged(int arg);
 
     void frameXChanged(int arg);
 
@@ -211,9 +218,15 @@ public slots:
 
     void setFrames(int arg)
     {
+        qWarning() << "Sprite::frames has been renamed Sprite::frameCount";
+        setFrameCount(arg);
+    }
+
+    void setFrameCount(int arg)
+    {
         if (m_frames != arg) {
             m_frames = arg;
-            emit framesChanged(arg);
+            emit frameCountChanged(arg);
         }
     }
 
@@ -278,7 +291,7 @@ private slots:
 
 private:
     friend class QQuickImageParticle;
-    friend class QQuickSpriteImage;
+    friend class QQuickSpriteSequence;
     friend class QQuickAnimatedSprite;
     friend class QQuickSpriteEngine;
     friend class QQuickStochasticEngine;
diff --git a/src/quick/items/qquickspriteimage.cpp b/src/quick/items/qquickspritesequence.cpp
index 1b3b57710a..a3a8a6ee8c 100644
--- a/src/quick/items/qquickspriteimage.cpp
+++ b/src/quick/items/qquickspritesequence.cpp
@@ -39,7 +39,7 @@
 **
 ****************************************************************************/
 
-#include "qquickspriteimage_p.h"
+#include "qquickspritesequence_p.h"
 #include "qquicksprite_p.h"
 #include "qquickspriteengine_p.h"
 #include <QtQuick/private/qsgcontext_p.h>
@@ -90,16 +90,16 @@ static const char fragmentShaderCode[] =
     "    gl_FragColor = mix(texture2D(texture, fTexS.xy), texture2D(texture, fTexS.zw), progress) * qt_Opacity;\n"
     "}\n";
 
-class QQuickSpriteImageMaterial : public QSGMaterial
+class QQuickSpriteSequenceMaterial : public QSGMaterial
 {
 public:
-    QQuickSpriteImageMaterial();
-    ~QQuickSpriteImageMaterial();
+    QQuickSpriteSequenceMaterial();
+    ~QQuickSpriteSequenceMaterial();
     virtual QSGMaterialType *type() const { static QSGMaterialType type; return &type; }
     virtual QSGMaterialShader *createShader() const;
     virtual int compare(const QSGMaterial *other) const
     {
-        return this - static_cast<const QQuickSpriteImageMaterial *>(other);
+        return this - static_cast<const QQuickSpriteSequenceMaterial *>(other);
     }
 
     QSGTexture *texture;
@@ -115,7 +115,7 @@ public:
     float elementHeight;
 };
 
-QQuickSpriteImageMaterial::QQuickSpriteImageMaterial()
+QQuickSpriteSequenceMaterial::QQuickSpriteSequenceMaterial()
     : animT(0.0f)
     , animX1(0.0f)
     , animY1(0.0f)
@@ -129,15 +129,15 @@ QQuickSpriteImageMaterial::QQuickSpriteImageMaterial()
     setFlag(Blending, true);
 }
 
-QQuickSpriteImageMaterial::~QQuickSpriteImageMaterial()
+QQuickSpriteSequenceMaterial::~QQuickSpriteSequenceMaterial()
 {
     delete texture;
 }
 
-class SpriteImageMaterialData : public QSGMaterialShader
+class SpriteSequenceMaterialData : public QSGMaterialShader
 {
 public:
-    SpriteImageMaterialData(const char * /* vertexFile */ = 0, const char * /* fragmentFile */ = 0)
+    SpriteSequenceMaterialData(const char * /* vertexFile */ = 0, const char * /* fragmentFile */ = 0)
     {
     }
 
@@ -151,7 +151,7 @@ public:
 
     virtual void updateState(const RenderState &state, QSGMaterial *newEffect, QSGMaterial *)
     {
-        QQuickSpriteImageMaterial *m = static_cast<QQuickSpriteImageMaterial *>(newEffect);
+        QQuickSpriteSequenceMaterial *m = static_cast<QQuickSpriteSequenceMaterial *>(newEffect);
         m->texture->bind();
 
         program()->setUniformValue(m_opacity_id, state.opacity());
@@ -191,11 +191,11 @@ public:
     static float chunkOfBytes[1024];
 };
 
-float SpriteImageMaterialData::chunkOfBytes[1024];
+float SpriteSequenceMaterialData::chunkOfBytes[1024];
 
-QSGMaterialShader *QQuickSpriteImageMaterial::createShader() const
+QSGMaterialShader *QQuickSpriteSequenceMaterial::createShader() const
 {
-    return new SpriteImageMaterialData;
+    return new SpriteSequenceMaterialData;
 }
 
 struct SpriteVertex {
@@ -211,21 +211,21 @@ struct SpriteVertices {
 };
 
 /*!
-    \qmlclass SpriteImage QQuickSpriteImage
+    \qmlclass SpriteSequence QQuickSpriteSequence
     \inqmlmodule QtQuick 2
     \inherits Item
-    \brief The SpriteImage element draws a sprite animation
+    \brief The SpriteSequence element draws a sprite animation
 
 */
 /*!
-    \qmlproperty bool QtQuick2::SpriteImage::running
+    \qmlproperty bool QtQuick2::SpriteSequence::running
 
     Whether the sprite is animating or not.
 
     Default is true
 */
 /*!
-    \qmlproperty bool QtQuick2::SpriteImage::interpolate
+    \qmlproperty bool QtQuick2::SpriteSequence::interpolate
 
     If true, interpolation will occur between sprite frames to make the
     animation appear smoother.
@@ -233,12 +233,12 @@ struct SpriteVertices {
     Default is true.
 */
 /*!
-    \qmlproperty string QtQuick2::SpriteImage::goalSprite
+    \qmlproperty string QtQuick2::SpriteSequence::goalSprite
 
     The name of the Sprite which is currently animating.
 */
 /*!
-    \qmlproperty string QtQuick2::SpriteImage::goalSprite
+    \qmlproperty string QtQuick2::SpriteSequence::goalSprite
 
     The name of the Sprite which the animation should move to.
 
@@ -250,19 +250,19 @@ struct SpriteVertices {
     If it is possible to return to the goalState from the starting point of the goalState
     it will continue to do so until goalState is set to "" or an unreachable state.
 */
-/*! \qmlmethod void QtQuick2::SpriteImage::jumpTo(string sprite)
+/*! \qmlmethod void QtQuick2::SpriteSequence::jumpTo(string sprite)
 
     This function causes the sprite to jump to the specified state immediately, intermediate
     states are not played.
 */
 /*!
-    \qmlproperty list<Sprite> QtQuick2::SpriteImage::sprites
+    \qmlproperty list<Sprite> QtQuick2::SpriteSequence::sprites
 
     The sprite or sprites to draw. Sprites will be scaled to the size of this element.
 */
 
 //TODO: Implicitly size element to size of first sprite?
-QQuickSpriteImage::QQuickSpriteImage(QQuickItem *parent) :
+QQuickSpriteSequence::QQuickSpriteSequence(QQuickItem *parent) :
     QQuickItem(parent)
     , m_node(0)
     , m_material(0)
@@ -278,14 +278,14 @@ QQuickSpriteImage::QQuickSpriteImage(QQuickItem *parent) :
             this, SLOT(update()));
 }
 
-void QQuickSpriteImage::jumpTo(const QString &sprite)
+void QQuickSpriteSequence::jumpTo(const QString &sprite)
 {
     if (!m_spriteEngine)
         return;
     m_spriteEngine->setGoal(m_spriteEngine->stateIndex(sprite), 0, true);
 }
 
-void QQuickSpriteImage::setGoalSprite(const QString &sprite)
+void QQuickSpriteSequence::setGoalSprite(const QString &sprite)
 {
     if (m_goalState != sprite){
         m_goalState = sprite;
@@ -294,12 +294,12 @@ void QQuickSpriteImage::setGoalSprite(const QString &sprite)
     }
 }
 
-QDeclarativeListProperty<QQuickSprite> QQuickSpriteImage::sprites()
+QDeclarativeListProperty<QQuickSprite> QQuickSpriteSequence::sprites()
 {
     return QDeclarativeListProperty<QQuickSprite>(this, &m_sprites, spriteAppend, spriteCount, spriteAt, spriteClear);
 }
 
-void QQuickSpriteImage::createEngine()
+void QQuickSpriteSequence::createEngine()
 {
     //TODO: delay until component complete
     if (m_spriteEngine)
@@ -311,18 +311,18 @@ void QQuickSpriteImage::createEngine()
     reset();
 }
 
-static QSGGeometry::Attribute SpriteImage_Attributes[] = {
+static QSGGeometry::Attribute SpriteSequence_Attributes[] = {
     QSGGeometry::Attribute::create(0, 2, GL_FLOAT),         // tex
 };
 
-static QSGGeometry::AttributeSet SpriteImage_AttributeSet =
+static QSGGeometry::AttributeSet SpriteSequence_AttributeSet =
 {
     1, // Attribute Count
     2 * sizeof(float),
-    SpriteImage_Attributes
+    SpriteSequence_Attributes
 };
 
-QSGGeometryNode* QQuickSpriteImage::buildNode()
+QSGGeometryNode* QQuickSpriteSequence::buildNode()
 {
     if (!m_spriteEngine) {
         qmlInfo(this) << "No sprite engine...";
@@ -336,7 +336,7 @@ QSGGeometryNode* QQuickSpriteImage::buildNode()
         return 0;
     }
 
-    m_material = new QQuickSpriteImageMaterial();
+    m_material = new QQuickSpriteSequenceMaterial();
 
     QImage image = m_spriteEngine->assembledImage();
     if (image.isNull())
@@ -359,7 +359,7 @@ QSGGeometryNode* QQuickSpriteImage::buildNode()
 
     int vCount = 4;
     int iCount = 6;
-    QSGGeometry *g = new QSGGeometry(SpriteImage_AttributeSet, vCount, iCount);
+    QSGGeometry *g = new QSGGeometry(SpriteSequence_AttributeSet, vCount, iCount);
     g->setDrawingMode(GL_TRIANGLES);
 
     SpriteVertices *p = (SpriteVertices *) g->vertexData();
@@ -393,12 +393,12 @@ QSGGeometryNode* QQuickSpriteImage::buildNode()
     return m_node;
 }
 
-void QQuickSpriteImage::reset()
+void QQuickSpriteSequence::reset()
 {
     m_pleaseReset = true;
 }
 
-QSGNode *QQuickSpriteImage::updatePaintNode(QSGNode *, UpdatePaintNodeData *)
+QSGNode *QQuickSpriteSequence::updatePaintNode(QSGNode *, UpdatePaintNodeData *)
 {
     if (m_pleaseReset) {
         delete m_node;
@@ -419,7 +419,7 @@ QSGNode *QQuickSpriteImage::updatePaintNode(QSGNode *, UpdatePaintNodeData *)
     return m_node;
 }
 
-void QQuickSpriteImage::prepareNextFrame()
+void QQuickSpriteSequence::prepareNextFrame()
 {
     if (m_node == 0)
         m_node = buildNode();
diff --git a/src/quick/items/qquickspriteimage_p.h b/src/quick/items/qquickspritesequence_p.h
index 8017263bb1..8a95594f61 100644
--- a/src/quick/items/qquickspriteimage_p.h
+++ b/src/quick/items/qquickspritesequence_p.h
@@ -39,8 +39,8 @@
 **
 ****************************************************************************/
 
-#ifndef QQUICKSPRITEIMAGE_P_H
-#define QQUICKSPRITEIMAGE_P_H
+#ifndef QQUICKSPRITESEQUENCE_P_H
+#define QQUICKSPRITESEQUENCE_P_H
 
 #include <QtQuick/QQuickItem>
 #include <QTime>
@@ -53,8 +53,8 @@ class QSGContext;
 class QQuickSprite;
 class QQuickSpriteEngine;
 class QSGGeometryNode;
-class QQuickSpriteImageMaterial;
-class Q_AUTOTEST_EXPORT QQuickSpriteImage : public QQuickItem
+class QQuickSpriteSequenceMaterial;
+class Q_AUTOTEST_EXPORT QQuickSpriteSequence : public QQuickItem
 {
     Q_OBJECT
     Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged)
@@ -66,7 +66,7 @@ class Q_AUTOTEST_EXPORT QQuickSpriteImage : public QQuickItem
     Q_CLASSINFO("DefaultProperty", "sprites")
 
 public:
-    explicit QQuickSpriteImage(QQuickItem *parent = 0);
+    explicit QQuickSpriteSequence(QQuickItem *parent = 0);
 
     QDeclarativeListProperty<QQuickSprite> sprites();
 
@@ -127,7 +127,7 @@ private:
     void prepareNextFrame();
     QSGGeometryNode* buildNode();
     QSGGeometryNode *m_node;
-    QQuickSpriteImageMaterial *m_material;
+    QQuickSpriteSequenceMaterial *m_material;
     QList<QQuickSprite*> m_sprites;
     QQuickSpriteEngine* m_spriteEngine;
     QTime m_timestamp;
@@ -145,4 +145,4 @@ QT_END_NAMESPACE
 
 QT_END_HEADER
 
-#endif // QQUICKSPRITEIMAGE_P_H
+#endif // QQUICKSPRITESEQUENCE_P_H