aboutsummaryrefslogtreecommitdiffstats
path: root/examples/particles/emitters/doc/src/emitters.qdoc
blob: f6a9fd3db44dff85d868cdb53c159f34d28d17d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
    \title QtQuick.Particles Examples - Emitters
    \example particles/emitters
    \brief This is a collection of examples using Emitters in the QML particle system.
    \image qml-emitters-example.png

    This is a collection of small QML examples relating to using Emitters in the particle system.
    Each example is a small QML file emphasizing a particular element or feature.

    Velocity from motion gives the effect of strong particle motion through primarily moving the emitters:
    \snippet examples/particles/emitters/content/velocityfrommotion.qml 0

    Burst and pulse calls the burst and pulse methods on two idential emitters.
    \snippet examples/particles/emitters/content/burstandpulse.qml 0
    Note how burst takes an argument of number of particles to emit, and pulse takes an argument of number of milliseconds to emit for.
    This gives a slightly different behaviour, which is easy to see in this example.

    Custom Emitter connects to the emitParticles signal to set arbitrary values on particle data as they're emitted;
    \snippet examples/particles/emitters/content/customemitter.qml 0
    This is used to emit curving particles in six rotating spokes.

    Emit mask sets an image mask on the Emitter, to emit out of an arbitrary shape.
    \snippet examples/particles/emitters/content/emitmask.qml 0

    Maximum emitted emits no more than a certain number of particles at a time. This example makes it easy to see what happens when the limit is reached.

    Shape and Direction emits particles out of an unfilled Ellipse shape, using a TargetDirection
    \snippet examples/particles/emitters/content/shapeanddirection.qml 0
    This sends the particles towards the center of the ellipse with proportional speed, keeping the ellipse outline as they move to the center.

    TrailEmitter uses that element to add smoke particles to trail the fire particles in the scene.
    \snippet examples/particles/emitters/content/trailemitter.qml 0

*/