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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgsshadoweffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsShadowEffect : QgsPaintEffect /NoDefaultCtors/
{
%Docstring(signature="appended")
Base class for paint effects which offset, blurred shadows
%End
%TypeHeaderCode
#include "qgsshadoweffect.h"
%End
public:
QgsShadowEffect();
virtual QVariantMap properties() const;
virtual void readProperties( const QVariantMap &props );
void setBlurLevel( const double level );
%Docstring
Sets blur level (radius) for the shadow.
:param level: blur level. values indicating greater blur strength.
.. seealso:: :py:func:`blurLevel`
.. seealso:: :py:func:`setBlurUnit`
.. seealso:: :py:func:`setBlurMapUnitScale`
%End
double blurLevel() const;
%Docstring
Returns the blur level (radius) for the shadow.
:return: blur level. values indicating greater blur strength.
.. seealso:: :py:func:`setBlurLevel`
.. seealso:: :py:func:`blurUnit`
.. seealso:: :py:func:`blurMapUnitScale`
%End
void setBlurUnit( const Qgis::RenderUnit unit );
%Docstring
Sets the units used for the shadow 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 shadow 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 shadow 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 shadow 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 setOffsetAngle( const int angle );
%Docstring
Sets the angle for offsetting the shadow.
:param angle: offset angle in degrees clockwise from North
.. seealso:: :py:func:`offsetAngle`
.. seealso:: :py:func:`setOffsetDistance`
%End
int offsetAngle() const;
%Docstring
Returns the angle used for offsetting the shadow.
:return: offset angle in degrees clockwise from North
.. seealso:: :py:func:`setOffsetAngle`
.. seealso:: :py:func:`offsetDistance`
%End
void setOffsetDistance( const double distance );
%Docstring
Sets the distance for offsetting the shadow.
:param distance: offset distance. Units are specified via
:py:func:`~QgsShadowEffect.setOffsetUnit`
.. seealso:: :py:func:`offsetDistance`
.. seealso:: :py:func:`setOffsetUnit`
.. seealso:: :py:func:`setOffsetMapUnitScale`
%End
double offsetDistance() const;
%Docstring
Returns the distance used for offsetting the shadow.
:return: offset distance. Distance units are retrieved via
:py:func:`~QgsShadowEffect.offsetUnit`
.. seealso:: :py:func:`setOffsetDistance`
.. seealso:: :py:func:`offsetUnit`
.. seealso:: :py:func:`offsetMapUnitScale`
%End
void setOffsetUnit( const Qgis::RenderUnit unit );
%Docstring
Sets the units used for the shadow offset distance.
:param unit: units for offset distance
.. seealso:: :py:func:`offsetUnit`
.. seealso:: :py:func:`setOffsetDistance`
.. seealso:: :py:func:`setOffsetMapUnitScale`
%End
Qgis::RenderUnit offsetUnit() const;
%Docstring
Returns the units used for the shadow offset distance.
:return: units for offset distance
.. seealso:: :py:func:`setOffsetUnit`
.. seealso:: :py:func:`offsetDistance`
.. seealso:: :py:func:`offsetMapUnitScale`
%End
void setOffsetMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit scale used for the shadow offset distance.
:param scale: map unit scale for offset distance
.. seealso:: :py:func:`offsetMapUnitScale`
.. seealso:: :py:func:`setOffsetDistance`
.. seealso:: :py:func:`setOffsetUnit`
%End
const QgsMapUnitScale &offsetMapUnitScale() const;
%Docstring
Returns the map unit scale used for the shadow offset distance.
:return: map unit scale for offset distance
.. seealso:: :py:func:`setOffsetMapUnitScale`
.. seealso:: :py:func:`offsetDistance`
.. seealso:: :py:func:`offsetUnit`
%End
void setColor( const QColor &color );
%Docstring
Sets the color for the shadow.
:param color: shadow color
.. seealso:: :py:func:`color`
%End
QColor color() const;
%Docstring
Returns the color used for the shadow.
:return: shadow color
.. seealso:: :py:func:`setColor`
%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 QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
virtual void draw( QgsRenderContext &context );
virtual bool exteriorShadow() const = 0;
%Docstring
Specifies whether the shadow is drawn outside the picture or within the
picture.
:return: ``True`` if shadow is to be drawn outside the picture, or
``False`` to draw shadow within the picture
%End
};
class QgsDropShadowEffect : QgsShadowEffect /NoDefaultCtors/
{
%Docstring(signature="appended")
A paint effect which draws an offset and optionally blurred drop shadow
%End
%TypeHeaderCode
#include "qgsshadoweffect.h"
%End
public:
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
%Docstring
Creates a new QgsDropShadowEffect effect from a properties string map.
:param map: encoded properties string map
:return: new QgsDropShadowEffect
%End
QgsDropShadowEffect();
virtual QString type() const;
virtual QgsDropShadowEffect *clone() const /Factory/;
protected:
virtual bool exteriorShadow() const;
};
class QgsInnerShadowEffect : QgsShadowEffect /NoDefaultCtors/
{
%Docstring(signature="appended")
A paint effect which draws an offset and optionally blurred drop shadow
within a picture.
%End
%TypeHeaderCode
#include "qgsshadoweffect.h"
%End
public:
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
%Docstring
Creates a new QgsInnerShadowEffect effect from a properties string map.
:param map: encoded properties string map
:return: new QgsInnerShadowEffect
%End
QgsInnerShadowEffect();
virtual QString type() const;
virtual QgsInnerShadowEffect *clone() const /Factory/;
protected:
virtual bool exteriorShadow() const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgsshadoweffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
