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

#include <qgsrendercontext.h>

Collaboration diagram for QgsRenderContext:

Public Member Functions
	QgsRenderContext ()
	~QgsRenderContext ()
QPainter *	painter ()
const QPainter *	constPainter () const
const QgsCoordinateTransform *	coordinateTransform () const
const QgsRectangle &	extent () const
const QgsMapToPixel &	mapToPixel () const
double	scaleFactor () const
double	rasterScaleFactor () const
bool	renderingStopped () const
bool	forceVectorOutput () const
bool	useAdvancedEffects () const
	Returns true if advanced effects such as blend modes such be used.
void	setUseAdvancedEffects (bool enabled)
	Used to enable or disable advanced effects such as blend modes.
bool	drawEditingInformation () const
double	rendererScale () const
QgsLabelingEngineInterface *	labelingEngine () const
	Added in QGIS v1.4.
QColor	selectionColor () const
	Added in QGIS v2.0.
void	setCoordinateTransform (const QgsCoordinateTransform *t)
	Sets coordinate transformation.
void	setMapToPixel (const QgsMapToPixel &mtp)
void	setExtent (const QgsRectangle &extent)
void	setDrawEditingInformation (bool b)
void	setRenderingStopped (bool stopped)
void	setScaleFactor (double factor)
void	setRasterScaleFactor (double factor)
void	setRendererScale (double scale)
void	setPainter (QPainter *p)
void	setForceVectorOutput (bool force)
	Added in QGIS v1.5.
void	setLabelingEngine (QgsLabelingEngineInterface *iface)
	Added in QGIS v1.4.
void	setSelectionColor (const QColor &color)
	Added in QGIS v2.0.
bool	useRenderingOptimization () const
	Returns true if the rendering optimization (geometry simplification) can be executed.
void	setUseRenderingOptimization (bool enabled)

Private Attributes
QPainter *	mPainter
	Painter for rendering operations.
const QgsCoordinateTransform *	mCoordTransform
	For transformation between coordinate systems.
bool	mDrawEditingInformation
	True if vertex markers for editing should be drawn.
QgsRectangle	mExtent
bool	mForceVectorOutput
	If true then no rendered vector elements should be cached as image.
bool	mUseAdvancedEffects
	Flag if advanced visual effects such as blend modes should be used.
QgsMapToPixel	mMapToPixel
bool	mRenderingStopped
	True if the rendering has been canceled.
double	mScaleFactor
	Factor to scale line widths and point marker sizes.
double	mRasterScaleFactor
	Factor to scale rasters.
double	mRendererScale
	Map scale.
QgsLabelingEngineInterface *	mLabelingEngine
	Labeling engine (can be NULL)
QColor	mSelectionColor
	Color used for features that are marked as selected.
bool	mUseRenderingOptimization
	True if the rendering optimization (geometry simplification) can be executed.

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 37 of file qgsrendercontext.h.

Constructor & Destructor Documentation

QgsRenderContext::QgsRenderContext ( )

Definition at line 21 of file qgsrendercontext.cpp.

QgsRenderContext::~QgsRenderContext ( )

Definition at line 37 of file qgsrendercontext.cpp.

Member Function Documentation

const QPainter* QgsRenderContext::constPainter ( ) const

inline

Definition at line 46 of file qgsrendercontext.h.

const QgsCoordinateTransform* QgsRenderContext::coordinateTransform ( ) const

inline

Definition at line 48 of file qgsrendercontext.h.

Referenced by QgsFeatureRendererV2::_getLineString(), QgsFeatureRendererV2::_getPoint(), QgsFeatureRendererV2::_getPolygon(), QgsRasterLayer::draw(), QgsVectorLayer::draw(), and QgsLabel::renderLabel().

bool QgsRenderContext::drawEditingInformation ( ) const

inline

Definition at line 69 of file qgsrendercontext.h.

const QgsRectangle& QgsRenderContext::extent ( ) const

inline

Definition at line 50 of file qgsrendercontext.h.

Referenced by QgsFeatureRendererV2::_getLineString(), QgsFeatureRendererV2::_getPolygon(), QgsRasterLayer::draw(), QgsVectorLayer::draw(), QgsPalLabeling::drawLabeling(), QgsVectorLayer::drawLabels(), QgsAttributeTableFilterModel::generateListOfVisibleFeatures(), QgsVectorLayer::prepareLabelingAndDiagrams(), and QgsPointDisplacementRenderer::startRender().

bool QgsRenderContext::forceVectorOutput ( ) const

inline

Definition at line 60 of file qgsrendercontext.h.

Referenced by QgsSvgMarkerSymbolLayerV2::renderPoint(), and QgsSimpleMarkerSymbolLayerV2::startRender().

QgsLabelingEngineInterface* QgsRenderContext::labelingEngine ( ) const

inline

Added in QGIS v1.4.

Definition at line 74 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::drawRendererV2(), QgsVectorLayer::drawRendererV2Levels(), QgsVectorLayer::prepareLabelingAndDiagrams(), and QgsMapRenderer::render().

const QgsMapToPixel& QgsRenderContext::mapToPixel ( ) const

inline

QPainter* QgsRenderContext::painter ( )

inline

Definition at line 45 of file qgsrendercontext.h.

Referenced by QgsRasterLayer::draw(), QgsVectorLayer::draw(), QgsPointDisplacementRenderer::drawCircle(), QgsPalLabeling::drawLabel(), QgsPalLabeling::drawLabelBackground(), QgsPalLabeling::drawLabelBuffer(), QgsPalLabeling::drawLabeling(), QgsPointDisplacementRenderer::drawLabels(), QgsPalLabeling::drawLabelShadow(), QgsVectorFieldSymbolLayer::drawPreviewIcon(), QgsMapRenderer::render(), QgsPointDisplacementRenderer::renderFeature(), QgsLabel::renderLabel(), QgsEllipseSymbolLayerV2::renderPoint(), QgsSimpleMarkerSymbolLayerV2::renderPoint(), QgsSvgMarkerSymbolLayerV2::renderPoint(), QgsFontMarkerSymbolLayerV2::renderPoint(), QgsSimpleFillSymbolLayerV2::renderPolygon(), QgsGradientFillSymbolLayerV2::renderPolygon(), QgsImageFillSymbolLayer::renderPolygon(), QgsSimpleLineSymbolLayerV2::renderPolyline(), and QgsFeatureRendererV2::renderVertexMarker().

double QgsRenderContext::rasterScaleFactor ( ) const

inline

Definition at line 56 of file qgsrendercontext.h.

Referenced by QgsSVGFillSymbolLayer::applyPattern(), QgsLinePatternFillSymbolLayer::applyPattern(), QgsPointPatternFillSymbolLayer::applyPattern(), QgsRasterLayer::draw(), QgsPointDisplacementRenderer::drawLabels(), QgsSymbolLayerV2Utils::pixelSizeScaleFactor(), QgsPalLabeling::prepareLayer(), QgsMapRenderer::render(), QgsLabel::renderLabel(), QgsSimpleMarkerSymbolLayerV2::renderPoint(), QgsSvgMarkerSymbolLayerV2::renderPoint(), QgsPalLayerSettings::scaleToPixelContext(), QgsSimpleFillSymbolLayerV2::startRender(), QgsSimpleLineSymbolLayerV2::startRender(), and QgsSimpleMarkerSymbolLayerV2::startRender().

double QgsRenderContext::rendererScale ( ) const

inline

Definition at line 71 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::drawLabels(), QgsPalLabeling::prepareLayer(), QgsPalLayerSettings::registerFeature(), QgsMapRenderer::render(), QgsVectorLayer::simplifyDrawingCanbeApplied(), QgsEllipseSymbolLayerV2::startRender(), QgsPointDisplacementRenderer::startRender(), QgsSimpleFillSymbolLayerV2::startRender(), QgsSimpleLineSymbolLayerV2::startRender(), QgsSimpleMarkerSymbolLayerV2::startRender(), QgsRuleBasedRendererV2::Rule::startRender(), QgsSvgMarkerSymbolLayerV2::startRender(), QgsMarkerLineSymbolLayerV2::startRender(), QgsSVGFillSymbolLayer::startRender(), QgsLinePatternFillSymbolLayer::startRender(), and QgsPointPatternFillSymbolLayer::startRender().

bool QgsRenderContext::renderingStopped ( ) const

inline

Definition at line 58 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::drawRendererV2(), QgsVectorLayer::drawRendererV2Levels(), and QgsMapRenderer::render().

double QgsRenderContext::scaleFactor ( ) const

inline

Definition at line 54 of file qgsrendercontext.h.

Referenced by QgsSVGFillSymbolLayer::applyPattern(), QgsLinePatternFillSymbolLayer::applyPattern(), QgsPointPatternFillSymbolLayer::applyPattern(), QgsPalLayerSettings::checkMinimumSizeMM(), QgsDiagramRendererV2::convertSizeToMapUnits(), QgsRasterLayer::draw(), QgsPalLabeling::drawLabelBackground(), QgsSymbolLayerV2Utils::lineWidthScaleFactor(), QgsSymbolLayerV2Utils::pixelSizeScaleFactor(), QgsPalLabeling::prepareLayer(), QgsPalLayerSettings::registerFeature(), QgsMapRenderer::render(), QgsLabel::renderLabel(), QgsSvgMarkerSymbolLayerV2::renderPoint(), and QgsPalLayerSettings::scaleToPixelContext().

QColor QgsRenderContext::selectionColor ( ) const

inline

Added in QGIS v2.0.

Definition at line 77 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::drawRendererV2Levels(), QgsSimpleMarkerSymbolLayerV2::prepareCache(), QgsSvgMarkerSymbolLayerV2::renderPoint(), QgsFontMarkerSymbolLayerV2::renderPoint(), QgsImageFillSymbolLayer::renderPolygon(), QgsSimpleFillSymbolLayerV2::startRender(), QgsSimpleLineSymbolLayerV2::startRender(), QgsSimpleMarkerSymbolLayerV2::startRender(), and QgsGradientFillSymbolLayerV2::startRender().

void QgsRenderContext::setCoordinateTransform ( const QgsCoordinateTransform * t )

Sets coordinate transformation.

QgsRenderContext does not take ownership

Definition at line 41 of file qgsrendercontext.cpp.

References mCoordTransform.

Referenced by QgsHighlight::paint(), and QgsMapRenderer::render().

void QgsRenderContext::setDrawEditingInformation ( bool b )

inline

Definition at line 85 of file qgsrendercontext.h.

Referenced by QgsComposerMap::draw(), and QgsMapRenderer::render().

void QgsRenderContext::setExtent ( const QgsRectangle & extent )

inline

Definition at line 84 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::adjustExtentToSize(), QgsAttributeTableFilterModel::generateListOfVisibleFeatures(), QgsHighlight::paint(), and QgsMapRenderer::render().

void QgsRenderContext::setForceVectorOutput ( bool force )

inline

Added in QGIS v1.5.

Definition at line 92 of file qgsrendercontext.h.

Referenced by QgsLinePatternFillSymbolLayer::applyPattern(), QgsPointPatternFillSymbolLayer::applyPattern(), QgsComposerMap::draw(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setLabelingEngine ( QgsLabelingEngineInterface * iface )

inline

Added in QGIS v1.4.

Definition at line 94 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::render().

void QgsRenderContext::setMapToPixel ( const QgsMapToPixel & mtp )

inline

Definition at line 83 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::adjustExtentToSize(), QgsLinePatternFillSymbolLayer::applyPattern(), QgsPointPatternFillSymbolLayer::applyPattern(), QgsPalLabeling::drawLabelBackground(), QgsAttributeTableFilterModel::generateListOfVisibleFeatures(), QgsHighlight::paint(), and QgsMapRenderer::render().

void QgsRenderContext::setPainter ( QPainter * p )

inline

Definition at line 90 of file qgsrendercontext.h.

Referenced by QgsLinePatternFillSymbolLayer::applyPattern(), QgsPointPatternFillSymbolLayer::applyPattern(), QgsSymbolLayerV2Utils::createRenderContext(), QgsComposerMap::drawGridLine(), QgsPalLabeling::drawLabelBackground(), QgsComposerMap::drawOverviewMapExtent(), QgsComposerShape::drawShapeUsingSymbol(), QgsPaperItem::paint(), QgsHighlight::paint(), QgsMapRenderer::render(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setRasterScaleFactor ( double factor )

inline

Definition at line 88 of file qgsrendercontext.h.

Referenced by QgsLinePatternFillSymbolLayer::applyPattern(), QgsPointPatternFillSymbolLayer::applyPattern(), QgsSymbolLayerV2Utils::createRenderContext(), QgsComposerMap::drawGridLine(), QgsComposerMap::drawOverviewMapExtent(), QgsComposerShape::drawShapeUsingSymbol(), QgsPaperItem::paint(), QgsMapRenderer::render(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setRendererScale ( double scale )

inline

Definition at line 89 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::countSymbolFeatures(), QgsAttributeTableFilterModel::generateListOfVisibleFeatures(), QgsMapRenderer::render(), QgsVectorFileWriter::renderContext(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setRenderingStopped ( bool stopped )

inline

Definition at line 86 of file qgsrendercontext.h.

Referenced by QgsComposerMap::draw(), QgsVectorLayer::onCacheImageDelete(), QgsMapCanvas::paintEvent(), QgsMapRenderer::render(), and QgsMapCanvas::setRenderFlag().

void QgsRenderContext::setScaleFactor ( double factor )

inline

Definition at line 87 of file qgsrendercontext.h.

Referenced by QgsLinePatternFillSymbolLayer::applyPattern(), QgsPointPatternFillSymbolLayer::applyPattern(), QgsSymbolLayerV2Utils::createRenderContext(), QgsComposerMap::drawGridLine(), QgsPalLabeling::drawLabelBackground(), QgsComposerMap::drawOverviewMapExtent(), QgsComposerShape::drawShapeUsingSymbol(), QgsPaperItem::paint(), QgsMapRenderer::render(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setSelectionColor ( const QColor & color )

inline

Added in QGIS v2.0.

Definition at line 96 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::render().

void QgsRenderContext::setUseAdvancedEffects ( bool enabled )

inline

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

Note: : added in version 1.9

Definition at line 67 of file qgsrendercontext.h.

Referenced by QgsComposerMap::draw().

void QgsRenderContext::setUseRenderingOptimization ( bool enabled )

inline

Definition at line 100 of file qgsrendercontext.h.

Referenced by QgsComposerMap::draw().

bool QgsRenderContext::useAdvancedEffects ( ) const

inline

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

Note: added in 1.9

Definition at line 64 of file qgsrendercontext.h.

Referenced by QgsPalLabeling::drawLabel(), QgsPalLabeling::drawLabelBackground(), QgsPalLabeling::drawLabelBuffer(), QgsPalLabeling::drawLabelShadow(), and QgsMapRenderer::render().

bool QgsRenderContext::useRenderingOptimization ( ) const

inline

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

Definition at line 99 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::simplifyDrawingCanbeApplied().

Member Data Documentation

const QgsCoordinateTransform* QgsRenderContext::mCoordTransform

private

For transformation between coordinate systems.

Can be 0 if on-the-fly reprojection is not used

Definition at line 108 of file qgsrendercontext.h.

Referenced by setCoordinateTransform().

bool QgsRenderContext::mDrawEditingInformation

private

True if vertex markers for editing should be drawn.

Definition at line 111 of file qgsrendercontext.h.

QgsRectangle QgsRenderContext::mExtent

private

Definition at line 113 of file qgsrendercontext.h.

bool QgsRenderContext::mForceVectorOutput

private

If true then no rendered vector elements should be cached as image.

Definition at line 116 of file qgsrendercontext.h.

QgsLabelingEngineInterface* QgsRenderContext::mLabelingEngine

private

Labeling engine (can be NULL)

Definition at line 136 of file qgsrendercontext.h.

QgsMapToPixel QgsRenderContext::mMapToPixel

private

Definition at line 121 of file qgsrendercontext.h.

QPainter* QgsRenderContext::mPainter

private

Painter for rendering operations.

Definition at line 105 of file qgsrendercontext.h.

double QgsRenderContext::mRasterScaleFactor

private

Factor to scale rasters.

Definition at line 130 of file qgsrendercontext.h.

double QgsRenderContext::mRendererScale

private

Map scale.

Definition at line 133 of file qgsrendercontext.h.

bool QgsRenderContext::mRenderingStopped

private

True if the rendering has been canceled.

Definition at line 124 of file qgsrendercontext.h.

double QgsRenderContext::mScaleFactor

private

Factor to scale line widths and point marker sizes.

Definition at line 127 of file qgsrendercontext.h.

QColor QgsRenderContext::mSelectionColor

private

Color used for features that are marked as selected.

Definition at line 139 of file qgsrendercontext.h.

bool QgsRenderContext::mUseAdvancedEffects

private

Flag if advanced visual effects such as blend modes should be used.

True by default

Definition at line 119 of file qgsrendercontext.h.

bool QgsRenderContext::mUseRenderingOptimization

private

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

Definition at line 142 of file qgsrendercontext.h.

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

/tmp/buildd/qgis-2.2.0+wheezy1/src/core/qgsrendercontext.h
/tmp/buildd/qgis-2.2.0+wheezy1/src/core/qgsrendercontext.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation