aboutsummaryrefslogtreecommitdiffstats
path: root/src/declarative/particles/qsgpointattractor.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/qsgpointattractor.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/qsgpointattractor.cpp')
-rw-r--r--src/declarative/particles/qsgpointattractor.cpp13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/declarative/particles/qsgpointattractor.cpp b/src/declarative/particles/qsgpointattractor.cpp
index 9b4c997817..6be61aa716 100644
--- a/src/declarative/particles/qsgpointattractor.cpp
+++ b/src/declarative/particles/qsgpointattractor.cpp
@@ -43,6 +43,19 @@
#include <cmath>
#include <QDebug>
QT_BEGIN_NAMESPACE
+/*!
+ \qmlclass PointAttractor QSGPointAttractorAffector
+ \inqmlmodule QtQuick.Particles 2
+ \since QtQuick.Particles 2.0
+ \inherits Affector
+ \brief The PointAttractor allows you to attract particles towards a specific point.
+
+ Note that the size and position of this element affects which particles it affects.
+ The size of the point attracted to is always 0x0, and the location of that point
+ is specified by the x and y properties that badly need renaming.
+
+*/
+
QSGPointAttractorAffector::QSGPointAttractorAffector(QSGItem *parent) :
QSGParticleAffector(parent), m_strength(0.0), m_x(0), m_y(0)
, m_physics(Velocity), m_proportionalToDistance(Linear)