src/declarative/items/qquicksprite_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 QQUICKSPRITE_P_H
  43 #define QQUICKSPRITE_P_H
  44
  45 #include <QObject>
  46 #include <QUrl>
  47 #include <QVariantMap>
  48 #include <QDeclarativeListProperty>
  49 #include "qquickspriteengine_p.h"
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 QT_MODULE(Declarative)
  56
  57
  58 class QQuickSprite : public QQuickStochasticState
  59 {
  60     Q_OBJECT
  61     Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
  62     //If frame height or width is not specified, it is assumed to be a single long row of square frames.
  63     //Otherwise, it can be multiple contiguous rows, when one row runs out the next will be used.
  64     Q_PROPERTY(int frameHeight READ frameHeight WRITE setFrameHeight NOTIFY frameHeightChanged)
  65     Q_PROPERTY(int frameWidth READ frameWidth WRITE setFrameWidth NOTIFY frameWidthChanged)
  66
  67 public:
  68     explicit QQuickSprite(QObject *parent = 0);
  69
  70     QUrl source() const
  71     {
  72         return m_source;
  73     }
  74
  75     int frameHeight() const
  76     {
  77         return m_frameHeight;
  78     }
  79
  80     int frameWidth() const
  81     {
  82         return m_frameWidth;
  83     }
  84
  85
  86 signals:
  87
  88     void sourceChanged(QUrl arg);
  89
  90     void frameHeightChanged(int arg);
  91
  92     void frameWidthChanged(int arg);
  93
  94 public slots:
  95
  96     void setSource(QUrl arg)
  97     {
  98         if (m_source != arg) {
  99             m_source = arg;
 100             emit sourceChanged(arg);
 101         }
 102     }
 103
 104     void setFrameHeight(int arg)
 105     {
 106         if (m_frameHeight != arg) {
 107             m_frameHeight = arg;
 108             emit frameHeightChanged(arg);
 109         }
 110     }
 111
 112     void setFrameWidth(int arg)
 113     {
 114         if (m_frameWidth != arg) {
 115             m_frameWidth = arg;
 116             emit frameWidthChanged(arg);
 117         }
 118     }
 119
 120
 121 private:
 122     friend class QSGImageParticle;
 123     friend class QQuickSpriteEngine;
 124     friend class QQuickStochasticEngine;
 125     int m_generatedCount;
 126     int m_framesPerRow;
 127     QUrl m_source;
 128     int m_frameHeight;
 129     int m_frameWidth;
 130     int m_rowY;
 131
 132 };
 133
 134 QT_END_NAMESPACE
 135 QT_END_HEADER
 136 #endif // QQUICKSPRITE_P_H