QGIS API Documentation  2.99.0-Master (c558d51)
Classes | Public Member Functions | Static Public Member Functions | List of all members
QgsInvertedPolygonRenderer Class Reference

QgsInvertedPolygonRenderer is a polygon-only feature renderer used to display features inverted, where the exterior is turned to an interior and where the exterior theoretically spans the entire plane, allowing to mask the surroundings of some features. More...

#include <qgsinvertedpolygonrenderer.h>

Inheritance diagram for QgsInvertedPolygonRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsInvertedPolygonRenderer (QgsFeatureRenderer *embeddedRenderer=nullptr)
 Constructor. More...
 
virtual ~QgsInvertedPolygonRenderer ()
 
virtual Capabilities capabilities () override
 Proxy that will call this method on the embedded renderer. More...
 
virtual void checkLegendSymbolItem (const QString &key, bool state=true) override
 item in symbology was checked More...
 
virtual QgsInvertedPolygonRendererclone () const override
 Create a deep copy of this renderer. More...
 
virtual QString dump () const override
 Returns debug information about this renderer. More...
 
const QgsFeatureRendererembeddedRenderer () const override
 Returns the current embedded renderer (subrenderer) for this feature renderer. More...
 
virtual bool legendSymbolItemChecked (const QString &key) override
 items of symbology items in legend is checked More...
 
virtual QgsLegendSymbolList legendSymbolItems (double scaleDenominator=-1, const QString &rule="") override
 Proxy that will call this method on the embedded renderer. More...
 
virtual bool legendSymbolItemsCheckable () const override
 items of symbology items in legend should be checkable More...
 
virtual QgsLegendSymbologyList legendSymbologyItems (QSize iconSize) override
 Proxy that will call this method on the embedded renderer. More...
 
virtual QgsSymboloriginalSymbolForFeature (QgsFeature &feat, QgsRenderContext &context) override
 Proxy that will call this method on the embedded renderer. More...
 
virtual QgsSymbolList originalSymbolsForFeature (QgsFeature &feat, QgsRenderContext &context) override
 Proxy that will call this method on the embedded renderer. More...
 
bool preprocessingEnabled () const
 
virtual bool renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override
 Renders a given feature. More...
 
virtual QDomElement save (QDomDocument &doc) override
 store renderer info to XML element More...
 
void setEmbeddedRenderer (QgsFeatureRenderer *subRenderer) override
 Sets an embedded renderer (subrenderer) for this feature renderer. More...
 
virtual void setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override
 Sets the symbol to be used for a legend symbol item. More...
 
void setPreprocessingEnabled (bool enabled)
 
virtual void startRender (QgsRenderContext &context, const QgsFields &fields) override
 Needs to be called when a new render cycle is started. More...
 
virtual void stopRender (QgsRenderContext &context) override
 The actual rendering will take place here. More...
 
virtual QgsSymbolsymbolForFeature (QgsFeature &feature, QgsRenderContext &context) override
 Proxy that will call this method on the embedded renderer. More...
 
virtual QgsSymbolList symbols (QgsRenderContext &context) override
 Proxy that will call this method on the embedded renderer. More...
 
virtual QgsSymbolList symbolsForFeature (QgsFeature &feat, QgsRenderContext &context) override
 Proxy that will call this method on the embedded renderer. More...
 
virtual QSet< QString > usedAttributes () const override
 Proxy that will call this method on the embedded renderer. More...
 
virtual bool willRenderFeature (QgsFeature &feat, QgsRenderContext &context) override
 Proxy that will call this method on the embedded renderer. More...
 
- Public Member Functions inherited from QgsFeatureRenderer
virtual ~QgsFeatureRenderer ()
 
virtual QString filter (const QgsFields &fields=QgsFields())
 If a renderer does not require all the features this method may be overridden and return an expression used as where clause. More...
 
virtual bool filterNeedsGeometry () const
 Returns true if this renderer requires the geometry to apply the filter. More...
 
bool forceRasterRender () const
 Returns whether the renderer must render as a raster. More...
 
virtual QString legendClassificationAttribute () const
 If supported by the renderer, return classification attribute for the use in legend. More...
 
virtual QSet< QString > legendKeysForFeature (QgsFeature &feature, QgsRenderContext &context)
 Return legend keys matching a specified feature. More...
 
virtual QgsLegendSymbolListV2 legendSymbolItemsV2 () const
 Return a list of symbology items for the legend. More...
 
virtual void modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context)
 Allows for a renderer to modify the extent of a feature request prior to rendering. More...
 
QgsFeatureRequest::OrderBy orderBy () const
 Get the order in which features shall be processed by this renderer. More...
 
bool orderByEnabled () const
 Returns whether custom ordering will be applied before features are processed by this renderer. More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the renderer. More...
 
void setForceRasterRender (bool forceRaster)
 Sets whether the renderer should be rendered to a raster destination. More...
 
void setOrderBy (const QgsFeatureRequest::OrderBy &orderBy)
 Define the order in which features shall be processed by this renderer. More...
 
void setOrderByEnabled (bool enabled)
 Sets whether custom ordering should be applied before features are processed by this renderer. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the renderer. More...
 
void setUsingSymbolLevels (bool usingSymbolLevels)
 
void setVertexMarkerAppearance (int type, int size)
 set type and size of editing vertex markers for subsequent rendering More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
QString type () const
 
bool usingSymbolLevels () const
 
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName, const QgsStringMap &props=QgsStringMap()) const
 create the SLD UserStyle element following the SLD v1.1 specs with the given name More...
 

Static Public Member Functions

static QgsInvertedPolygonRendererconvertFromRenderer (const QgsFeatureRenderer *renderer)
 Creates a QgsInvertedPolygonRenderer by a conversion from an existing renderer. More...
 
static QgsFeatureRenderercreate (QDomElement &element)
 Creates a renderer out of an XML, for loading. More...
 
- Static Public Member Functions inherited from QgsFeatureRenderer
static QgsFeatureRendererdefaultRenderer (QgsWkbTypes::GeometryType geomType)
 return a new renderer - used by default in vector layers More...
 
static QgsFeatureRendererload (QDomElement &symbologyElem)
 create a renderer from XML element More...
 
static QgsFeatureRendererloadSld (const QDomNode &node, QgsWkbTypes::GeometryType geomType, QString &errorMessage)
 Create a new renderer according to the information contained in the UserStyle element of a SLD style document. More...
 

Additional Inherited Members

- Public Types inherited from QgsFeatureRenderer
enum  Capability { SymbolLevels = 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 }
 Used to specify details about a renderer. More...
 
- Protected Member Functions inherited from QgsFeatureRenderer
 QgsFeatureRenderer (const QString &type)
 
void copyRendererData (QgsFeatureRenderer *destRenderer) const
 Clones generic renderer data to another renderer. More...
 
void renderFeatureWithSymbol (QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
 
void renderVertexMarker (QPointF pt, QgsRenderContext &context)
 render editing vertex marker at specified point More...
 
void renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
 render editing vertex marker for a polygon More...
 
void renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
 render editing vertex marker for a polyline More...
 
- Static Protected Member Functions inherited from QgsFeatureRenderer
static QPointF _getPoint (QgsRenderContext &context, const QgsPointV2 &point)
 Creates a point in screen coordinates from a wkb string in map coordinates. More...
 
static void convertSymbolRotation (QgsSymbol *symbol, const QString &field)
 
static void convertSymbolSizeScale (QgsSymbol *symbol, QgsSymbol::ScaleMethod method, const QString &field)
 
- Protected Attributes inherited from QgsFeatureRenderer
int mCurrentVertexMarkerSize
 The current size of editing marker. More...
 
int mCurrentVertexMarkerType
 The current type of editing marker. More...
 
bool mForceRaster
 
QgsFeatureRequest::OrderBy mOrderBy
 
bool mOrderByEnabled
 
QgsPaintEffectmPaintEffect
 
QString mType
 
bool mUsingSymbolLevels
 

Detailed Description

QgsInvertedPolygonRenderer is a polygon-only feature renderer used to display features inverted, where the exterior is turned to an interior and where the exterior theoretically spans the entire plane, allowing to mask the surroundings of some features.

It is designed on top of another feature renderer, which is called "embedded" Most of the methods are then only proxies to the embedded renderer.

Features are collected to form one "inverted" polygon during renderFeature() and rendered on stopRender().

Note
added in 2.4

Definition at line 39 of file qgsinvertedpolygonrenderer.h.

Constructor & Destructor Documentation

QgsInvertedPolygonRenderer::QgsInvertedPolygonRenderer ( QgsFeatureRenderer embeddedRenderer = nullptr)

Constructor.

Parameters
embeddedRendereroptional embeddedRenderer. If null, a default one will be assigned. Ownership will be transferred.

Definition at line 32 of file qgsinvertedpolygonrenderer.cpp.

QgsInvertedPolygonRenderer::~QgsInvertedPolygonRenderer ( )
virtual

Definition at line 46 of file qgsinvertedpolygonrenderer.cpp.

Member Function Documentation

QgsFeatureRenderer::Capabilities QgsInvertedPolygonRenderer::capabilities ( )
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 462 of file qgsinvertedpolygonrenderer.cpp.

void QgsInvertedPolygonRenderer::checkLegendSymbolItem ( const QString &  key,
bool  state = true 
)
overridevirtual

item in symbology was checked

Note
added in 2.5

Reimplemented from QgsFeatureRenderer.

Definition at line 91 of file qgsinvertedpolygonrenderer.cpp.

QgsInvertedPolygonRenderer * QgsInvertedPolygonRenderer::clone ( ) const
overridevirtual

Create a deep copy of this renderer.

Should be implemented by all subclasses and generate a proper subclass.

Returns
A copy of this renderer

Implements QgsFeatureRenderer.

Definition at line 364 of file qgsinvertedpolygonrenderer.cpp.

QgsInvertedPolygonRenderer * QgsInvertedPolygonRenderer::convertFromRenderer ( const QgsFeatureRenderer renderer)
static

Creates a QgsInvertedPolygonRenderer by a conversion from an existing renderer.

Note
added in 2.5
Returns
a new renderer if the conversion was possible, otherwise 0.

Definition at line 507 of file qgsinvertedpolygonrenderer.cpp.

QgsFeatureRenderer * QgsInvertedPolygonRenderer::create ( QDomElement &  element)
static

Creates a renderer out of an XML, for loading.

Definition at line 380 of file qgsinvertedpolygonrenderer.cpp.

QString QgsInvertedPolygonRenderer::dump ( ) const
overridevirtual

Returns debug information about this renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 355 of file qgsinvertedpolygonrenderer.cpp.

const QgsFeatureRenderer * QgsInvertedPolygonRenderer::embeddedRenderer ( ) const
overridevirtual

Returns the current embedded renderer (subrenderer) for this feature renderer.

The base class implementation does not use subrenderers and will always return null.

See also
setEmbeddedRenderer()
Note
added in QGIS 2.16

Reimplemented from QgsFeatureRenderer.

Definition at line 62 of file qgsinvertedpolygonrenderer.cpp.

bool QgsInvertedPolygonRenderer::legendSymbolItemChecked ( const QString &  key)
overridevirtual

items of symbology items in legend is checked

Note
added in 2.5

Reimplemented from QgsFeatureRenderer.

Definition at line 83 of file qgsinvertedpolygonrenderer.cpp.

QgsLegendSymbolList QgsInvertedPolygonRenderer::legendSymbolItems ( double  scaleDenominator = -1,
const QString &  rule = "" 
)
overridevirtual

Proxy that will call this method on the embedded renderer.

Note
not available in python bindings

Reimplemented from QgsFeatureRenderer.

Definition at line 489 of file qgsinvertedpolygonrenderer.cpp.

bool QgsInvertedPolygonRenderer::legendSymbolItemsCheckable ( ) const
overridevirtual

items of symbology items in legend should be checkable

Note
added in 2.5

Reimplemented from QgsFeatureRenderer.

Definition at line 75 of file qgsinvertedpolygonrenderer.cpp.

QgsLegendSymbologyList QgsInvertedPolygonRenderer::legendSymbologyItems ( QSize  iconSize)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 480 of file qgsinvertedpolygonrenderer.cpp.

QgsSymbol * QgsInvertedPolygonRenderer::originalSymbolForFeature ( QgsFeature feat,
QgsRenderContext context 
)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 430 of file qgsinvertedpolygonrenderer.cpp.

QgsSymbolList QgsInvertedPolygonRenderer::originalSymbolsForFeature ( QgsFeature feat,
QgsRenderContext context 
)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 446 of file qgsinvertedpolygonrenderer.cpp.

bool QgsInvertedPolygonRenderer::preprocessingEnabled ( ) const
inline
Returns
true if the geometries are to be preprocessed (merged with an union) before rendering.

Definition at line 124 of file qgsinvertedpolygonrenderer.h.

bool QgsInvertedPolygonRenderer::renderFeature ( QgsFeature feature,
QgsRenderContext context,
int  layer = -1,
bool  selected = false,
bool  drawVertexMarker = false 
)
overridevirtual

Renders a given feature.

This will here collect features. The actual rendering will be postponed to stopRender()

Parameters
featurethe feature to render
contextthe rendering context
layerthe symbol layer to render, if that makes sense
selectedwhether this feature has been selected (this will add decorations)
drawVertexMarkerwhether this feature has vertex markers (in edit mode usually)
Returns
true if the rendering was ok

Reimplemented from QgsFeatureRenderer.

Definition at line 159 of file qgsinvertedpolygonrenderer.cpp.

QDomElement QgsInvertedPolygonRenderer::save ( QDomDocument &  doc)
overridevirtual

store renderer info to XML element

Reimplemented from QgsFeatureRenderer.

Definition at line 394 of file qgsinvertedpolygonrenderer.cpp.

void QgsInvertedPolygonRenderer::setEmbeddedRenderer ( QgsFeatureRenderer subRenderer)
overridevirtual

Sets an embedded renderer (subrenderer) for this feature renderer.

The base class implementation does nothing with subrenderers, but individual derived classes can use these to modify their behaviour.

Parameters
subRendererthe embedded renderer. Ownership will be transferred.
See also
embeddedRenderer()
Note
added in QGIS 2.16

Reimplemented from QgsFeatureRenderer.

Definition at line 50 of file qgsinvertedpolygonrenderer.cpp.

void QgsInvertedPolygonRenderer::setLegendSymbolItem ( const QString &  key,
QgsSymbol symbol 
)
overridevirtual

Sets the symbol to be used for a legend symbol item.

Parameters
keyrule key for legend symbol
symbolnew symbol for legend item. Ownership is transferred to renderer.
Note
added in QGIS 2.14

Reimplemented from QgsFeatureRenderer.

Definition at line 67 of file qgsinvertedpolygonrenderer.cpp.

void QgsInvertedPolygonRenderer::setPreprocessingEnabled ( bool  enabled)
inline
Parameters
enabledenables or disables the preprocessing. When enabled, geometries will be merged with an union before being rendered. It allows fixing some rendering artifacts (when rendering overlapping polygons for instance). This will involve some CPU-demanding computations and is thus disabled by default.

Definition at line 132 of file qgsinvertedpolygonrenderer.h.

void QgsInvertedPolygonRenderer::startRender ( QgsRenderContext context,
const QgsFields fields 
)
overridevirtual

Needs to be called when a new render cycle is started.

Parameters
contextAdditional information passed to the renderer about the job which will be rendered
fieldsThe fields available for rendering
Returns
Information passed back from the renderer that can e.g. be used to reduce the amount of requested features

Implements QgsFeatureRenderer.

Definition at line 99 of file qgsinvertedpolygonrenderer.cpp.

void QgsInvertedPolygonRenderer::stopRender ( QgsRenderContext context)
overridevirtual

The actual rendering will take place here.

Features collected during renderFeature() are rendered using the embedded feature renderer

Implements QgsFeatureRenderer.

Definition at line 251 of file qgsinvertedpolygonrenderer.cpp.

QgsSymbol * QgsInvertedPolygonRenderer::symbolForFeature ( QgsFeature feature,
QgsRenderContext context 
)
overridevirtual

Proxy that will call this method on the embedded renderer.

Implements QgsFeatureRenderer.

Definition at line 421 of file qgsinvertedpolygonrenderer.cpp.

QgsSymbolList QgsInvertedPolygonRenderer::symbols ( QgsRenderContext context)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 453 of file qgsinvertedpolygonrenderer.cpp.

QgsSymbolList QgsInvertedPolygonRenderer::symbolsForFeature ( QgsFeature feat,
QgsRenderContext context 
)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 437 of file qgsinvertedpolygonrenderer.cpp.

QSet< QString > QgsInvertedPolygonRenderer::usedAttributes ( ) const
overridevirtual

Proxy that will call this method on the embedded renderer.

Implements QgsFeatureRenderer.

Definition at line 471 of file qgsinvertedpolygonrenderer.cpp.

bool QgsInvertedPolygonRenderer::willRenderFeature ( QgsFeature feat,
QgsRenderContext context 
)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 498 of file qgsinvertedpolygonrenderer.cpp.


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