diff options
| author | Alan Alpert <alan.alpert@nokia.com> | 2010-07-14 15:05:02 +1000 |
|---|---|---|
| committer | Alan Alpert <alan.alpert@nokia.com> | 2010-07-14 15:05:02 +1000 |
| commit | 2d4876330e292253a9133b0197e573097ecfa5bb (patch) | |
| tree | 2d1bb84d57116a0090a843feadb19011d86e4ba5 /src/imports | |
| parent | 2ba0dfd82a3d82e98a70aeda3b142e0a870eeb0d (diff) | |
Clean up particle motion documentation
Task-number: QTBUG-11917
Diffstat (limited to 'src/imports')
| -rw-r--r-- | src/imports/particles/qdeclarativeparticles.cpp | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/src/imports/particles/qdeclarativeparticles.cpp b/src/imports/particles/qdeclarativeparticles.cpp index e95dfc7f36..8fe8a9fb25 100644 --- a/src/imports/particles/qdeclarativeparticles.cpp +++ b/src/imports/particles/qdeclarativeparticles.cpp @@ -158,6 +158,11 @@ void QDeclarativeParticleMotion::destroy(QDeclarativeParticle &particle) \brief The ParticleMotionLinear object moves particles linearly. \sa Particles + + This is the default motion, and moves the particles according to the + properties specified in the Particles element. + + It has no further properties. */ /*! @@ -178,6 +183,13 @@ void QDeclarativeParticleMotionLinear::advance(QDeclarativeParticle &p, int inte \since 4.7 \brief The ParticleMotionGravity object moves particles towards a point. + This motion attracts the particles to the specified point with the specified acceleration. + To mimic earth gravity, set yattractor to -6360000 and acceleration to 9.8. + + The defaults are all 0, not earth gravity, and so no motion will occur without setting + at least the acceleration property. + + \sa Particles */ @@ -186,6 +198,7 @@ void QDeclarativeParticleMotionLinear::advance(QDeclarativeParticle &p, int inte \class QDeclarativeParticleMotionGravity \ingroup group_effects \brief The QDeclarativeParticleMotionGravity class moves the particles towards a point. + */ /*! @@ -305,14 +318,14 @@ Rectangle { */ /*! - \qmlproperty real QDeclarativeParticleMotionWander::xvariance - \qmlproperty real QDeclarativeParticleMotionWander::yvariance + \qmlproperty real ParticleMotionWander::xvariance + \qmlproperty real ParticleMotionWander::yvariance These properties set the amount to wander in the x and y directions. */ /*! - \qmlproperty real QDeclarativeParticleMotionWander::pace + \qmlproperty real ParticleMotionWander::pace This property holds how quickly the paricles will move from side to side. */ |