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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgsblureffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsBlurEffect : QgsPaintEffect /NoDefaultCtors/
{
%Docstring(signature="appended")
A paint effect which blurs a source picture, using a number of different
blur methods.
%End
%TypeHeaderCode
#include "qgsblureffect.h"
%End
public:
enum BlurMethod /BaseType=IntEnum/
{
StackBlur,
GaussianBlur
};
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
%Docstring
Creates a new QgsBlurEffect effect from a properties string map.
:param map: encoded properties string map
:return: new QgsBlurEffect
%End
QgsBlurEffect();
virtual QString type() const;
virtual QVariantMap properties() const;
virtual void readProperties( const QVariantMap &props );
virtual QgsBlurEffect *clone() const /Factory/;
void setBlurLevel( const double level );
%Docstring
Sets blur level (radius)
:param level: blur level. Depending on the current
:py:func:`~QgsBlurEffect.blurMethod`, this parameter has
different effects
.. seealso:: :py:func:`blurLevel`
.. seealso:: :py:func:`setBlurUnit`
.. seealso:: :py:func:`setBlurMapUnitScale`
.. seealso:: :py:func:`setBlurMethod`
%End
double blurLevel() const;
%Docstring
Returns the blur level (radius)
:return: blur level. Depending on the current
:py:func:`~QgsBlurEffect.blurMethod`, this parameter has
different effects
.. seealso:: :py:func:`setBlurLevel`
.. seealso:: :py:func:`blurUnit`
.. seealso:: :py:func:`blurMapUnitScale`
.. seealso:: :py:func:`blurMethod`
%End
void setBlurUnit( const Qgis::RenderUnit unit );
%Docstring
Sets the units used for the blur level (radius).
:param unit: units for blur level
.. seealso:: :py:func:`blurUnit`
.. seealso:: :py:func:`setBlurLevel`
.. seealso:: :py:func:`setBlurMapUnitScale`
.. versionadded:: 3.4.9
%End
Qgis::RenderUnit blurUnit() const;
%Docstring
Returns the units used for the blur level (radius).
:return: units for blur level
.. seealso:: :py:func:`setBlurUnit`
.. seealso:: :py:func:`blurLevel`
.. seealso:: :py:func:`blurMapUnitScale`
.. versionadded:: 3.4.9
%End
void setBlurMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit scale used for the blur strength (radius).
:param scale: map unit scale for blur strength
.. seealso:: :py:func:`blurMapUnitScale`
.. seealso:: :py:func:`setBlurLevel`
.. seealso:: :py:func:`setBlurUnit`
.. versionadded:: 3.4.9
%End
const QgsMapUnitScale &blurMapUnitScale() const;
%Docstring
Returns the map unit scale used for the blur strength (radius).
:return: map unit scale for blur strength
.. seealso:: :py:func:`setBlurMapUnitScale`
.. seealso:: :py:func:`blurLevel`
.. seealso:: :py:func:`blurUnit`
.. versionadded:: 3.4.9
%End
void setBlurMethod( const BlurMethod method );
%Docstring
Sets the blur method (algorithm) to use for performing the blur.
:param method: blur method
.. seealso:: :py:func:`blurMethod`
%End
BlurMethod blurMethod() const;
%Docstring
Returns the blur method (algorithm) used for performing the blur.
:return: blur method
.. seealso:: :py:func:`setBlurMethod`
%End
void setOpacity( const double opacity );
%Docstring
Sets the ``opacity`` for the effect.
:param opacity: double between 0 and 1 inclusive, where 0 is fully
transparent and 1 is fully opaque
.. seealso:: :py:func:`opacity`
%End
double opacity() const;
%Docstring
Returns the opacity for the effect.
:return: opacity value between 0 and 1 inclusive, where 0 is fully
transparent and 1 is fully opaque
.. seealso:: :py:func:`setOpacity`
%End
void setBlendMode( const QPainter::CompositionMode mode );
%Docstring
Sets the blend mode for the effect
:param mode: blend mode used for drawing the effect on to a destination
paint device
.. seealso:: :py:func:`blendMode`
%End
QPainter::CompositionMode blendMode() const;
%Docstring
Returns the blend mode for the effect
:return: blend mode used for drawing the effect on to a destination
paint device
.. seealso:: :py:func:`setBlendMode`
%End
protected:
virtual void draw( QgsRenderContext &context );
virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgsblureffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
