QgsRenderContext Class Reference
[QGIS core library]

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

#include <qgsrendercontext.h>

Collaboration diagram for QgsRenderContext:

List of all members.

Public Member Functions

QgsRenderContext ()

~QgsRenderContext ()

QPainter * painter ()

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

double rendererScale () const

QgsLabelingEngineInterface * labelingEngine () const

Added in QGIS v1.4.

void setCoordinateTransform (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.

Private Attributes

QPainter * mPainter

Painter for rendering operations.

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.

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

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

Constructor & Destructor Documentation

QgsRenderContext::QgsRenderContext ( )

Definition at line 21 of file qgsrendercontext.cpp.

QgsRenderContext::~QgsRenderContext ( )

Definition at line 34 of file qgsrendercontext.cpp.

References mCoordTransform.

Member Function Documentation

QPainter* QgsRenderContext::painter ( ) [inline]

Definition at line 43 of file qgsrendercontext.h.

Referenced by QgsRasterLayer::draw(), QgsVectorLayer::drawFeature(), QgsPalLabeling::drawLabeling(), QgsVectorLayer::drawLineString(), QgsVectorLayer::drawPolygon(), QgsMapRenderer::render(), QgsUniqueValueRenderer::renderFeature(), QgsSingleSymbolRenderer::renderFeature(), QgsGraduatedSymbolRenderer::renderFeature(), QgsContinuousColorRenderer::renderFeature(), QgsLabel::renderLabel(), QgsFontMarkerSymbolLayerV2::renderPoint(), QgsSvgMarkerSymbolLayerV2::renderPoint(), QgsSimpleMarkerSymbolLayerV2::renderPoint(), QgsSVGFillSymbolLayer::renderPolygon(), QgsSimpleFillSymbolLayerV2::renderPolygon(), QgsLineDecorationSymbolLayerV2::renderPolyline(), QgsSimpleLineSymbolLayerV2::renderPolyline(), QgsFeatureRendererV2::renderVertexMarker(), and QgsSvgMarkerSymbolLayerV2::startRender().

const QgsCoordinateTransform* QgsRenderContext::coordinateTransform ( ) const [inline]

Definition at line 45 of file qgsrendercontext.h.

Referenced by QgsFeatureRendererV2::_getLineString(), QgsFeatureRendererV2::_getPoint(), QgsFeatureRendererV2::_getPolygon(), QgsVectorLayer::drawFeature(), QgsPALObjectPositionManager::findObjectPositions(), QgsLabel::renderLabel(), and QgsVectorLayer::transformPoints().

const QgsRectangle& QgsRenderContext::extent ( ) const [inline]

Definition at line 47 of file qgsrendercontext.h.

Referenced by QgsRasterLayer::draw(), QgsVectorLayer::draw(), QgsPalLabeling::drawLabeling(), QgsVectorLayer::drawLabels(), and QgsPALObjectPositionManager::findObjectPositions().

const QgsMapToPixel& QgsRenderContext::mapToPixel ( ) const [inline]

Definition at line 49 of file qgsrendercontext.h.

Referenced by QgsFeatureRendererV2::_getLineString(), QgsFeatureRendererV2::_getPoint(), QgsFeatureRendererV2::_getPolygon(), QgsPalLayerSettings::checkMinimumSizeMM(), QgsRasterLayer::draw(), QgsVectorLayer::drawFeature(), QgsSymbolLayerV2Utils::lineWidthScaleFactor(), QgsSymbolLayerV2Utils::pixelSizeScaleFactor(), QgsMapRenderer::render(), QgsUniqueValueRenderer::renderFeature(), QgsSingleSymbolRenderer::renderFeature(), QgsGraduatedSymbolRenderer::renderFeature(), QgsLabel::renderLabel(), QgsPalLayerSettings::sizeToPixel(), and QgsVectorLayer::transformPoints().

double QgsRenderContext::scaleFactor ( ) const [inline]

Definition at line 51 of file qgsrendercontext.h.

Referenced by QgsPalLayerSettings::checkMinimumSizeMM(), QgsRasterLayer::draw(), QgsPALObjectPositionManager::findObjectPositions(), QgsSymbolLayerV2Utils::lineWidthScaleFactor(), QgsSymbolLayerV2Utils::pixelSizeScaleFactor(), QgsPalLabeling::prepareLayer(), QgsMapRenderer::render(), QgsUniqueValueRenderer::renderFeature(), QgsSingleSymbolRenderer::renderFeature(), QgsGraduatedSymbolRenderer::renderFeature(), QgsContinuousColorRenderer::renderFeature(), QgsLabel::renderLabel(), and QgsPalLayerSettings::sizeToPixel().

double QgsRenderContext::rasterScaleFactor ( ) const [inline]

Definition at line 53 of file qgsrendercontext.h.

Referenced by QgsRasterLayer::draw(), QgsVectorLayer::drawFeature(), QgsSymbolLayerV2Utils::pixelSizeScaleFactor(), QgsPalLabeling::prepareLayer(), QgsMapRenderer::render(), QgsUniqueValueRenderer::renderFeature(), QgsSingleSymbolRenderer::renderFeature(), QgsGraduatedSymbolRenderer::renderFeature(), QgsContinuousColorRenderer::renderFeature(), QgsLabel::renderLabel(), QgsSimpleMarkerSymbolLayerV2::renderPoint(), QgsPalLayerSettings::sizeToPixel(), QgsSimpleMarkerSymbolLayerV2::startRender(), QgsSVGFillSymbolLayer::startRender(), and QgsSimpleFillSymbolLayerV2::startRender().

bool QgsRenderContext::renderingStopped ( ) const [inline]

Definition at line 55 of file qgsrendercontext.h.

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

bool QgsRenderContext::forceVectorOutput ( ) const [inline]

Definition at line 57 of file qgsrendercontext.h.

Referenced by QgsSimpleMarkerSymbolLayerV2::startRender().

bool QgsRenderContext::drawEditingInformation ( ) const [inline]

Definition at line 59 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::drawLineString(), and QgsVectorLayer::drawPolygon().

double QgsRenderContext::rendererScale ( ) const [inline]

Definition at line 61 of file qgsrendercontext.h.

Referenced by QgsVectorLayer::drawLabels(), QgsPALObjectPositionManager::findObjectPositions(), QgsMapRenderer::render(), and QgsRuleBasedRendererV2::startRender().

QgsLabelingEngineInterface* QgsRenderContext::labelingEngine ( ) const [inline]

Added in QGIS v1.4.

Definition at line 64 of file qgsrendercontext.h.

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

void QgsRenderContext::setCoordinateTransform ( QgsCoordinateTransform * t )

Sets coordinate transformation.

QgsRenderContext takes ownership and deletes if necessary

Definition at line 39 of file qgsrendercontext.cpp.

References mCoordTransform.

Referenced by QgsMapRenderer::render(), and QgsLabel::renderLabel().

void QgsRenderContext::setMapToPixel ( const QgsMapToPixel & mtp ) [inline]

Definition at line 70 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::adjustExtentToSize(), QgsMapRenderer::render(), and QgsLabel::renderLabel().

void QgsRenderContext::setExtent ( const QgsRectangle & extent ) [inline]

Definition at line 71 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::adjustExtentToSize(), QgsMapRenderer::render(), and QgsLabel::renderLabel().

void QgsRenderContext::setDrawEditingInformation ( bool b ) [inline]

Definition at line 72 of file qgsrendercontext.h.

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

void QgsRenderContext::setRenderingStopped ( bool stopped ) [inline]

Definition at line 73 of file qgsrendercontext.h.

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

void QgsRenderContext::setScaleFactor ( double factor ) [inline]

Definition at line 74 of file qgsrendercontext.h.

Referenced by QgsSymbolLayerV2Utils::createRenderContext(), QgsMapRenderer::render(), QgsRenderer::renderFeature(), QgsLabel::renderLabel(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setRasterScaleFactor ( double factor ) [inline]

Definition at line 75 of file qgsrendercontext.h.

Referenced by QgsSymbolLayerV2Utils::createRenderContext(), QgsMapRenderer::render(), QgsRenderer::renderFeature(), QgsLabel::renderLabel(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setRendererScale ( double scale ) [inline]

Definition at line 76 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::render(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setPainter ( QPainter * p ) [inline]

Definition at line 77 of file qgsrendercontext.h.

Referenced by QgsSymbolLayerV2Utils::createRenderContext(), QgsMapRenderer::render(), QgsRenderer::renderFeature(), QgsLabel::renderLabel(), and QgsMapCanvasItem::setRenderContextVariables().

void QgsRenderContext::setForceVectorOutput ( bool force ) [inline]

Added in QGIS v1.5.

Definition at line 79 of file qgsrendercontext.h.

Referenced by QgsComposerMap::draw().

void QgsRenderContext::setLabelingEngine ( QgsLabelingEngineInterface * iface ) [inline]

Added in QGIS v1.4.

Definition at line 81 of file qgsrendercontext.h.

Referenced by QgsMapRenderer::render().

Member Data Documentation

QPainter* QgsRenderContext::mPainter [private]

Painter for rendering operations.

Definition at line 86 of file qgsrendercontext.h.

QgsCoordinateTransform* QgsRenderContext::mCoordTransform [private]

For transformation between coordinate systems.

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

Definition at line 89 of file qgsrendercontext.h.

Referenced by setCoordinateTransform(), and ~QgsRenderContext().

bool QgsRenderContext::mDrawEditingInformation [private]

True if vertex markers for editing should be drawn.

Definition at line 92 of file qgsrendercontext.h.

QgsRectangle QgsRenderContext::mExtent [private]

Definition at line 94 of file qgsrendercontext.h.

bool QgsRenderContext::mForceVectorOutput [private]

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

Definition at line 97 of file qgsrendercontext.h.

QgsMapToPixel QgsRenderContext::mMapToPixel [private]

Definition at line 99 of file qgsrendercontext.h.

bool QgsRenderContext::mRenderingStopped [private]

True if the rendering has been canceled.

Definition at line 102 of file qgsrendercontext.h.

double QgsRenderContext::mScaleFactor [private]

Factor to scale line widths and point marker sizes.

Definition at line 105 of file qgsrendercontext.h.

double QgsRenderContext::mRasterScaleFactor [private]

Factor to scale rasters.

Definition at line 108 of file qgsrendercontext.h.

double QgsRenderContext::mRendererScale [private]

Map scale.

Definition at line 111 of file qgsrendercontext.h.

QgsLabelingEngineInterface* QgsRenderContext::mLabelingEngine [private]

Labeling engine (can be NULL).

Definition at line 114 of file qgsrendercontext.h.

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

src/core/qgsrendercontext.h
src/core/qgsrendercontext.cpp


Public Member Functions
	QgsRenderContext ()
	~QgsRenderContext ()
QPainter *	painter ()
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	drawEditingInformation () const
double	rendererScale () const
QgsLabelingEngineInterface *	labelingEngine () const
	Added in QGIS v1.4.
void	setCoordinateTransform (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.
Private Attributes
QPainter *	mPainter
	Painter for rendering operations.
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.
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).

QgsRenderContext Class Reference [QGIS core library]

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

QgsRenderContext Class Reference
[QGIS core library]