1/************************************************************************
2 * This file has been generated automatically from                      *
3 *                                                                      *
4 * src/core/effects/qgsblureffect.h                                     *
5 *                                                                      *
6 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
7 ************************************************************************/
8
9
10
11
12class QgsBlurEffect : QgsPaintEffect /NoDefaultCtors/
13{
14%Docstring
15A paint effect which blurs a source picture, using a number of different blur
16methods.
17
18.. versionadded:: 2.9
19%End
20
21%TypeHeaderCode
22#include "qgsblureffect.h"
23%End
24  public:
25
26    enum BlurMethod
27    {
28      StackBlur,
29      GaussianBlur
30    };
31
32    static QgsPaintEffect *create( const QgsStringMap &map ) /Factory/;
33%Docstring
34Creates a new QgsBlurEffect effect from a properties string map.
35
36:param map: encoded properties string map
37
38:return: new QgsBlurEffect
39%End
40
41    QgsBlurEffect();
42%Docstring
43Constructor for QgsBlurEffect.
44%End
45
46    virtual QString type() const;
47    virtual QgsStringMap properties() const;
48
49    virtual void readProperties( const QgsStringMap &props );
50
51    virtual QgsBlurEffect *clone() const /Factory/;
52
53
54    void setBlurLevel( const double level );
55%Docstring
56Sets blur level (radius)
57
58:param level: blur level. Depending on the current :py:func:`~QgsBlurEffect.blurMethod`, this parameter
59              has different effects
60
61.. seealso:: :py:func:`blurLevel`
62
63.. seealso:: :py:func:`setBlurUnit`
64
65.. seealso:: :py:func:`setBlurMapUnitScale`
66
67.. seealso:: :py:func:`setBlurMethod`
68%End
69
70    double blurLevel() const;
71%Docstring
72Returns the blur level (radius)
73
74:return: blur level. Depending on the current :py:func:`~QgsBlurEffect.blurMethod`, this parameter
75         has different effects
76
77.. seealso:: :py:func:`setBlurLevel`
78
79.. seealso:: :py:func:`blurUnit`
80
81.. seealso:: :py:func:`blurMapUnitScale`
82
83.. seealso:: :py:func:`blurMethod`
84%End
85
86    void setBlurUnit( const QgsUnitTypes::RenderUnit unit );
87%Docstring
88Sets the units used for the blur level (radius).
89
90:param unit: units for blur level
91
92.. seealso:: :py:func:`blurUnit`
93
94.. seealso:: :py:func:`setBlurLevel`
95
96.. seealso:: :py:func:`setBlurMapUnitScale`
97
98.. versionadded:: 3.4.9
99%End
100
101    QgsUnitTypes::RenderUnit blurUnit() const;
102%Docstring
103Returns the units used for the blur level (radius).
104
105:return: units for blur level
106
107.. seealso:: :py:func:`setBlurUnit`
108
109.. seealso:: :py:func:`blurLevel`
110
111.. seealso:: :py:func:`blurMapUnitScale`
112
113.. versionadded:: 3.4.9
114%End
115
116    void setBlurMapUnitScale( const QgsMapUnitScale &scale );
117%Docstring
118Sets the map unit scale used for the blur strength (radius).
119
120:param scale: map unit scale for blur strength
121
122.. seealso:: :py:func:`blurMapUnitScale`
123
124.. seealso:: :py:func:`setBlurLevel`
125
126.. seealso:: :py:func:`setBlurUnit`
127
128.. versionadded:: 3.4.9
129%End
130
131    const QgsMapUnitScale &blurMapUnitScale() const;
132%Docstring
133Returns the map unit scale used for the blur strength (radius).
134
135:return: map unit scale for blur strength
136
137.. seealso:: :py:func:`setBlurMapUnitScale`
138
139.. seealso:: :py:func:`blurLevel`
140
141.. seealso:: :py:func:`blurUnit`
142
143.. versionadded:: 3.4.9
144%End
145
146    void setBlurMethod( const BlurMethod method );
147%Docstring
148Sets the blur method (algorithm) to use for performing the blur.
149
150:param method: blur method
151
152.. seealso:: :py:func:`blurMethod`
153%End
154
155    BlurMethod blurMethod() const;
156%Docstring
157Returns the blur method (algorithm) used for performing the blur.
158
159:return: blur method
160
161.. seealso:: :py:func:`setBlurMethod`
162%End
163
164    void setOpacity( const double opacity );
165%Docstring
166Sets the ``opacity`` for the effect.
167
168:param opacity: double between 0 and 1 inclusive, where 0 is fully transparent
169                and 1 is fully opaque
170
171.. seealso:: :py:func:`opacity`
172%End
173
174    double opacity() const;
175%Docstring
176Returns the opacity for the effect.
177
178:return: opacity value between 0 and 1 inclusive, where 0 is fully transparent
179         and 1 is fully opaque
180
181.. seealso:: :py:func:`setOpacity`
182%End
183
184    void setBlendMode( const QPainter::CompositionMode mode );
185%Docstring
186Sets the blend mode for the effect
187
188:param mode: blend mode used for drawing the effect on to a destination
189             paint device
190
191.. seealso:: :py:func:`blendMode`
192%End
193
194    QPainter::CompositionMode blendMode() const;
195%Docstring
196Returns the blend mode for the effect
197
198:return: blend mode used for drawing the effect on to a destination
199         paint device
200
201.. seealso:: :py:func:`setBlendMode`
202%End
203
204  protected:
205
206    virtual void draw( QgsRenderContext &context );
207
208    virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
209
210
211};
212
213
214/************************************************************************
215 * This file has been generated automatically from                      *
216 *                                                                      *
217 * src/core/effects/qgsblureffect.h                                     *
218 *                                                                      *
219 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
220 ************************************************************************/
221