QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsrendercontext.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsrendercontext.cpp
3 --------------------
4 begin : March 16, 2008
5 copyright : (C) 2008 by Marco Hugentobler
6 email : marco dot hugentobler at karto dot baug dot ethz dot ch
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18
19#include "qgsrendercontext.h"
20
21#include "qgsmapsettings.h"
23#include "qgslogger.h"
24#include "qgselevationmap.h"
25#include "qgsunittypes.h"
26#include "qgssymbollayer.h"
28
29#define POINTS_TO_MM 2.83464567
30#define INCH_TO_MM 25.4
31
33 : mFlags( Qgis::RenderContextFlag::DrawEditingInfo | Qgis::RenderContextFlag::UseAdvancedEffects | Qgis::RenderContextFlag::DrawSelection | Qgis::RenderContextFlag::UseRenderingOptimization )
34{
36 // For RenderMetersInMapUnits support, when rendering in Degrees, the Ellipsoid must be set
37 // - for Previews/Icons the default Extent can be used
38 mDistanceArea.setEllipsoid( mDistanceArea.sourceCrs().ellipsoidAcronym() );
39}
40
42
45 , mFlags( rh.mFlags )
46 , mPainter( rh.mPainter )
47 , mPreviewRenderPainter( rh.mPreviewRenderPainter )
48 , mMaskPainter( rh.mMaskPainter )
49 , mCoordTransform( rh.mCoordTransform )
50 , mDistanceArea( rh.mDistanceArea )
51 , mExtent( rh.mExtent )
52 , mOriginalMapExtent( rh.mOriginalMapExtent )
53 , mMapToPixel( rh.mMapToPixel )
54 , mRenderingStopped( rh.mRenderingStopped )
55 , mFeedback( rh.mFeedback )
56 , mScaleFactor( rh.mScaleFactor )
57 , mDpiTarget( rh.mDpiTarget )
58 , mRendererScale( rh.mRendererScale )
59 , mSymbologyReferenceScale( rh.mSymbologyReferenceScale )
60 , mLabelingEngine( rh.mLabelingEngine )
61 , mLabelSink( rh.mLabelSink )
62 , mSelectionColor( rh.mSelectionColor )
63 , mVectorSimplifyMethod( rh.mVectorSimplifyMethod )
64 , mExpressionContext( rh.mExpressionContext )
65 , mGeometry( rh.mGeometry )
66 , mFeatureFilterProvider( rh.mFeatureFilterProvider ? rh.mFeatureFilterProvider->clone() : nullptr )
67 , mSegmentationTolerance( rh.mSegmentationTolerance )
68 , mSegmentationToleranceType( rh.mSegmentationToleranceType )
69 , mTransformContext( rh.mTransformContext )
70 , mPathResolver( rh.mPathResolver )
71 , mTextRenderFormat( rh.mTextRenderFormat )
72 , mRenderedFeatureHandlers( rh.mRenderedFeatureHandlers )
73 , mHasRenderedFeatureHandlers( rh.mHasRenderedFeatureHandlers )
74 , mCustomRenderingFlags( rh.mCustomRenderingFlags )
75 , mDisabledSymbolLayers()
76 , mClippingRegions( rh.mClippingRegions )
77 , mFeatureClipGeometry( rh.mFeatureClipGeometry )
78 , mTextureOrigin( rh.mTextureOrigin )
79 , mZRange( rh.mZRange )
80 , mSize( rh.mSize )
81 , mDevicePixelRatio( rh.mDevicePixelRatio )
82 , mImageFormat( rh.mImageFormat )
83 , mRendererUsage( rh.mRendererUsage )
84 , mFrameRate( rh.mFrameRate )
85 , mCurrentFrame( rh.mCurrentFrame )
86 , mSymbolLayerClippingGeometries( rh.mSymbolLayerClippingGeometries )
87 , mMaskRenderSettings( rh.mMaskRenderSettings )
88#ifdef QGISDEBUG
89 , mHasTransformContext( rh.mHasTransformContext )
90#endif
91 , mElevationMap( rh.mElevationMap )
92{
93}
94
96{
97 mFlags = rh.mFlags;
98 mPainter = rh.mPainter;
99 mPreviewRenderPainter = rh.mPreviewRenderPainter;
100 mMaskPainter = rh.mMaskPainter;
101 mCoordTransform = rh.mCoordTransform;
102 mExtent = rh.mExtent;
103 mOriginalMapExtent = rh.mOriginalMapExtent;
104 mMapToPixel = rh.mMapToPixel;
105 mRenderingStopped = rh.mRenderingStopped;
106 mFeedback = rh.mFeedback;
107 mScaleFactor = rh.mScaleFactor;
108 mDpiTarget = rh.mDpiTarget;
109 mRendererScale = rh.mRendererScale;
110 mSymbologyReferenceScale = rh.mSymbologyReferenceScale;
111 mLabelingEngine = rh.mLabelingEngine;
112 mLabelSink = rh.mLabelSink;
113 mSelectionColor = rh.mSelectionColor;
114 mVectorSimplifyMethod = rh.mVectorSimplifyMethod;
115 mExpressionContext = rh.mExpressionContext;
116 mGeometry = rh.mGeometry;
117 mFeatureFilterProvider.reset( rh.mFeatureFilterProvider ? rh.mFeatureFilterProvider->clone() : nullptr );
118 mSegmentationTolerance = rh.mSegmentationTolerance;
119 mSegmentationToleranceType = rh.mSegmentationToleranceType;
120 mDistanceArea = rh.mDistanceArea;
121 mTransformContext = rh.mTransformContext;
122 mPathResolver = rh.mPathResolver;
123 mTextRenderFormat = rh.mTextRenderFormat;
124 mRenderedFeatureHandlers = rh.mRenderedFeatureHandlers;
125 mHasRenderedFeatureHandlers = rh.mHasRenderedFeatureHandlers;
126 mCustomRenderingFlags = rh.mCustomRenderingFlags;
127 mClippingRegions = rh.mClippingRegions;
128 mFeatureClipGeometry = rh.mFeatureClipGeometry;
129 mTextureOrigin = rh.mTextureOrigin;
130 mZRange = rh.mZRange;
131 mSize = rh.mSize;
132 mDevicePixelRatio = rh.mDevicePixelRatio;
133 mImageFormat = rh.mImageFormat;
135 mRendererUsage = rh.mRendererUsage;
136 mFrameRate = rh.mFrameRate;
137 mCurrentFrame = rh.mCurrentFrame;
138 mSymbolLayerClippingGeometries = rh.mSymbolLayerClippingGeometries;
139 mMaskRenderSettings = rh.mMaskRenderSettings;
140 if ( isTemporal() )
142#ifdef QGISDEBUG
143 mHasTransformContext = rh.mHasTransformContext;
144#endif
145 mElevationMap = rh.elevationMap();
146
147 return *this;
148}
149
151{
152 QgsRenderContext context;
153 context.setPainter( painter );
154 if ( painter && painter->device() )
155 {
156 context.setScaleFactor( painter->device()->physicalDpiX() / 25.4 );
157 }
158 else
159 {
160 context.setScaleFactor( 3.465 ); //assume 88 dpi as standard value
161 }
162
163 if ( painter && painter->renderHints() & QPainter::Antialiasing )
165 if ( painter && painter->renderHints() & QPainter::SmoothPixmapTransform )
167 if ( painter && painter->renderHints() & QPainter::LosslessImageRendering )
169
170 return context;
171}
172
174{
175 if ( !painter )
176 painter = mPainter;
177
178 if ( !painter )
179 return;
180
181 painter->setRenderHint( QPainter::Antialiasing, mFlags & Qgis::RenderContextFlag::Antialiasing );
182 painter->setRenderHint( QPainter::LosslessImageRendering, mFlags & Qgis::RenderContextFlag::LosslessImageRendering );
183 painter->setRenderHint( QPainter::SmoothPixmapTransform, mFlags & Qgis::RenderContextFlag::HighQualityImageTransforms );
184}
185
187{
188#ifdef QGISDEBUG
189 if ( !mHasTransformContext )
190 QgsDebugMsgLevel( QStringLiteral( "No QgsCoordinateTransformContext context set for transform" ), 4 );
191#endif
192 return mTransformContext;
193}
194
196{
197 mTransformContext = context;
198#ifdef QGISDEBUG
199 mHasTransformContext = true;
200#endif
201}
202
204{
205 mFeedback = feedback;
206}
207
209{
210 return mFeedback;
211}
212
214{
215 mFlags = flags;
216}
217
219{
220 if ( on )
221 mFlags |= flag;
222 else
223 mFlags &= ~( static_cast< int >( flag ) );
224}
225
227{
228 return mFlags;
229}
230
232{
233 return mFlags.testFlag( flag );
234}
235
237{
239 QgsRectangle extent = mapSettings.visibleExtent();
240 extent.grow( mapSettings.extentBuffer() );
241 ctx.setMapToPixel( mapSettings.mapToPixel() );
242 ctx.setExtent( extent );
243 ctx.setMapExtent( mapSettings.visibleExtent() );
249 ctx.setSelectionColor( mapSettings.selectionColor() );
263 ctx.setScaleFactor( mapSettings.outputDpi() / 25.4 ); // = pixels per mm
264 ctx.setDpiTarget( mapSettings.dpiTarget() >= 0.0 ? mapSettings.dpiTarget() : -1.0 );
265 ctx.setRendererScale( mapSettings.scale() );
266 ctx.setExpressionContext( mapSettings.expressionContext() );
269 ctx.mDistanceArea.setSourceCrs( mapSettings.destinationCrs(), mapSettings.transformContext() );
270 ctx.mDistanceArea.setEllipsoid( mapSettings.ellipsoid() );
271 ctx.setTransformContext( mapSettings.transformContext() );
272 ctx.setPathResolver( mapSettings.pathResolver() );
273 ctx.setTextRenderFormat( mapSettings.textRenderFormat() );
274 ctx.setVectorSimplifyMethod( mapSettings.simplifyMethod() );
275 ctx.mRenderedFeatureHandlers = mapSettings.renderedFeatureHandlers();
276 ctx.mHasRenderedFeatureHandlers = !mapSettings.renderedFeatureHandlers().isEmpty();
277 //this flag is only for stopping during the current rendering progress,
278 //so must be false at every new render operation
279 ctx.setRenderingStopped( false );
280 ctx.mCustomRenderingFlags = mapSettings.customRenderingFlags();
281 ctx.setIsTemporal( mapSettings.isTemporal() );
282 if ( ctx.isTemporal() )
283 ctx.setTemporalRange( mapSettings.temporalRange() );
284
285 ctx.setZRange( mapSettings.zRange() );
286 ctx.setOutputSize( mapSettings.outputSize() );
287 ctx.setDevicePixelRatio( mapSettings.devicePixelRatio() );
288 ctx.setImageFormat( mapSettings.outputImageFormat() );
289
290 ctx.mClippingRegions = mapSettings.clippingRegions();
291
292 ctx.setMaskSettings( mapSettings.maskSettings() );
293
294 ctx.mRendererUsage = mapSettings.rendererUsage();
295 ctx.mFrameRate = mapSettings.frameRate();
296 ctx.mCurrentFrame = mapSettings.currentFrame();
297
298 return ctx;
299}
300
302{
303 return mFlags.testFlag( Qgis::RenderContextFlag::ForceVectorOutput );
304}
305
307{
308 return mFlags.testFlag( Qgis::RenderContextFlag::UseAdvancedEffects );
309}
310
315
317{
318 return mFlags.testFlag( Qgis::RenderContextFlag::DrawEditingInfo );
319}
320
322{
323 return mFlags.testFlag( Qgis::RenderContextFlag::DrawSelection );
324}
325
327{
328 mCoordTransform = t;
329}
330
335
340
345
350
355
357{
358 if ( ffp )
359 {
360 mFeatureFilterProvider.reset( ffp->clone() );
361 }
362 else
363 {
364 mFeatureFilterProvider.reset( nullptr );
365 }
366}
367
369{
370 return mFeatureFilterProvider.get();
371}
372
374{
375 double conversionFactor = 1.0;
376 bool isMapUnitHack = false;
377 switch ( unit )
378 {
380 conversionFactor = mScaleFactor;
381 break;
382
384 conversionFactor = mScaleFactor / POINTS_TO_MM;
385 break;
386
388 conversionFactor = mScaleFactor * INCH_TO_MM;
389 break;
390
392 {
393 if ( mMapToPixel.isValid() )
394 size = convertMetersToMapUnits( size );
396 // Fall through to RenderMapUnits with size in meters converted to size in MapUnits
397 [[fallthrough]];
398 }
400 {
401 if ( mMapToPixel.isValid() )
402 {
403 const double mup = scale.computeMapUnitsPerPixel( *this );
404 if ( mup > 0 )
405 {
406 conversionFactor = 1.0 / mup;
407 }
408 else
409 {
410 conversionFactor = 1.0;
411 }
412 }
413 else
414 {
415 // invalid map to pixel. A size in map units can't be calculated, so treat the size as points
416 // and clamp it to a reasonable range. It's the best we can do in this situation!
417 isMapUnitHack = true;
418 conversionFactor = mScaleFactor / POINTS_TO_MM;
419 }
420 break;
421 }
423 conversionFactor = 1.0;
424 break;
425
428 //no sensible value
429 conversionFactor = 1.0;
430 break;
431 }
432
433 double convertedSize = size * conversionFactor;
434
435 if ( unit == Qgis::RenderUnit::MapUnits )
436 {
437 //check max/min size
438 if ( scale.minSizeMMEnabled )
439 convertedSize = std::max( convertedSize, scale.minSizeMM * mScaleFactor );
440 if ( scale.maxSizeMMEnabled )
441 convertedSize = std::min( convertedSize, scale.maxSizeMM * mScaleFactor );
442 }
443
444 if ( isMapUnitHack )
445 {
446 // since we are arbitrarily treating map units as mm, we need to clamp to an (arbitrary!) reasonable range.
447 convertedSize = std::clamp( convertedSize, 10.0, 100.0 );
448 }
449 else
450 {
451 const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
452 convertedSize *= symbologyReferenceScaleFactor;
453 }
454
456 {
457 // apply property based constraints in order to optimise symbol preview rendering
458 switch ( property )
459 {
461 break;
462
464 // excessively large shadow offset in symbol preview icons is undesirable -- it pushes the shadow outside of view
465 convertedSize = std::min( convertedSize, 100.0 );
466 break;
468 // excessively large blur in symbol preview icons is too slow to calculate
469 convertedSize = std::min<double>( convertedSize, 30 );
470 break;
472 // excessively large glow spread in symbol preview icons is too slow to calculate
473 convertedSize = std::min<double>( convertedSize, 50 );
474 break;
475 }
476 }
477
478 return convertedSize;
479}
480
481double QgsRenderContext::convertToMapUnits( double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale ) const
482{
483 const double mup = mMapToPixel.mapUnitsPerPixel();
484
485 const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
486
487 switch ( unit )
488 {
490 {
491 size = convertMetersToMapUnits( size );
492 // Fall through to RenderMapUnits with values of meters converted to MapUnits
493 [[fallthrough]];
494 }
496 {
497 // check scale
498 double minSizeMU = std::numeric_limits<double>::lowest();
499 if ( scale.minSizeMMEnabled )
500 {
501 minSizeMU = scale.minSizeMM * mScaleFactor * mup;
502 }
503 if ( !qgsDoubleNear( scale.minScale, 0.0 ) )
504 {
505 minSizeMU = std::max( minSizeMU, size * ( mRendererScale / scale.minScale ) );
506 }
507 size = std::max( size, minSizeMU );
508
509 double maxSizeMU = std::numeric_limits<double>::max();
510 if ( scale.maxSizeMMEnabled )
511 {
512 maxSizeMU = scale.maxSizeMM * mScaleFactor * mup;
513 }
514 if ( !qgsDoubleNear( scale.maxScale, 0.0 ) )
515 {
516 maxSizeMU = std::min( maxSizeMU, size * ( mRendererScale / scale.maxScale ) );
517 }
518 size = std::min( size, maxSizeMU );
519
520 return size;
521 }
523 {
524 return size * mScaleFactor * mup / symbologyReferenceScaleFactor;
525 }
527 {
528 return size * mScaleFactor * mup / POINTS_TO_MM / symbologyReferenceScaleFactor;
529 }
531 {
532 return size * mScaleFactor * mup * INCH_TO_MM / symbologyReferenceScaleFactor;
533 }
535 {
536 return size * mup / symbologyReferenceScaleFactor;
537 }
538
541 //no sensible value
542 return 0.0;
543 }
544 return 0.0;
545}
546
547double QgsRenderContext::convertFromMapUnits( double sizeInMapUnits, Qgis::RenderUnit outputUnit ) const
548{
549 const double mup = mMapToPixel.mapUnitsPerPixel();
550 const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
551
552 switch ( outputUnit )
553 {
555 {
556 return sizeInMapUnits / convertMetersToMapUnits( 1.0 );
557 }
559 {
560 return sizeInMapUnits;
561 }
563 {
564 return sizeInMapUnits / ( mScaleFactor * mup ) * symbologyReferenceScaleFactor;
565 }
567 {
568 return sizeInMapUnits / ( mScaleFactor * mup / POINTS_TO_MM ) * symbologyReferenceScaleFactor;
569 }
571 {
572 return sizeInMapUnits / ( mScaleFactor * mup * INCH_TO_MM ) * symbologyReferenceScaleFactor;
573 }
575 {
576 return sizeInMapUnits / mup * symbologyReferenceScaleFactor;
577 }
578
581 //no sensible value
582 return 0.0;
583 }
584 return 0.0;
585}
586
587double QgsRenderContext::convertMetersToMapUnits( double meters ) const
588{
589 switch ( mDistanceArea.sourceCrs().mapUnits() )
590 {
592 return meters;
594 {
595 if ( mExtent.isNull() )
596 {
597 // we don't have an extent to calculate exactly -- so just use a very rough approximation
599 }
600
601 QgsPointXY pointCenter = mExtent.center();
602 // The Extent is in the sourceCrs(), when different from destinationCrs()
603 // - the point must be transformed, since DistanceArea uses the destinationCrs()
604 // Note: the default QgsCoordinateTransform() : authid() will return an empty String
605 if ( !mCoordTransform.isShortCircuited() )
606 {
607 try
608 {
609 pointCenter = mCoordTransform.transform( pointCenter );
610 }
611 catch ( const QgsCsException & )
612 {
613 QgsDebugError( QStringLiteral( "QgsRenderContext::convertMetersToMapUnits(): failed to reproject pointCenter" ) );
614 // what should we return;.. ?
615 return meters;
616 }
617 }
618
619 const int multiplier = meters < 0 ? -1 : 1;
620 return multiplier * mDistanceArea.measureLineProjected( pointCenter, std::fabs( meters ) );
621 }
632 }
633 return meters;
634}
635
636QList<QgsRenderedFeatureHandlerInterface *> QgsRenderContext::renderedFeatureHandlers() const
637{
638 return mRenderedFeatureHandlers;
639}
640
641QList<QgsMapClippingRegion> QgsRenderContext::clippingRegions() const
642{
643 return mClippingRegions;
644}
645
647{
648 return mFeatureClipGeometry;
649}
650
652{
653 mFeatureClipGeometry = geometry;
654}
655
657{
658 return mTextureOrigin;
659}
660
661void QgsRenderContext::setTextureOrigin( const QPointF &origin )
662{
663 mTextureOrigin = origin;
664}
665
667{
668 mMaskRenderSettings = settings;
669}
670
672{
673 return mZRange;
674}
675
677{
678 mZRange = range;
679}
680
682{
683 return mSize;
684}
685
687{
688 mSize = size;
689}
690
692{
693 return mDevicePixelRatio;
694}
695
697{
698 mDevicePixelRatio = ratio;
699}
700
702{
703 return outputSize() * mDevicePixelRatio;
704}
705
707{
708 return mFrameRate;
709}
710
712{
713 mFrameRate = rate;
714}
715
717{
718 return mCurrentFrame;
719}
720
722{
723 mCurrentFrame = frame;
724}
725
727{
728 return mElevationMap;
729}
730
732{
733 mElevationMap = map;
734}
735
736void QgsRenderContext::addSymbolLayerClipPath( const QString &symbolLayerId, QPainterPath path )
737{
739 if ( !geometry.isEmpty() )
740 addSymbolLayerClipGeometry( symbolLayerId, geometry );
741}
742
743QList<QPainterPath> QgsRenderContext::symbolLayerClipPaths( const QString &symbolLayerId ) const
744{
745 const QVector<QgsGeometry> geometries = symbolLayerClipGeometries( symbolLayerId );
746 QList<QPainterPath> res;
747 res.reserve( geometries.size() );
748 for ( const QgsGeometry &geometry : geometries )
749 {
750 res << geometry.constGet()->asQPainterPath();
751 }
752 return res;
753}
754
755void QgsRenderContext::addSymbolLayerClipGeometry( const QString &symbolLayerId, const QgsGeometry &geometry )
756{
757 if ( geometry.isMultipart() )
758 {
759 mSymbolLayerClippingGeometries[ symbolLayerId ].append( geometry.asGeometryCollection() );
760 }
761 else
762 {
763 mSymbolLayerClippingGeometries[ symbolLayerId ].append( geometry );
764 }
765}
766
767bool QgsRenderContext::symbolLayerHasClipGeometries( const QString &symbolLayerId ) const
768{
769 auto it = mSymbolLayerClippingGeometries.constFind( symbolLayerId );
770 if ( it == mSymbolLayerClippingGeometries.constEnd() )
771 return false;
772 return !it.value().isEmpty();
773}
774
775QVector<QgsGeometry> QgsRenderContext::symbolLayerClipGeometries( const QString &symbolLayerId ) const
776{
777 return mSymbolLayerClippingGeometries[ symbolLayerId ];
778}
779
780void QgsRenderContext::setDisabledSymbolLayers( const QSet<const QgsSymbolLayer *> &symbolLayers )
781{
782 mDisabledSymbolLayers.clear();
783 for ( const QgsSymbolLayer *symbolLayer : symbolLayers )
784 mDisabledSymbolLayers << symbolLayer->id();
785}
786
787void QgsRenderContext::setDisabledSymbolLayersV2( const QSet<QString> &symbolLayers )
788{
789 mDisabledSymbolLayers = symbolLayers;
790}
791
792QSet<const QgsSymbolLayer *> QgsRenderContext::disabledSymbolLayers() const
793{
794 return QSet<const QgsSymbolLayer *>();
795}
796
798{
799 return mDisabledSymbolLayers;
800}
801
803{
804 return !mDisabledSymbolLayers.contains( layer->id() );
805}
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
RenderSubcomponentProperty
Rendering subcomponent properties.
Definition qgis.h:2606
@ Generic
Generic subcomponent property.
@ NoSimplification
No simplification can be applied.
@ Feet
Imperial feet.
@ Centimeters
Centimeters.
@ Millimeters
Millimeters.
@ Miles
Terrestrial miles.
@ Unknown
Unknown distance unit.
@ Yards
Imperial yards.
@ Degrees
Degrees, for planar geographic CRS distance measurements.
@ Inches
Inches (since QGIS 3.32)
@ NauticalMiles
Nautical miles.
@ Kilometers
Kilometers.
QFlags< RenderContextFlag > RenderContextFlags
Render context flags.
Definition qgis.h:2377
RenderUnit
Rendering size units.
Definition qgis.h:4494
@ Percentage
Percentage of another measurement (e.g., canvas size, feature size)
@ Millimeters
Millimeters.
@ Points
Points (e.g., for font sizes)
@ Unknown
Mixed or unknown units.
@ MapUnits
Map units.
@ MetersInMapUnits
Meters value as Map units.
RenderContextFlag
Flags which affect rendering operations.
Definition qgis.h:2353
@ DrawEditingInfo
Enable drawing of vertex markers for layers in editing mode.
@ RenderSymbolPreview
The render is for a symbol preview only and map based properties may not be available,...
@ DrawSymbolBounds
Draw bounds of symbols (for debugging/testing)
@ RenderPreviewJob
Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering.
@ RenderMapTile
Draw map such that there are no problems between adjacent tiles.
@ RecordProfile
Enable run-time profiling while rendering (since QGIS 3.34)
@ UseRenderingOptimization
Enable vector simplification and other rendering optimizations.
@ ForceVectorOutput
Vector graphics should not be cached and drawn as raster images.
@ RenderPartialOutput
Whether to make extra effort to update map image with partially rendered layers (better for interacti...
@ LosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ AlwaysUseGlobalMasks
When applying clipping paths for selective masking, always use global ("entire map") paths,...
@ DrawSelection
Whether vector selections should be shown in the rendered map.
@ Antialiasing
Use antialiasing while drawing.
@ SkipSymbolRendering
Disable symbol rendering while still drawing labels if enabled (since QGIS 3.24)
@ Render3DMap
Render is for a 3D map.
@ UseAdvancedEffects
Enable layer opacity and blending effects.
@ HighQualityImageTransforms
Enable high quality image transformations, which results in better appearance of scaled or rotated ra...
@ RenderBlocking
Render and load remote sources in the same thread to ensure rendering remote sources (svg and images)...
@ DrawEditingInfo
Enable drawing of vertex markers for layers in editing mode.
@ DrawSymbolBounds
Draw bounds of symbols (for debugging/testing)
@ RenderPreviewJob
Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering.
@ RenderMapTile
Draw map such that there are no problems between adjacent tiles.
@ RecordProfile
Enable run-time profiling while rendering (since QGIS 3.34)
@ UseRenderingOptimization
Enable vector simplification and other rendering optimizations.
@ ForceVectorOutput
Vector graphics should not be cached and drawn as raster images.
@ RenderPartialOutput
Whether to make extra effort to update map image with partially rendered layers (better for interacti...
@ LosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ AlwaysUseGlobalMasks
When applying clipping paths for selective masking, always use global ("entire map") paths,...
@ DrawSelection
Whether vector selections should be shown in the rendered map.
@ Antialiasing
Enable anti-aliasing for map rendering.
@ SkipSymbolRendering
Disable symbol rendering while still drawing labels if enabled (since QGIS 3.24)
@ Render3DMap
Render is for a 3D map.
@ UseAdvancedEffects
Enable layer opacity and blending effects.
@ HighQualityImageTransforms
Enable high quality image transformations, which results in better appearance of scaled or rotated ra...
@ RenderBlocking
Render and load remote sources in the same thread to ensure rendering remote sources (svg and images)...
virtual bool isEmpty() const
Returns true if the geometry is empty.
virtual QPainterPath asQPainterPath() const =0
Returns the geometry represented as a QPainterPath.
QString ellipsoidAcronym() const
Returns the ellipsoid acronym for the ellipsoid used by the CRS.
Contains information about the context in which a coordinate transform is executed.
Class for doing transforms between two map coordinate systems.
QgsPointXY transform(const QgsPointXY &point, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward) const
Transform the point from the source CRS to the destination CRS.
bool isShortCircuited() const
Returns true if the transform short circuits because the source and destination are equivalent.
Custom exception class for Coordinate Reference System related exceptions.
QgsCoordinateReferenceSystem sourceCrs() const
Returns the source spatial reference system.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
double measureLineProjected(const QgsPointXY &p1, double distance=1, double azimuth=M_PI_2, QgsPointXY *projectedPoint=nullptr) const
Calculates the distance from one point with distance in meters and azimuth (direction) When the sourc...
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
QgsRange which stores a range of double values.
Definition qgsrange.h:231
Stores digital elevation model in a raster image which may get updated as a part of map layer renderi...
Abstract interface for use by classes that filter the features or attributes of a layer.
virtual QgsFeatureFilterProvider * clone() const =0
Create a clone of the feature filter provider.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
static QgsGeometry painterPathToGeometry(const QPainterPath &path)
Converts a painter path to a QgsGeometry.
A geometry is the spatial representation of a feature.
The QgsMapSettings class contains configuration for rendering of the map.
Qgis::RendererUsage rendererUsage() const
Returns the rendering usage.
double scale() const
Returns the calculated map scale.
double segmentationTolerance() const
Gets the segmentation tolerance applied when rendering curved geometries.
QgsDoubleRange zRange() const
Returns the range of z-values which will be visible in the map.
const QgsVectorSimplifyMethod & simplifyMethod() const
Returns the simplification settings to use when rendering vector layers.
QList< QgsRenderedFeatureHandlerInterface * > renderedFeatureHandlers() const
Returns the list of rendered feature handlers to use while rendering the map settings.
double dpiTarget() const
Returns the target DPI (dots per inch) to be taken into consideration when rendering.
long long currentFrame() const
Returns the current frame number of the map, for maps which are part of an animation.
const QgsMapToPixel & mapToPixel() const
float devicePixelRatio() const
Returns the device pixel ratio.
QSize outputSize() const
Returns the size of the resulting map image, in pixels.
QImage::Format outputImageFormat() const
format of internal QImage, default QImage::Format_ARGB32_Premultiplied
double extentBuffer() const
Returns the buffer in map units to use around the visible extent for rendering symbols whose correspo...
double frameRate() const
Returns the frame rate of the map (in frames per second), for maps which are part of an animation.
QColor selectionColor() const
Returns the color that is used for drawing of selected vector features.
QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const
Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
QgsRectangle visibleExtent() const
Returns the actual extent derived from requested extent that takes output image size into account.
QVariantMap customRenderingFlags() const
Returns any custom rendering flags.
QString ellipsoid() const
Returns ellipsoid's acronym.
Qgis::TextRenderFormat textRenderFormat() const
Returns the text render format, which dictates how text is rendered (e.g.
double outputDpi() const
Returns the DPI (dots per inch) used for conversion between real world units (e.g.
bool testFlag(Qgis::MapSettingsFlag flag) const
Check whether a particular flag is enabled.
QList< QgsMapClippingRegion > clippingRegions() const
Returns the list of clipping regions to apply to the map.
const QgsPathResolver & pathResolver() const
Returns the path resolver for conversion between relative and absolute paths during rendering operati...
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
const QgsExpressionContext & expressionContext() const
Gets the expression context.
const QgsMaskRenderSettings & maskSettings() const
Returns a reference to the mask render settings, which control how masks are drawn and behave during ...
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
bool isValid() const
Returns true if the object is valid (i.e.
double mapUnitsPerPixel() const
Returns the current map units per pixel.
Struct for storing maximum and minimum scales for measurements in map units.
double computeMapUnitsPerPixel(const QgsRenderContext &c) const
Computes a map units per pixel scaling factor, respecting the minimum and maximum scales set for the ...
bool minSizeMMEnabled
Whether the minimum size in mm should be respected.
double maxScale
The maximum scale, or 0.0 if unset.
double minScale
The minimum scale, or 0.0 if unset.
double maxSizeMM
The maximum size in millimeters, or 0.0 if unset.
bool maxSizeMMEnabled
Whether the maximum size in mm should be respected.
double minSizeMM
The minimum size in millimeters, or 0.0 if unset.
Contains settings regarding how masks are calculated and handled during a map render.
A class to represent a 2D point.
Definition qgspointxy.h:60
A rectangle specified with double values.
bool isNull() const
Test if the rectangle is null (holding no spatial information).
QgsPointXY center() const
Returns the center point of the rectangle.
void grow(double delta)
Grows the rectangle in place by the specified amount.
Contains information about the context of a rendering operation.
void setForceVectorOutput(bool force)
Sets whether rendering operations should use vector operations instead of any faster raster shortcuts...
void setMapExtent(const QgsRectangle &extent)
Sets the original extent of the map being rendered.
void setTextureOrigin(const QPointF &origin)
Sets the texture origin, which should be used as a brush transform when rendering using QBrush object...
bool symbolLayerHasClipGeometries(const QString &symbolLayerId) const
Returns true if the symbol layer with matching ID has any associated clip geometries.
void setRenderingStopped(bool stopped)
Sets whether the rendering operation has been stopped and any ongoing rendering should be canceled im...
void setCoordinateTransform(const QgsCoordinateTransform &t)
Sets the current coordinate transform for the context.
double convertToMapUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to map units.
void setShowSelection(bool showSelection)
Sets whether vector selections should be shown in the rendered map.
void setDrawEditingInformation(bool b)
Sets whether edit markers should be drawn during the render operation.
bool useAdvancedEffects() const
Returns true if advanced effects such as blend modes such be used.
void setScaleFactor(double factor)
Sets the scaling factor for the render to convert painter units to physical sizes.
void setImageFormat(QImage::Format format)
Sets QImage format which should be used for QImages created during rendering.
void setSegmentationToleranceType(QgsAbstractGeometry::SegmentationToleranceType type)
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
QSet< QString > disabledSymbolLayersV2() const
When rendering a map layer in a second pass (for selective masking), some symbol layers may be disabl...
void setDevicePixelRatio(float ratio)
Sets the device pixel ratio.
void setUseAdvancedEffects(bool enabled)
Used to enable or disable advanced effects such as blend modes.
void setCurrentFrame(long long frame)
Sets the current frame of the map, for maps which are part of an animation.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QPainter * painter()
Returns the destination QPainter for the render operation.
void setMaskSettings(const QgsMaskRenderSettings &settings)
Sets the mask render settings, which control how masks are drawn and behave during render operations.
void setPainterFlagsUsingContext(QPainter *painter=nullptr) const
Sets relevant flags on a destination painter, using the flags and settings currently defined for the ...
void setTextRenderFormat(Qgis::TextRenderFormat format)
Sets the text render format, which dictates how text is rendered (e.g.
void setVectorSimplifyMethod(const QgsVectorSimplifyMethod &simplifyMethod)
Sets the simplification setting to use when rendering vector layers.
double convertFromMapUnits(double sizeInMapUnits, Qgis::RenderUnit outputUnit) const
Converts a size from map units to the specified units.
QgsCoordinateTransformContext transformContext() const
Returns the context's coordinate transform context, which stores various information regarding which ...
QSize outputSize() const
Returns the size of the resulting rendered image, in pixels.
QgsGeometry featureClipGeometry() const
Returns the geometry to use to clip features at render time.
QgsElevationMap * elevationMap() const
Returns the destination elevation map for the render operation.
const QgsRectangle & extent() const
When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the l...
bool testFlag(Qgis::RenderContextFlag flag) const
Check whether a particular flag is enabled.
bool forceVectorOutput() const
Returns true if rendering operations should use vector operations instead of any faster raster shortc...
Q_DECL_DEPRECATED void setDisabledSymbolLayers(const QSet< const QgsSymbolLayer * > &symbolLayers)
When rendering a map layer in a second pass (for selective masking), some symbol layers may be disabl...
long long currentFrame() const
Returns the current frame number of the map (in frames per second), for maps which are part of an ani...
void setDpiTarget(double dpi)
Sets the targeted dpi for rendering.
~QgsRenderContext() override
void setPathResolver(const QgsPathResolver &resolver)
Sets the path resolver for conversion between relative and absolute paths during rendering operations...
float devicePixelRatio() const
Returns the device pixel ratio.
void setFeedback(QgsFeedback *feedback)
Attach a feedback object that can be queried regularly during rendering to check if rendering should ...
Q_DECL_DEPRECATED void addSymbolLayerClipPath(const QString &symbolLayerId, QPainterPath path)
Add a clip path to be applied to the symbolLayer before rendering.
void setFeatureClipGeometry(const QgsGeometry &geometry)
Sets a geometry to use to clip features at render time.
void setDisabledSymbolLayersV2(const QSet< QString > &symbolLayers)
When rendering a map layer in a second pass (for selective masking), some symbol layers may be disabl...
const QgsFeatureFilterProvider * featureFilterProvider() const
Gets the filter feature provider used for additional filtering of rendered features.
QList< QgsRenderedFeatureHandlerInterface * > renderedFeatureHandlers() const
Returns the list of rendered feature handlers to use while rendering map layers.
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
double frameRate() const
Returns the frame rate of the map, for maps which are part of an animation.
bool showSelection() const
Returns true if vector selections should be shown in the rendered map.
QList< QgsMapClippingRegion > clippingRegions() const
Returns the list of clipping regions to apply during the render.
void setFrameRate(double rate)
Sets the frame rate of the map (in frames per second), for maps which are part of an animation.
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the context's coordinate transform context, which stores various information regarding which dat...
void setFlags(Qgis::RenderContextFlags flags)
Set combination of flags that will be used for rendering.
void setExtent(const QgsRectangle &extent)
When rendering a map layer, calling this method sets the "clipping" extent for the layer (in the laye...
void setMapToPixel(const QgsMapToPixel &mtp)
Sets the context's map to pixel transform, which transforms between map coordinates and device coordi...
Q_DECL_DEPRECATED QSet< const QgsSymbolLayer * > disabledSymbolLayers() const
When rendering a map layer in a second pass (for selective masking), some symbol layers may be disabl...
void setOutputSize(QSize size)
Sets the size of the resulting rendered image, in pixels.
QgsFeedback * feedback() const
Returns the feedback object that can be queried regularly during rendering to check if rendering shou...
QPointF textureOrigin() const
Returns the texture origin, which should be used as a brush transform when rendering using QBrush obj...
void setPainter(QPainter *p)
Sets the destination QPainter for the render operation.
QgsDoubleRange zRange() const
Returns the range of z-values which should be rendered.
bool isSymbolLayerEnabled(const QgsSymbolLayer *layer) const
When rendering a map layer in a second pass (for selective masking), some symbol layers may be disabl...
QSize deviceOutputSize() const
Returns the device output size of the render.
QVector< QgsGeometry > symbolLayerClipGeometries(const QString &symbolLayerId) const
Returns clipping geometries to be applied to the symbolLayer before rendering.
static QgsRenderContext fromMapSettings(const QgsMapSettings &mapSettings)
create initialized QgsRenderContext instance from given QgsMapSettings
bool drawEditingInformation() const
Returns true if edit markers should be drawn during the render operation.
static QgsRenderContext fromQPainter(QPainter *painter)
Creates a default render context given a pixel based QPainter destination.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
void setUseRenderingOptimization(bool enabled)
Sets whether the rendering optimization (geometry simplification) should be executed.
void setRendererScale(double scale)
Sets the renderer map scale.
void setZRange(const QgsDoubleRange &range)
Sets the range of z-values which should be rendered.
double convertMetersToMapUnits(double meters) const
Convert meter distances to active MapUnit values for QgsUnitTypes::RenderMetersInMapUnits.
void addSymbolLayerClipGeometry(const QString &symbolLayerId, const QgsGeometry &geometry)
Add a clip geometry to be applied to the symbolLayer before rendering.
Qgis::RenderContextFlags flags() const
Returns combination of flags used for rendering.
Q_DECL_DEPRECATED QList< QPainterPath > symbolLayerClipPaths(const QString &symbolLayerId) const
Returns clip paths to be applied to the symbolLayer before rendering.
const QgsAbstractGeometry * geometry() const
Returns pointer to the unsegmentized geometry.
void setElevationMap(QgsElevationMap *map)
Sets the destination elevation map for the render operation.
QgsRenderContext & operator=(const QgsRenderContext &rh)
bool useRenderingOptimization() const
Returns true if the rendering optimization (geometry simplification) can be executed.
void setSelectionColor(const QColor &color)
Sets the color to use when rendering selected features.
void setSegmentationTolerance(double tolerance)
Sets the segmentation tolerance applied when rendering curved geometries.
void setFeatureFilterProvider(const QgsFeatureFilterProvider *ffp)
Set a filter feature provider used for additional filtering of rendered features.
QString id() const
Returns symbol layer identifier This id is unique in the whole project.
Base class for objects with an associated (optional) temporal range.
const QgsDateTimeRange & temporalRange() const
Returns the datetime range for the object.
bool isTemporal() const
Returns true if the object's temporal range is enabled, and the object will be filtered when renderin...
void setIsTemporal(bool enabled)
Sets whether the temporal range is enabled (i.e.
void setTemporalRange(const QgsDateTimeRange &range)
Sets the temporal range for the object.
static Q_INVOKABLE double fromUnitToUnitFactor(Qgis::DistanceUnit fromUnit, Qgis::DistanceUnit toUnit)
Returns the conversion factor between the specified distance units.
void setSimplifyHints(Qgis::VectorRenderingSimplificationFlags simplifyHints)
Sets the simplification hints of the vector layer managed.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition qgis.h:5465
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:39
#define QgsDebugError(str)
Definition qgslogger.h:38
#define INCH_TO_MM
#define POINTS_TO_MM