src/quick/particles/qquickitemparticle_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 ITEMPARTICLE_H
  43 #define ITEMPARTICLE_H
  44 #include "qquickparticlepainter_p.h"
  45 #include <QPointer>
  46 #include <QSet>
  47 #include <private/qdeclarativeanimation_p_p.h>
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 class QQuickVisualDataModel;
  53 class QQuickItemParticleAttached;
  54
  55 class QQuickItemParticle : public QQuickParticlePainter
  56 {
  57     Q_OBJECT
  58     Q_PROPERTY(bool fade READ fade WRITE setFade NOTIFY fadeChanged)
  59     Q_PROPERTY(QDeclarativeComponent* delegate READ delegate WRITE setDelegate NOTIFY delegateChanged)
  60 public:
  61     explicit QQuickItemParticle(QQuickItem *parent = 0);
  62
  63     bool fade() const { return m_fade; }
  64
  65     virtual QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *);
  66
  67     static QQuickItemParticleAttached *qmlAttachedProperties(QObject *object);
  68     QDeclarativeComponent* delegate() const
  69     {
  70         return m_delegate;
  71     }
  72
  73 signals:
  74     void fadeChanged();
  75
  76     void delegateChanged(QDeclarativeComponent* arg);
  77
  78 public slots:
  79     //TODO: Add a follow mode, where moving the delegate causes the logical particle to go with it?
  80     void freeze(QQuickItem* item);
  81     void unfreeze(QQuickItem* item);
  82     void take(QQuickItem* item,bool prioritize=false);//take by modelparticle
  83     void give(QQuickItem* item);//give from modelparticle
  84
  85     void setFade(bool arg){if (arg == m_fade) return; m_fade = arg; emit fadeChanged();}
  86     void setDelegate(QDeclarativeComponent* arg)
  87     {
  88         if (m_delegate != arg) {
  89             m_delegate = arg;
  90             emit delegateChanged(arg);
  91         }
  92     }
  93
  94 protected:
  95     virtual void reset();
  96     virtual void commit(int gIdx, int pIdx);
  97     virtual void initialize(int gIdx, int pIdx);
  98     void prepareNextFrame();
  99 private:
 100     void tick(int time = 0);
 101     QList<QQuickItem* > m_deletables;
 102     QList< QQuickParticleData* > m_loadables;
 103     bool m_fade;
 104
 105     QList<QQuickItem*> m_pendingItems;
 106     QList<int> m_available;
 107     QSet<QQuickItem*> m_stasis;
 108     qreal m_lastT;
 109     int m_activeCount;
 110     QDeclarativeComponent* m_delegate;
 111
 112     typedef QTickAnimationProxy<QQuickItemParticle, &QQuickItemParticle::tick> Clock;
 113     Clock *clock;
 114 };
 115
 116 class QQuickItemParticleAttached : public QObject
 117 {
 118     Q_OBJECT
 119     Q_PROPERTY(QQuickItemParticle* particle READ particle CONSTANT);
 120 public:
 121     QQuickItemParticleAttached(QObject* parent)
 122         : QObject(parent), m_mp(0)
 123     {;}
 124     QQuickItemParticle* particle() {return m_mp;}
 125     void detach(){emit detached();}
 126     void attach(){emit attached();}
 127 private:
 128     QQuickItemParticle* m_mp;
 129     friend class QQuickItemParticle;
 130 Q_SIGNALS:
 131     void detached();
 132     void attached();
 133 };
 134
 135 QT_END_NAMESPACE
 136
 137 QML_DECLARE_TYPEINFO(QQuickItemParticle, QML_HAS_ATTACHED_PROPERTIES)
 138
 139 QT_END_HEADER
 140 #endif // ITEMPARTICLE_H