18#ifndef QGSRENDERCONTEXT_H
19#define QGSRENDERCONTEXT_H
25#include <QPainterPath>
117 const QPainter *
painter()
const {
return mPainter; }
152 void setPainterFlagsUsingContext( QPainter *painter =
nullptr )
const;
163 QPainter *
maskPainter(
int id = 0 ) {
return mMaskPainter.value(
id,
nullptr ); }
177 Q_DECL_DEPRECATED
void setDisabledSymbolLayers(
const QSet<const QgsSymbolLayer *> &symbolLayers )
SIP_DEPRECATED;
188 void setDisabledSymbolLayersV2(
const QSet<QString> &symbolLayers );
200 Q_DECL_DEPRECATED QSet<const QgsSymbolLayer *> disabledSymbolLayers() const
SIP_DEPRECATED;
211 QSet<QString> disabledSymbolLayersV2() const;
367 bool forceVectorOutput()
const;
374 bool useAdvancedEffects()
const;
381 void setUseAdvancedEffects(
bool enabled );
388 bool drawEditingInformation()
const;
442 bool showSelection()
const;
496 void setDrawEditingInformation(
bool b );
591 void setForceVectorOutput(
bool force );
621 void setShowSelection(
bool showSelection );
628 bool useRenderingOptimization()
const;
635 void setUseRenderingOptimization(
bool enabled );
773 double convertFromMapUnits(
double sizeInMapUnits,
Qgis::RenderUnit outputUnit )
const;
779 double convertMetersToMapUnits(
double meters )
const;
789 return mTextRenderFormat;
800 mTextRenderFormat = format;
808 QList<QgsRenderedFeatureHandlerInterface *> renderedFeatureHandlers()
const;
907 void setCustomProperty(
const QString &property,
const QVariant &value ) { mCustomProperties[property] = value; }
932 QList< QgsMapClippingRegion > clippingRegions()
const;
959 void setFeatureClipGeometry(
const QgsGeometry &geometry );
968 QPointF textureOrigin()
const;
977 void setTextureOrigin(
const QPointF &origin );
1012 Q_DECL_DEPRECATED
void addSymbolLayerClipPath(
const QString &symbolLayerId, QPainterPath path )
SIP_DEPRECATED;
1020 Q_DECL_DEPRECATED QList<QPainterPath> symbolLayerClipPaths(
const QString &symbolLayerId )
const SIP_DEPRECATED;
1028 void addSymbolLayerClipGeometry(
const QString &symbolLayerId,
const QgsGeometry &geometry );
1036 bool symbolLayerHasClipGeometries(
const QString &symbolLayerId )
const;
1045 QVector<QgsGeometry> symbolLayerClipGeometries(
const QString &symbolLayerId )
const;
1071 QSize outputSize()
const;
1079 void setOutputSize( QSize size );
1089 float devicePixelRatio()
const;
1099 void setDevicePixelRatio(
float ratio );
1112 QSize deviceOutputSize()
const;
1159 double frameRate()
const;
1169 void setFrameRate(
double rate );
1179 long long currentFrame()
const;
1189 void setCurrentFrame(
long long frame );
1215 QPainter *mPainter =
nullptr;
1218 QPainter *mPreviewRenderPainter =
nullptr;
1226 QMap<int, QPainter *> mMaskPainter;
1239 int mCurrentMaskId = -1;
1245 bool mIsGuiPreview =
false;
1262 bool mRenderingStopped =
false;
1268 double mScaleFactor = 1.0;
1271 double mDpiTarget = -1.0;
1274 double mRendererScale = 1.0;
1276 double mSymbologyReferenceScale = -1;
1285 QColor mSelectionColor;
1297 std::unique_ptr< QgsFeatureFilterProvider > mFeatureFilterProvider;
1299 double mSegmentationTolerance = M_PI_2 / 90;
1308 QList< QgsRenderedFeatureHandlerInterface * > mRenderedFeatureHandlers;
1309 bool mHasRenderedFeatureHandlers =
false;
1310 QVariantMap mCustomProperties;
1312 QSet<QString> mDisabledSymbolLayers;
1314 QList< QgsMapClippingRegion > mClippingRegions;
1317 QPointF mTextureOrigin;
1322 float mDevicePixelRatio = 1.0;
1323 QImage::Format mImageFormat = QImage::Format_ARGB32_Premultiplied;
1327 double mFrameRate = -1;
1328 long long mCurrentFrame = -1;
1331 QMap< QString, QVector<QgsGeometry> > mSymbolLayerClippingGeometries;
1336 bool mHasTransformContext =
false;
1366 : mContext( context )
1367 , mPreviousPainter( context.painter() )
1395 QPainter *mPreviousPainter =
nullptr;
1396 bool mReleased =
false;
1423 : mContext( context )
1467 : mContext( context )
1509 : mPainter( painter )
1519 mPainter->restore();
1524 QPainter *mPainter =
nullptr;
1548 : mContext( &context )
1549 , mOriginalScale( context.symbologyReferenceScale() )
1558 : mContext( o.mContext )
1559 , mOriginalScale( o.mOriginalScale )
1561 o.mContext =
nullptr;
1576 double mOriginalScale = 0;
RenderSubcomponentProperty
Rendering subcomponent properties.
@ Generic
Generic subcomponent property.
QFlags< RenderContextFlag > RenderContextFlags
Render context flags.
TextRenderFormat
Options for rendering text.
@ AlwaysOutlines
Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality...
RenderUnit
Rendering size units.
RenderContextFlag
Flags which affect rendering operations.
RendererUsage
Usage of the renderer.
@ Unknown
Renderer used for unknown usage.
Abstract base class for all geometries.
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle.
@ MaximumAngle
Maximum angle between generating radii (lines from arc center to output vertices)
Contains information about the context in which a coordinate transform is executed.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
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...
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Abstract interface for use by classes that filter the features or attributes of a layer.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
A geometry is the spatial representation of a feature.
Abstract base class that can be used to intercept rendered labels from a labeling / rendering job.
The QgsLabelingEngine class provides map labeling functionality.
A map clipping region (in map coordinates and CRS).
The QgsMapSettings class contains configuration for rendering of the map.
Perform transforms between map coordinates and device coordinates.
Struct for storing maximum and minimum scales for measurements in map units.
This class allows the creation of mask ids based on the different label layers and to give a mask id ...
Contains settings regarding how masks are calculated and handled during a map render.
Resolves relative paths into absolute paths and vice versa.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
const QgsMaskIdProvider * maskIdProvider() const
Returns the mask id provider attached to the context.
QgsMaskRenderSettings & maskSettings()
Returns a reference to the mask render settings, which control how masks are drawn and behave during ...
void setMapExtent(const QgsRectangle &extent)
Sets the original extent of the map being rendered.
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
void setRenderingStopped(bool stopped)
Sets whether the rendering operation has been stopped and any ongoing rendering should be canceled im...
Q_DECL_DEPRECATED QVariantMap customRenderingFlags() const
Gets custom rendering flags.
void setDistanceArea(const QgsDistanceArea &distanceArea)
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
Qgis::RendererUsage rendererUsage() const
Returns the renderer usage.
void setScaleFactor(double factor)
Sets the scaling factor for the render to convert painter units to physical sizes.
bool hasRenderedFeatureHandlers() const
Returns true if the context has any rendered feature handlers.
void setImageFormat(QImage::Format format)
Sets QImage format which should be used for QImages created during rendering.
QgsVectorSimplifyMethod & vectorSimplifyMethod()
Returns the simplification settings to use when rendering vector layers.
void setSegmentationToleranceType(QgsAbstractGeometry::SegmentationToleranceType type)
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
double symbologyReferenceScale() const
Returns the symbology reference scale.
double segmentationTolerance() const
Gets the segmentation tolerance applied when rendering curved geometries.
const QPainter * painter() const
Returns the const destination QPainter for the render operation.
const QgsDistanceArea & distanceArea() const
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
Q_DECL_DEPRECATED void clearCustomRenderingFlag(const QString &flag)
Clears the specified custom rendering flag.
const QPainter * previewRenderPainter() const
Returns the const destination QPainter for temporary in-progress preview renders.
QPainter * painter()
Returns the destination QPainter for the render operation.
double rendererScale() const
Returns the renderer map scale.
QgsExpressionContext & expressionContext()
Gets the expression context.
void setTextRenderFormat(Qgis::TextRenderFormat format)
Sets the text render format, which dictates how text is rendered (e.g.
void setGeometry(const QgsAbstractGeometry *geometry)
Sets pointer to original (unsegmentized) geometry.
void setVectorSimplifyMethod(const QgsVectorSimplifyMethod &simplifyMethod)
Sets the simplification setting to use when rendering vector layers.
QgsLabelSink * labelSink() const
Returns the associated label sink, or nullptr if not set.
bool isGuiPreview() const
Returns the Gui preview mode.
void setPreviewRenderPainter(QPainter *painter)
Sets the destination painter for temporary in-progress preview renders.
const QgsRectangle & extent() const
When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the l...
void setCurrentMaskId(int id)
Stores a mask id as the "current" one.
void clearCustomProperty(const QString &property)
Clears the specified custom rendering property.
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...
void setIsGuiPreview(bool preview)
Sets GUI preview mode.
QVariantMap customProperties() const
Returns custom rendering properties.
void setLabelSink(QgsLabelSink *sink)
Assigns the label sink which will take over responsibility for handling labels.
const QgsExpressionContext & expressionContext() const
Gets the expression context (const version).
Qgis::TextRenderFormat textRenderFormat() const
Returns the text render format, which dictates how text is rendered (e.g.
QgsRectangle mapExtent() const
Returns the original extent of the map being rendered.
void setSymbologyReferenceScale(double scale)
Sets the symbology reference scale.
double dpiTarget() const
Returns the targeted DPI for rendering.
const QgsVectorSimplifyMethod & vectorSimplifyMethod() const
Returns the simplification settings to use when rendering vector layers.
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
void setMaskIdProvider(QgsMaskIdProvider *provider)
Attaches a mask id provider to the context.
QColor selectionColor() const
Returns the color to use when rendering selected features.
void setExtent(const QgsRectangle &extent)
When rendering a map layer, calling this method sets the "clipping" extent for the layer (in the laye...
QPainter * maskPainter(int id=0)
Returns a mask QPainter for the render operation.
void setMapToPixel(const QgsMapToPixel &mtp)
Sets the context's map to pixel transform, which transforms between map coordinates and device coordi...
int currentMaskId() const
Returns the current mask id, which can be used with maskPainter()
void setCustomProperty(const QString &property, const QVariant &value)
Sets a custom rendering property.
Q_DECL_DEPRECATED void setCustomRenderingFlag(const QString &flag, const QVariant &value)
Sets a custom rendering flag.
void setPainter(QPainter *p)
Sets the destination QPainter for the render operation.
void setMaskPainter(QPainter *p, int id=0)
Sets a mask QPainter for the render operation.
void setLabelingEngine(QgsLabelingEngine *engine)
Assigns the labeling engine.
bool renderingStopped() const
Returns true if the rendering operation has been stopped and any ongoing rendering should be canceled...
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
void setRendererScale(double scale)
Sets the renderer map scale.
QgsLabelingEngine * labelingEngine() const
Gets access to new labeling engine (may be nullptr).
QPainter * previewRenderPainter()
Returns the const destination QPainter for temporary in-progress preview renders.
void setRendererUsage(Qgis::RendererUsage usage)
Sets the renderer usage.
QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const
Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
const QgsAbstractGeometry * geometry() const
Returns pointer to the unsegmentized geometry.
QImage::Format imageFormat() const
Returns the QImage format which should be used for QImages created during rendering.
const QgsMaskRenderSettings & maskSettings() const
Returns a reference to the mask render settings, which control how masks are drawn and behave during ...
const QgsPathResolver & pathResolver() const
Returns the path resolver for conversion between relative and absolute paths during rendering operati...
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.
An interface for classes which provider custom handlers for features rendered as part of a map render...
Scoped object for saving and restoring a QPainter object's state.
QgsScopedQPainterState(QPainter *painter)
Constructor for QgsScopedQPainterState.
~QgsScopedQPainterState()
Restores the painter back to its original state.
Scoped object for temporary replacement of a QgsRenderContext destination painter.
QgsScopedRenderContextPainterSwap(QgsRenderContext &context, QPainter *temporaryPainter)
Constructor for QgsScopedRenderContextPainterSwap.
~QgsScopedRenderContextPainterSwap()
Returns the destination painter for the context back to the original QPainter object.
void reset()
Resets the destination painter for the context back to the original QPainter object.
Scoped object for temporary override of the symbologyReferenceScale property of a QgsRenderContext.
QgsScopedRenderContextReferenceScaleOverride(QgsScopedRenderContextReferenceScaleOverride &&o) noexcept
Move constructor.
~QgsScopedRenderContextReferenceScaleOverride()
Returns the render context back to the original reference scale.
QgsScopedRenderContextReferenceScaleOverride(QgsRenderContext &context, double scale)
Constructor for QgsScopedRenderContextReferenceScaleOverride.
Scoped object for temporary scaling of a QgsRenderContext for millimeter based rendering.
~QgsScopedRenderContextScaleToMm()
Returns the destination painter back to pixel based units.
QgsScopedRenderContextScaleToMm(QgsRenderContext &context)
Constructor for QgsScopedRenderContextScaleToMm.
Scoped object for temporary scaling of a QgsRenderContext for pixel based rendering.
QgsScopedRenderContextScaleToPixels(QgsRenderContext &context)
Constructor for QgsScopedRenderContextScaleToPixels.
~QgsScopedRenderContextScaleToPixels()
Returns the destination painter back to millimeter based units.
Base class for objects with an associated (optional) temporal range.
This class contains information how to simplify geometries fetched from a vector layer.