Fix uses of various qml doc commands
[profile/ivi/qtdeclarative.git] / src / particles / qquickgravity.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 "qquickgravity_p.h"
43 #include <cmath>
44 QT_BEGIN_NAMESPACE
45 const qreal CONV = 0.017453292520444443;
46 /*!
47     \qmltype Gravity
48     \instantiates QQuickGravityAffector
49     \inqmlmodule QtQuick.Particles 2
50     \ingroup qtquick-particles
51     \inherits Affector
52     \brief For applying accleration in an angle
53
54     This element will accelerate all affected particles to a vector of
55     the specified magnitude in the specified angle. If the angle and acceleration do
56     not vary, it is more efficient to set the specified acceleration on the Emitter.
57
58     This element models the gravity of a massive object whose center of
59     gravity is far away (and thus the gravitational pull is effectively constant
60     across the scene). To model the gravity of an object near or inside the scene,
61     use PointAttractor.
62 */
63
64 /*!
65     \qmlproperty real QtQuick.Particles2::Gravity::magnitude
66
67     Pixels per second that objects will be accelerated by.
68 */
69 /*!
70     \qmlproperty real QtQuick.Particles2::Gravity::acceleration
71
72     Name changed to magnitude, will be removed soon.
73 */
74 /*!
75     \qmlproperty real QtQuick.Particles2::Gravity::angle
76
77     Angle of acceleration.
78 */
79
80 QQuickGravityAffector::QQuickGravityAffector(QQuickItem *parent) :
81     QQuickParticleAffector(parent), m_magnitude(-10), m_angle(90), m_needRecalc(true)
82 {
83 }
84
85 bool QQuickGravityAffector::affectParticle(QQuickParticleData *d, qreal dt)
86 {
87     if (!m_magnitude)
88         return false;
89     if (m_needRecalc) {
90         m_needRecalc = false;
91         m_dx = m_magnitude * cos(m_angle * CONV);
92         m_dy = m_magnitude * sin(m_angle * CONV);
93     }
94
95     d->setInstantaneousVX(d->curVX() + m_dx*dt);
96     d->setInstantaneousVY(d->curVY() + m_dy*dt);
97     return true;
98 }
99 QT_END_NAMESPACE