QGIS API Documentation  3.21.0-Master (5b68dc587e)
qgsembeddedsymbolrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsembeddedsymbolrenderer.h
3  ---------------------
4  begin : March 2021
5  copyright : (C) 2021 by Nyall Dawson
6  email : nyall dot dawson at gmail 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 QGSEMBEDDEDSYMBOLRENDERER_H
16 #define QGSEMBEDDEDSYMBOLRENDERER_H
17 
18 #include "qgis_core.h"
19 #include "qgis.h"
20 #include "qgsrenderer.h"
21 
36 {
37  public:
38 
47 
48  QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
49  QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
50  void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
51  bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) SIP_THROW( QgsCsException ) override;
52  void stopRender( QgsRenderContext &context ) override;
53  QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
54  bool usesEmbeddedSymbols() const override;
55  QgsEmbeddedSymbolRenderer *clone() const override SIP_FACTORY;
56  QgsFeatureRenderer::Capabilities capabilities() override;
57  QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
58  QgsSymbolList symbols( QgsRenderContext &context ) const override;
59 
64  QgsSymbol *defaultSymbol() const;
65 
73  void setDefaultSymbol( QgsSymbol *symbol SIP_TRANSFER );
74 
80  static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
81 
86  static QgsEmbeddedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
87 
88  private:
89 #ifdef SIP_RUN
92 #endif
93 
94  std::unique_ptr<QgsSymbol> mDefaultSymbol;
95 
96 };
97 
98 
99 #endif // QGSEMBEDDEDSYMBOLRENDERER_H
Custom exception class for Coordinate Reference System related exceptions.
Definition: qgsexception.h:66
A vector feature renderer which uses embedded feature symbology to render per-feature symbols.
~QgsEmbeddedSymbolRenderer() override
virtual QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const =0
To be overridden.
virtual QgsSymbol * originalSymbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns symbol for feature.
Definition: qgsrenderer.cpp:84
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
Definition: qgsrenderer.cpp:96
virtual bool renderFeature(const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) SIP_THROW(QgsCsException)
Render a feature using this renderer in the given context.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Container of fields for a vector layer.
Definition: qgsfields.h:45
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:38
#define SIP_THROW(name)
Definition: qgis_sip.h:189
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsSymbol * > QgsSymbolList
Definition: qgsrenderer.h:44