aboutsummaryrefslogtreecommitdiffstats
path: root/src/declarative/particles/qsgturbulence.cpp
diff options
context:
space:
mode:
authorAlan Alpert <alan.alpert@nokia.com>2011-07-11 11:20:58 +1000
committerQt by Nokia <qt-info@nokia.com>2011-07-20 06:57:44 +0200
commit963e769c01237265a403e2d28c1b2691cb45bf99 (patch)
tree89e874d035fc37348552f6ed8fc05bede181d9c8 /src/declarative/particles/qsgturbulence.cpp
parent12ebf79f3a92646ae7d5671d8ba4147055d203c2 (diff)
Initial stab at docs for QtQuick.Particles 2.0
Change-Id: I3c53f7998dff95616a994edf19094fa4007d74ab Reviewed-on: http://codereview.qt.nokia.com/1388 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Martin Jones <martin.jones@nokia.com>
Diffstat (limited to 'src/declarative/particles/qsgturbulence.cpp')
-rw-r--r--src/declarative/particles/qsgturbulence.cpp21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/declarative/particles/qsgturbulence.cpp b/src/declarative/particles/qsgturbulence.cpp
index 929c6527a0..c846f151b4 100644
--- a/src/declarative/particles/qsgturbulence.cpp
+++ b/src/declarative/particles/qsgturbulence.cpp
@@ -46,6 +46,27 @@
#include <QDebug>
QT_BEGIN_NAMESPACE
+/*!
+ \qmlclass Turbulence QSGTurbulenceAffector
+ \inqmlmodule QtQuick.Particles 2
+ \since QtQuick.Particles 2.0
+ \inherits Affector
+ \brief The TurbulenceAffector is a bit of a hack and probably shouldn't be used yet.
+
+*/
+/*!
+ \qmlproperty int QtQuick.Particles2::Turbulence::strength
+ Maximum magnitude of a point in the vector field.
+*/
+/*!
+ \qmlproperty int QtQuick.Particles2::Turbulence::frequency
+ Times per second vector field is perturbed.
+*/
+/*!
+ \qmlproperty int QtQuick.Particles2::Turbulence::gridSize
+ Square root of the number of points in the vector field simulcrum.
+*/
+
QSGTurbulenceAffector::QSGTurbulenceAffector(QSGItem *parent) :
QSGParticleAffector(parent),
m_strength(10), m_lastT(0), m_frequency(64), m_gridSize(10), m_field(0), m_inited(false)