QGIS API Documentation
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsRenderContext Class Reference

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
}
 Enumeration of flags that affect rendering operations. More...
 

Public Member Functions

 QgsRenderContext ()
 
 QgsRenderContext (const QgsRenderContext &rh)
 
 ~QgsRenderContext ()
 
const QPainterconstPainter () const
 
const QgsCoordinateTransformcoordinateTransform () const
 
bool drawEditingInformation () const
 
QgsExpressionContextexpressionContext ()
 Gets the expression context. More...
 
const QgsExpressionContextexpressionContext () const
 Gets the expression context (const version). More...
 
const QgsRectangleextent () const
 
const QgsFeatureFilterProviderfeatureFilterProvider () const
 Get the filter feature provider used for additional filtering of rendered features. More...
 
Flags flags () const
 Return combination of flags used for rendering. More...
 
bool forceVectorOutput () const
 
const QgsAbstractGeometryV2geometry () const
 Returns pointer to the unsegmentized geometry. More...
 
QgsLabelingEngineInterfacelabelingEngine () const
 
QgsLabelingEngineV2labelingEngineV2 () const
 Get access to new labeling engine (may be nullptr) More...
 
const QgsMapToPixelmapToPixel () const
 
QgsRenderContextoperator= (const QgsRenderContext &rh)
 
QPainterpainter ()
 
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 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 (const QgsRenderContext::Flags &flags)
 Set combination of flags that will be used for rendering. More...
 
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 testFlag (Flag flag) const
 Check whether a particular flag is enabled. 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 QgsVectorSimplifyMethodvectorSimplifyMethod () 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 44 of file qgsrendercontext.h.

Member Enumeration Documentation

Enumeration of flags that affect rendering operations.

Note
added in 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 transparency 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.

Definition at line 57 of file qgsrendercontext.h.

Constructor & Destructor Documentation

QgsRenderContext::QgsRenderContext ( )

Definition at line 26 of file qgsrendercontext.cpp.

QgsRenderContext::QgsRenderContext ( const QgsRenderContext rh)

Definition at line 42 of file qgsrendercontext.cpp.

QgsRenderContext::~QgsRenderContext ( )

Definition at line 83 of file qgsrendercontext.cpp.

Member Function Documentation

const QPainter* QgsRenderContext::constPainter ( ) const
inline

Definition at line 96 of file qgsrendercontext.h.

const QgsCoordinateTransform* QgsRenderContext::coordinateTransform ( ) const
inline

Definition at line 98 of file qgsrendercontext.h.

bool QgsRenderContext::drawEditingInformation ( ) const

Definition at line 153 of file qgsrendercontext.cpp.

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 193 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
not available in Python bindings

Definition at line 201 of file qgsrendercontext.h.

const QgsRectangle& QgsRenderContext::extent ( ) const
inline

Definition at line 100 of file qgsrendercontext.h.

const QgsFeatureFilterProvider* QgsRenderContext::featureFilterProvider ( ) const
inline

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

Returns
the filter feature provider
Note
added in QGIS 2.14
See also
setFeatureFilterProvider()

Definition at line 220 of file qgsrendercontext.h.

QgsRenderContext::Flags QgsRenderContext::flags ( ) const

Return combination of flags used for rendering.

Note
added in QGIS 2.14

Definition at line 102 of file qgsrendercontext.cpp.

bool QgsRenderContext::forceVectorOutput ( ) const

Definition at line 138 of file qgsrendercontext.cpp.

QgsRenderContext QgsRenderContext::fromMapSettings ( const QgsMapSettings mapSettings)
static

create initialized QgsRenderContext instance from given QgsMapSettings

Note
added in 2.4

Definition at line 112 of file qgsrendercontext.cpp.

const QgsAbstractGeometryV2* QgsRenderContext::geometry ( ) const
inline

Returns pointer to the unsegmentized geometry.

Definition at line 204 of file qgsrendercontext.h.

QgsLabelingEngineInterface* QgsRenderContext::labelingEngine ( ) const
inline

Definition at line 124 of file qgsrendercontext.h.

QgsLabelingEngineV2* QgsRenderContext::labelingEngineV2 ( ) const
inline

Get access to new labeling engine (may be nullptr)

Note
not available in Python bindings

Definition at line 128 of file qgsrendercontext.h.

const QgsMapToPixel& QgsRenderContext::mapToPixel ( ) const
inline

Definition at line 102 of file qgsrendercontext.h.

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

Definition at line 62 of file qgsrendercontext.cpp.

QPainter* QgsRenderContext::painter ( )
inline

Definition at line 95 of file qgsrendercontext.h.

double QgsRenderContext::rasterScaleFactor ( ) const
inline

Definition at line 106 of file qgsrendercontext.h.

double QgsRenderContext::rendererScale ( ) const
inline

Definition at line 122 of file qgsrendercontext.h.

bool QgsRenderContext::renderingStopped ( ) const
inline

Definition at line 108 of file qgsrendercontext.h.

double QgsRenderContext::scaleFactor ( ) const
inline

Definition at line 104 of file qgsrendercontext.h.

QColor QgsRenderContext::selectionColor ( ) const
inline

Definition at line 130 of file qgsrendercontext.h.

void QgsRenderContext::setCoordinateTransform ( const QgsCoordinateTransform t)

Sets coordinate transformation.

QgsRenderContext does not take ownership

Definition at line 163 of file qgsrendercontext.cpp.

void QgsRenderContext::setDrawEditingInformation ( bool  b)

Definition at line 168 of file qgsrendercontext.cpp.

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

void QgsRenderContext::setExtent ( const QgsRectangle extent)
inline

Definition at line 145 of file qgsrendercontext.h.

void QgsRenderContext::setFeatureFilterProvider ( const QgsFeatureFilterProvider ffp)

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

Parameters
ffpthe filter feature provider
Note
added in QGIS 2.14
See also
featureFilterProvider()

Definition at line 193 of file qgsrendercontext.cpp.

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

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

Note
added in QGIS 2.14

Definition at line 94 of file qgsrendercontext.cpp.

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

Set combination of flags that will be used for rendering.

Note
added in QGIS 2.14

Definition at line 89 of file qgsrendercontext.cpp.

void QgsRenderContext::setForceVectorOutput ( bool  force)

Definition at line 173 of file qgsrendercontext.cpp.

void QgsRenderContext::setGeometry ( const QgsAbstractGeometryV2 geometry)
inline

Sets pointer to original (unsegmentized) geometry.

Definition at line 206 of file qgsrendercontext.h.

void QgsRenderContext::setLabelingEngine ( QgsLabelingEngineInterface iface)
inline

Definition at line 157 of file qgsrendercontext.h.

void QgsRenderContext::setLabelingEngineV2 ( QgsLabelingEngineV2 engine2)
inline

Assign new labeling engine.

Note
not available in Python bindings

Definition at line 160 of file qgsrendercontext.h.

void QgsRenderContext::setMapToPixel ( const QgsMapToPixel mtp)
inline

Definition at line 144 of file qgsrendercontext.h.

void QgsRenderContext::setPainter ( QPainter p)
inline

Definition at line 153 of file qgsrendercontext.h.

void QgsRenderContext::setRasterScaleFactor ( double  factor)
inline

Definition at line 151 of file qgsrendercontext.h.

void QgsRenderContext::setRendererScale ( double  scale)
inline

Definition at line 152 of file qgsrendercontext.h.

void QgsRenderContext::setRenderingStopped ( bool  stopped)
inline

Definition at line 149 of file qgsrendercontext.h.

void QgsRenderContext::setScaleFactor ( double  factor)
inline

Definition at line 150 of file qgsrendercontext.h.

void QgsRenderContext::setSelectionColor ( const QColor color)
inline

Definition at line 161 of file qgsrendercontext.h.

void QgsRenderContext::setShowSelection ( const bool  showSelection)

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

Parameters
showSelectionset to true if selections should be shown
See also
showSelection
setSelectionColor
Note
Added in QGIS v2.4

Definition at line 178 of file qgsrendercontext.cpp.

void QgsRenderContext::setUseAdvancedEffects ( bool  enabled)

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

Definition at line 148 of file qgsrendercontext.cpp.

void QgsRenderContext::setUseRenderingOptimization ( bool  enabled)

Definition at line 188 of file qgsrendercontext.cpp.

void QgsRenderContext::setVectorSimplifyMethod ( const QgsVectorSimplifyMethod simplifyMethod)
inline

Definition at line 179 of file qgsrendercontext.h.

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
Note
Added in QGIS v2.4

Definition at line 158 of file qgsrendercontext.cpp.

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

Check whether a particular flag is enabled.

Note
added in QGIS 2.14

Definition at line 107 of file qgsrendercontext.cpp.

bool QgsRenderContext::useAdvancedEffects ( ) const

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

Definition at line 143 of file qgsrendercontext.cpp.

bool QgsRenderContext::useRenderingOptimization ( ) const

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

Definition at line 183 of file qgsrendercontext.cpp.

const QgsVectorSimplifyMethod& QgsRenderContext::vectorSimplifyMethod ( ) const
inline

Added in QGIS v2.4.

Definition at line 178 of file qgsrendercontext.h.


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