/
qgsrendercontext.sip.in
1042 lines (710 loc) · 28.5 KB
/
qgsrendercontext.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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsrendercontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsRenderContext : QgsTemporalRangeObject
{
%Docstring(signature="appended")
Contains information about the context of a rendering operation.
The context of a rendering operation defines properties such as
the conversion ratio between screen and map units, the extents
to be rendered etc.
%End
%TypeHeaderCode
#include "qgsrendercontext.h"
%End
public:
QgsRenderContext();
~QgsRenderContext();
QgsRenderContext( const QgsRenderContext &rh );
void setFlags( Qgis::RenderContextFlags flags );
%Docstring
Set combination of flags that will be used for rendering.
.. versionadded:: 2.14
%End
void setFlag( Qgis::RenderContextFlag flag, bool on = true );
%Docstring
Enable or disable a particular flag (other flags are not affected)
.. versionadded:: 2.14
%End
Qgis::RenderContextFlags flags() const;
%Docstring
Returns combination of flags used for rendering.
.. versionadded:: 2.14
%End
bool testFlag( Qgis::RenderContextFlag flag ) const;
%Docstring
Check whether a particular flag is enabled.
.. versionadded:: 2.14
%End
static QgsRenderContext fromMapSettings( const QgsMapSettings &mapSettings );
%Docstring
create initialized QgsRenderContext instance from given :py:class:`QgsMapSettings`
.. versionadded:: 2.4
%End
static QgsRenderContext fromQPainter( QPainter *painter );
%Docstring
Creates a default render context given a pixel based QPainter destination.
If no painter is specified or the painter has no device, then a default
DPI of 88 will be assumed.
.. versionadded:: 3.0
%End
QPainter *painter();
%Docstring
Returns the destination QPainter for the render operation.
.. seealso:: :py:func:`setPainter`
%End
void setPainterFlagsUsingContext( QPainter *painter = 0 ) const;
%Docstring
Sets relevant flags on a destination ``painter``, using the flags and settings
currently defined for the render context.
If no ``painter`` is specified, then the flags will be applied to the render
context's :py:func:`~QgsRenderContext.painter`.
.. versionadded:: 3.16
%End
QPainter *maskPainter( int id = 0 );
%Docstring
Returns a mask QPainter for the render operation.
Multiple mask painters can be defined, each with a unique identifier.
None is returned if a mask painter with the given identifier does not exist.
This is currently used to implement selective masking.
.. seealso:: :py:func:`setMaskPainter`
.. seealso:: :py:func:`currentMaskId`
.. versionadded:: 3.12
%End
QSet<const QgsSymbolLayer *> disabledSymbolLayers() const;
%Docstring
When rendering a map layer in a second pass (for selective masking),
some symbol layers may be disabled.
Returns the list of disabled symbol layers.
.. seealso:: :py:func:`setDisabledSymbolLayers`
.. seealso:: :py:func:`isSymbolLayerEnabled`
.. versionadded:: 3.12
%End
bool isSymbolLayerEnabled( const QgsSymbolLayer *layer ) const;
%Docstring
When rendering a map layer in a second pass (for selective masking),
some symbol layers may be disabled.
Checks whether a given symbol layer has been disabled for the current pass.
.. seealso:: :py:func:`setDisabledSymbolLayers`
.. seealso:: :py:func:`disabledSymbolLayers`
.. versionadded:: 3.12
%End
QgsCoordinateTransform coordinateTransform() const;
%Docstring
Returns the current coordinate transform for the context.
This represents the coordinate transform required to transform a layer
which is being rendered back to the CRS of the rendered map. If no coordinate
transformation is required, or the render context is not associated with
a map layer render, then an invalid coordinate transformation is returned.
.. seealso:: :py:func:`setCoordinateTransform`
%End
const QgsDistanceArea &distanceArea() const;
%Docstring
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
.. versionadded:: 3.0
%End
QgsCoordinateTransformContext transformContext() const;
%Docstring
Returns the context's coordinate transform context, which stores various
information regarding which datum transforms should be used when transforming points
from a source to destination coordinate reference system.
.. seealso:: :py:func:`setTransformContext`
.. versionadded:: 3.0
%End
void setTransformContext( const QgsCoordinateTransformContext &context );
%Docstring
Sets the context's coordinate transform ``context``, which stores various
information regarding which datum transforms should be used when transforming points
from a source to destination coordinate reference system.
.. seealso:: :py:func:`transformContext`
.. versionadded:: 3.0
%End
const QgsPathResolver &pathResolver() const;
%Docstring
Returns the path resolver for conversion between relative and absolute paths
during rendering operations, e.g. for resolving relative symbol paths.
.. seealso:: :py:func:`setPathResolver`
.. versionadded:: 3.0
%End
void setPathResolver( const QgsPathResolver &resolver );
%Docstring
Sets the path ``resolver`` for conversion between relative and absolute paths
during rendering operations, e.g. for resolving relative symbol paths.
.. seealso:: :py:func:`pathResolver`
.. versionadded:: 3.0
%End
const QgsRectangle &extent() const;
%Docstring
When rendering a map layer, calling this method returns the "clipping"
extent for the layer (in the layer's CRS).
This extent is a "worst-case" scenario, which is guaranteed to cover the complete
visible portion of the layer when it is rendered to a map. It is often larger
than the actual visible portion of that layer.
.. warning::
For some layers, depending on the visible extent and the coordinate
transforms involved, this extent will represent the entire globe. This method
should never be used to determine the actual visible extent of a map render.
.. seealso:: :py:func:`setExtent`
.. seealso:: :py:func:`mapExtent`
%End
QgsRectangle mapExtent() const;
%Docstring
Returns the original extent of the map being rendered.
Unlike :py:func:`~QgsRenderContext.extent`, this extent is always in the final destination CRS for the map
render and represents the exact bounds of the map being rendered.
.. seealso:: :py:func:`extent`
.. seealso:: :py:func:`setMapExtent`
.. versionadded:: 3.4.8
%End
const QgsMapToPixel &mapToPixel() const;
%Docstring
Returns the context's map to pixel transform, which transforms between map coordinates and device coordinates.
.. seealso:: :py:func:`setMapToPixel`
%End
double scaleFactor() const;
%Docstring
Returns the scaling factor for the render to convert painter units
to physical sizes. This is usually equal to the number of pixels
per millimeter.
.. seealso:: :py:func:`setScaleFactor`
%End
double dpiTarget() const;
%Docstring
Returns the targeted DPI for rendering.
.. seealso:: :py:func:`setDpiTarget`
.. versionadded:: 3.20
%End
bool renderingStopped() const;
%Docstring
Returns ``True`` if the rendering operation has been stopped and any ongoing
rendering should be canceled immediately.
.. note::
Since QGIS 3.22 the :py:func:`~QgsRenderContext.feedback` member exists as an alternative means of cancellation support.
.. seealso:: :py:func:`setRenderingStopped`
.. seealso:: :py:func:`feedback`
%End
void setFeedback( QgsFeedback *feedback );
%Docstring
Attach a ``feedback`` object that can be queried regularly during rendering to check
if rendering should be canceled.
Ownership of ``feedback`` is NOT transferred, and the caller must take care that it exists
for the lifetime of the render context.
.. seealso:: :py:func:`feedback`
.. versionadded:: 3.22
%End
QgsFeedback *feedback() const;
%Docstring
Returns the feedback object that can be queried regularly during rendering to check
if rendering should be canceled, if set. Maybe be ``None``.
.. seealso:: :py:func:`setFeedback`
.. versionadded:: 3.22
%End
bool forceVectorOutput() const;
%Docstring
Returns ``True`` if rendering operations should use vector operations instead
of any faster raster shortcuts.
.. seealso:: :py:func:`setForceVectorOutput`
%End
bool useAdvancedEffects() const;
%Docstring
Returns ``True`` if advanced effects such as blend modes such be used
.. seealso:: :py:func:`setUseAdvancedEffects`
%End
void setUseAdvancedEffects( bool enabled );
%Docstring
Used to enable or disable advanced effects such as blend modes
.. seealso:: :py:func:`useAdvancedEffects`
%End
bool drawEditingInformation() const;
%Docstring
Returns ``True`` if edit markers should be drawn during the render operation.
.. seealso:: :py:func:`setDrawEditingInformation`
%End
double rendererScale() const;
%Docstring
Returns the renderer map scale. This will match the desired scale denominator
for the rendered map, eg 1000.0 for a 1:1000 map render.
.. seealso:: :py:func:`setRendererScale`
%End
double symbologyReferenceScale() const;
%Docstring
Returns the symbology reference scale.
This represents the desired scale denominator for the rendered map, eg 1000.0 for a 1:1000 map render.
A value of -1 indicates that symbology scaling by reference scale is disabled.
The symbology reference scale is an optional property which specifies the reference
scale at which symbology in paper units (such a millimeters or points) is fixed
to. For instance, if the scale is 1000 then a 2mm thick line will be rendered at
exactly 2mm thick when a map is rendered at 1:1000, or 1mm thick when rendered at 1:2000, or 4mm thick at 1:500.
.. seealso:: :py:func:`setSymbologyReferenceScale`
.. seealso:: :py:func:`rendererScale`
.. versionadded:: 3.22
%End
QColor selectionColor() const;
%Docstring
Returns the color to use when rendering selected features.
.. seealso:: :py:func:`setSelectionColor`
%End
bool showSelection() const;
%Docstring
Returns ``True`` if vector selections should be shown in the rendered map
:return: ``True`` if selections should be shown
.. seealso:: :py:func:`setShowSelection`
.. seealso:: :py:func:`selectionColor`
.. versionadded:: 2.4
%End
void setCoordinateTransform( const QgsCoordinateTransform &t );
%Docstring
Sets the current coordinate transform for the context.
This represents the coordinate transform required to transform the layer
which is being rendered back to the CRS of the rendered map.
Set to an invalid :py:class:`QgsCoordinateTransform` to indicate that no transformation is required.
.. seealso:: :py:func:`coordinateTransform`
%End
void setMapToPixel( const QgsMapToPixel &mtp );
%Docstring
Sets the context's map to pixel transform, which transforms between map coordinates and device coordinates.
.. seealso:: :py:func:`mapToPixel`
%End
void setExtent( const QgsRectangle &extent );
%Docstring
When rendering a map layer, calling this method sets the "clipping"
extent for the layer (in the layer's CRS).
This extent should be a "worst-case" scenario, which is guaranteed to
completely cover the entire visible portion of the layer when it is rendered
to the map. It may be larger than the actual visible area, but MUST contain at least the
entire visible area.
.. seealso:: :py:func:`setExtent`
.. seealso:: :py:func:`setMapExtent`
%End
void setMapExtent( const QgsRectangle &extent );
%Docstring
Sets the original ``extent`` of the map being rendered.
Unlike :py:func:`~QgsRenderContext.setExtent`, this extent is always in the final destination CRS for the map
render and represents the exact bounds of the map being rendered.
.. seealso:: :py:func:`mapExtent`
.. seealso:: :py:func:`setExtent`
.. versionadded:: 3.4.8
%End
void setDrawEditingInformation( bool b );
%Docstring
Sets whether edit markers should be drawn during the render operation.
.. seealso:: :py:func:`drawEditingInformation`
%End
void setRenderingStopped( bool stopped );
%Docstring
Sets whether the rendering operation has been ``stopped`` and any ongoing
rendering should be canceled immediately.
.. note::
Since QGIS 3.22 the :py:func:`~QgsRenderContext.feedback` member exists as an alternative means of cancellation support.
.. seealso:: :py:func:`renderingStopped`
.. seealso:: :py:func:`feedback`
.. seealso:: :py:func:`setFeedback`
%End
void setDistanceArea( const QgsDistanceArea &distanceArea );
%Docstring
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
Will be used to convert meter distances to active MapUnit values for :py:class:`QgsUnitTypes`.RenderMetersInMapUnits
.. versionadded:: 3.0
%End
void setScaleFactor( double factor );
%Docstring
Sets the scaling factor for the render to convert painter units
to physical sizes. This should usually be equal to the number of pixels
per millimeter.
.. seealso:: :py:func:`scaleFactor`
%End
void setDpiTarget( double dpi );
%Docstring
Sets the targeted ``dpi`` for rendering.
.. seealso:: :py:func:`dpiTarget`
.. versionadded:: 3.20
%End
void setRendererScale( double scale );
%Docstring
Sets the renderer map scale. This should match the desired scale denominator
for the rendered map, eg 1000.0 for a 1:1000 map render.
.. seealso:: :py:func:`rendererScale`
%End
void setSymbologyReferenceScale( double scale );
%Docstring
Sets the symbology reference ``scale``.
This should match the desired scale denominator for the rendered map, eg 1000.0 for a 1:1000 map render.
Set to -1 to disable symbology scaling by reference scale.
The symbology reference scale is an optional property which specifies the reference
scale at which symbology in paper units (such a millimeters or points) is fixed
to. For instance, if ``scale`` is set to 1000 then a 2mm thick line will be rendered at
exactly 2mm thick when a map is rendered at 1:1000, or 1mm thick when rendered at 1:2000, or 4mm thick at 1:500.
.. seealso:: :py:func:`symbologyReferenceScale`
.. seealso:: :py:func:`rendererScale`
.. versionadded:: 3.22
%End
void setPainter( QPainter *p );
%Docstring
Sets the destination QPainter for the render operation. Ownership of the painter
is not transferred and the QPainter destination must stay alive for the duration
of any rendering operations.
.. seealso:: :py:func:`painter`
%End
void setMaskPainter( QPainter *p, int id = 0 );
%Docstring
Sets a mask QPainter for the render operation. Ownership of the painter
is not transferred and the QPainter must stay alive for the duration
of any rendering operations.
Multiple mask painters can be defined and the second parameter gives a unique identifier to each one.
.. seealso:: :py:func:`maskPainter`
%End
void setDisabledSymbolLayers( const QSet<const QgsSymbolLayer *> &symbolLayers );
%Docstring
When rendering a map layer in a second pass (for selective masking),
some symbol layers may be disabled.
Sets the list of disabled symbol layers.
.. seealso:: :py:func:`disabledSymbolLayers`
.. seealso:: :py:func:`isSymbolLayerEnabled`
.. versionadded:: 3.12
%End
void setForceVectorOutput( bool force );
%Docstring
Sets whether rendering operations should use vector operations instead
of any faster raster shortcuts.
.. seealso:: :py:func:`forceVectorOutput`
%End
void setSelectionColor( const QColor &color );
%Docstring
Sets the ``color`` to use when rendering selected features.
.. seealso:: :py:func:`selectionColor`
%End
void setShowSelection( bool showSelection );
%Docstring
Sets whether vector selections should be shown in the rendered map
:param showSelection: set to ``True`` if selections should be shown
.. seealso:: :py:func:`showSelection`
.. seealso:: :py:func:`setSelectionColor`
.. versionadded:: 2.4
%End
bool useRenderingOptimization() const;
%Docstring
Returns ``True`` if the rendering optimization (geometry simplification) can be executed
.. seealso:: :py:func:`setUseRenderingOptimization`
%End
void setUseRenderingOptimization( bool enabled );
%Docstring
Sets whether the rendering optimization (geometry simplification) should be executed
.. seealso:: :py:func:`useRenderingOptimization`
%End
const QgsVectorSimplifyMethod &vectorSimplifyMethod() const;
%Docstring
Returns the simplification settings to use when rendering vector layers.
The default is to use no simplification.
.. seealso:: :py:func:`setVectorSimplifyMethod`
.. versionadded:: 2.4
%End
void setVectorSimplifyMethod( const QgsVectorSimplifyMethod &simplifyMethod );
%Docstring
Sets the simplification setting to use when rendering vector layers.
This can be used to specify simplification methods to apply during map exports and renders,
e.g. to allow vector layers to be simplified to an appropriate maximum level of detail
during PDF exports or to speed up layer rendering
The default is to use no simplification.
.. seealso:: :py:func:`vectorSimplifyMethod`
.. versionadded:: 2.4
%End
void setExpressionContext( const QgsExpressionContext &context );
%Docstring
Sets the expression context. This context is used for all expression evaluation
associated with this render context.
.. seealso:: :py:func:`expressionContext`
.. versionadded:: 2.12
%End
QgsExpressionContext &expressionContext();
%Docstring
Gets the expression context. This context should be used for all expression evaluation
associated with this render context.
.. seealso:: :py:func:`setExpressionContext`
.. versionadded:: 2.12
%End
const QgsAbstractGeometry *geometry() const;
%Docstring
Returns pointer to the unsegmentized geometry
%End
void setGeometry( const QgsAbstractGeometry *geometry );
%Docstring
Sets pointer to original (unsegmentized) geometry
%End
void setFeatureFilterProvider( const QgsFeatureFilterProvider *ffp );
%Docstring
Set a filter feature provider used for additional filtering of rendered features.
:param ffp: the filter feature provider
.. seealso:: :py:func:`featureFilterProvider`
.. versionadded:: 2.14
%End
const QgsFeatureFilterProvider *featureFilterProvider() const;
%Docstring
Gets the filter feature provider used for additional filtering of rendered features.
:return: the filter feature provider
.. seealso:: :py:func:`setFeatureFilterProvider`
.. versionadded:: 2.14
%End
void setSegmentationTolerance( double tolerance );
%Docstring
Sets the segmentation tolerance applied when rendering curved geometries
:param tolerance: the segmentation tolerance
.. seealso:: :py:func:`segmentationTolerance`
.. seealso:: :py:func:`segmentationToleranceType`
%End
double segmentationTolerance() const;
%Docstring
Gets the segmentation tolerance applied when rendering curved geometries
.. seealso:: :py:func:`setSegmentationTolerance`
%End
void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type );
%Docstring
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
:param type: the segmentation tolerance typename
.. seealso:: :py:func:`segmentationToleranceType`
.. seealso:: :py:func:`segmentationTolerance`
%End
QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const;
%Docstring
Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
.. seealso:: :py:func:`setSegmentationToleranceType`
%End
double convertToPainterUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property = Qgis::RenderSubcomponentProperty::Generic ) const;
%Docstring
Converts a size from the specified units to painter units (pixels). The conversion respects the limits
specified by the optional scale parameter.
Since QGIS 3.22 the optional ``property`` argument can be used to specify the associated property. This
is used in some contexts to refine the converted size. For example, a Qgis.RenderSubcomponentProperty.BlurSize
property will be limited to a suitably fast range when the render context has the Qgis.RenderContextFlag.RenderSymbolPreview set.
.. seealso:: :py:func:`convertToMapUnits`
.. versionadded:: 3.0
%End
double convertToMapUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale() ) const;
%Docstring
Converts a size from the specified units to map units. The conversion respects the limits
specified by the optional scale parameter.
.. seealso:: :py:func:`convertToPainterUnits`
.. versionadded:: 3.0
%End
double convertFromMapUnits( double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit ) const;
%Docstring
Converts a size from map units to the specified units.
.. seealso:: :py:func:`convertToMapUnits`
.. versionadded:: 3.0
%End
double convertMetersToMapUnits( double meters ) const;
%Docstring
Convert meter distances to active MapUnit values for :py:class:`QgsUnitTypes`.RenderMetersInMapUnits
\note
When the :py:func:`~QgsRenderContext.sourceCrs` is geographic, the center of the Extent will be used
.. versionadded:: 3.0
%End
Qgis::TextRenderFormat textRenderFormat() const;
%Docstring
Returns the text render format, which dictates how text is rendered (e.g. as paths or real text objects).
.. seealso:: :py:func:`setTextRenderFormat`
.. versionadded:: 3.4.3
%End
void setTextRenderFormat( Qgis::TextRenderFormat format );
%Docstring
Sets the text render ``format``, which dictates how text is rendered (e.g. as paths or real text objects).
.. seealso:: :py:func:`textRenderFormat`
.. versionadded:: 3.4.3
%End
QList<QgsRenderedFeatureHandlerInterface *> renderedFeatureHandlers() const;
%Docstring
Returns the list of rendered feature handlers to use while rendering map layers.
.. seealso:: :py:func:`hasRenderedFeatureHandlers`
.. versionadded:: 3.10
%End
bool hasRenderedFeatureHandlers() const;
%Docstring
Returns ``True`` if the context has any rendered feature handlers.
.. seealso:: :py:func:`renderedFeatureHandlers`
.. versionadded:: 3.10
%End
void setMaskIdProvider( QgsMaskIdProvider *provider );
%Docstring
Attaches a mask id provider to the context. It will allow some rendering operations to set the current mask id
based on the context (label layer names and label rules for instance).
.. seealso:: :py:class:`QgsMaskIdProvider`
.. seealso:: :py:func:`setCurrentMaskId`
.. seealso:: :py:func:`maskIdProvider`
.. versionadded:: 3.12
%End
const QgsMaskIdProvider *maskIdProvider() const;
%Docstring
Returns the mask id provider attached to the context.
.. seealso:: :py:func:`setMaskIdProvider`
.. versionadded:: 3.12
%End
void setCurrentMaskId( int id );
%Docstring
Stores a mask id as the "current" one.
.. seealso:: :py:func:`currentMaskId`
.. versionadded:: 3.12
%End
int currentMaskId() const;
%Docstring
Returns the current mask id, which can be used with :py:func:`~QgsRenderContext.maskPainter`
.. seealso:: :py:func:`setCurrentMaskId`
.. seealso:: :py:func:`maskPainter`
.. versionadded:: 3.12
%End
void setIsGuiPreview( bool preview );
%Docstring
Sets GUI preview mode.
GUI preview mode is used to change the behavior of some renderings when
they are done to preview of symbology in the GUI.
This is especially used to display mask symbol layers rather than painting them
in a mask painter, which is not meant to be visible, by definition.
.. seealso:: :py:func:`isGuiPreview`
.. versionadded:: 3.12
%End
bool isGuiPreview() const;
%Docstring
Returns the Gui preview mode.
GUI preview mode is used to change the behavior of some renderings when
they are done to preview of symbology in the GUI.
This is especially used to display mask symbol layers rather than painting them
in a mask painter, which is not meant to be visible, by definition.
.. seealso:: :py:func:`isGuiPreview`
.. seealso:: :py:func:`setIsGuiPreview`
.. versionadded:: 3.12
%End
QVariantMap customRenderingFlags() const;
%Docstring
Gets custom rendering flags. Layers might honour these to alter their rendering.
:return: a map of custom flags
.. seealso:: :py:func:`setCustomRenderingFlag`
.. versionadded:: 3.12
%End
void setCustomRenderingFlag( const QString &flag, const QVariant &value );
%Docstring
Sets a custom rendering flag. Layers might honour these to alter their rendering.
:param flag: the flag name
:param value: the flag value
.. seealso:: :py:func:`customRenderingFlags`
.. versionadded:: 3.12
%End
void clearCustomRenderingFlag( const QString &flag );
%Docstring
Clears the specified custom rendering flag.
:param flag: the flag name
.. seealso:: :py:func:`setCustomRenderingFlag`
.. versionadded:: 3.12
%End
QList< QgsMapClippingRegion > clippingRegions() const;
%Docstring
Returns the list of clipping regions to apply during the render.
These regions are always in the final destination CRS for the map.
.. versionadded:: 3.16
%End
QgsGeometry featureClipGeometry() const;
%Docstring
Returns the geometry to use to clip features at render time.
When vector features are rendered, they should be clipped to this geometry.
.. warning::
The clipping must take effect for rendering the feature's symbol only,
and should never be applied directly to the feature being rendered. Doing so would
impact the results of rendering rules which rely on feature geometry, such as
a rule-based renderer using the feature's area.
.. seealso:: :py:func:`setFeatureClipGeometry`
.. versionadded:: 3.16
%End
void setFeatureClipGeometry( const QgsGeometry &geometry );
%Docstring
Sets a ``geometry`` to use to clip features at render time.
.. note::
This is not usually set directly, but rather specified by calling :py:class:`QgsMapSettings`::py:func:`~QgsRenderContext.addClippingRegion`
prior to constructing a QgsRenderContext.
.. seealso:: :py:func:`featureClipGeometry`
.. versionadded:: 3.16
%End
QPointF textureOrigin() const;
%Docstring
Returns the texture origin, which should be used as a brush transform when
rendering using QBrush objects.
.. seealso:: :py:func:`setTextureOrigin`
.. versionadded:: 3.16
%End
void setTextureOrigin( const QPointF &origin );
%Docstring
Sets the texture ``origin``, which should be used as a brush transform when
rendering using QBrush objects.
.. seealso:: :py:func:`textureOrigin`
.. versionadded:: 3.16
%End
QgsDoubleRange zRange() const;
%Docstring
Returns the range of z-values which should be rendered.
.. seealso:: :py:func:`setZRange`
.. versionadded:: 3.18
%End
void setZRange( const QgsDoubleRange &range );
%Docstring
Sets the ``range`` of z-values which should be rendered.
.. seealso:: :py:func:`zRange`
.. versionadded:: 3.18
%End
QSize outputSize() const;
%Docstring
Returns the size of the resulting rendered image, in pixels.
.. seealso:: :py:func:`deviceOutputSize`
.. seealso:: :py:func:`setOutputSize`
.. versionadded:: 3.22
%End
void setOutputSize( QSize size );
%Docstring
Sets the ``size`` of the resulting rendered image, in pixels.
.. seealso:: :py:func:`outputSize`
.. versionadded:: 3.22
%End
float devicePixelRatio() const;
%Docstring
Returns the device pixel ratio.
Common values are 1 for normal-dpi displays and 2 for high-dpi "retina" displays.
.. seealso:: :py:func:`setDevicePixelRatio`
.. versionadded:: 3.22
%End
void setDevicePixelRatio( float ratio );
%Docstring
Sets the device pixel ``ratio``.
Common values are 1 for normal-dpi displays and 2 for high-dpi "retina" displays.
.. seealso:: :py:func:`devicePixelRatio`
.. versionadded:: 3.22
%End
QSize deviceOutputSize() const;
%Docstring
Returns the device output size of the render.