-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsrenderer.sip.in
555 lines (393 loc) · 16.1 KB
/
qgsrenderer.sip.in
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsrenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
typedef QList<QgsSymbol *> QgsSymbolList;
class QgsSymbolLevelItem
{
%TypeHeaderCode
#include "qgsrenderer.h"
%End
public:
QgsSymbolLevelItem( QgsSymbol *symbol, int layer );
QgsSymbol *symbol();
int layer();
protected:
};
typedef QList< QgsSymbolLevelItem > QgsSymbolLevel;
typedef QList< QList< QgsSymbolLevelItem > > QgsSymbolLevelOrder;
class QgsFeatureRenderer
{
%TypeHeaderCode
#include "qgsrenderer.h"
%End
%ConvertToSubClassCode
const QString type = sipCpp->type();
if ( type == QStringLiteral( "singleSymbol" ) )
sipType = sipType_QgsSingleSymbolRenderer;
else if ( type == QStringLiteral( "categorizedSymbol" ) )
sipType = sipType_QgsCategorizedSymbolRenderer;
else if ( type == QStringLiteral( "graduatedSymbol" ) )
sipType = sipType_QgsGraduatedSymbolRenderer;
else if ( type == QStringLiteral( "RuleRenderer" ) )
sipType = sipType_QgsRuleBasedRenderer;
else if ( type == QStringLiteral( "heatmapRenderer" ) )
sipType = sipType_QgsHeatmapRenderer;
else if ( type == QStringLiteral( "invertedPolygonRenderer" ) )
sipType = sipType_QgsInvertedPolygonRenderer;
else if ( type == QStringLiteral( "pointCluster" ) )
sipType = sipType_QgsPointClusterRenderer;
else if ( type == QStringLiteral( "pointDisplacement" ) )
sipType = sipType_QgsPointDisplacementRenderer;
else if ( type == QStringLiteral( "25dRenderer" ) )
sipType = sipType_Qgs25DRenderer;
else if ( type == QStringLiteral( "nullSymbol" ) )
sipType = sipType_QgsNullSymbolRenderer;
else
sipType = 0;
%End
public:
static QgsFeatureRenderer *defaultRenderer( QgsWkbTypes::GeometryType geomType ) /Factory/;
%Docstring
return a new renderer - used by default in vector layers
%End
QString type() const;
virtual QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const = 0;
%Docstring
To be overridden
Must be called between startRender() and stopRender() calls.
:param feature: feature
:param context: render context
:return: returns pointer to symbol or 0 if symbol was not found
.. versionadded:: 2.12
%End
virtual QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;
%Docstring
Return symbol for feature. The difference compared to symbolForFeature() is that it returns original
symbol which can be used as an identifier for renderer's rule - the former may return a temporary replacement
of a symbol for use in rendering.
.. versionadded:: 2.12
%End
virtual QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;
%Docstring
Return legend keys matching a specified feature.
.. versionadded:: 2.14
%End
virtual void startRender( QgsRenderContext &context, const QgsFields &fields );
%Docstring
Must be called when a new render cycle is started. A call to startRender() must always
be followed by a corresponding call to stopRender() after all features have been rendered.
:param context: Additional information passed to the renderer about the job which will be rendered
:param fields: The fields available for rendering
.. seealso:: :py:func:`stopRender`
.. warning::
This method is not thread safe. Before calling startRender() in a non-main thread,
the renderer should instead be cloned and startRender()/stopRender() called on the clone.
%End
virtual void stopRender( QgsRenderContext &context );
%Docstring
Must be called when a render cycle has finished, to allow the renderer to clean up.
Calls to stopRender() must always be preceded by a call to startRender().
.. warning::
This method is not thread safe. Before calling startRender() in a non-main thread,
the renderer should instead be cloned and startRender()/stopRender() called on the clone.
.. seealso:: :py:func:`startRender`
%End
virtual QString filter( const QgsFields &fields = QgsFields() );
%Docstring
If a renderer does not require all the features this method may be overridden
and return an expression used as where clause.
This will be called once after startRender() and before the first call
to renderFeature().
By default this returns a null string and all features will be requested.
You do not need to specify the extent in here, this is taken care of separately and
will be combined with a filter returned from this method.
:return: An expression used as where clause
%End
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const = 0;
%Docstring
Return a list of attributes required by this renderer. Attributes not listed in here may
not have been requested from the provider at rendering time.
:return: A set of attributes
%End
virtual bool filterNeedsGeometry() const;
%Docstring
Returns true if this renderer requires the geometry to apply the filter.
%End
virtual ~QgsFeatureRenderer();
virtual QgsFeatureRenderer *clone() const = 0 /Factory/;
%Docstring
Create a deep copy of this renderer. Should be implemented by all subclasses
and generate a proper subclass.
:return: A copy of this renderer
%End
virtual bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false );
%Docstring
Render a feature using this renderer in the given context.
Must be called between startRender() and stopRender() calls.
Default implementation renders a symbol as determined by symbolForFeature() call.
Returns true if the feature has been returned (this is used for example
to determine whether the feature may be labelled).
If layer is not -1, the renderer should draw only a particula layer from symbols
(in order to support symbol level rendering).
.. seealso:: :py:func:`startRender`
.. seealso:: :py:func:`stopRender`
%End
virtual QString dump() const;
%Docstring
Returns debug information about this renderer
%End
enum Capability
{
SymbolLevels,
MoreSymbolsPerFeature,
Filter,
ScaleDependent
};
typedef QFlags<QgsFeatureRenderer::Capability> Capabilities;
virtual QgsFeatureRenderer::Capabilities capabilities();
%Docstring
Returns details about internals of this renderer.
E.g. if you only want to deal with visible features:
.. code-block:: python
if not renderer.capabilities().testFlag(QgsFeatureRenderer.Filter) or renderer.willRenderFeature(feature, context):
deal_with_my_feature()
else:
skip_the_curren_feature()
%End
virtual QgsSymbolList symbols( QgsRenderContext &context ) const;
%Docstring
Returns list of symbols used by the renderer.
:param context: render context
.. versionadded:: 2.12
%End
bool usingSymbolLevels() const;
void setUsingSymbolLevels( bool usingSymbolLevels );
static QgsFeatureRenderer *load( QDomElement &symbologyElem, const QgsReadWriteContext &context ) /Factory/;
%Docstring
create a renderer from XML element
%End
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context );
%Docstring
store renderer info to XML element
%End
virtual QDomElement writeSld( QDomDocument &doc, const QString &styleName, const QgsStringMap &props = QgsStringMap() ) const;
%Docstring
create the SLD UserStyle element following the SLD v1.1 specs with the given name
.. versionadded:: 2.8
%End
static QgsFeatureRenderer *loadSld( const QDomNode &node, QgsWkbTypes::GeometryType geomType, QString &errorMessage ) /Factory/;
%Docstring
Create a new renderer according to the information contained in
the UserStyle element of a SLD style document
:param node: the node in the SLD document whose the UserStyle element
is a child
:param geomType: the geometry type of the features, used to convert
Symbolizer elements
:param errorMessage: it will contain the error message if something
went wrong
:return: the renderer
%End
virtual void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props = QgsStringMap() ) const;
%Docstring
used from subclasses to create SLD Rule elements following SLD v1.1 specs
%End
virtual bool legendSymbolItemsCheckable() const;
%Docstring
items of symbology items in legend should be checkable
.. versionadded:: 2.5
%End
virtual bool legendSymbolItemChecked( const QString &key );
%Docstring
items of symbology items in legend is checked
.. versionadded:: 2.5
%End
virtual void checkLegendSymbolItem( const QString &key, bool state = true );
%Docstring
item in symbology was checked
.. versionadded:: 2.5
%End
virtual void setLegendSymbolItem( const QString &key, QgsSymbol *symbol /Transfer/ );
%Docstring
Sets the symbol to be used for a legend symbol item.
:param key: rule key for legend symbol
:param symbol: new symbol for legend item. Ownership is transferred to renderer.
.. versionadded:: 2.14
%End
virtual QgsLegendSymbolList legendSymbolItems() const;
%Docstring
Returns a list of symbology items for the legend
.. versionadded:: 2.6
%End
virtual QString legendClassificationAttribute() const;
%Docstring
If supported by the renderer, return classification attribute for the use in legend
.. versionadded:: 2.6
%End
void setVertexMarkerAppearance( int type, int size );
%Docstring
set type and size of editing vertex markers for subsequent rendering
%End
virtual bool willRenderFeature( const QgsFeature &feature, QgsRenderContext &context ) const;
%Docstring
Returns whether the renderer will render a feature or not.
Must be called between startRender() and stopRender() calls.
Default implementation uses symbolForFeature().
.. versionadded:: 2.12
%End
virtual QgsSymbolList symbolsForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;
%Docstring
Returns list of symbols used for rendering the feature.
For renderers that do not support MoreSymbolsPerFeature it is more efficient
to use symbolForFeature()
.. versionadded:: 2.12
%End
virtual QgsSymbolList originalSymbolsForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;
%Docstring
Equivalent of originalSymbolsForFeature() call
extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()
.. versionadded:: 2.12
%End
virtual void modifyRequestExtent( QgsRectangle &extent, QgsRenderContext &context );
%Docstring
Allows for a renderer to modify the extent of a feature request prior to rendering
:param extent: reference to request's filter extent. Modify extent to change the
extent of feature request
:param context: render context
.. versionadded:: 2.7
%End
QgsPaintEffect *paintEffect() const;
%Docstring
Returns the current paint effect for the renderer.
:return: paint effect
.. versionadded:: 2.9
.. seealso:: :py:func:`setPaintEffect`
%End
void setPaintEffect( QgsPaintEffect *effect );
%Docstring
Sets the current paint effect for the renderer.
:param effect: paint effect. Ownership is transferred to the renderer.
.. versionadded:: 2.9
.. seealso:: :py:func:`paintEffect`
%End
bool forceRasterRender() const;
%Docstring
Returns whether the renderer must render as a raster.
.. versionadded:: 2.12
.. seealso:: :py:func:`setForceRasterRender`
%End
void setForceRasterRender( bool forceRaster );
%Docstring
Sets whether the renderer should be rendered to a raster destination.
:param forceRaster: set to true if renderer must be drawn on a raster surface.
This may be desirable for highly detailed layers where rendering as a vector
would result in a large, complex vector output.
.. seealso:: :py:func:`forceRasterRender`
.. versionadded:: 2.12
%End
QgsFeatureRequest::OrderBy orderBy() const;
%Docstring
Get the order in which features shall be processed by this renderer.
.. versionadded:: 2.14
.. note::
this property has no effect if orderByEnabled() is false
.. seealso:: :py:func:`orderByEnabled`
%End
void setOrderBy( const QgsFeatureRequest::OrderBy &orderBy );
%Docstring
Define the order in which features shall be processed by this renderer.
.. note::
this property has no effect if orderByEnabled() is false
.. versionadded:: 2.14
.. seealso:: :py:func:`setOrderByEnabled`
%End
bool orderByEnabled() const;
%Docstring
Returns whether custom ordering will be applied before features are processed by this renderer.
.. versionadded:: 2.14
.. seealso:: :py:func:`orderBy`
.. seealso:: :py:func:`setOrderByEnabled`
%End
void setOrderByEnabled( bool enabled );
%Docstring
Sets whether custom ordering should be applied before features are processed by this renderer.
:param enabled: set to true to enable custom feature ordering
.. versionadded:: 2.14
.. seealso:: :py:func:`setOrderBy`
.. seealso:: :py:func:`orderByEnabled`
%End
virtual void setEmbeddedRenderer( QgsFeatureRenderer *subRenderer /Transfer/ );
%Docstring
Sets an embedded renderer (subrenderer) for this feature renderer. The base class implementation
does nothing with subrenderers, but individual derived classes can use these to modify their behavior.
:param subRenderer: the embedded renderer. Ownership will be transferred.
.. seealso:: :py:func:`embeddedRenderer`
.. versionadded:: 2.16
%End
virtual const QgsFeatureRenderer *embeddedRenderer() const;
%Docstring
Returns the current embedded renderer (subrenderer) for this feature renderer. The base class
implementation does not use subrenderers and will always return null.
.. seealso:: :py:func:`setEmbeddedRenderer`
.. versionadded:: 2.16
%End
protected:
QgsFeatureRenderer( const QString &type );
void renderFeatureWithSymbol( const QgsFeature &feature,
QgsSymbol *symbol,
QgsRenderContext &context,
int layer,
bool selected,
bool drawVertexMarker );
void renderVertexMarker( QPointF pt, QgsRenderContext &context );
%Docstring
render editing vertex marker at specified point
%End
void renderVertexMarkerPolyline( QPolygonF &pts, QgsRenderContext &context );
%Docstring
render editing vertex marker for a polyline
%End
void renderVertexMarkerPolygon( QPolygonF &pts, QList<QPolygonF> *rings, QgsRenderContext &context );
%Docstring
render editing vertex marker for a polygon
%End
static QPointF _getPoint( QgsRenderContext &context, const QgsPoint &point );
%Docstring
Creates a point in screen coordinates from a wkb string in map
coordinates
%End
void copyRendererData( QgsFeatureRenderer *destRenderer ) const;
%Docstring
Clones generic renderer data to another renderer.
Currently clones
* Order By
* Paint Effect
:param destRenderer: destination renderer for copied effect
%End
static void convertSymbolSizeScale( QgsSymbol *symbol, QgsSymbol::ScaleMethod method, const QString &field );
%Docstring
.. note::
this function is used to convert old sizeScale expressions to symbol
level DataDefined size
%End
static void convertSymbolRotation( QgsSymbol *symbol, const QString &field );
%Docstring
.. note::
this function is used to convert old rotations expressions to symbol
level DataDefined angle
%End
private:
QgsFeatureRenderer( const QgsFeatureRenderer & );
QgsFeatureRenderer &operator=( const QgsFeatureRenderer & );
};
QFlags<QgsFeatureRenderer::Capability> operator|(QgsFeatureRenderer::Capability f1, QFlags<QgsFeatureRenderer::Capability> f2);
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsrenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/