Doc: Sanitized QML types
[profile/ivi/qtdeclarative.git] / src / particles / qquickwander.cpp
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 #include "qquickwander_p.h"
43 #include "qquickparticlesystem_p.h"//for ParticlesVertices
44 QT_BEGIN_NAMESPACE
45 /*!
46     \qmlclass Wander QQuickWanderAffector
47     \inqmlmodule QtQuick.Particles 2
48     \inherits Affector
49     \brief For applying random particle trajectory
50
51 */
52 /*!
53     \qmlproperty real QtQuick.Particles2::Wander::pace
54
55     Maximum attribute change per second.
56 */
57 /*!
58     \qmlproperty real QtQuick.Particles2::Wander::xVariance
59
60     Maximum attribute x value (as a result of Wander).
61
62     If unset, Wander will not affect x values.
63 */
64 /*!
65     \qmlproperty real QtQuick.Particles2::Wander::yVariance
66
67     Maximum attribute y value (as a result of Wander).
68
69     If unset, Wander will not affect y values.
70 */
71 /*!
72     \qmlproperty AffectableParameter QtQuick.Particles2::Wander::affectedParameter
73
74     What attribute of particles is directly affected.
75     \list
76     \li PointAttractor.Position
77     \li PointAttractor.Velocity
78     \li PointAttractor.Acceleration
79     \endlist
80 */
81
82 QQuickWanderAffector::QQuickWanderAffector(QQuickItem *parent) :
83     QQuickParticleAffector(parent), m_xVariance(0), m_yVariance(0), m_pace(0)
84     , m_affectedParameter(Velocity)
85 {
86     m_needsReset = true;
87 }
88
89 QQuickWanderAffector::~QQuickWanderAffector()
90 {
91     for (QHash<int, WanderData*>::const_iterator iter=m_wanderData.constBegin();
92         iter != m_wanderData.constEnd(); iter++)
93         delete (*iter);
94 }
95
96 WanderData* QQuickWanderAffector::getData(int idx)
97 {
98     if (m_wanderData.contains(idx))
99         return m_wanderData[idx];
100     WanderData* d = new WanderData;
101     d->x_vel = 0;
102     d->y_vel = 0;
103     d->x_peak = m_xVariance;
104     d->y_peak = m_yVariance;
105     d->x_var = m_pace * qreal(qrand()) / RAND_MAX;
106     d->y_var = m_pace * qreal(qrand()) / RAND_MAX;
107
108     m_wanderData.insert(idx, d);
109     return d;
110 }
111
112 // TODO: see below
113 //void QQuickWanderAffector::reset(int systemIdx)
114 //{
115 //    if (m_wanderData.contains(systemIdx))
116 //        delete m_wanderData[systemIdx];
117 //    m_wanderData.remove(systemIdx);
118 //}
119
120 bool QQuickWanderAffector::affectParticle(QQuickParticleData* data, qreal dt)
121 {
122     /*TODO: Add a mode which does basically this - picking a direction, going in it (random speed) and then going back
123     WanderData* d = getData(data->systemIndex);
124     if (m_xVariance != 0.) {
125         if ((d->x_vel > d->x_peak && d->x_var > 0.0) || (d->x_vel < -d->x_peak && d->x_var < 0.0)) {
126             d->x_var = -d->x_var;
127             d->x_peak = m_xVariance + m_xVariance * qreal(qrand()) / RAND_MAX;
128         }
129         d->x_vel += d->x_var * dt;
130     }
131     qreal dx = dt * d->x_vel;
132
133     if (m_yVariance != 0.) {
134         if ((d->y_vel > d->y_peak && d->y_var > 0.0) || (d->y_vel < -d->y_peak && d->y_var < 0.0)) {
135             d->y_var = -d->y_var;
136             d->y_peak = m_yVariance + m_yVariance * qreal(qrand()) / RAND_MAX;
137         }
138         d->y_vel += d->y_var * dt;
139     }
140     qreal dy = dt * d->x_vel;
141
142     //### Should we be amending vel instead?
143     ParticleVertex* p = &(data->pv);
144     p->x += dx;
145
146     p->y += dy;
147     return true;
148     */
149     qreal dx = dt * m_pace * (2 * qreal(qrand())/RAND_MAX - 1);
150     qreal dy = dt * m_pace * (2 * qreal(qrand())/RAND_MAX - 1);
151     qreal newX, newY;
152     switch (m_affectedParameter){
153     case Position:
154         newX = data->curX() + dx;
155         if (m_xVariance > qAbs(newX) )
156             data->x += dx;
157         newY = data->curY() + dy;
158         if (m_yVariance > qAbs(newY) )
159             data->y += dy;
160         break;
161     default:
162     case Velocity:
163         newX = data->curVX() + dx;
164         if (m_xVariance > qAbs(newX) )
165             data->setInstantaneousVX(newX);
166         newY = data->curVY() + dy;
167         if (m_yVariance > qAbs(newY) )
168             data->setInstantaneousVY(newY);
169         break;
170     case Acceleration:
171         newX = data->ax + dx;
172         if (m_xVariance > qAbs(newX) )
173             data->setInstantaneousAX(newX);
174         newY = data->ay + dy;
175         if (m_yVariance > qAbs(newY) )
176             data->setInstantaneousAY(newY);
177         break;
178     }
179     return true;
180 }
181 QT_END_NAMESPACE