QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
qgsrendererregistry.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrendererregistry.cpp
3  ---------------------
4  begin : November 2009
5  copyright : (C) 2009 by Martin Dobias
6  email : wonder dot sk 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 #include "qgsrendererregistry.h"
16 
17 // default renderers
18 #include "qgssinglesymbolrenderer.h"
19 #include "qgscategorizedsymbolrenderer.h"
20 #include "qgsgraduatedsymbolrenderer.h"
21 #include "qgsrulebasedrenderer.h"
22 #include "qgspointdisplacementrenderer.h"
23 #include "qgspointclusterrenderer.h"
24 #include "qgsinvertedpolygonrenderer.h"
25 #include "qgsmergedfeaturerenderer.h"
26 #include "qgsheatmaprenderer.h"
27 #include "qgs25drenderer.h"
28 #include "qgsnullsymbolrenderer.h"
29 #include "qgsvectorlayer.h"
30 
31 QgsRendererRegistry::QgsRendererRegistry()
32 {
33  // add default renderers
34  addRenderer( new QgsRendererMetadata( QStringLiteral( "nullSymbol" ),
35  QObject::tr( "No Symbols" ),
36  QgsNullSymbolRenderer::create ) );
37 
38  addRenderer( new QgsRendererMetadata( QStringLiteral( "singleSymbol" ),
39  QObject::tr( "Single Symbol" ),
40  QgsSingleSymbolRenderer::create,
41  QgsSingleSymbolRenderer::createFromSld ) );
42 
43  addRenderer( new QgsRendererMetadata( QStringLiteral( "categorizedSymbol" ),
44  QObject::tr( "Categorized" ),
45  QgsCategorizedSymbolRenderer::create ) );
46 
47  addRenderer( new QgsRendererMetadata( QStringLiteral( "graduatedSymbol" ),
48  QObject::tr( "Graduated" ),
49  QgsGraduatedSymbolRenderer::create ) );
50 
51  addRenderer( new QgsRendererMetadata( QStringLiteral( "RuleRenderer" ),
52  QObject::tr( "Rule-based" ),
53  QgsRuleBasedRenderer::create,
54  QgsRuleBasedRenderer::createFromSld ) );
55 
56  addRenderer( new QgsRendererMetadata( QStringLiteral( "pointDisplacement" ),
57  QObject::tr( "Point Displacement" ),
58  QgsPointDisplacementRenderer::create,
59  QIcon(),
60  nullptr,
61  QgsRendererAbstractMetadata::PointLayer ) );
62 
63  addRenderer( new QgsRendererMetadata( QStringLiteral( "pointCluster" ),
64  QObject::tr( "Point Cluster" ),
65  QgsPointClusterRenderer::create,
66  QIcon(),
67  nullptr,
68  QgsRendererAbstractMetadata::PointLayer ) );
69 
70  addRenderer( new QgsRendererMetadata( QStringLiteral( "mergedFeatureRenderer" ),
71  QObject::tr( "Merged Features" ),
72  QgsMergedFeatureRenderer::create,
73  QIcon(),
74  nullptr,
75  QgsRendererAbstractMetadata::LineLayer | QgsRendererAbstractMetadata::PolygonLayer ) );
76 
77  addRenderer( new QgsRendererMetadata( QStringLiteral( "invertedPolygonRenderer" ),
78  QObject::tr( "Inverted Polygons" ),
79  QgsInvertedPolygonRenderer::create,
80  QIcon(),
81  nullptr,
82  QgsRendererAbstractMetadata::PolygonLayer ) );
83 
84  addRenderer( new QgsRendererMetadata( QStringLiteral( "heatmapRenderer" ),
85  QObject::tr( "Heatmap" ),
86  QgsHeatmapRenderer::create,
87  QIcon(),
88  nullptr,
89  QgsRendererAbstractMetadata::PointLayer ) );
90 
91 
92  addRenderer( new QgsRendererMetadata( QStringLiteral( "25dRenderer" ),
93  QObject::tr( "2.5 D" ),
94  Qgs25DRenderer::create,
95  QIcon(),
96  nullptr,
97  QgsRendererAbstractMetadata::PolygonLayer ) );
98 }
99 
100 QgsRendererRegistry::~QgsRendererRegistry()
101 {
102  qDeleteAll( mRenderers );
103 }
104 
105 bool QgsRendererRegistry::addRenderer( QgsRendererAbstractMetadata *metadata )
106 {
107  if ( !metadata || mRenderers.contains( metadata->name() ) )
108  return false;
109 
110  mRenderers[metadata->name()] = metadata;
111  mRenderersOrder << metadata->name();
112  return true;
113 }
114 
115 bool QgsRendererRegistry::removeRenderer( const QString &rendererName )
116 {
117  if ( !mRenderers.contains( rendererName ) )
118  return false;
119 
120  delete mRenderers[rendererName];
121  mRenderers.remove( rendererName );
122  mRenderersOrder.removeAll( rendererName );
123  return true;
124 }
125 
126 QgsRendererAbstractMetadata *QgsRendererRegistry::rendererMetadata( const QString &rendererName )
127 {
128  return mRenderers.value( rendererName );
129 }
130 
131 QStringList QgsRendererRegistry::renderersList( QgsRendererAbstractMetadata::LayerTypes layerTypes ) const
132 {
133  QStringList renderers;
134  const auto constMRenderersOrder = mRenderersOrder;
135  for ( const QString &renderer : constMRenderersOrder )
136  {
137  QgsRendererAbstractMetadata *r = mRenderers.value( renderer );
138  if ( r && r->compatibleLayerTypes() & layerTypes )
139  renderers << renderer;
140  }
141  return renderers;
142 }
143 
144 QStringList QgsRendererRegistry::renderersList( const QgsVectorLayer *layer ) const
145 {
146  QgsRendererAbstractMetadata::LayerType layerType = QgsRendererAbstractMetadata::All;
147 
148  switch ( layer->geometryType() )
149  {
150  case QgsWkbTypes::PointGeometry:
151  layerType = QgsRendererAbstractMetadata::PointLayer;
152  break;
153 
154  case QgsWkbTypes::LineGeometry:
155  layerType = QgsRendererAbstractMetadata::LineLayer;
156  break;
157 
158  case QgsWkbTypes::PolygonGeometry:
159  layerType = QgsRendererAbstractMetadata::PolygonLayer;
160  break;
161 
162  case QgsWkbTypes::UnknownGeometry:
163  case QgsWkbTypes::NullGeometry:
164  break;
165  }
166 
167  return renderersList( layerType );
168 }
Qgs25DRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Create a new 2.5D renderer from XML.
Definition: qgs25drenderer.cpp:129
QgsCategorizedSymbolRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Creates a categorized renderer from an XML element.
Definition: qgscategorizedsymbolrenderer.cpp:655
QgsGraduatedSymbolRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
create renderer from XML element
Definition: qgsgraduatedsymbolrenderer.cpp:462
QgsHeatmapRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Creates a new heatmap renderer instance from XML.
Definition: qgsheatmaprenderer.cpp:308
QgsInvertedPolygonRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Creates a renderer out of an XML, for loading.
Definition: qgsinvertedpolygonrenderer.cpp:68
QgsMergedFeatureRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Creates a renderer out of an XML, for loading.
Definition: qgsmergedfeaturerenderer.cpp:426
QgsNullSymbolRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Creates a null renderer from XML element.
Definition: qgsnullsymbolrenderer.cpp:100
QgsPointClusterRenderer::create
static QgsFeatureRenderer * create(QDomElement &symbologyElem, const QgsReadWriteContext &context)
Creates a renderer from XML element.
Definition: qgspointclusterrenderer.cpp:97
QgsPointDisplacementRenderer::create
static QgsFeatureRenderer * create(QDomElement &symbologyElem, const QgsReadWriteContext &context)
Create a renderer from XML element.
Definition: qgspointdisplacementrenderer.cpp:151
QgsRendererAbstractMetadata
Stores metadata about one renderer class.
Definition: qgsrendererregistry.h:42
QgsRendererAbstractMetadata::LayerType
LayerType
Layer types the renderer is compatible with.
Definition: qgsrendererregistry.h:50
QgsRendererAbstractMetadata::All
@ All
Compatible with all vector layers.
Definition: qgsrendererregistry.h:54
QgsRendererAbstractMetadata::LineLayer
@ LineLayer
Compatible with line layers.
Definition: qgsrendererregistry.h:52
QgsRendererAbstractMetadata::PolygonLayer
@ PolygonLayer
Compatible with polygon layers.
Definition: qgsrendererregistry.h:53
QgsRendererAbstractMetadata::PointLayer
@ PointLayer
Compatible with point layers.
Definition: qgsrendererregistry.h:51
QgsRendererAbstractMetadata::compatibleLayerTypes
virtual QgsRendererAbstractMetadata::LayerTypes compatibleLayerTypes() const
Returns flags indicating the types of layer the renderer is compatible with.
Definition: qgsrendererregistry.h:100
QgsRendererAbstractMetadata::name
QString name() const
Returns the unique name of the renderer.
Definition: qgsrendererregistry.h:76
QgsRendererMetadata
Convenience metadata class that uses static functions to create renderer and its widget.
Definition: qgsrendererregistry.h:143
QgsRendererRegistry::addRenderer
bool addRenderer(QgsRendererAbstractMetadata *metadata)
Adds a renderer to the registry.
Definition: qgsrendererregistry.cpp:105
QgsRendererRegistry::renderersList
QStringList renderersList(QgsRendererAbstractMetadata::LayerTypes layerTypes=QgsRendererAbstractMetadata::All) const
Returns a list of available renderers.
Definition: qgsrendererregistry.cpp:131
QgsRendererRegistry::rendererMetadata
QgsRendererAbstractMetadata * rendererMetadata(const QString &rendererName)
Returns the metadata for a specified renderer.
Definition: qgsrendererregistry.cpp:126
QgsRendererRegistry::removeRenderer
bool removeRenderer(const QString &rendererName)
Removes a renderer from registry.
Definition: qgsrendererregistry.cpp:115
QgsRuleBasedRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Creates a new rule-based renderer instance from XML.
Definition: qgsrulebasedrenderer.cpp:1139
QgsRuleBasedRenderer::createFromSld
static QgsFeatureRenderer * createFromSld(QDomElement &element, QgsWkbTypes::GeometryType geomType)
Definition: qgsrulebasedrenderer.cpp:1162
QgsSingleSymbolRenderer::create
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Creates a new single symbol renderer from an XML element, using the supplied read/write context.
Definition: qgssinglesymbolrenderer.cpp:146
QgsSingleSymbolRenderer::createFromSld
static QgsFeatureRenderer * createFromSld(QDomElement &element, QgsWkbTypes::GeometryType geomType)
Creates a new single symbol renderer from an SLD element.
Definition: qgssinglesymbolrenderer.cpp:186
QgsVectorLayer
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:388
QgsVectorLayer::geometryType
Q_INVOKABLE QgsWkbTypes::GeometryType geometryType() const
Returns point, line or polygon.
Definition: qgsvectorlayer.cpp:667
Generated on Sun Mar 21 2021 09:16:51 for QGIS API Documentation by doxygen 1.9.1