29#define POINTS_TO_MM 2.83464567
30#define INCH_TO_MM 25.4
33 : mFlags(
Qgis::RenderContextFlag::DrawEditingInfo |
Qgis::RenderContextFlag::UseAdvancedEffects |
Qgis::RenderContextFlag::DrawSelection |
Qgis::RenderContextFlag::UseRenderingOptimization )
46 , mPainter( rh.mPainter )
47 , mPreviewRenderPainter( rh.mPreviewRenderPainter )
48 , mMaskPainter( rh.mMaskPainter )
51 , mMaskIdProvider( nullptr )
52 , mCurrentMaskId( -1 )
54 , mIsGuiPreview( rh.mIsGuiPreview )
55 , mCoordTransform( rh.mCoordTransform )
56 , mDistanceArea( rh.mDistanceArea )
57 , mExtent( rh.mExtent )
58 , mOriginalMapExtent( rh.mOriginalMapExtent )
59 , mMapToPixel( rh.mMapToPixel )
60 , mRenderingStopped( rh.mRenderingStopped )
61 , mFeedback( rh.mFeedback )
62 , mScaleFactor( rh.mScaleFactor )
63 , mDpiTarget( rh.mDpiTarget )
64 , mRendererScale( rh.mRendererScale )
65 , mSymbologyReferenceScale( rh.mSymbologyReferenceScale )
66 , mLabelingEngine( rh.mLabelingEngine )
67 , mLabelSink( rh.mLabelSink )
68 , mSelectionColor( rh.mSelectionColor )
69 , mVectorSimplifyMethod( rh.mVectorSimplifyMethod )
70 , mExpressionContext( rh.mExpressionContext )
71 , mGeometry( rh.mGeometry )
72 , mFeatureFilterProvider( rh.mFeatureFilterProvider ? rh.mFeatureFilterProvider->clone() : nullptr )
73 , mSegmentationTolerance( rh.mSegmentationTolerance )
74 , mSegmentationToleranceType( rh.mSegmentationToleranceType )
75 , mTransformContext( rh.mTransformContext )
76 , mPathResolver( rh.mPathResolver )
77 , mTextRenderFormat( rh.mTextRenderFormat )
78 , mRenderedFeatureHandlers( rh.mRenderedFeatureHandlers )
79 , mHasRenderedFeatureHandlers( rh.mHasRenderedFeatureHandlers )
80 , mCustomProperties( rh.mCustomProperties )
81 , mDisabledSymbolLayers()
82 , mClippingRegions( rh.mClippingRegions )
83 , mFeatureClipGeometry( rh.mFeatureClipGeometry )
84 , mTextureOrigin( rh.mTextureOrigin )
85 , mZRange( rh.mZRange )
87 , mDevicePixelRatio( rh.mDevicePixelRatio )
88 , mImageFormat( rh.mImageFormat )
89 , mRendererUsage( rh.mRendererUsage )
90 , mFrameRate( rh.mFrameRate )
91 , mCurrentFrame( rh.mCurrentFrame )
92 , mSymbolLayerClippingGeometries( rh.mSymbolLayerClippingGeometries )
93 , mMaskRenderSettings( rh.mMaskRenderSettings )
95 , mHasTransformContext( rh.mHasTransformContext )
97 , mElevationMap( rh.mElevationMap )
104 mPainter = rh.mPainter;
105 mPreviewRenderPainter = rh.mPreviewRenderPainter;
106 mMaskPainter = rh.mMaskPainter;
110 mIsGuiPreview = rh.mIsGuiPreview;
111 mCoordTransform = rh.mCoordTransform;
112 mExtent = rh.mExtent;
113 mOriginalMapExtent = rh.mOriginalMapExtent;
114 mMapToPixel = rh.mMapToPixel;
115 mRenderingStopped = rh.mRenderingStopped;
116 mFeedback = rh.mFeedback;
117 mScaleFactor = rh.mScaleFactor;
118 mDpiTarget = rh.mDpiTarget;
119 mRendererScale = rh.mRendererScale;
120 mSymbologyReferenceScale = rh.mSymbologyReferenceScale;
121 mLabelingEngine = rh.mLabelingEngine;
122 mLabelSink = rh.mLabelSink;
123 mSelectionColor = rh.mSelectionColor;
124 mVectorSimplifyMethod = rh.mVectorSimplifyMethod;
125 mExpressionContext = rh.mExpressionContext;
126 mGeometry = rh.mGeometry;
127 mFeatureFilterProvider.reset( rh.mFeatureFilterProvider ? rh.mFeatureFilterProvider->clone() : nullptr );
128 mSegmentationTolerance = rh.mSegmentationTolerance;
129 mSegmentationToleranceType = rh.mSegmentationToleranceType;
130 mDistanceArea = rh.mDistanceArea;
131 mTransformContext = rh.mTransformContext;
132 mPathResolver = rh.mPathResolver;
133 mTextRenderFormat = rh.mTextRenderFormat;
134 mRenderedFeatureHandlers = rh.mRenderedFeatureHandlers;
135 mHasRenderedFeatureHandlers = rh.mHasRenderedFeatureHandlers;
136 mCustomProperties = rh.mCustomProperties;
137 mClippingRegions = rh.mClippingRegions;
138 mFeatureClipGeometry = rh.mFeatureClipGeometry;
139 mTextureOrigin = rh.mTextureOrigin;
140 mZRange = rh.mZRange;
142 mDevicePixelRatio = rh.mDevicePixelRatio;
143 mImageFormat = rh.mImageFormat;
145 mRendererUsage = rh.mRendererUsage;
146 mFrameRate = rh.mFrameRate;
147 mCurrentFrame = rh.mCurrentFrame;
148 mSymbolLayerClippingGeometries = rh.mSymbolLayerClippingGeometries;
149 mMaskRenderSettings = rh.mMaskRenderSettings;
153 mHasTransformContext = rh.mHasTransformContext;
175 if (
painter &&
painter->renderHints() & QPainter::SmoothPixmapTransform )
177 if (
painter &&
painter->renderHints() & QPainter::LosslessImageRendering )
199 if ( !mHasTransformContext )
200 QgsDebugMsgLevel( QStringLiteral(
"No QgsCoordinateTransformContext context set for transform" ), 4 );
202 return mTransformContext;
207 mTransformContext = context;
209 mHasTransformContext =
true;
233 mFlags &= ~(
static_cast< int >( flag ) );
243 return mFlags.testFlag( flag );
305 ctx.mFrameRate = mapSettings.
frameRate();
308 const QStringList layerIds = mapSettings.
layerIds(
true );
309 if ( !layerIds.empty() )
374 mFeatureFilterProvider.reset( ffp->
clone() );
378 mFeatureFilterProvider.reset(
nullptr );
384 return mFeatureFilterProvider.get();
389 double conversionFactor = 1.0;
390 bool isMapUnitHack =
false;
394 conversionFactor = mScaleFactor;
420 conversionFactor = 1.0 / mup;
424 conversionFactor = 1.0;
431 isMapUnitHack =
true;
437 conversionFactor = 1.0;
443 conversionFactor = 1.0;
447 double convertedSize = size * conversionFactor;
453 convertedSize = std::max( convertedSize, scale.
minSizeMM * mScaleFactor );
455 convertedSize = std::min( convertedSize, scale.
maxSizeMM * mScaleFactor );
461 convertedSize = std::clamp( convertedSize, 10.0, 100.0 );
465 const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
466 convertedSize *= symbologyReferenceScaleFactor;
479 convertedSize = std::min( convertedSize, 100.0 );
483 convertedSize = std::min<double>( convertedSize, 30 );
487 convertedSize = std::min<double>( convertedSize, 50 );
492 return convertedSize;
497 double conversionFactor = 1.0;
502 conversionFactor = 1 / mScaleFactor;
510 conversionFactor = 1 / ( mScaleFactor *
INCH_TO_MM );
527 conversionFactor = mup / 1.0;
531 conversionFactor = 1.0;
543 conversionFactor = 1.0;
549 conversionFactor = 1.0;
554 return size * conversionFactor;
561 const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
574 double minSizeMU = std::numeric_limits<double>::lowest();
577 minSizeMU = scale.
minSizeMM * mScaleFactor * mup;
581 minSizeMU = std::max( minSizeMU, size * ( mRendererScale / scale.
minScale ) );
583 size = std::max( size, minSizeMU );
585 double maxSizeMU = std::numeric_limits<double>::max();
588 maxSizeMU = scale.
maxSizeMM * mScaleFactor * mup;
592 maxSizeMU = std::min( maxSizeMU, size * ( mRendererScale / scale.
maxScale ) );
594 size = std::min( size, maxSizeMU );
600 return size * mScaleFactor * mup / symbologyReferenceScaleFactor;
604 return size * mScaleFactor * mup /
POINTS_TO_MM / symbologyReferenceScaleFactor;
608 return size * mScaleFactor * mup *
INCH_TO_MM / symbologyReferenceScaleFactor;
612 return size * mup / symbologyReferenceScaleFactor;
626 const double symbologyReferenceScaleFactor = mSymbologyReferenceScale > 0 ? mSymbologyReferenceScale / mRendererScale : 1;
628 switch ( outputUnit )
636 return sizeInMapUnits;
640 return sizeInMapUnits / ( mScaleFactor * mup ) * symbologyReferenceScaleFactor;
644 return sizeInMapUnits / ( mScaleFactor * mup /
POINTS_TO_MM ) * symbologyReferenceScaleFactor;
648 return sizeInMapUnits / ( mScaleFactor * mup *
INCH_TO_MM ) * symbologyReferenceScaleFactor;
652 return sizeInMapUnits / mup * symbologyReferenceScaleFactor;
685 pointCenter = mCoordTransform.
transform( pointCenter );
689 QgsDebugError( QStringLiteral(
"QgsRenderContext::convertMetersToMapUnits(): failed to reproject pointCenter" ) );
695 const int multiplier = meters < 0 ? -1 : 1;
753 return mRenderedFeatureHandlers;
758 return mClippingRegions;
763 return mFeatureClipGeometry;
773 return mTextureOrigin;
778 mTextureOrigin = origin;
783 mMaskRenderSettings = settings;
808 return mDevicePixelRatio;
813 mDevicePixelRatio = ratio;
833 return mCurrentFrame;
838 mCurrentFrame = frame;
843 return mElevationMap;
861 QList<QPainterPath> res;
862 res.reserve( geometries.size() );
874 mSymbolLayerClippingGeometries[ symbolLayerId ].append(
geometry.asGeometryCollection() );
878 mSymbolLayerClippingGeometries[ symbolLayerId ].append(
geometry );
884 auto it = mSymbolLayerClippingGeometries.constFind( symbolLayerId );
885 if ( it == mSymbolLayerClippingGeometries.constEnd() )
887 return !it.value().isEmpty();
892 return mSymbolLayerClippingGeometries[ symbolLayerId ];
897 mDisabledSymbolLayers.clear();
899 mDisabledSymbolLayers << symbolLayer->id();
904 mDisabledSymbolLayers = symbolLayers;
909 return QSet<const QgsSymbolLayer *>();
914 return mDisabledSymbolLayers;
919 return !mDisabledSymbolLayers.contains( layer->
id() );
The Qgis class provides global constants for use throughout the application.
RenderSubcomponentProperty
Rendering subcomponent properties.
@ ShadowOffset
Shadow offset.
@ GlowSpread
Glow spread size.
@ Generic
Generic subcomponent property.
@ NoSimplification
No simplification can be applied.
@ YardsBritishSears1922Truncated
British yards (Sears 1922 truncated)
@ MilesUSSurvey
US Survey miles.
@ LinksBritishSears1922
British links (Sears 1922)
@ YardsBritishBenoit1895A
British yards (Benoit 1895 A)
@ LinksBritishBenoit1895A
British links (Benoit 1895 A)
@ Centimeters
Centimeters.
@ YardsIndian1975
Indian yards (1975)
@ FeetUSSurvey
US Survey feet.
@ Millimeters
Millimeters.
@ FeetBritishSears1922
British feet (Sears 1922)
@ YardsClarkes
Clarke's yards.
@ YardsIndian
Indian yards.
@ FeetBritishBenoit1895B
British feet (Benoit 1895 B)
@ Miles
Terrestrial miles.
@ LinksUSSurvey
US Survey links.
@ ChainsUSSurvey
US Survey chains.
@ FeetClarkes
Clarke's feet.
@ Unknown
Unknown distance unit.
@ FeetBritish1936
British feet (1936)
@ FeetIndian1962
Indian feet (1962)
@ YardsBritishSears1922
British yards (Sears 1922)
@ FeetIndian1937
Indian feet (1937)
@ YardsIndian1937
Indian yards (1937)
@ Degrees
Degrees, for planar geographic CRS distance measurements.
@ ChainsBritishBenoit1895B
British chains (Benoit 1895 B)
@ LinksBritishSears1922Truncated
British links (Sears 1922 truncated)
@ ChainsBritishBenoit1895A
British chains (Benoit 1895 A)
@ YardsBritishBenoit1895B
British yards (Benoit 1895 B)
@ FeetBritish1865
British feet (1865)
@ YardsIndian1962
Indian yards (1962)
@ FeetBritishSears1922Truncated
British feet (Sears 1922 truncated)
@ MetersGermanLegal
German legal meter.
@ LinksBritishBenoit1895B
British links (Benoit 1895 B)
@ ChainsInternational
International chains.
@ LinksInternational
International links.
@ ChainsBritishSears1922Truncated
British chains (Sears 1922 truncated)
@ FeetIndian
Indian (geodetic) feet.
@ NauticalMiles
Nautical miles.
@ ChainsClarkes
Clarke's chains.
@ LinksClarkes
Clarke's links.
@ ChainsBritishSears1922
British chains (Sears 1922)
@ FeetIndian1975
Indian feet (1975)
@ FeetGoldCoast
Gold Coast feet.
@ FeetBritishBenoit1895A
British feet (Benoit 1895 A)
QFlags< RenderContextFlag > RenderContextFlags
Render context flags.
RenderUnit
Rendering size units.
@ 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.
@ MetersInMapUnits
Meters value as Map units.
RenderContextFlag
Flags which affect rendering operations.
@ 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.
@ 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.
@ 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.
@ 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.
@ 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.
Qgis::DistanceUnit mapUnits
Contains information about the context in which a coordinate transform is executed.
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.
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.
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.
QStringList layerIds(bool expandGroupLayers=false) const
Returns the list of layer IDs which will be rendered in the map.
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.
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.
double convertFromPainterUnits(double size, Qgis::RenderUnit unit) const
Converts a size from painter units (pixels) to the specified render unit.
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.
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
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.
void setCustomProperty(const QString &property, const QVariant &value)
Sets a custom rendering property.
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)
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)