Contains information about the context of a rendering operation. More...

#include <qgsrendercontext.h>

Public Types
enum	Flag { DrawEditingInfo = 0x01, ForceVectorOutput = 0x02, UseAdvancedEffects = 0x04, UseRenderingOptimization = 0x08, DrawSelection = 0x10, DrawSymbolBounds = 0x20, RenderMapTile = 0x40, Antialiasing = 0x80, RenderPartialOutput = 0x100, RenderPreviewJob = 0x200 }
	Enumeration of flags that affect rendering operations. More...

enum	TextRenderFormat { TextFormatAlwaysOutlines, TextFormatAlwaysText }
	Options for rendering text. More...

Public Member Functions
	QgsRenderContext ()

	QgsRenderContext (const QgsRenderContext &rh)

double	convertFromMapUnits (double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit) const
	Converts a size from map units to the specified units. More...

double	convertMetersToMapUnits (double meters) const
	Convert meter distances to active MapUnit values for QgsUnitTypes::RenderMetersInMapUnits. More...

double	convertToMapUnits (double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
	Converts a size from the specified units to map units. More...

double	convertToPainterUnits (double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
	Converts a size from the specified units to painter units (pixels). More...

QgsCoordinateTransform	coordinateTransform () const
	Returns the current coordinate transform for the context. More...

const QgsDistanceArea &	distanceArea () const
	A general purpose distance and area calculator, capable of performing ellipsoid based calculations. More...

bool	drawEditingInformation () const
	Returns `true` if edit markers should be drawn during the render operation. More...

QgsExpressionContext &	expressionContext ()
	Gets the expression context. More...

const QgsExpressionContext &	expressionContext () const
	Gets the expression context (const version). More...

const QgsRectangle &	extent () const
	When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the layer's CRS). More...

const QgsFeatureFilterProvider *	featureFilterProvider () const
	Gets the filter feature provider used for additional filtering of rendered features. More...

Flags	flags () const
	Returns combination of flags used for rendering. More...

bool	forceVectorOutput () const
	Returns `true` if rendering operations should use vector operations instead of any faster raster shortcuts. More...

const QgsAbstractGeometry *	geometry () const
	Returns pointer to the unsegmentized geometry. More...

QgsLabelingEngine *	labelingEngine () const
	Gets access to new labeling engine (may be `nullptr`) More...

QgsRectangle	mapExtent () const
	Returns the original extent of the map being rendered. More...

const QgsMapToPixel &	mapToPixel () const
	Returns the context's map to pixel transform, which transforms between map coordinates and device coordinates. More...

QgsRenderContext &	operator= (const QgsRenderContext &rh)

QPainter *	painter ()
	Returns the destination QPainter for the render operation. More...

const QgsPathResolver &	pathResolver () const
	Returns the path resolver for conversion between relative and absolute paths during rendering operations, e.g. More...

double	rendererScale () const
	Returns the renderer map scale. More...

bool	renderingStopped () const
	Returns `true` if the rendering operation has been stopped and any ongoing rendering should be canceled immediately. More...

double	scaleFactor () const
	Returns the scaling factor for the render to convert painter units to physical sizes. More...

double	segmentationTolerance () const
	Gets the segmentation tolerance applied when rendering curved geometries. More...

QgsAbstractGeometry::SegmentationToleranceType	segmentationToleranceType () const
	Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) More...

QColor	selectionColor () const
	Returns the color to use when rendering selected features. More...

void	setCoordinateTransform (const QgsCoordinateTransform &t)
	Sets the current coordinate transform for the context. More...

void	setDistanceArea (const QgsDistanceArea &distanceArea)
	A general purpose distance and area calculator, capable of performing ellipsoid based calculations. More...

void	setDrawEditingInformation (bool b)
	Sets whether edit markers should be drawn during the render operation. More...

void	setExpressionContext (const QgsExpressionContext &context)
	Sets the expression context. More...

void	setExtent (const QgsRectangle &extent)
	When rendering a map layer, calling this method sets the "clipping" extent for the layer (in the layer's CRS). More...

void	setFeatureFilterProvider (const QgsFeatureFilterProvider *ffp)
	Set a filter feature provider used for additional filtering of rendered features. More...

void	setFlag (Flag flag, bool on=true)
	Enable or disable a particular flag (other flags are not affected) More...

void	setFlags (QgsRenderContext::Flags flags)
	Set combination of flags that will be used for rendering. More...

void	setForceVectorOutput (bool force)
	Sets whether rendering operations should use vector operations instead of any faster raster shortcuts. More...

void	setGeometry (const QgsAbstractGeometry *geometry)
	Sets pointer to original (unsegmentized) geometry. More...

void	setLabelingEngine (QgsLabelingEngine *engine2)
	Assign new labeling engine. More...

void	setMapExtent (const QgsRectangle &extent)
	Sets the original extent of the map being rendered. More...

void	setMapToPixel (const QgsMapToPixel &mtp)
	Sets the context's map to pixel transform, which transforms between map coordinates and device coordinates. More...

void	setPainter (QPainter *p)
	Sets the destination QPainter for the render operation. More...

void	setPathResolver (const QgsPathResolver &resolver)
	Sets the path resolver for conversion between relative and absolute paths during rendering operations, e.g. More...

void	setRendererScale (double scale)
	Sets the renderer map scale. More...

void	setRenderingStopped (bool stopped)
	Sets whether the rendering operation has been stopped and any ongoing rendering should be canceled immediately. More...

void	setScaleFactor (double factor)
	Sets the scaling factor for the render to convert painter units to physical sizes. More...

void	setSegmentationTolerance (double tolerance)
	Sets the segmentation tolerance applied when rendering curved geometries. More...

void	setSegmentationToleranceType (QgsAbstractGeometry::SegmentationToleranceType type)
	Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) More...

void	setSelectionColor (const QColor &color)
	Sets the color to use when rendering selected features. More...

void	setShowSelection (bool showSelection)
	Sets whether vector selections should be shown in the rendered map. More...

void	setTextRenderFormat (TextRenderFormat format)
	Sets the text render format, which dictates how text is rendered (e.g. More...

void	setTransformContext (const QgsCoordinateTransformContext &context)
	Sets the context's coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system. More...

void	setUseAdvancedEffects (bool enabled)
	Used to enable or disable advanced effects such as blend modes. More...

void	setUseRenderingOptimization (bool enabled)

void	setVectorSimplifyMethod (const QgsVectorSimplifyMethod &simplifyMethod)

bool	showSelection () const
	Returns `true` if vector selections should be shown in the rendered map. More...

bool	testFlag (Flag flag) const
	Check whether a particular flag is enabled. More...

TextRenderFormat	textRenderFormat () const
	Returns the text render format, which dictates how text is rendered (e.g. More...

QgsCoordinateTransformContext	transformContext () const
	Returns the context's coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system. More...

bool	useAdvancedEffects () const
	Returns `true` if advanced effects such as blend modes such be used. More...

bool	useRenderingOptimization () const
	Returns `true` if the rendering optimization (geometry simplification) can be executed. More...

const QgsVectorSimplifyMethod &	vectorSimplifyMethod () const
	Added in QGIS v2.4. More...

Static Public Member Functions
static QgsRenderContext	fromMapSettings (const QgsMapSettings &mapSettings)
	create initialized QgsRenderContext instance from given QgsMapSettings More...

static QgsRenderContext	fromQPainter (QPainter *painter)
	Creates a default render context given a pixel based QPainter destination. More...

Detailed Description

Contains information about the context of a rendering operation.

The context of a rendering operation defines properties such as the conversion ratio between screen and map units, the extents to be rendered etc.

Definition at line 50 of file qgsrendercontext.h.

Member Enumeration Documentation

◆ Flag

enum QgsRenderContext::Flag

Enumeration of flags that affect rendering operations.

Since: QGIS 2.14

Enumerator
DrawEditingInfo	Enable drawing of vertex markers for layers in editing mode.
ForceVectorOutput	Vector graphics should not be cached and drawn as raster images.
UseAdvancedEffects	Enable layer opacity and blending effects.
UseRenderingOptimization	Enable vector simplification and other rendering optimizations.
DrawSelection	Whether vector selections should be shown in the rendered map.
DrawSymbolBounds	Draw bounds of symbols (for debugging/testing)
RenderMapTile	Draw map such that there are no problems between adjacent tiles.
Antialiasing	Use antialiasing while drawing.
RenderPartialOutput	Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0.
RenderPreviewJob	Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering.

Definition at line 62 of file qgsrendercontext.h.

◆ TextRenderFormat

enum QgsRenderContext::TextRenderFormat

Options for rendering text.

Since: QGIS 3.4.3

Enumerator

TextFormatAlwaysOutlines

Always render text using path objects (AKA outlines/curves).

This setting guarantees the best quality rendering, even when using a raster paint surface (where sub-pixel path based text rendering is superior to sub-pixel text-based rendering). The downside is that text is converted to paths only, so users cannot open created vector outputs for post-processing in other applications and retain text editability.

This setting also guarantees complete compatibility with the full range of formatting options available through QgsTextRenderer and QgsTextFormat, some of which may not be possible to reproduce when using a vector-based paint surface and TextFormatAlwaysText mode.

A final benefit to this setting is that vector exports created using text as outlines do not require all users to have the original fonts installed in order to display the text in its original style.

TextFormatAlwaysText

Always render text as text objects.

While this mode preserves text objects as text for post-processing in external vector editing applications, it can result in rendering artifacts or poor quality rendering, depending on the text format settings.

Even with raster based paint devices, TextFormatAlwaysText can result in inferior rendering quality to TextFormatAlwaysOutlines.

When rendering using TextFormatAlwaysText to a vector based device (e.g. PDF or SVG), care must be taken to ensure that the required fonts are available to users when opening the created files, or default fallback fonts will be used to display the output instead. (Although PDF exports MAY automatically embed some fonts when possible, depending on the user's platform).

Definition at line 81 of file qgsrendercontext.h.

Constructor & Destructor Documentation

◆ QgsRenderContext() [1/2]

QgsRenderContext::QgsRenderContext ( )

Definition at line 31 of file qgsrendercontext.cpp.

◆ QgsRenderContext() [2/2]

QgsRenderContext::QgsRenderContext ( const QgsRenderContext & rh )

Definition at line 40 of file qgsrendercontext.cpp.

Member Function Documentation

◆ convertFromMapUnits()

double QgsRenderContext::convertFromMapUnits	(	double	sizeInMapUnits,
		QgsUnitTypes::RenderUnit	outputUnit
	)		const

Converts a size from map units to the specified units.

See also: convertToMapUnits()

Since: QGIS 3.0

Definition at line 390 of file qgsrendercontext.cpp.

◆ convertMetersToMapUnits()

double QgsRenderContext::convertMetersToMapUnits ( double meters ) const

Convert meter distances to active MapUnit values for QgsUnitTypes::RenderMetersInMapUnits.

Note: When the sourceCrs() is geographic, the center of the Extent will be used

Since: QGIS 3.0

Definition at line 429 of file qgsrendercontext.cpp.

◆ convertToMapUnits()

double QgsRenderContext::convertToMapUnits	(	double	size,
		QgsUnitTypes::RenderUnit	unit,
		const QgsMapUnitScale &	scale = `QgsMapUnitScale()`
	)		const

Converts a size from the specified units to map units.

The conversion respects the limits specified by the optional scale parameter.

See also: convertToPainterUnits()

Since: QGIS 3.0

Definition at line 326 of file qgsrendercontext.cpp.

◆ convertToPainterUnits()

double QgsRenderContext::convertToPainterUnits	(	double	size,
		QgsUnitTypes::RenderUnit	unit,
		const QgsMapUnitScale &	scale = `QgsMapUnitScale()`
	)		const

Converts a size from the specified units to painter units (pixels).

The conversion respects the limits specified by the optional scale parameter.

See also: convertToMapUnits()

Since: QGIS 3.0

Definition at line 264 of file qgsrendercontext.cpp.

◆ coordinateTransform()

QgsCoordinateTransform QgsRenderContext::coordinateTransform ( ) const

inline

Returns the current coordinate transform for the context.

This represents the coordinate transform required to transform a layer which is being rendered back to the CRS of the rendered map. If no coordinate transformation is required, or the render context is not associated with a map layer render, then an invalid coordinate transformation is returned.

See also: setCoordinateTransform()

Definition at line 177 of file qgsrendercontext.h.

◆ distanceArea()

const QgsDistanceArea& QgsRenderContext::distanceArea ( ) const

inline

A general purpose distance and area calculator, capable of performing ellipsoid based calculations.

Since: QGIS 3.0

Definition at line 183 of file qgsrendercontext.h.

◆ drawEditingInformation()

bool QgsRenderContext::drawEditingInformation ( ) const

Returns true if edit markers should be drawn during the render operation.

See also: setDrawEditingInformation()

Definition at line 207 of file qgsrendercontext.cpp.

◆ expressionContext() [1/2]

QgsExpressionContext& QgsRenderContext::expressionContext ( )

inline

Gets the expression context.

This context should be used for all expression evaluation associated with this render context.

See also: setExpressionContext()

Since: QGIS 2.12

Definition at line 476 of file qgsrendercontext.h.

◆ expressionContext() [2/2]

const QgsExpressionContext& QgsRenderContext::expressionContext ( ) const

inline

Gets the expression context (const version).

This context should be used for all expression evaluation associated with this render context.

See also: setExpressionContext()

Note: not available in Python bindings

Since: QGIS 2.12

Definition at line 485 of file qgsrendercontext.h.

◆ extent()

const QgsRectangle& QgsRenderContext::extent ( ) const

inline

When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the layer's CRS).

This extent is a "worst-case" scenario, which is guaranteed to cover the complete visible portion of the layer when it is rendered to a map. It is often larger than the actual visible portion of that layer.

Warning: For some layers, depending on the visible extent and the coordinate transforms involved, this extent will represent the entire globe. This method should never be used to determine the actual visible extent of a map render.

See also: setExtent(); mapExtent()

Definition at line 238 of file qgsrendercontext.h.

◆ featureFilterProvider()

const QgsFeatureFilterProvider * QgsRenderContext::featureFilterProvider ( ) const

Gets the filter feature provider used for additional filtering of rendered features.

Returns: the filter feature provider

See also: setFeatureFilterProvider()

Since: QGIS 2.14

Definition at line 259 of file qgsrendercontext.cpp.

◆ flags()

QgsRenderContext::Flags QgsRenderContext::flags ( ) const

Returns combination of flags used for rendering.

Since: QGIS 2.14

Definition at line 147 of file qgsrendercontext.cpp.

◆ forceVectorOutput()

bool QgsRenderContext::forceVectorOutput ( ) const

Returns true if rendering operations should use vector operations instead of any faster raster shortcuts.

See also: setForceVectorOutput()

Definition at line 192 of file qgsrendercontext.cpp.

◆ fromMapSettings()

QgsRenderContext QgsRenderContext::fromMapSettings ( const QgsMapSettings & mapSettings )

static

create initialized QgsRenderContext instance from given QgsMapSettings

Since: QGIS 2.4

Definition at line 157 of file qgsrendercontext.cpp.

◆ fromQPainter()

QgsRenderContext QgsRenderContext::fromQPainter ( QPainter * painter )

static

Creates a default render context given a pixel based QPainter destination.

If no painter is specified or the painter has no device, then a default DPI of 88 will be assumed.

Since: QGIS 3.0

Definition at line 98 of file qgsrendercontext.cpp.

◆ geometry()

const QgsAbstractGeometry* QgsRenderContext::geometry ( ) const

inline

Returns pointer to the unsegmentized geometry.

Definition at line 488 of file qgsrendercontext.h.

◆ labelingEngine()

QgsLabelingEngine* QgsRenderContext::labelingEngine ( ) const

inline

Gets access to new labeling engine (may be nullptr)

Note: not available in Python bindings

Definition at line 311 of file qgsrendercontext.h.

◆ mapExtent()

QgsRectangle QgsRenderContext::mapExtent ( ) const

inline

Returns the original extent of the map being rendered.

Unlike extent(), this extent is always in the final destination CRS for the map render and represents the exact bounds of the map being rendered.

See also: extent(); setMapExtent()

Since: QGIS 3.4.8

Definition at line 250 of file qgsrendercontext.h.

◆ mapToPixel()

const QgsMapToPixel& QgsRenderContext::mapToPixel ( ) const

inline

Returns the context's map to pixel transform, which transforms between map coordinates and device coordinates.

See also: setMapToPixel()

Definition at line 257 of file qgsrendercontext.h.

◆ operator=()

QgsRenderContext & QgsRenderContext::operator= ( const QgsRenderContext & rh )

Definition at line 68 of file qgsrendercontext.cpp.

◆ painter()

QPainter* QgsRenderContext::painter ( )

inline

Returns the destination QPainter for the render operation.

See also: setPainter()

Definition at line 165 of file qgsrendercontext.h.

◆ pathResolver()

const QgsPathResolver& QgsRenderContext::pathResolver ( ) const

inline

Returns the path resolver for conversion between relative and absolute paths during rendering operations, e.g.

for resolving relative symbol paths.

See also: setPathResolver()

Since: QGIS 3.0

Definition at line 212 of file qgsrendercontext.h.

◆ rendererScale()

double QgsRenderContext::rendererScale ( ) const

inline

Returns the renderer map scale.

This will match the desired scale denominator for the rendered map, eg 1000.0 for a 1:1000 map render.

See also: setRendererScale()

Definition at line 305 of file qgsrendercontext.h.

◆ renderingStopped()

bool QgsRenderContext::renderingStopped ( ) const

inline

Returns true if the rendering operation has been stopped and any ongoing rendering should be canceled immediately.

See also: setRenderingStopped()

Definition at line 273 of file qgsrendercontext.h.

◆ scaleFactor()

double QgsRenderContext::scaleFactor ( ) const

inline

Returns the scaling factor for the render to convert painter units to physical sizes.

This is usually equal to the number of pixels per millimeter.

See also: setScaleFactor()

Definition at line 265 of file qgsrendercontext.h.

◆ segmentationTolerance()

double QgsRenderContext::segmentationTolerance ( ) const

inline

Gets the segmentation tolerance applied when rendering curved geometries.

Definition at line 513 of file qgsrendercontext.h.

◆ segmentationToleranceType()

QgsAbstractGeometry::SegmentationToleranceType QgsRenderContext::segmentationToleranceType ( ) const

inline

Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)

Definition at line 520 of file qgsrendercontext.h.

◆ selectionColor()

QColor QgsRenderContext::selectionColor ( ) const

inline

Returns the color to use when rendering selected features.

See also: setSelectionColor()

Definition at line 318 of file qgsrendercontext.h.

◆ setCoordinateTransform()

void QgsRenderContext::setCoordinateTransform ( const QgsCoordinateTransform & t )

Sets the current coordinate transform for the context.

This represents the coordinate transform required to transform the layer which is being rendered back to the CRS of the rendered map.

Set to an invalid QgsCoordinateTransform to indicate that no transformation is required.

See also: coordinateTransform()

Definition at line 217 of file qgsrendercontext.cpp.

◆ setDistanceArea()

void QgsRenderContext::setDistanceArea ( const QgsDistanceArea & distanceArea )

inline

A general purpose distance and area calculator, capable of performing ellipsoid based calculations.

Will be used to convert meter distances to active MapUnit values for QgsUnitTypes::RenderMetersInMapUnits

Since: QGIS 3.0

Definition at line 396 of file qgsrendercontext.h.

◆ setDrawEditingInformation()

void QgsRenderContext::setDrawEditingInformation ( bool b )

Sets whether edit markers should be drawn during the render operation.

See also: drawEditingInformation()

Definition at line 222 of file qgsrendercontext.cpp.

◆ setExpressionContext()

void QgsRenderContext::setExpressionContext ( const QgsExpressionContext & context )

inline

Sets the expression context.

This context is used for all expression evaluation associated with this render context.

See also: expressionContext()

Since: QGIS 2.12

Definition at line 468 of file qgsrendercontext.h.

◆ setExtent()

void QgsRenderContext::setExtent ( const QgsRectangle & extent )

inline

When rendering a map layer, calling this method sets the "clipping" extent for the layer (in the layer's CRS).

This extent should be a "worst-case" scenario, which is guaranteed to completely cover the entire visible portion of the layer when it is rendered to the map. It may be larger than the actual visible area, but MUST contain at least the entire visible area.

See also: setExtent(); setMapExtent()

Definition at line 362 of file qgsrendercontext.h.

◆ setFeatureFilterProvider()

void QgsRenderContext::setFeatureFilterProvider ( const QgsFeatureFilterProvider * ffp )

Set a filter feature provider used for additional filtering of rendered features.

Parameters

ffp	the filter feature provider

See also: featureFilterProvider()

Since: QGIS 2.14

Definition at line 247 of file qgsrendercontext.cpp.

◆ setFlag()

void QgsRenderContext::setFlag	(	QgsRenderContext::Flag	flag,
		bool	on = `true`
	)

Enable or disable a particular flag (other flags are not affected)

Since: QGIS 2.14

Definition at line 139 of file qgsrendercontext.cpp.

◆ setFlags()

void QgsRenderContext::setFlags ( QgsRenderContext::Flags flags )

Set combination of flags that will be used for rendering.

Since: QGIS 2.14

Definition at line 134 of file qgsrendercontext.cpp.

◆ setForceVectorOutput()

void QgsRenderContext::setForceVectorOutput ( bool force )

Sets whether rendering operations should use vector operations instead of any faster raster shortcuts.

See also: forceVectorOutput()

Definition at line 227 of file qgsrendercontext.cpp.

◆ setGeometry()

void QgsRenderContext::setGeometry ( const QgsAbstractGeometry * geometry )

inline

Sets pointer to original (unsegmentized) geometry.

Definition at line 490 of file qgsrendercontext.h.

◆ setLabelingEngine()

void QgsRenderContext::setLabelingEngine ( QgsLabelingEngine * engine2 )

inline

Assign new labeling engine.

Note: not available in Python bindings

Definition at line 433 of file qgsrendercontext.h.

◆ setMapExtent()

void QgsRenderContext::setMapExtent ( const QgsRectangle & extent )

inline

Sets the original extent of the map being rendered.

Unlike setExtent(), this extent is always in the final destination CRS for the map render and represents the exact bounds of the map being rendered.

See also: mapExtent(); setExtent()

Since: QGIS 3.4.8

Definition at line 374 of file qgsrendercontext.h.

◆ setMapToPixel()

void QgsRenderContext::setMapToPixel ( const QgsMapToPixel & mtp )

inline

Sets the context's map to pixel transform, which transforms between map coordinates and device coordinates.

See also: mapToPixel()

Definition at line 348 of file qgsrendercontext.h.

◆ setPainter()

void QgsRenderContext::setPainter ( QPainter * p )

inline

Sets the destination QPainter for the render operation.

Ownership of the painter is not transferred and the QPainter destination must stay alive for the duration of any rendering operations.

See also: painter()

Definition at line 419 of file qgsrendercontext.h.

◆ setPathResolver()

void QgsRenderContext::setPathResolver ( const QgsPathResolver & resolver )

inline

Sets the path resolver for conversion between relative and absolute paths during rendering operations, e.g.

for resolving relative symbol paths.

See also: pathResolver()

Since: QGIS 3.0

Definition at line 221 of file qgsrendercontext.h.

◆ setRendererScale()

void QgsRenderContext::setRendererScale ( double scale )

inline

Sets the renderer map scale.

This should match the desired scale denominator for the rendered map, eg 1000.0 for a 1:1000 map render.

See also: rendererScale()

Definition at line 411 of file qgsrendercontext.h.

◆ setRenderingStopped()

void QgsRenderContext::setRenderingStopped ( bool stopped )

inline

Sets whether the rendering operation has been stopped and any ongoing rendering should be canceled immediately.

See also: renderingStopped()

Definition at line 389 of file qgsrendercontext.h.

◆ setScaleFactor()

void QgsRenderContext::setScaleFactor ( double factor )

inline

Sets the scaling factor for the render to convert painter units to physical sizes.

This should usually be equal to the number of pixels per millimeter.

See also: scaleFactor()

Definition at line 404 of file qgsrendercontext.h.

◆ setSegmentationTolerance()

void QgsRenderContext::setSegmentationTolerance ( double tolerance )

inline

Sets the segmentation tolerance applied when rendering curved geometries.

Parameters

tolerance the segmentation tolerance

Definition at line 511 of file qgsrendercontext.h.

◆ setSegmentationToleranceType()

void QgsRenderContext::setSegmentationToleranceType ( QgsAbstractGeometry::SegmentationToleranceType type )

inline

Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)

Parameters

type	the segmentation tolerance typename

Definition at line 518 of file qgsrendercontext.h.

◆ setSelectionColor()

void QgsRenderContext::setSelectionColor ( const QColor & color )

inline

Sets the color to use when rendering selected features.

See also: selectionColor()

Definition at line 440 of file qgsrendercontext.h.

◆ setShowSelection()

void QgsRenderContext::setShowSelection ( bool showSelection )

Sets whether vector selections should be shown in the rendered map.

Parameters

showSelection set to true if selections should be shown

See also: showSelection; setSelectionColor

Since: QGIS v2.4

Definition at line 232 of file qgsrendercontext.cpp.

◆ setTextRenderFormat()

void QgsRenderContext::setTextRenderFormat ( TextRenderFormat format )

inline

Sets the text render format, which dictates how text is rendered (e.g.

as paths or real text objects).

See also: textRenderFormat()

Since: QGIS 3.4.3

Definition at line 572 of file qgsrendercontext.h.

◆ setTransformContext()

void QgsRenderContext::setTransformContext ( const QgsCoordinateTransformContext & context )

Sets the context's coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system.

See also: transformContext()

Since: QGIS 3.0

Definition at line 126 of file qgsrendercontext.cpp.

◆ setUseAdvancedEffects()

void QgsRenderContext::setUseAdvancedEffects ( bool enabled )

Used to enable or disable advanced effects such as blend modes.

Definition at line 202 of file qgsrendercontext.cpp.

◆ setUseRenderingOptimization()

void QgsRenderContext::setUseRenderingOptimization ( bool enabled )

Definition at line 242 of file qgsrendercontext.cpp.

◆ setVectorSimplifyMethod()

void QgsRenderContext::setVectorSimplifyMethod ( const QgsVectorSimplifyMethod & simplifyMethod )

inline

Definition at line 460 of file qgsrendercontext.h.

◆ showSelection()

bool QgsRenderContext::showSelection ( ) const

Returns true if vector selections should be shown in the rendered map.

Returns: true if selections should be shown

See also: setShowSelection; selectionColor

Since: QGIS v2.4

Definition at line 212 of file qgsrendercontext.cpp.

◆ testFlag()

bool QgsRenderContext::testFlag ( QgsRenderContext::Flag flag ) const

Check whether a particular flag is enabled.

Since: QGIS 2.14

Definition at line 152 of file qgsrendercontext.cpp.

◆ textRenderFormat()

TextRenderFormat QgsRenderContext::textRenderFormat ( ) const

inline

Returns the text render format, which dictates how text is rendered (e.g.

as paths or real text objects).

See also: setTextRenderFormat()

Since: QGIS 3.4.3

Definition at line 561 of file qgsrendercontext.h.

◆ transformContext()

QgsCoordinateTransformContext QgsRenderContext::transformContext ( ) const

Returns the context's coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system.

See also: setTransformContext()

Since: QGIS 3.0

Definition at line 117 of file qgsrendercontext.cpp.

◆ useAdvancedEffects()

bool QgsRenderContext::useAdvancedEffects ( ) const

Returns true if advanced effects such as blend modes such be used.

Definition at line 197 of file qgsrendercontext.cpp.

◆ useRenderingOptimization()

bool QgsRenderContext::useRenderingOptimization ( ) const

Returns true if the rendering optimization (geometry simplification) can be executed.

Definition at line 237 of file qgsrendercontext.cpp.

◆ vectorSimplifyMethod()

const QgsVectorSimplifyMethod& QgsRenderContext::vectorSimplifyMethod ( ) const

inline

Added in QGIS v2.4.

Definition at line 459 of file qgsrendercontext.h.

The documentation for this class was generated from the following files:

/tmp/buildd/qgis-3.8.0+99unstable/src/core/qgsrendercontext.h
/tmp/buildd/qgis-3.8.0+99unstable/src/core/qgsrendercontext.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Flag

◆ TextRenderFormat

Constructor & Destructor Documentation

◆ QgsRenderContext() [1/2]

◆ QgsRenderContext() [2/2]

Member Function Documentation

◆ convertFromMapUnits()

◆ convertMetersToMapUnits()

◆ convertToMapUnits()

◆ convertToPainterUnits()

◆ coordinateTransform()

◆ distanceArea()

◆ drawEditingInformation()

◆ expressionContext() [1/2]

◆ expressionContext() [2/2]

◆ extent()

◆ featureFilterProvider()

◆ flags()

◆ forceVectorOutput()

◆ fromMapSettings()

◆ fromQPainter()

◆ geometry()

◆ labelingEngine()

◆ mapExtent()

◆ mapToPixel()

◆ operator=()

◆ painter()

◆ pathResolver()

◆ rendererScale()

◆ renderingStopped()

◆ scaleFactor()

◆ segmentationTolerance()

◆ segmentationToleranceType()

◆ selectionColor()

◆ setCoordinateTransform()

◆ setDistanceArea()

◆ setDrawEditingInformation()

◆ setExpressionContext()

◆ setExtent()

◆ setFeatureFilterProvider()

◆ setFlag()

◆ setFlags()

◆ setForceVectorOutput()

◆ setGeometry()

◆ setLabelingEngine()

◆ setMapExtent()

◆ setMapToPixel()

◆ setPainter()

◆ setPathResolver()

◆ setRendererScale()

◆ setRenderingStopped()

◆ setScaleFactor()

◆ setSegmentationTolerance()

◆ setSegmentationToleranceType()

◆ setSelectionColor()

◆ setShowSelection()

◆ setTextRenderFormat()

◆ setTransformContext()

◆ setUseAdvancedEffects()

◆ setUseRenderingOptimization()

◆ setVectorSimplifyMethod()

◆ showSelection()

◆ testFlag()

◆ textRenderFormat()

◆ transformContext()

◆ useAdvancedEffects()

◆ useRenderingOptimization()

◆ vectorSimplifyMethod()