1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the Declarative module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
42 #ifndef ITEMPARTICLE_H
43 #define ITEMPARTICLE_H
44 #include "qquickparticlepainter_p.h"
47 #include <private/qdeclarativeanimation_p_p.h>
52 class QQuickVisualDataModel;
53 class QQuickItemParticleAttached;
55 class QQuickItemParticle : public QQuickParticlePainter
58 Q_PROPERTY(bool fade READ fade WRITE setFade NOTIFY fadeChanged)
59 Q_PROPERTY(QDeclarativeComponent* delegate READ delegate WRITE setDelegate NOTIFY delegateChanged)
61 explicit QQuickItemParticle(QQuickItem *parent = 0);
63 bool fade() const { return m_fade; }
65 virtual QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *);
67 static QQuickItemParticleAttached *qmlAttachedProperties(QObject *object);
68 QDeclarativeComponent* delegate() const
76 void delegateChanged(QDeclarativeComponent* arg);
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
85 void setFade(bool arg){if (arg == m_fade) return; m_fade = arg; emit fadeChanged();}
86 void setDelegate(QDeclarativeComponent* arg)
88 if (m_delegate != arg) {
90 emit delegateChanged(arg);
96 virtual void commit(int gIdx, int pIdx);
97 virtual void initialize(int gIdx, int pIdx);
98 void prepareNextFrame();
100 void tick(int time = 0);
101 QList<QQuickItem* > m_deletables;
102 QList< QQuickParticleData* > m_loadables;
105 QList<QQuickItem*> m_pendingItems;
106 QList<int> m_available;
107 QSet<QQuickItem*> m_stasis;
110 QDeclarativeComponent* m_delegate;
112 typedef QTickAnimationProxy<QQuickItemParticle, &QQuickItemParticle::tick> Clock;
116 class QQuickItemParticleAttached : public QObject
119 Q_PROPERTY(QQuickItemParticle* particle READ particle CONSTANT);
121 QQuickItemParticleAttached(QObject* parent)
122 : QObject(parent), m_mp(0)
124 QQuickItemParticle* particle() {return m_mp;}
125 void detach(){emit detached();}
126 void attach(){emit attached();}
128 QQuickItemParticle* m_mp;
129 friend class QQuickItemParticle;
137 QML_DECLARE_TYPEINFO(QQuickItemParticle, QML_HAS_ATTACHED_PROPERTIES)
140 #endif // ITEMPARTICLE_H