src/quick/particles/qquickparticlepainter_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 PARTICLE_H
  43 #define PARTICLE_H
  44
  45 #include <QObject>
  46 #include <QDebug>
  47 #include <QPair>
  48 #include "qquickparticlesystem_p.h"
  49
  50 QT_BEGIN_HEADER
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 class QQuickParticlePainter : public QQuickItem
  55 {
  56     Q_OBJECT
  57     Q_PROPERTY(QQuickParticleSystem* system READ system WRITE setSystem NOTIFY systemChanged)
  58     Q_PROPERTY(QStringList groups READ groups WRITE setGroups NOTIFY groupsChanged)
  59
  60 public:
  61     explicit QQuickParticlePainter(QQuickItem *parent = 0);
  62     //Data Interface to system
  63     void load(QQuickParticleData*);
  64     void reload(QQuickParticleData*);
  65     void setCount(int c);
  66     int count();
  67     void performPendingCommits();//Called from updatePaintNode
  68     QQuickParticleSystem* system() const
  69     {
  70         return m_system;
  71     }
  72
  73
  74     QStringList groups() const
  75     {
  76         return m_groups;
  77     }
  78
  79 signals:
  80     void countChanged();
  81     void systemChanged(QQuickParticleSystem* arg);
  82
  83     void groupsChanged(QStringList arg);
  84
  85 public slots:
  86     void setSystem(QQuickParticleSystem* arg);
  87
  88     void setGroups(QStringList arg)
  89     {
  90         if (m_groups != arg) {
  91             m_groups = arg;
  92             //Note: The system watches this as it has to recalc things when groups change. It will request a reset if necessary
  93             emit groupsChanged(arg);
  94         }
  95     }
  96
  97     void calcSystemOffset(bool resetPending = false);
  98
  99 protected:
 100     /* Reset resets all your internal data structures. But anything attached to a particle should
 101        be in attached data. So reset + reloads should have no visible effect.
 102        ###Hunt down all cases where we do a complete reset for convenience and be more targeted
 103     */
 104     virtual void reset();
 105
 106     virtual void componentComplete();
 107     virtual void initialize(int gIdx, int pIdx){//Called from main thread
 108         Q_UNUSED(gIdx);
 109         Q_UNUSED(pIdx);
 110     }
 111     virtual void commit(int gIdx, int pIdx){//Called in Render Thread
 112         //###If you need to do something on size changed, check m_data size in this? Or we reset you every time?
 113         Q_UNUSED(gIdx);
 114         Q_UNUSED(pIdx);
 115     }
 116
 117     QQuickParticleSystem* m_system;
 118     friend class QQuickParticleSystem;
 119     int m_count;
 120     bool m_pleaseReset;//Used by subclasses, but it's a nice optimization to know when stuff isn't going to matter.
 121     QStringList m_groups;
 122     QPointF m_systemOffset;
 123
 124 private:
 125     QSet<QPair<int,int> > m_pendingCommits;
 126 };
 127
 128 QT_END_NAMESPACE
 129 QT_END_HEADER
 130 #endif // PARTICLE_H