aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlan Alpert <alan.alpert@nokia.com>2011-09-14 17:26:59 +1000
committerQt by Nokia <qt-info@nokia.com>2011-09-16 03:48:32 +0200
commit2d3646f1d5b4cc6ada0d38013392491289b079f9 (patch)
tree425f3d165b8de1f87981660bd2162d44df5a2b0a
parentd6a2d7ae8ccec47720371ce9c91c2f40ea4965e7 (diff)
Documentation Augmentation
Change-Id: I662526a9c0f9c8694ec39aa0d5ad9286d1c9f208 Reviewed-on: http://codereview.qt-project.org/4863 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Martin Jones <martin.jones@nokia.com>
-rw-r--r--doc/src/declarative/particles.qdoc8
-rw-r--r--src/declarative/particles/qsgparticleemitter.cpp6
2 files changed, 9 insertions, 5 deletions
diff --git a/doc/src/declarative/particles.qdoc b/doc/src/declarative/particles.qdoc
index 4f84db2ef2..94b1c2b347 100644
--- a/doc/src/declarative/particles.qdoc
+++ b/doc/src/declarative/particles.qdoc
@@ -55,6 +55,7 @@
All the particle system elements act on "logical particles". Every particle has a logical representation inside
the particle system, and this is what the elements act upon. Not every logical particle needs to be visualized,
and some logical particles could lead to multiple visual particles being drawn on screen.
+
\section1 Particle Groups
Every logical particle is a member of a particle group, and each group is identified by a name. If no other
group has been specified, a logical particle belongs to the group with the name "" (the empty string), which
@@ -66,9 +67,10 @@
other (aside from the usual stochastic parameter variation) will need to be in different groups.
Particles can also change groups dynamically. When this happens the particles trajectory is unaltered, but it
- can be acted upon by different ParticlePainters or Affectors. Particles can either have their state changed by
- an Affector, or stochastic state transitions can be defined in the group definition (in the particleStates property).
- Generally, groups should only be defined in that property if they require stochastic state transitions. Otherwise,
+ can be acted upon by different ParticlePainters or Affectors. Particles can either have their group changed by
+ an Affector, or stochastic state transitions can be defined in a ParticleGroup element.
+
+ Generally, groups should only be defined in a ParticleGroup if they require stochastic state transitions. Otherwise,
it is sufficient to have the groups be defined simply by the strings used in the particle/particles properties
of the elements.
diff --git a/src/declarative/particles/qsgparticleemitter.cpp b/src/declarative/particles/qsgparticleemitter.cpp
index fdba3def41..f10bf1edd7 100644
--- a/src/declarative/particles/qsgparticleemitter.cpp
+++ b/src/declarative/particles/qsgparticleemitter.cpp
@@ -77,9 +77,11 @@ QT_BEGIN_NAMESPACE
/*!
\qmlproperty Shape QtQuick.Particles2::Emitter::shape
- This shape is applied to the bounding box of the emitter. Particles are then emitting
- from inside the area of the shape.
+ This shape is applied with the size of the Emitter. Particles will be emitted
+ randomly from any area covered by the shape.
+ The default shape is a filled in rectangle, which corresponds to the full bounding
+ box of the Emitter.
*/
/*!
\qmlproperty bool QtQuick.Particles2::Emitter::emitting