QGIS API Documentation
qgsinvertedpolygonrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsinvertedpolygonrenderer.h
3  ---------------------
4  begin : April 2014
5  copyright : (C) 2014 Hugo Mercier / Oslandia
6  email : hugo dot mercier at oslandia dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 #ifndef QGSINVERTEDPOLYGONRENDERER_H
16 #define QGSINVERTEDPOLYGONRENDERER_H
17 
18 #include "qgis.h"
19 #include "qgsrendererv2.h"
20 #include "qgssymbolv2.h"
21 #include "qgsexpression.h"
22 #include "qgsfeature.h"
23 #include "qgsgeometry.h"
24 #include <QScopedPointer>
25 
41 {
42  public:
43 
47  QgsInvertedPolygonRenderer( const QgsFeatureRendererV2* embeddedRenderer = nullptr );
48  virtual ~QgsInvertedPolygonRenderer();
49 
51  virtual QgsInvertedPolygonRenderer* clone() const override;
52 
53  virtual void startRender( QgsRenderContext& context, const QgsFields& fields ) override;
54 
64  virtual bool renderFeature( QgsFeature& feature, QgsRenderContext& context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override;
65 
70  virtual void stopRender( QgsRenderContext& context ) override;
71 
73  virtual QString dump() const override;
74 
76  virtual QList<QString> usedAttributes() override;
78  virtual int capabilities() override;
82  virtual QgsSymbolV2List symbols( QgsRenderContext& context ) override;
86  virtual QgsSymbolV2* symbolForFeature( QgsFeature& feature, QgsRenderContext& context ) override;
90  virtual QgsSymbolV2* originalSymbolForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
94  virtual QgsSymbolV2List symbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
98  virtual QgsSymbolV2List originalSymbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
100  virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ) override;
104  virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = "" ) override;
108  virtual bool willRenderFeature( QgsFeature& feat, QgsRenderContext& context ) override;
109 
111  static QgsFeatureRendererV2* create( QDomElement& element );
112 
117  virtual QDomElement save( QDomDocument& doc ) override;
118 
122  void setEmbeddedRenderer( const QgsFeatureRendererV2* subRenderer );
125  const QgsFeatureRendererV2* embeddedRenderer() const;
126 
128  bool preprocessingEnabled() const { return mPreprocessingEnabled; }
135  void setPreprocessingEnabled( bool enabled ) { mPreprocessingEnabled = enabled; }
136 
141  static QgsInvertedPolygonRenderer* convertFromRenderer( const QgsFeatureRendererV2* renderer );
142 
143  private:
148 
151 
153  struct CombinedFeature
154  {
155  QList<QgsGeometry*> geometries; //< list of geometries
156  QgsFeature feature; //< one feature (for attriute-based rendering)
157  };
160  FeatureCategoryVector mFeaturesCategories;
161 
163  QMap<QByteArray, int> mSymbolCategories;
164 
166  QgsPolygon mExtentPolygon;
167 
169  QgsRenderContext mContext;
170 
172  QgsFields mFields;
173 
177  struct FeatureDecoration
178  {
179  QgsFeature feature;
180  bool selected;
181  bool drawMarkers;
182  int layer;
183  FeatureDecoration( QgsFeature& a_feature, bool a_selected, bool a_drawMarkers, int a_layer ) :
184  feature( a_feature ), selected( a_selected ), drawMarkers( a_drawMarkers ), layer( a_layer ) {}
185  };
186  QList<FeatureDecoration> mFeatureDecorations;
187 
189  bool mPreprocessingEnabled;
190 };
191 
192 
193 #endif // QGSMASKRENDERERV2_H
virtual QString dump() const
for debugging
virtual Q_DECL_DEPRECATED QgsSymbolV2 * originalSymbolForFeature(QgsFeature &feature)
Return symbol for feature.
virtual QDomElement save(QDomDocument &doc)
store renderer info to XML element
Container of fields for a vector layer.
Definition: qgsfield.h:187
virtual QList< QString > usedAttributes()=0
Returns a set of attributes required for this renderer.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:187
virtual Q_DECL_DEPRECATED bool willRenderFeature(QgsFeature &feat)
Returns whether the renderer will render a feature or not.
virtual QgsLegendSymbologyList legendSymbologyItems(QSize iconSize)
return a list of symbology items for the legend
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)=0
Needs to be called when a new render cycle is started.
virtual void stopRender(QgsRenderContext &context)=0
Needs to be called when a render cycle has finished to clean up.
virtual Q_DECL_DEPRECATED QgsSymbolV2List originalSymbolsForFeature(QgsFeature &feat)
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbol...
virtual bool renderFeature(QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
Render a feature using this renderer in the given context.
virtual QgsFeatureRendererV2 * clone() const =0
virtual Q_DECL_DEPRECATED QgsSymbolV2 * symbolForFeature(QgsFeature &feature)
To be overridden.
QgsInvertedPolygonRenderer is a polygon-only feature renderer used to display features inverted...
virtual QgsLegendSymbolList legendSymbolItems(double scaleDenominator=-1, const QString &rule="")
return a list of item text / symbol
virtual Q_DECL_DEPRECATED QgsSymbolV2List symbols()
For symbol levels.
Contains information about the context of a rendering operation.
virtual Q_DECL_DEPRECATED QgsSymbolV2List symbolsForFeature(QgsFeature &feat)
Returns list of symbols used for rendering the feature.
virtual int capabilities()
returns bitwise OR-ed capabilities of the renderer