aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/particles/imageparticle/doc/src/imageparticle.qdoc
blob: 4bbbc6a4302ee17ae91db25f2ebb4371d7cf15b9 (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
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \title Qt Quick Particles Examples - Image Particles
    \example particles/imageparticle
    \examplecategory {Graphics}
    \brief This is a collection of examples using Affectors in the QML particle system.
    \image qml-imageparticle-example.png

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

    All at once shows off several of the features of ImageParticle at the same time.
    \snippet particles/imageparticle/allatonce.qml 0

    Colored shows a simple ImageParticle with some color variation.
    \snippet particles/imageparticle/colored.qml 0

    Color Table sets the color over life on the particles to provide a fixed rainbow effect.
    \snippet particles/imageparticle/colortable.qml 0

    Deformation spins and squishes a starfish particle.
    \snippet particles/imageparticle/deformation.qml spin
    \snippet particles/imageparticle/deformation.qml deform

    Rotation demonstrates the autoRotate property, so that particles rotate in the direction that they travel.

    Sharing demonstrates what happens when multiple ImageParticles try to render the same particle.
    The following ImageParticle renders the particles inside the ListView:
    \snippet particles/imageparticle/sharing.qml 0
    The following ImageParticle is placed inside the list highlight, and renders the particles above the other ImageParticle.
    \snippet particles/imageparticle/sharing.qml 1
    Note that because it sets the color and alpha in this ImageParticle, it renders the particles in a different color.
    Since it doesn't specify anything about the rotation, it shares the rotation with the other ImageParticle so that the flowers are rotated the same way in both.
    Note that you can undo rotation in another ImageParticle, you just need to explicitly set rotationVariation to 0.

    Sprites demonstrates using an image particle to render animated sprites instead of static images for each particle.
*/