QGIS API Documentation  3.23.0-Master (7c4a6de034)
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"
22 #include "qgsexpression.h"
23 #include "qgsvectorlayer.h"
25 #include "qgslogger.h"
26 #include "qgspoint.h"
27 
28 #define POINTS_TO_MM 2.83464567
29 #define INCH_TO_MM 25.4
30 
32  : mFlags( Qgis::RenderContextFlag::DrawEditingInfo | Qgis::RenderContextFlag::UseAdvancedEffects | Qgis::RenderContextFlag::DrawSelection | Qgis::RenderContextFlag::UseRenderingOptimization )
33 {
35  // For RenderMetersInMapUnits support, when rendering in Degrees, the Ellipsoid must be set
36  // - for Previews/Icons the default Extent can be used
37  mDistanceArea.setEllipsoid( mDistanceArea.sourceCrs().ellipsoidAcronym() );
38 }
39 
41 
44  , mFlags( rh.mFlags )
45  , mPainter( rh.mPainter )
46  , mMaskPainter( rh.mMaskPainter )
47  , mCoordTransform( rh.mCoordTransform )
48  , mDistanceArea( rh.mDistanceArea )
49  , mExtent( rh.mExtent )
50  , mOriginalMapExtent( rh.mOriginalMapExtent )
51  , mMapToPixel( rh.mMapToPixel )
52  , mRenderingStopped( rh.mRenderingStopped )
53  , mFeedback( rh.mFeedback )
54  , mScaleFactor( rh.mScaleFactor )
55  , mDpiTarget( rh.mDpiTarget )
56  , mRendererScale( rh.mRendererScale )
57  , mSymbologyReferenceScale( rh.mSymbologyReferenceScale )
58  , mLabelingEngine( rh.mLabelingEngine )
59  , mLabelSink( rh.mLabelSink )
60  , mSelectionColor( rh.mSelectionColor )
61  , mVectorSimplifyMethod( rh.mVectorSimplifyMethod )
62  , mExpressionContext( rh.mExpressionContext )
63  , mGeometry( rh.mGeometry )
64  , mFeatureFilterProvider( rh.mFeatureFilterProvider ? rh.mFeatureFilterProvider->clone() : nullptr )
65  , mSegmentationTolerance( rh.mSegmentationTolerance )
66  , mSegmentationToleranceType( rh.mSegmentationToleranceType )
67  , mTransformContext( rh.mTransformContext )
68  , mPathResolver( rh.mPathResolver )
69  , mTextRenderFormat( rh.mTextRenderFormat )
70  , mRenderedFeatureHandlers( rh.mRenderedFeatureHandlers )
71  , mHasRenderedFeatureHandlers( rh.mHasRenderedFeatureHandlers )
72  , mCustomRenderingFlags( rh.mCustomRenderingFlags )
73  , mDisabledSymbolLayers()
74  , mClippingRegions( rh.mClippingRegions )
75  , mFeatureClipGeometry( rh.mFeatureClipGeometry )
76  , mTextureOrigin( rh.mTextureOrigin )
77  , mZRange( rh.mZRange )
78  , mSize( rh.mSize )
79  , mDevicePixelRatio( rh.mDevicePixelRatio )
80  , mImageFormat( rh.mImageFormat )
81  , mRendererUsage( rh.mRendererUsage )
82 #ifdef QGISDEBUG
83  , mHasTransformContext( rh.mHasTransformContext )
84 #endif
85 {
86 }
87 
89 {
90  mFlags = rh.mFlags;
91  mPainter = rh.mPainter;
92  mMaskPainter = rh.mMaskPainter;
93  mCoordTransform = rh.mCoordTransform;
94  mExtent = rh.mExtent;
95  mOriginalMapExtent = rh.mOriginalMapExtent;
96  mMapToPixel = rh.mMapToPixel;
97  mRenderingStopped = rh.mRenderingStopped;
98  mFeedback = rh.mFeedback;
99  mScaleFactor = rh.mScaleFactor;
100  mDpiTarget = rh.mDpiTarget;
101  mRendererScale = rh.mRendererScale;
102  mSymbologyReferenceScale = rh.mSymbologyReferenceScale;
103  mLabelingEngine = rh.mLabelingEngine;
104  mLabelSink = rh.mLabelSink;
105  mSelectionColor = rh.mSelectionColor;
106  mVectorSimplifyMethod = rh.mVectorSimplifyMethod;
107  mExpressionContext = rh.mExpressionContext;
108  mGeometry = rh.mGeometry;
109  mFeatureFilterProvider.reset( rh.mFeatureFilterProvider ? rh.mFeatureFilterProvider->clone() : nullptr );
110  mSegmentationTolerance = rh.mSegmentationTolerance;
111  mSegmentationToleranceType = rh.mSegmentationToleranceType;
112  mDistanceArea = rh.mDistanceArea;
113  mTransformContext = rh.mTransformContext;
114  mPathResolver = rh.mPathResolver;
115  mTextRenderFormat = rh.mTextRenderFormat;
116  mRenderedFeatureHandlers = rh.mRenderedFeatureHandlers;
117  mHasRenderedFeatureHandlers = rh.mHasRenderedFeatureHandlers;
118  mCustomRenderingFlags = rh.mCustomRenderingFlags;
119  mClippingRegions = rh.mClippingRegions;
120  mFeatureClipGeometry = rh.mFeatureClipGeometry;
121  mTextureOrigin = rh.mTextureOrigin;
122  mZRange = rh.mZRange;
123  mSize = rh.mSize;
124  mDevicePixelRatio = rh.mDevicePixelRatio;
125  mImageFormat = rh.mImageFormat;
126  setIsTemporal( rh.isTemporal() );
127  mRendererUsage = rh.mRendererUsage;
128  if ( isTemporal() )
130 #ifdef QGISDEBUG
131  mHasTransformContext = rh.mHasTransformContext;
132 #endif
133 
134  return *this;
135 }
136 
138 {
139  QgsRenderContext context;
140  context.setPainter( painter );
141  if ( painter && painter->device() )
142  {
143  context.setScaleFactor( painter->device()->logicalDpiX() / 25.4 );
144  }
145  else
146  {
147  context.setScaleFactor( 3.465 ); //assume 88 dpi as standard value
148  }
149 
150  if ( painter && painter->renderHints() & QPainter::Antialiasing )
152  if ( painter && painter->renderHints() & QPainter::SmoothPixmapTransform )
154 
155 #if QT_VERSION >= QT_VERSION_CHECK(5, 13, 0)
156  if ( painter && painter->renderHints() & QPainter::LosslessImageRendering )
158 #endif
159 
160  return context;
161 }
162 
163 void QgsRenderContext::setPainterFlagsUsingContext( QPainter *painter ) const
164 {
165  if ( !painter )
166  painter = mPainter;
167 
168  if ( !painter )
169  return;
170 
171  painter->setRenderHint( QPainter::Antialiasing, mFlags & Qgis::RenderContextFlag::Antialiasing );
172 #if QT_VERSION >= QT_VERSION_CHECK(5, 13, 0)
173  painter->setRenderHint( QPainter::LosslessImageRendering, mFlags & Qgis::RenderContextFlag::LosslessImageRendering );
174 #endif
175  painter->setRenderHint( QPainter::SmoothPixmapTransform, mFlags & Qgis::RenderContextFlag::HighQualityImageTransforms );
176 }
177 
179 {
180 #ifdef QGISDEBUG
181  if ( !mHasTransformContext )
182  QgsDebugMsgLevel( QStringLiteral( "No QgsCoordinateTransformContext context set for transform" ), 4 );
183 #endif
184  return mTransformContext;
185 }
186 
188 {
189  mTransformContext = context;
190 #ifdef QGISDEBUG
191  mHasTransformContext = true;
192 #endif
193 }
194 
196 {
197  mFeedback = feedback;
198 }
199 
201 {
202  return mFeedback;
203 }
204 
205 void QgsRenderContext::setFlags( Qgis::RenderContextFlags flags )
206 {
207  mFlags = flags;
208 }
209 
211 {
212  if ( on )
213  mFlags |= flag;
214  else
215  mFlags &= ~( static_cast< int >( flag ) );
216 }
217 
218 Qgis::RenderContextFlags QgsRenderContext::flags() const
219 {
220  return mFlags;
221 }
222 
224 {
225  return mFlags.testFlag( flag );
226 }
227 
229 {
230  QgsRenderContext ctx;
231  QgsRectangle extent = mapSettings.visibleExtent();
232  extent.grow( mapSettings.extentBuffer() );
233  ctx.setMapToPixel( mapSettings.mapToPixel() );
234  ctx.setExtent( extent );
235  ctx.setMapExtent( mapSettings.visibleExtent() );
241  ctx.setSelectionColor( mapSettings.selectionColor() );
253  ctx.setScaleFactor( mapSettings.outputDpi() / 25.4 ); // = pixels per mm
254  ctx.setDpiTarget( mapSettings.dpiTarget() >= 0.0 ? mapSettings.dpiTarget() : -1.0 );
255  ctx.setRendererScale( mapSettings.scale() );
256  ctx.setExpressionContext( mapSettings.expressionContext() );
257  ctx.setSegmentationTolerance( mapSettings.segmentationTolerance() );
259  ctx.mDistanceArea.setSourceCrs( mapSettings.destinationCrs(), mapSettings.transformContext() );
260  ctx.mDistanceArea.setEllipsoid( mapSettings.ellipsoid() );
261  ctx.setTransformContext( mapSettings.transformContext() );
262  ctx.setPathResolver( mapSettings.pathResolver() );
263  ctx.setTextRenderFormat( mapSettings.textRenderFormat() );
264  ctx.setVectorSimplifyMethod( mapSettings.simplifyMethod() );
265  ctx.mRenderedFeatureHandlers = mapSettings.renderedFeatureHandlers();
266  ctx.mHasRenderedFeatureHandlers = !mapSettings.renderedFeatureHandlers().isEmpty();
267  //this flag is only for stopping during the current rendering progress,
268  //so must be false at every new render operation
269  ctx.setRenderingStopped( false );
270  ctx.mCustomRenderingFlags = mapSettings.customRenderingFlags();
271  ctx.setIsTemporal( mapSettings.isTemporal() );
272  if ( ctx.isTemporal() )
273  ctx.setTemporalRange( mapSettings.temporalRange() );
274 
275  ctx.setZRange( mapSettings.zRange() );
276  ctx.setOutputSize( mapSettings.outputSize() );
277  ctx.setDevicePixelRatio( mapSettings.devicePixelRatio() );
278  ctx.setImageFormat( mapSettings.outputImageFormat() );
279 
280  ctx.mClippingRegions = mapSettings.clippingRegions();
281 
282  ctx.mRendererUsage = mapSettings.rendererUsage();
283 
284  return ctx;
285 }
286 
288 {
289  return mFlags.testFlag( Qgis::RenderContextFlag::ForceVectorOutput );
290 }
291 
293 {
294  return mFlags.testFlag( Qgis::RenderContextFlag::UseAdvancedEffects );
295 }
296 
298 {
300 }
301 
303 {
304  return mFlags.testFlag( Qgis::RenderContextFlag::DrawEditingInfo );
305 }
306 
308 {
309  return mFlags.testFlag( Qgis::RenderContextFlag::DrawSelection );
310 }
311 
313 {
314  mCoordTransform = t;
315 }
316 
318 {
320 }
321 
323 {
325 }
326 
327 void QgsRenderContext::setShowSelection( const bool showSelection )
328 {
330 }
331 
333 {
334  return mFlags.testFlag( Qgis::RenderContextFlag::UseRenderingOptimization );
335 }
336 
338 {
340 }
341 
343 {
344  if ( ffp )
345  {
346  mFeatureFilterProvider.reset( ffp->clone() );
347  }
348  else
349  {
350  mFeatureFilterProvider.reset( nullptr );
351  }
352 }
353 
355 {
356  return mFeatureFilterProvider.get();
357 }
358 
360 {
361  double conversionFactor = 1.0;
362  bool isMapUnitHack = false;
363  switch ( unit )
364  {
366  conversionFactor = mScaleFactor;
367  break;
368 
370  conversionFactor = mScaleFactor / POINTS_TO_MM;
371  break;
372 
374  conversionFactor = mScaleFactor * INCH_TO_MM;
375  break;
376 
378  {
379  if ( mMapToPixel.isValid() )
380  size = convertMetersToMapUnits( size );
382  // Fall through to RenderMapUnits with size in meters converted to size in MapUnits
384  }
386  {
387  if ( mMapToPixel.isValid() )
388  {
389  const double mup = scale.computeMapUnitsPerPixel( *this );
390  if ( mup > 0 )
391  {
392  conversionFactor = 1.0 / mup;
393  }
394  else
395  {
396  conversionFactor = 1.0;
397  }
398  }
399  else
400  {
401  // invalid map to pixel. A size in map units can't be calculated, so treat the size as points
402  // and clamp it to a reasonable range. It's the best we can do in this situation!
403  isMapUnitHack = true;
404  conversionFactor = mScaleFactor / POINTS_TO_MM;
405  }
406  break;
407  }
409  conversionFactor = 1.0;
410  break;
411 
414  //no sensible value
415  conversionFactor = 1.0;
416  break;
417  }
418 
419  double convertedSize = size * conversionFactor;
420 
421  if ( unit == QgsUnitTypes::RenderMapUnits )
422  {
423  //check max/min size
424  if ( scale.minSizeMMEnabled )
425  convertedSize = std::max( convertedSize, scale.minSizeMM * mScaleFactor );
426  if ( scale.maxSizeMMEnabled )
427  convertedSize = std::min( convertedSize, scale.maxSizeMM * mScaleFactor );
428  }
429 
430  if ( isMapUnitHack )
431  {
432  // since we are arbitrarily treating map units as mm, we need to clamp to an (arbitrary!) reasonable range.
433  convertedSize = std::clamp( convertedSize, 10.0, 100.0 );
434  }
435  else
436  {
437  const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
438  convertedSize *= symbologyReferenceScaleFactor;
439  }
440 
442  {
443  // apply property based constraints in order to optimise symbol preview rendering
444  switch ( property )
445  {
447  break;
448 
450  // excessively large shadow offset in symbol preview icons is undesirable -- it pushes the shadow outside of view
451  convertedSize = std::min( convertedSize, 100.0 );
452  break;
454  // excessively large blur in symbol preview icons is too slow to calculate
455  convertedSize = std::min<double>( convertedSize, 30 );
456  break;
458  // excessively large glow spread in symbol preview icons is too slow to calculate
459  convertedSize = std::min<double>( convertedSize, 50 );
460  break;
461  }
462  }
463 
464  return convertedSize;
465 }
466 
467 double QgsRenderContext::convertToMapUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale ) const
468 {
469  const double mup = mMapToPixel.mapUnitsPerPixel();
470 
471  const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
472 
473  switch ( unit )
474  {
476  {
477  size = convertMetersToMapUnits( size );
478  // Fall through to RenderMapUnits with values of meters converted to MapUnits
480  }
482  {
483  // check scale
484  double minSizeMU = std::numeric_limits<double>::lowest();
485  if ( scale.minSizeMMEnabled )
486  {
487  minSizeMU = scale.minSizeMM * mScaleFactor * mup;
488  }
489  if ( !qgsDoubleNear( scale.minScale, 0.0 ) )
490  {
491  minSizeMU = std::max( minSizeMU, size * ( mRendererScale / scale.minScale ) );
492  }
493  size = std::max( size, minSizeMU );
494 
495  double maxSizeMU = std::numeric_limits<double>::max();
496  if ( scale.maxSizeMMEnabled )
497  {
498  maxSizeMU = scale.maxSizeMM * mScaleFactor * mup;
499  }
500  if ( !qgsDoubleNear( scale.maxScale, 0.0 ) )
501  {
502  maxSizeMU = std::min( maxSizeMU, size * ( mRendererScale / scale.maxScale ) );
503  }
504  size = std::min( size, maxSizeMU );
505 
506  return size;
507  }
509  {
510  return size * mScaleFactor * mup / symbologyReferenceScaleFactor;
511  }
513  {
514  return size * mScaleFactor * mup / POINTS_TO_MM / symbologyReferenceScaleFactor;
515  }
517  {
518  return size * mScaleFactor * mup * INCH_TO_MM / symbologyReferenceScaleFactor;
519  }
521  {
522  return size * mup / symbologyReferenceScaleFactor;
523  }
524 
527  //no sensible value
528  return 0.0;
529  }
530  return 0.0;
531 }
532 
533 double QgsRenderContext::convertFromMapUnits( double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit ) const
534 {
535  const double mup = mMapToPixel.mapUnitsPerPixel();
536  const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
537 
538  switch ( outputUnit )
539  {
541  {
542  return sizeInMapUnits / convertMetersToMapUnits( 1.0 );
543  }
545  {
546  return sizeInMapUnits;
547  }
549  {
550  return sizeInMapUnits / ( mScaleFactor * mup ) * symbologyReferenceScaleFactor;
551  }
553  {
554  return sizeInMapUnits / ( mScaleFactor * mup / POINTS_TO_MM ) * symbologyReferenceScaleFactor;
555  }
557  {
558  return sizeInMapUnits / ( mScaleFactor * mup * INCH_TO_MM ) * symbologyReferenceScaleFactor;
559  }
561  {
562  return sizeInMapUnits / mup * symbologyReferenceScaleFactor;
563  }
564 
567  //no sensible value
568  return 0.0;
569  }
570  return 0.0;
571 }
572 
573 double QgsRenderContext::convertMetersToMapUnits( double meters ) const
574 {
575  switch ( mDistanceArea.sourceCrs().mapUnits() )
576  {
578  return meters;
580  {
581  if ( mExtent.isNull() )
582  {
583  // we don't have an extent to calculate exactly -- so just use a very rough approximation
585  }
586 
587  QgsPointXY pointCenter = mExtent.center();
588  // The Extent is in the sourceCrs(), when different from destinationCrs()
589  // - the point must be transformed, since DistanceArea uses the destinationCrs()
590  // Note: the default QgsCoordinateTransform() : authid() will return an empty String
591  if ( !mCoordTransform.isShortCircuited() )
592  {
593  pointCenter = mCoordTransform.transform( pointCenter );
594  }
595 
596  const int multiplier = meters < 0 ? -1 : 1;
597  return multiplier * mDistanceArea.measureLineProjected( pointCenter, std::fabs( meters ) );
598  }
607  return ( meters * QgsUnitTypes::fromUnitToUnitFactor( QgsUnitTypes::DistanceMeters, mDistanceArea.sourceCrs().mapUnits() ) );
608  }
609  return meters;
610 }
611 
612 QList<QgsRenderedFeatureHandlerInterface *> QgsRenderContext::renderedFeatureHandlers() const
613 {
614  return mRenderedFeatureHandlers;
615 }
616 
617 QList<QgsMapClippingRegion> QgsRenderContext::clippingRegions() const
618 {
619  return mClippingRegions;
620 }
621 
623 {
624  return mFeatureClipGeometry;
625 }
626 
628 {
629  mFeatureClipGeometry = geometry;
630 }
631 
633 {
634  return mTextureOrigin;
635 }
636 
637 void QgsRenderContext::setTextureOrigin( const QPointF &origin )
638 {
639  mTextureOrigin = origin;
640 }
641 
643 {
644  return mZRange;
645 }
646 
648 {
649  mZRange = range;
650 }
651 
653 {
654  return mSize;
655 }
656 
658 {
659  mSize = size;
660 }
661 
663 {
664  return mDevicePixelRatio;
665 }
666 
668 {
669  mDevicePixelRatio = ratio;
670 }
671 
673 {
674  return outputSize() * mDevicePixelRatio;
675 }
676 
677 
The Qgis class provides global constants for use throughout the application.
Definition: qgis.h:64
RenderSubcomponentProperty
Rendering subcomponent properties.
Definition: qgis.h:995
@ Generic
Generic subcomponent property.
RenderContextFlag
Flags which affect rendering operations.
Definition: qgis.h:950
@ 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.
@ 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...
@ 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.
@ 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...
@ 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)...
QString ellipsoidAcronym() const
Returns the ellipsoid acronym for the ellipsoid used by the CRS.
Q_GADGET QgsUnitTypes::DistanceUnit mapUnits
Contains information about the context in which a coordinate transform is executed.
Class for doing transforms between two map coordinate systems.
bool isShortCircuited() const
Returns true if the transform short circuits because the source and destination are equivalent.
QgsPointXY transform(const QgsPointXY &point, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward) const SIP_THROW(QgsCsException)
Transform the point from the source CRS to the destination CRS.
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:203
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:45
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:125
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.
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.
const QgsExpressionContext & expressionContext() const
Gets the expression context.
const QgsPathResolver & pathResolver() const
Returns the path resolver for conversion between relative and absolute paths during rendering operati...
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...
const QgsMapToPixel & mapToPixel() const
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...
const QgsVectorSimplifyMethod & simplifyMethod() const
Returns the simplification settings to use when rendering vector layers.
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.
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
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.
Definition: qgsmaptopixel.h:83
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.
A class to represent a 2D point.
Definition: qgspointxy.h:59
A rectangle specified with double values.
Definition: qgsrectangle.h:42
bool isNull() const
Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
Definition: qgsrectangle.h:479
void grow(double delta)
Grows the rectangle in place by the specified amount.
Definition: qgsrectangle.h:296
QgsPointXY center() const SIP_HOLDGIL
Returns the center point of the rectangle.
Definition: qgsrectangle.h:251
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...
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.
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...
void setDevicePixelRatio(float ratio)
Sets the device pixel ratio.
const QgsAbstractGeometry * geometry() const
Returns pointer to the unsegmentized geometry.
double convertFromMapUnits(double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit) const
Converts a size from map units to the specified units.
void setUseAdvancedEffects(bool enabled)
Used to enable or disable advanced effects such as blend modes.
QPainter * painter()
Returns the destination QPainter for the render operation.
void setPainterFlagsUsingContext(QPainter *painter=nullptr) const
Sets relevant flags on a destination painter, using the flags and settings currently defined for the ...
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
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.
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.
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...
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 ...
void setFeatureClipGeometry(const QgsGeometry &geometry)
Sets a geometry to use to clip features at render time.
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)
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 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...
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...
double convertToMapUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to map units.
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.
QSize deviceOutputSize() const
Returns the device output size of the render.
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.
Qgis::RenderContextFlags flags() const
Returns combination of flags used for rendering.
const QgsRectangle & extent() const
When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the l...
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.
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.
@ DistanceMeters
Meters.
Definition: qgsunittypes.h:69
@ DistanceDegrees
Degrees, for planar geographic CRS distance measurements.
Definition: qgsunittypes.h:75
@ DistanceKilometers
Kilometers.
Definition: qgsunittypes.h:70
@ DistanceMiles
Terrestrial miles.
Definition: qgsunittypes.h:74
@ DistanceUnknownUnit
Unknown distance unit.
Definition: qgsunittypes.h:78
@ DistanceMillimeters
Millimeters.
Definition: qgsunittypes.h:77
@ DistanceYards
Imperial yards.
Definition: qgsunittypes.h:73
@ DistanceFeet
Imperial feet.
Definition: qgsunittypes.h:71
@ DistanceNauticalMiles
Nautical miles.
Definition: qgsunittypes.h:72
@ DistanceCentimeters
Centimeters.
Definition: qgsunittypes.h:76
static Q_INVOKABLE double fromUnitToUnitFactor(QgsUnitTypes::DistanceUnit fromUnit, QgsUnitTypes::DistanceUnit toUnit)
Returns the conversion factor between the specified distance units.
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:168
@ RenderUnknownUnit
Mixed or unknown units.
Definition: qgsunittypes.h:175
@ RenderMetersInMapUnits
Meters value as Map units.
Definition: qgsunittypes.h:176
@ RenderPercentage
Percentage of another measurement (e.g., canvas size, feature size)
Definition: qgsunittypes.h:172
@ RenderPoints
Points (e.g., for font sizes)
Definition: qgsunittypes.h:173
@ RenderPixels
Pixels.
Definition: qgsunittypes.h:171
@ RenderInches
Inches.
Definition: qgsunittypes.h:174
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:169
@ RenderMapUnits
Map units.
Definition: qgsunittypes.h:170
void setSimplifyHints(SimplifyHints simplifyHints)
Sets the simplification hints of the vector layer managed.
@ NoSimplification
No simplification can be applied.
#define FALLTHROUGH
Definition: qgis.h:2069
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition: qgis.h:1546
#define QgsDebugMsgLevel(str, level)
Definition: qgslogger.h:39
#define INCH_TO_MM
#define POINTS_TO_MM