summaryrefslogtreecommitdiffstats
path: root/doc/src/10-best-practices/distortion-ripple.qdoc
blob: fe720da75e9d2b0d8f597f52f67b8ae8e071ec95 (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
61
62
63
64
65
66
67
68
69
70
71
72
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** 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. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!

\title Distortion Ripple
\page distortion-ripple.html
\ingroup qt3dstudio-best-practices

The distortion ripple effect adds circular ripples, moving away from the center of the effect.

\image effects-distortion-ripple.png

\section1 Properties

\table
  \header
    \li Property
    \li Description
  \row
    \li
      Radius
    \li
      The spread between the ripples.
  \row
    \li
      Center
    \li
      The center of the effect. \c 0.5 and \c 0.5 is the center of the layer while \c 1.0 and \c 1.0
      is the upper right corner of the layer.
  \row
    \li
      Wave width
    \li
      Adjusts the amount of ripples.
  \row
    \li
      Wave height
    \li
      Adjusts the distortion amount.
  \row
    \li
      Ripple phase
    \li
      The offset of each ripple. Animate this property to achieve an effect of moving waves.
\endtable

*/