QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
qgsgeometrygeneratorsymbollayer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometrygeneratorsymbollayer.h
3  ---------------------
4  begin : November 2015
5  copyright : (C) 2015 by Matthias Kuhn
6  email : matthias at opengis dot ch
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 
16 #ifndef QGSGEOMETRYGENERATORSYMBOLLAYER_H
17 #define QGSGEOMETRYGENERATORSYMBOLLAYER_H
18 
19 #include "qgis_core.h"
20 #include "qgssymbollayer.h"
21 
27 {
28  public:
30 
32  static QgsSymbolLayer *create( const QVariantMap &properties ) SIP_FACTORY;
33 
34  QString layerType() const override;
35 
42  void setSymbolType( QgsSymbol::SymbolType symbolType );
43 
50  QgsSymbol::SymbolType symbolType() const { return mSymbolType; }
51 
52  void startRender( QgsSymbolRenderContext &context ) override;
53  void stopRender( QgsSymbolRenderContext &context ) override;
54  void startFeatureRender( const QgsFeature &feature, QgsRenderContext &context ) override;
55  void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context ) override;
56  bool usesMapUnits() const override;
57 
58  QgsSymbolLayer *clone() const override SIP_FACTORY;
59 
60  QVariantMap properties() const override;
61 
62  void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override;
63 
67  void setGeometryExpression( const QString &exp );
68 
72  QString geometryExpression() const { return mExpression->expression(); }
73 
74  QgsSymbol *subSymbol() override { return mSymbol; }
75 
76  bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override;
77 
78  QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
79  bool hasDataDefinedProperties() const override;
80 
86  bool isCompatibleWithSymbol( QgsSymbol *symbol ) const override;
87 
98  virtual void render( QgsSymbolRenderContext &context );
99 
100  void setColor( const QColor &color ) override;
101 
102  private:
103  QgsGeometryGeneratorSymbolLayer( const QString &expression );
104 
105 #ifdef SIP_RUN
107 #endif
108 
109  std::unique_ptr<QgsExpression> mExpression;
110  std::unique_ptr<QgsFillSymbol> mFillSymbol;
111  std::unique_ptr<QgsLineSymbol> mLineSymbol;
112  std::unique_ptr<QgsMarkerSymbol> mMarkerSymbol;
113  QgsSymbol *mSymbol = nullptr;
114 
118  QgsSymbol::SymbolType mSymbolType;
119 
120  bool mRenderingFeature = false;
121  bool mHasRenderedFeature = false;
122 };
123 
124 #endif // QGSGEOMETRYGENERATORSYMBOLLAYER_H
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:56
QgsSymbol::SymbolType symbolType() const
Access the symbol type.
QgsSymbol * subSymbol() override
Returns the symbol's sub symbol, if present.
Contains information about the context of a rendering operation.
virtual void startFeatureRender(const QgsFeature &feature, QgsRenderContext &context)
Called before the layer will be rendered for a particular feature.
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const
Returns the set of attributes referenced by the layer.
virtual void startRender(QgsSymbolRenderContext &context)=0
Called before a set of rendering operations commences on the supplied render context.
virtual QgsSymbolLayer * clone() const =0
Shall be reimplemented by subclasses to create a deep copy of the instance.
virtual QString layerType() const =0
Returns a string that represents this layer type.
virtual void stopRender(QgsSymbolRenderContext &context)=0
Called after a set of rendering operations has finished on the supplied render context.
virtual bool isCompatibleWithSymbol(QgsSymbol *symbol) const
Returns if the layer can be used below the specified symbol.
virtual void stopFeatureRender(const QgsFeature &feature, QgsRenderContext &context)
Called after the layer has been rendered for a particular feature.
virtual bool usesMapUnits() const
Returns true if the symbol layer has any components which use map unit based sizes.
virtual void setColor(const QColor &color)
The fill color.
virtual bool hasDataDefinedProperties() const
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.
virtual bool setSubSymbol(QgsSymbol *symbol)
Sets layer's subsymbol. takes ownership of the passed symbol.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:65
SymbolType
Type of the symbol.
Definition: qgssymbol.h:87
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76