examples/particles/emitters/doc/src/emitters.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Free Documentation License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Free
  19 ** Documentation License version 1.3 as published by the Free Software
  20 ** Foundation and appearing in the file included in the packaging of
  21 ** this file.  Please review the following information to ensure
  22 ** the GNU Free Documentation License version 1.3 requirements
  23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27 /*!
  28     \title QtQuick.Particles Examples - Emitters
  29     \example particles/emitters
  30     \brief This is a collection of examples using Emitters in the QML particle system.
  31     \image qml-emitters-example.png
  32
  33     This is a collection of small QML examples relating to using Emitters in the particle system.
  34     Each example is a small QML file emphasizing a particular element or feature.
  35
  36     Velocity from motion gives the effect of strong particle motion through primarily moving the emitters:
  37     \snippet particles/emitters/content/velocityfrommotion.qml 0
  38
  39     Burst and pulse calls the burst and pulse methods on two idential emitters.
  40     \snippet particles/emitters/content/burstandpulse.qml 0
  41     Note how burst takes an argument of number of particles to emit, and pulse takes an argument of number of milliseconds to emit for.
  42     This gives a slightly different behaviour, which is easy to see in this example.
  43
  44     Custom Emitter connects to the emitParticles signal to set arbitrary values on particle data as they're emitted;
  45     \snippet particles/emitters/content/customemitter.qml 0
  46     This is used to emit curving particles in six rotating spokes.
  47
  48     Emit mask sets an image mask on the Emitter, to emit out of an arbitrary shape.
  49     \snippet particles/emitters/content/emitmask.qml 0
  50
  51     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.
  52
  53     Shape and Direction emits particles out of an unfilled Ellipse shape, using a TargetDirection
  54     \snippet particles/emitters/content/shapeanddirection.qml 0
  55     This sends the particles towards the center of the ellipse with proportional speed, keeping the ellipse outline as they move to the center.
  56
  57     TrailEmitter uses that element to add smoke particles to trail the fire particles in the scene.
  58     \snippet particles/emitters/content/customemitter.qml 0
  59
  60 */