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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgsgloweffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsGlowEffect : QgsPaintEffect
{
%Docstring(signature="appended")
Base class for paint effect which draw a glow inside or outside a
picture.
%End
%TypeHeaderCode
#include "qgsgloweffect.h"
%End
public:
enum GlowColorType /BaseType=IntEnum/
{
SingleColor,
ColorRamp
};
QgsGlowEffect();
QgsGlowEffect( const QgsGlowEffect &other );
~QgsGlowEffect();
virtual QVariantMap properties() const;
virtual void readProperties( const QVariantMap &props );
void setSpread( const double spread );
%Docstring
Sets the spread distance for drawing the glow effect.
:param spread: spread distance. Units are specified via
:py:func:`~QgsGlowEffect.setSpreadUnit`
.. seealso:: :py:func:`spread`
.. seealso:: :py:func:`setSpreadUnit`
.. seealso:: :py:func:`setSpreadMapUnitScale`
%End
double spread() const;
%Docstring
Returns the spread distance used for drawing the glow effect.
:return: spread distance. Units are retrieved via
:py:func:`~QgsGlowEffect.spreadUnit`
.. seealso:: :py:func:`setSpread`
.. seealso:: :py:func:`spreadUnit`
.. seealso:: :py:func:`spreadMapUnitScale`
%End
void setSpreadUnit( const Qgis::RenderUnit unit );
%Docstring
Sets the units used for the glow spread distance.
:param unit: units for spread distance
.. seealso:: :py:func:`spreadUnit`
.. seealso:: :py:func:`setSpread`
.. seealso:: :py:func:`setSpreadMapUnitScale`
%End
Qgis::RenderUnit spreadUnit() const;
%Docstring
Returns the units used for the glow spread distance.
:return: units for spread distance
.. seealso:: :py:func:`setSpreadUnit`
.. seealso:: :py:func:`spread`
.. seealso:: :py:func:`spreadMapUnitScale`
%End
void setSpreadMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit scale used for the spread distance.
:param scale: map unit scale for spread distance
.. seealso:: :py:func:`spreadMapUnitScale`
.. seealso:: :py:func:`setSpread`
.. seealso:: :py:func:`setSpreadUnit`
%End
const QgsMapUnitScale &spreadMapUnitScale() const;
%Docstring
Returns the map unit scale used for the spread distance.
:return: map unit scale for spread distance
.. seealso:: :py:func:`setSpreadMapUnitScale`
.. seealso:: :py:func:`spread`
.. seealso:: :py:func:`spreadUnit`
%End
void setBlurLevel( const double level );
%Docstring
Sets blur level (radius) for the glow. This can be used to smooth the
output from the glow effect.
:param level: blur level.
.. seealso:: :py:func:`blurLevel`
.. seealso:: :py:func:`setBlurUnit`
.. seealso:: :py:func:`setBlurMapUnitScale`
%End
double blurLevel() const;
%Docstring
Returns the blur level (radius) for the glow.
:return: blur level.
.. 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 glow 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 glow 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 glow 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 glow 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 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 setColor( const QColor &color );
%Docstring
Sets the color for the glow. This only applies if the
:py:func:`~QgsGlowEffect.colorType` is set to SingleColor. The glow will
fade between the specified color and a totally transparent version of
the color.
:param color: glow color
.. seealso:: :py:func:`color`
.. seealso:: :py:func:`setColorType`
%End
QColor color() const;
%Docstring
Returns the color for the glow. This only applies if the
:py:func:`~QgsGlowEffect.colorType` is set to SingleColor. The glow will
fade between the specified color and a totally transparent version of
the color.
:return: glow color
.. seealso:: :py:func:`setColor`
.. seealso:: :py:func:`colorType`
%End
void setRamp( QgsColorRamp *ramp /Transfer/ );
%Docstring
Sets the color ramp for the glow. This only applies if the
:py:func:`~QgsGlowEffect.colorType` is set to ColorRamp. The glow will
utilize colors from the ramp.
:param ramp: color ramp for glow. Ownership of the ramp is transferred
to the effect.
.. seealso:: :py:func:`ramp`
.. seealso:: :py:func:`setColorType`
%End
QgsColorRamp *ramp() const;
%Docstring
Returns the color ramp used for the glow. This only applies if the
:py:func:`~QgsGlowEffect.colorType` is set to ColorRamp. The glow will
utilize colors from the ramp.
:return: color ramp for glow
.. seealso:: :py:func:`setRamp`
.. seealso:: :py:func:`colorType`
%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
void setColorType( GlowColorType colorType );
%Docstring
Sets the color mode to use for the glow. The glow can either be drawn
using a :py:class:`QgsColorRamp` color ramp or by simply specificing a
single color. setColorType is used to specify which mode to use for the
glow.
:param colorType: color type to use for glow
.. seealso:: :py:func:`colorType`
.. seealso:: :py:func:`setColor`
.. seealso:: :py:func:`setRamp`
%End
GlowColorType colorType() const;
%Docstring
Returns the color mode used for the glow. The glow can either be drawn
using a :py:class:`QgsColorRamp` color ramp or by specificing a single
color.
:return: current color mode used for the glow
.. seealso:: :py:func:`setColorType`
.. seealso:: :py:func:`color`
.. seealso:: :py:func:`ramp`
%End
protected:
virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
virtual void draw( QgsRenderContext &context );
virtual bool shadeExterior() const = 0;
%Docstring
Specifies whether the glow is drawn outside the picture or within the
picture.
:return: ``True`` if glow is to be drawn outside the picture, or
``False`` to draw glow within the picture
%End
};
class QgsOuterGlowEffect : QgsGlowEffect
{
%Docstring(signature="appended")
A paint effect which draws a glow outside of a picture.
%End
%TypeHeaderCode
#include "qgsgloweffect.h"
%End
public:
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
%Docstring
Creates a new QgsOuterGlowEffect effect from a properties string map.
:param map: encoded properties string map
:return: new QgsOuterGlowEffect
%End
QgsOuterGlowEffect();
virtual QString type() const;
virtual QgsOuterGlowEffect *clone() const /Factory/;
protected:
virtual bool shadeExterior() const;
};
class QgsInnerGlowEffect : QgsGlowEffect
{
%Docstring(signature="appended")
A paint effect which draws a glow within a picture.
%End
%TypeHeaderCode
#include "qgsgloweffect.h"
%End
public:
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
%Docstring
Creates a new QgsInnerGlowEffect effect from a properties string map.
:param map: encoded properties string map
:return: new QgsInnerGlowEffect
%End
QgsInnerGlowEffect();
virtual QString type() const;
virtual QgsInnerGlowEffect *clone() const /Factory/;
protected:
virtual bool shadeExterior() const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgsgloweffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
