diff options
| author | Alan Alpert <alan.alpert@nokia.com> | 2011-07-11 11:20:58 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2011-07-20 06:57:44 +0200 |
| commit | 963e769c01237265a403e2d28c1b2691cb45bf99 (patch) | |
| tree | 89e874d035fc37348552f6ed8fc05bede181d9c8 /src/declarative/particles/qsgfollowemitter.cpp | |
| parent | 12ebf79f3a92646ae7d5671d8ba4147055d203c2 (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/qsgfollowemitter.cpp')
| -rw-r--r-- | src/declarative/particles/qsgfollowemitter.cpp | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/src/declarative/particles/qsgfollowemitter.cpp b/src/declarative/particles/qsgfollowemitter.cpp index 9b5b084705..ff9f83df14 100644 --- a/src/declarative/particles/qsgfollowemitter.cpp +++ b/src/declarative/particles/qsgfollowemitter.cpp @@ -44,6 +44,23 @@ #include <cmath> QT_BEGIN_NAMESPACE +/*! + \qmlclass Emitter QSGBasicEmitter + \inqmlmodule QtQuick.Particles 2 + \since QtQuick.Particles 2.0 + \brief The Emitter element allows you to emit logical particles. + + This element emits logical particles into the ParticleSystem, with the + given starting attributes. + + Note that logical particles are not + automatically rendered, you will need to have one or more + ParticlePainter elements visualizing them. + + Note that the given starting attributes can be modified at any point + in the particle's lifetime by any Affector element in the same + ParticleSystem. This includes attributes like lifespan. +*/ QSGFollowEmitter::QSGFollowEmitter(QSGItem *parent) : QSGParticleEmitter(parent) , m_particlesPerParticlePerSecond(0) @@ -63,6 +80,65 @@ QSGFollowEmitter::QSGFollowEmitter(QSGItem *parent) : this, SLOT(recalcParticlesPerSecond())); } + +/*! + \qmlproperty ParticleSystem QtQuick.Particles2::FollowEmitter::system + + This is the Particle system that the FollowEmitter will emit into. + This can be omitted if the FollowEmitter is a direct child of the ParticleSystem +*/ +/*! + \qmlproperty string QtQuick.Particles2::FollowEmitter::particle +*/ +/*! + \qmlproperty string QtQuick.Particles2::FollowEmitter::follow +*/ +/*! + \qmlproperty Shape QtQuick.Particles2::FollowEmitter::shape +*/ +/*! + \qmlproperty Shape QtQuick.Particles2::FollowEmitter::emitShape +*/ +/*! + \qmlproperty real QtQuick.Particles2::FollowEmitter::emitWidth +*/ +/*! + \qmlproperty real QtQuick.Particles2::FollowEmitter::emitHeight +*/ +/*! + \qmlproperty bool QtQuick.Particles2::FollowEmitter::emitting +*/ +/*! + \qmlproperty real QtQuick.Particles2::FollowEmitter::emitRatePerParticle +*/ +/*! + \qmlproperty int QtQuick.Particles2::FollowEmitter::lifeSpan +*/ +/*! + \qmlproperty int QtQuick.Particles2::FollowEmitter::lifeSpanVariation +*/ +/*! + \qmlproperty int QtQuick.Particles2::FollowEmitter::emitCap +*/ +/*! + \qmlproperty real QtQuick.Particles2::FollowEmitter::size +*/ +/*! + \qmlproperty real QtQuick.Particles2::FollowEmitter::endSize +*/ +/*! + \qmlproperty real QtQuick.Particles2::FollowEmitter::sizeVariation +*/ +/*! + \qmlproperty StochasticDirection QtQuick.Particles2::FollowEmitter::speed +*/ +/*! + \qmlproperty StochasticDirection QtQuick.Particles2::FollowEmitter::acceleration +*/ +/*! + \qmlproperty qreal QtQuick.Particles2::FollowEmitter::speedFromMovement +*/ + void QSGFollowEmitter::recalcParticlesPerSecond(){ if (!m_system) return; |