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

#include <qgsrendercontext.h>

Public Member Functions
	QgsRenderContext ()

	~QgsRenderContext ()

const QPainter *	constPainter () const

const QgsCoordinateTransform *	coordinateTransform () const

bool	drawEditingInformation () const

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

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

const QgsRectangle &	extent () const

bool	forceVectorOutput () const

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

QgsLabelingEngineInterface *	labelingEngine () const

QgsLabelingEngineV2 *	labelingEngineV2 () const
	Get access to new labeling engine (may be NULL) More...

const QgsMapToPixel &	mapToPixel () const

QPainter *	painter ()

double	rasterScaleFactor () const

double	rendererScale () const

bool	renderingStopped () const

double	scaleFactor () const

QColor	selectionColor () const

void	setCoordinateTransform (const QgsCoordinateTransform *t)
	Sets coordinate transformation. More...

void	setDrawEditingInformation (bool b)

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

void	setExtent (const QgsRectangle &extent)

void	setForceVectorOutput (bool force)

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

void	setLabelingEngine (QgsLabelingEngineInterface *iface)

void	setLabelingEngineV2 (QgsLabelingEngineV2 *engine2)
	Assign new labeling engine. More...

void	setMapToPixel (const QgsMapToPixel &mtp)

void	setPainter (QPainter *p)

void	setRasterScaleFactor (double factor)

void	setRendererScale (double scale)

void	setRenderingStopped (bool stopped)

void	setScaleFactor (double factor)

void	setSelectionColor (const QColor &color)

void	setShowSelection (const bool showSelection)
	Sets whether vector selections should be shown in the rendered map. 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	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...

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 / bounding box to be rendered etc.

Definition at line 42 of file qgsrendercontext.h.

Constructor & Destructor Documentation

QgsRenderContext::QgsRenderContext ( )

Definition at line 23 of file qgsrendercontext.cpp.

QgsRenderContext::~QgsRenderContext ( )

Definition at line 42 of file qgsrendercontext.cpp.

Member Function Documentation

const QPainter* QgsRenderContext::constPainter ( ) const

inline

Definition at line 55 of file qgsrendercontext.h.

const QgsCoordinateTransform* QgsRenderContext::coordinateTransform ( ) const

inline

Definition at line 57 of file qgsrendercontext.h.

bool QgsRenderContext::drawEditingInformation ( ) const

inline

Definition at line 76 of file qgsrendercontext.h.

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()

Note: added in QGIS 2.12

Definition at line 141 of file qgsrendercontext.h.

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: added in QGIS 2.12

Definition at line 148 of file qgsrendercontext.h.

const QgsRectangle& QgsRenderContext::extent ( ) const

inline

Definition at line 59 of file qgsrendercontext.h.

bool QgsRenderContext::forceVectorOutput ( ) const

inline

Definition at line 69 of file qgsrendercontext.h.

QgsRenderContext QgsRenderContext::fromMapSettings ( const QgsMapSettings & mapSettings )

static

create initialized QgsRenderContext instance from given QgsMapSettings

Note: added in 2.4

Definition at line 46 of file qgsrendercontext.cpp.

const QgsAbstractGeometryV2* QgsRenderContext::geometry ( ) const

inline

Returns pointer to the unsegmentized geometry.

Definition at line 151 of file qgsrendercontext.h.

QgsLabelingEngineInterface* QgsRenderContext::labelingEngine ( ) const

inline

Definition at line 80 of file qgsrendercontext.h.

QgsLabelingEngineV2* QgsRenderContext::labelingEngineV2 ( ) const

inline

Get access to new labeling engine (may be NULL)

Definition at line 83 of file qgsrendercontext.h.

const QgsMapToPixel& QgsRenderContext::mapToPixel ( ) const

inline

Definition at line 61 of file qgsrendercontext.h.

QPainter* QgsRenderContext::painter ( )

inline

Definition at line 54 of file qgsrendercontext.h.

double QgsRenderContext::rasterScaleFactor ( ) const

inline

Definition at line 65 of file qgsrendercontext.h.

double QgsRenderContext::rendererScale ( ) const

inline

Definition at line 78 of file qgsrendercontext.h.

bool QgsRenderContext::renderingStopped ( ) const

inline

Definition at line 67 of file qgsrendercontext.h.

double QgsRenderContext::scaleFactor ( ) const

inline

Definition at line 63 of file qgsrendercontext.h.

QColor QgsRenderContext::selectionColor ( ) const

inline

Definition at line 85 of file qgsrendercontext.h.

void QgsRenderContext::setCoordinateTransform ( const QgsCoordinateTransform * t )

Sets coordinate transformation.

QgsRenderContext does not take ownership

Definition at line 70 of file qgsrendercontext.cpp.

void QgsRenderContext::setDrawEditingInformation ( bool b )

inline

Definition at line 101 of file qgsrendercontext.h.

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()

Note: added in QGIS 2.12

Definition at line 134 of file qgsrendercontext.h.

void QgsRenderContext::setExtent ( const QgsRectangle & extent )

inline

Definition at line 100 of file qgsrendercontext.h.

void QgsRenderContext::setForceVectorOutput ( bool force )

inline

Definition at line 107 of file qgsrendercontext.h.

void QgsRenderContext::setGeometry ( const QgsAbstractGeometryV2 * geometry )

inline

Sets pointer to original (unsegmentized) geometry.

Definition at line 153 of file qgsrendercontext.h.

void QgsRenderContext::setLabelingEngine ( QgsLabelingEngineInterface * iface )

inline

Definition at line 108 of file qgsrendercontext.h.

void QgsRenderContext::setLabelingEngineV2 ( QgsLabelingEngineV2 * engine2 )

inline

Assign new labeling engine.

Definition at line 110 of file qgsrendercontext.h.

void QgsRenderContext::setMapToPixel ( const QgsMapToPixel & mtp )

inline

Definition at line 99 of file qgsrendercontext.h.

void QgsRenderContext::setPainter ( QPainter * p )

inline

Definition at line 106 of file qgsrendercontext.h.

void QgsRenderContext::setRasterScaleFactor ( double factor )

inline

Definition at line 104 of file qgsrendercontext.h.

void QgsRenderContext::setRendererScale ( double scale )

inline

Definition at line 105 of file qgsrendercontext.h.

void QgsRenderContext::setRenderingStopped ( bool stopped )

inline

Definition at line 102 of file qgsrendercontext.h.

void QgsRenderContext::setScaleFactor ( double factor )

inline

Definition at line 103 of file qgsrendercontext.h.

void QgsRenderContext::setSelectionColor ( const QColor & color )

inline

Definition at line 111 of file qgsrendercontext.h.

void QgsRenderContext::setShowSelection ( const bool showSelection )

inline

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

Note: Added in QGIS v2.4

Definition at line 119 of file qgsrendercontext.h.

void QgsRenderContext::setUseAdvancedEffects ( bool enabled )

inline

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

Definition at line 74 of file qgsrendercontext.h.

void QgsRenderContext::setUseRenderingOptimization ( bool enabled )

inline

Definition at line 123 of file qgsrendercontext.h.

void QgsRenderContext::setVectorSimplifyMethod ( const QgsVectorSimplifyMethod & simplifyMethod )

inline

Definition at line 127 of file qgsrendercontext.h.

bool QgsRenderContext::showSelection ( ) const

inline

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

Returns: true if selections should be shown

See also: setShowSelection; selectionColor

Note: Added in QGIS v2.4

Definition at line 93 of file qgsrendercontext.h.

bool QgsRenderContext::useAdvancedEffects ( ) const

inline

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

Definition at line 72 of file qgsrendercontext.h.

bool QgsRenderContext::useRenderingOptimization ( ) const

inline

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

Definition at line 122 of file qgsrendercontext.h.

const QgsVectorSimplifyMethod& QgsRenderContext::vectorSimplifyMethod ( ) const

inline

Added in QGIS v2.4.

Definition at line 126 of file qgsrendercontext.h.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation