src/particles/qquickparticlepainter_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQuick module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  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     void itemChange(ItemChange, const ItemChangeData &);
  80
  81 signals:
  82     void countChanged();
  83     void systemChanged(QQuickParticleSystem* arg);
  84
  85     void groupsChanged(QStringList arg);
  86
  87 public slots:
  88     void setSystem(QQuickParticleSystem* arg);
  89
  90     void setGroups(QStringList arg)
  91     {
  92         if (m_groups != arg) {
  93             m_groups = arg;
  94             //Note: The system watches this as it has to recalc things when groups change. It will request a reset if necessary
  95             emit groupsChanged(arg);
  96         }
  97     }
  98
  99     void calcSystemOffset(bool resetPending = false);
 100
 101 private slots:
 102     virtual void sceneGraphInvalidated() {}
 103
 104 protected:
 105     /* Reset resets all your internal data structures. But anything attached to a particle should
 106        be in attached data. So reset + reloads should have no visible effect.
 107        ###Hunt down all cases where we do a complete reset for convenience and be more targeted
 108     */
 109     virtual void reset();
 110
 111     virtual void componentComplete();
 112     virtual void initialize(int gIdx, int pIdx){//Called from main thread
 113         Q_UNUSED(gIdx);
 114         Q_UNUSED(pIdx);
 115     }
 116     virtual void commit(int gIdx, int pIdx){//Called in Render Thread
 117         //###If you need to do something on size changed, check m_data size in this? Or we reset you every time?
 118         Q_UNUSED(gIdx);
 119         Q_UNUSED(pIdx);
 120     }
 121
 122     QQuickParticleSystem* m_system;
 123     friend class QQuickParticleSystem;
 124     int m_count;
 125     bool m_pleaseReset;//Used by subclasses, but it's a nice optimization to know when stuff isn't going to matter.
 126     QStringList m_groups;
 127     QPointF m_systemOffset;
 128
 129     QQuickWindow *m_window;
 130
 131 private:
 132     QSet<QPair<int,int> > m_pendingCommits;
 133 };
 134
 135 QT_END_NAMESPACE
 136 QT_END_HEADER
 137 #endif // PARTICLE_H