QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
qgsrenderer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsrenderer.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
16#include "qgsrenderer.h"
17
18#include <algorithm>
19
20#include "qgsapplication.h"
21#include "qgsfeature.h"
23#include "qgslinesymbol.h"
24#include "qgslogger.h"
25#include "qgsmarkersymbol.h"
26#include "qgspainteffect.h"
28#include "qgspoint.h"
29#include "qgsproperty.h"
30#include "qgsrendercontext.h"
31#include "qgsrendererregistry.h"
33#include "qgssldexportcontext.h"
34#include "qgssymbol.h"
35#include "qgssymbollayerutils.h"
36#include "qgsvectorlayer.h"
37
38#include <QDomDocument>
39#include <QDomElement>
40#include <QPolygonF>
41#include <QThread>
42
43QgsPropertiesDefinition QgsFeatureRenderer::sPropertyDefinitions;
44
46{
47 return QgsSymbol::_getPoint( context, point );
48}
49
51{
52 if ( !destRenderer )
53 return;
54
55 if ( mPaintEffect )
56 destRenderer->setPaintEffect( mPaintEffect->clone() );
57
58 destRenderer->setForceRasterRender( mForceRaster );
60 destRenderer->mOrderBy = mOrderBy;
61 destRenderer->mOrderByEnabled = mOrderByEnabled;
62 destRenderer->mReferenceScale = mReferenceScale;
63 destRenderer->mDataDefinedProperties = mDataDefinedProperties;
64}
65
67 : mType( type )
68{
70 mPaintEffect->setEnabled( false );
71}
72
77
79{
80 QgsFeatureRenderer::initPropertyDefinitions();
81 return sPropertyDefinitions;
82}
83
88
90{
91 return symbolForFeature( feature, context );
92}
93
94QSet< QString > QgsFeatureRenderer::legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const
95{
96 Q_UNUSED( feature )
97 Q_UNUSED( context )
98 return QSet< QString >();
99}
100
102{
103#ifdef QGISDEBUG
104 if ( !mThread )
105 {
106 mThread = QThread::currentThread();
107 }
108 else
109 {
110 Q_ASSERT_X( mThread == QThread::currentThread(), "QgsFeatureRenderer::startRender", "startRender called in a different thread - use a cloned renderer instead" );
111 }
112#endif
113
114 mDataDefinedProperties.prepare( context.expressionContext() );
115}
116
118{
119 return false;
120}
121
123{
124#ifdef QGISDEBUG
125 Q_ASSERT_X( mThread == QThread::currentThread(), "QgsFeatureRenderer::stopRender", "stopRender called in a different thread - use a cloned renderer instead" );
126#endif
127}
128
130{
131 return false;
132}
133
135{
136 return false;
137}
138
139bool QgsFeatureRenderer::renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker )
140{
141#ifdef QGISDEBUG
142 Q_ASSERT_X( mThread == QThread::currentThread(), "QgsFeatureRenderer::renderFeature", "renderFeature called in a different thread - use a cloned renderer instead" );
143#endif
144
145 QgsSymbol *symbol = symbolForFeature( feature, context );
146 if ( !symbol )
147 return false;
148
149 renderFeatureWithSymbol( feature, symbol, context, layer, selected, drawVertexMarker );
150 return true;
151}
152
153void QgsFeatureRenderer::renderFeatureWithSymbol( const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker )
154{
155 symbol->renderFeature( feature, context, layer, selected, drawVertexMarker, mCurrentVertexMarkerType, mCurrentVertexMarkerSize );
156}
157
159{
160 return QStringLiteral( "UNKNOWN RENDERER\n" );
161}
162
167
169{
170 Q_UNUSED( context )
171 return QgsSymbolList();
172}
173
175{
176 // <renderer-v2 type=""> ... </renderer-v2>
177
178 if ( element.isNull() )
179 return nullptr;
180
181 // load renderer
182 const QString rendererType = element.attribute( QStringLiteral( "type" ) );
183
185 if ( !m )
186 return nullptr;
187
188 QgsFeatureRenderer *r = m->createRenderer( element, context );
189 if ( r )
190 {
191 r->setUsingSymbolLevels( element.attribute( QStringLiteral( "symbollevels" ), QStringLiteral( "0" ) ).toInt() );
192 r->setForceRasterRender( element.attribute( QStringLiteral( "forceraster" ), QStringLiteral( "0" ) ).toInt() );
193 r->setReferenceScale( element.attribute( QStringLiteral( "referencescale" ), QStringLiteral( "-1" ) ).toDouble() );
194
195 //restore layer effect
196 const QDomElement effectElem = element.firstChildElement( QStringLiteral( "effect" ) );
197 if ( !effectElem.isNull() )
198 {
199 r->setPaintEffect( QgsApplication::paintEffectRegistry()->createEffect( effectElem ) );
200 }
201
202 // restore order by
203 const QDomElement orderByElem = element.firstChildElement( QStringLiteral( "orderby" ) );
204 r->mOrderBy.load( orderByElem );
205 r->setOrderByEnabled( element.attribute( QStringLiteral( "enableorderby" ), QStringLiteral( "0" ) ).toInt() );
206
207 const QDomElement elemDataDefinedProperties = element.firstChildElement( QStringLiteral( "data-defined-properties" ) );
208 if ( !elemDataDefinedProperties.isNull() )
209 r->mDataDefinedProperties.readXml( elemDataDefinedProperties, propertyDefinitions() );
210 }
211 return r;
212}
213
214QDomElement QgsFeatureRenderer::save( QDomDocument &doc, const QgsReadWriteContext &context )
215{
216 Q_UNUSED( context )
217 // create empty renderer element
218 QDomElement rendererElem = doc.createElement( RENDERER_TAG_NAME );
219
220 saveRendererData( doc, rendererElem, context );
221
222 return rendererElem;
223}
224
225void QgsFeatureRenderer::saveRendererData( QDomDocument &doc, QDomElement &rendererElem, const QgsReadWriteContext & )
226{
227 rendererElem.setAttribute( QStringLiteral( "forceraster" ), ( mForceRaster ? QStringLiteral( "1" ) : QStringLiteral( "0" ) ) );
228 rendererElem.setAttribute( QStringLiteral( "symbollevels" ), ( mUsingSymbolLevels ? QStringLiteral( "1" ) : QStringLiteral( "0" ) ) );
229 rendererElem.setAttribute( QStringLiteral( "referencescale" ), mReferenceScale );
230
231 QDomElement elemDataDefinedProperties = doc.createElement( QStringLiteral( "data-defined-properties" ) );
232 mDataDefinedProperties.writeXml( elemDataDefinedProperties, propertyDefinitions() );
233 rendererElem.appendChild( elemDataDefinedProperties );
234
236 mPaintEffect->saveProperties( doc, rendererElem );
237
238 if ( !mOrderBy.isEmpty() )
239 {
240 QDomElement orderBy = doc.createElement( QStringLiteral( "orderby" ) );
241 mOrderBy.save( orderBy );
242 rendererElem.appendChild( orderBy );
243 }
244 rendererElem.setAttribute( QStringLiteral( "enableorderby" ), ( mOrderByEnabled ? QStringLiteral( "1" ) : QStringLiteral( "0" ) ) );
245}
246
247QgsFeatureRenderer *QgsFeatureRenderer::loadSld( const QDomNode &node, Qgis::GeometryType geomType, QString &errorMessage )
248{
249 const QDomElement element = node.toElement();
250 if ( element.isNull() )
251 return nullptr;
252
253 // get the UserStyle element
254 const QDomElement userStyleElem = element.firstChildElement( QStringLiteral( "UserStyle" ) );
255 if ( userStyleElem.isNull() )
256 {
257 // UserStyle element not found, nothing will be rendered
258 errorMessage = QStringLiteral( "Info: UserStyle element not found." );
259 return nullptr;
260 }
261
262 // get the FeatureTypeStyle element
263 QDomElement featTypeStyleElem = userStyleElem.firstChildElement( QStringLiteral( "FeatureTypeStyle" ) );
264 if ( featTypeStyleElem.isNull() )
265 {
266 errorMessage = QStringLiteral( "Info: FeatureTypeStyle element not found." );
267 return nullptr;
268 }
269
270 // create empty FeatureTypeStyle element to merge Rule's from all FeatureTypeStyle's
271 QDomElement mergedFeatTypeStyle = featTypeStyleElem.cloneNode( false ).toElement();
272
273 // use the RuleRenderer when more rules are present or the rule
274 // has filters or min/max scale denominators set,
275 // otherwise use the SingleSymbol renderer
276 bool needRuleRenderer = false;
277 int ruleCount = 0;
278
279 while ( !featTypeStyleElem.isNull() )
280 {
281 QDomElement ruleElem = featTypeStyleElem.firstChildElement( QStringLiteral( "Rule" ) );
282 while ( !ruleElem.isNull() )
283 {
284 // test rule children element to check if we need to create RuleRenderer
285 // and if the rule has a symbolizer
286 bool hasRendererSymbolizer = false;
287 bool hasRuleRenderer = false;
288 QDomElement ruleChildElem = ruleElem.firstChildElement();
289 while ( !ruleChildElem.isNull() )
290 {
291 // rule has filter or min/max scale denominator, use the RuleRenderer
292 if ( ruleChildElem.localName() == QLatin1String( "Filter" ) ||
293 ruleChildElem.localName() == QLatin1String( "ElseFilter" ) ||
294 ruleChildElem.localName() == QLatin1String( "MinScaleDenominator" ) ||
295 ruleChildElem.localName() == QLatin1String( "MaxScaleDenominator" ) )
296 {
297 hasRuleRenderer = true;
298 }
299 // rule has a renderer symbolizer, not a text symbolizer
300 else if ( ruleChildElem.localName().endsWith( QLatin1String( "Symbolizer" ) ) &&
301 ruleChildElem.localName() != QLatin1String( "TextSymbolizer" ) )
302 {
303 QgsDebugMsgLevel( QStringLiteral( "Symbolizer element found and not a TextSymbolizer" ), 2 );
304 hasRendererSymbolizer = true;
305 }
306
307 ruleChildElem = ruleChildElem.nextSiblingElement();
308 }
309
310 if ( hasRendererSymbolizer )
311 {
312 ruleCount++;
313
314 // append a clone of all Rules to the merged FeatureTypeStyle element
315 mergedFeatTypeStyle.appendChild( ruleElem.cloneNode().toElement() );
316
317 if ( hasRuleRenderer )
318 {
319 QgsDebugMsgLevel( QStringLiteral( "Filter or Min/MaxScaleDenominator element found: need a RuleRenderer" ), 2 );
320 needRuleRenderer = true;
321 }
322 }
323
324 // more rules present, use the RuleRenderer
325 if ( ruleCount > 1 )
326 {
327 QgsDebugMsgLevel( QStringLiteral( "more Rule elements found: need a RuleRenderer" ), 2 );
328 needRuleRenderer = true;
329 }
330
331 ruleElem = ruleElem.nextSiblingElement( QStringLiteral( "Rule" ) );
332 }
333 featTypeStyleElem = featTypeStyleElem.nextSiblingElement( QStringLiteral( "FeatureTypeStyle" ) );
334 }
335
336 QString rendererType;
337 if ( needRuleRenderer )
338 {
339 rendererType = QStringLiteral( "RuleRenderer" );
340 }
341 else
342 {
343 rendererType = QStringLiteral( "singleSymbol" );
344 }
345 QgsDebugMsgLevel( QStringLiteral( "Instantiating a '%1' renderer..." ).arg( rendererType ), 2 );
346
347 // create the renderer and return it
349 if ( !m )
350 {
351 errorMessage = QStringLiteral( "Error: Unable to get metadata for '%1' renderer." ).arg( rendererType );
352 return nullptr;
353 }
354
355 QgsFeatureRenderer *r = m->createRendererFromSld( mergedFeatTypeStyle, geomType );
356 return r;
357}
358
359void QgsFeatureRenderer::toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const
360{
361 QgsSldExportContext context;
362 context.setExtraProperties( props );
363 toSld( doc, element, context );
364}
365
366bool QgsFeatureRenderer::toSld( QDomDocument &, QDomElement &, QgsSldExportContext &context ) const
367{
368 context.pushError( QObject::tr( "Vector %1 renderer cannot be converted to SLD" ).arg( type() ) );
369 return false;
370}
371
373{
374 // build up a list of unique legend keys
375 const QgsLegendSymbolList allLegendSymbols = legendSymbolItems();
376 QSet< QString > keys;
377 keys.reserve( allLegendSymbols.size() );
378 for ( const QgsLegendSymbolItem &symbol : allLegendSymbols )
379 {
380 keys.insert( symbol.ruleKey() );
381 }
382 return keys;
383}
384
385QDomElement QgsFeatureRenderer::writeSld( QDomDocument &doc, const QString &styleName, const QVariantMap &props ) const
386{
387 QDomElement userStyleElem = doc.createElement( QStringLiteral( "UserStyle" ) );
388
389 QDomElement nameElem = doc.createElement( QStringLiteral( "se:Name" ) );
390 nameElem.appendChild( doc.createTextNode( styleName ) );
391 userStyleElem.appendChild( nameElem );
392
393 QDomElement featureTypeStyleElem = doc.createElement( QStringLiteral( "se:FeatureTypeStyle" ) );
394 QgsSldExportContext context;
395 context.setExtraProperties( props );
396
397 toSld( doc, featureTypeStyleElem, context );
398 userStyleElem.appendChild( featureTypeStyleElem );
399
400 return userStyleElem;
401}
402
404{
405 return false;
406}
407
409{
410 Q_UNUSED( key )
411 return false;
412}
413
414void QgsFeatureRenderer::checkLegendSymbolItem( const QString &key, bool state )
415{
416 Q_UNUSED( key )
417 Q_UNUSED( state )
418}
419
420void QgsFeatureRenderer::setLegendSymbolItem( const QString &key, QgsSymbol *symbol )
421{
422 Q_UNUSED( key )
423 delete symbol;
424}
425
426QString QgsFeatureRenderer::legendKeyToExpression( const QString &, QgsVectorLayer *, bool &ok ) const
427{
428 ok = false;
429 return QString();
430}
431
436
438{
439 const QgsSymbolList symbolList = symbols( context );
440
441 if ( symbolList.empty() )
442 return 0;
443
444 QgsExpressionContext &expContext = context.expressionContext();
445
446 auto getValueFromSymbol = [ &expContext, &context ]( const QgsSymbol * sym ) -> double
447 {
448 const QgsProperty property = sym->dataDefinedProperties().property( QgsSymbol::Property::ExtentBuffer );
449
450 double value = 0.0;
451
452 if ( property.isActive() )
453 {
454 expContext.setOriginalValueVariable( sym->extentBuffer() );
455
456 value = sym->dataDefinedProperties().valueAsDouble( QgsSymbol::Property::ExtentBuffer, expContext, sym->extentBuffer() );
457 if ( value < 0 )
458 value = 0;
459 }
460 else
461 {
462 value = sym->extentBuffer();
463 }
464
465 if ( sym->extentBufferSizeUnit() != Qgis::RenderUnit::MapUnits )
466 {
467 value = context.convertToMapUnits( value, sym->extentBufferSizeUnit(), sym->mapUnitScale() );
468 }
469
470 return value;
471 };
472
473 if ( symbolList.size() == 1 )
474 return getValueFromSymbol( symbolList[0] );
475
476 auto it = std::max_element( symbolList.constBegin(), symbolList.constEnd(), [ &getValueFromSymbol ]( const QgsSymbol * a, const QgsSymbol * b ) -> bool
477 {
478 return getValueFromSymbol( a ) < getValueFromSymbol( b );
479 } );
480
481 return getValueFromSymbol( *it );
482}
483
484QList<QgsLayerTreeModelLegendNode *> QgsFeatureRenderer::createLegendNodes( QgsLayerTreeLayer *nodeLayer ) const
485{
486 QList<QgsLayerTreeModelLegendNode *> nodes;
487
488 const QgsLegendSymbolList symbolItems = legendSymbolItems();
489 nodes.reserve( symbolItems.size() );
490
491 for ( const QgsLegendSymbolItem &item : symbolItems )
492 {
493 if ( const QgsDataDefinedSizeLegend *dataDefinedSizeLegendSettings = item.dataDefinedSizeLegendSettings() )
494 {
495 nodes << new QgsDataDefinedSizeLegendNode( nodeLayer, *dataDefinedSizeLegendSettings );
496 }
497 else
498 {
499 nodes << new QgsSymbolLegendNode( nodeLayer, item );
500 }
501 }
502 return nodes;
503}
504
510
512{
513 return nullptr != symbolForFeature( feature, context );
514}
515
517{
519 QgsSymbolLayerUtils::drawVertexMarker( pt.x(), pt.y(), *context.painter(),
521 markerSize );
522}
523
525{
526 const auto constPts = pts;
527 for ( const QPointF pt : constPts )
528 renderVertexMarker( pt, context );
529}
530
531void QgsFeatureRenderer::renderVertexMarkerPolygon( QPolygonF &pts, QList<QPolygonF> *rings, QgsRenderContext &context )
532{
533 const auto constPts = pts;
534 for ( const QPointF pt : constPts )
535 renderVertexMarker( pt, context );
536
537 if ( rings )
538 {
539 const auto constRings = *rings;
540 for ( const QPolygonF &ring : constRings )
541 {
542 const auto constRing = ring;
543 for ( const QPointF pt : constRing )
544 renderVertexMarker( pt, context );
545 }
546 }
547}
548
550{
551 QgsSymbolList lst;
552 QgsSymbol *s = symbolForFeature( feature, context );
553 if ( s ) lst.append( s );
554 return lst;
555}
556
558{
559 double extentBuffer = maximumExtentBuffer( context );
560
561 extent.grow( extentBuffer );
562}
563
565{
566 QgsSymbolList lst;
567 QgsSymbol *s = originalSymbolForFeature( feature, context );
568 if ( s ) lst.append( s );
569 return lst;
570}
571
576
578{
579 mPaintEffect.reset( effect );
580
581}
582
584{
585 mDataDefinedProperties.setProperty( key, property );
586}
587
592
597
599{
600 return mOrderByEnabled;
601}
602
604{
605 mOrderByEnabled = enabled;
606}
607
609{
610 delete subRenderer;
611}
612
614{
615 return nullptr;
616}
617
619{
620 return true;
621}
622
623void QgsFeatureRenderer::convertSymbolSizeScale( QgsSymbol *symbol, Qgis::ScaleMethod method, const QString &field )
624{
625 if ( symbol->type() == Qgis:: SymbolType::Marker )
626 {
627 QgsMarkerSymbol *s = static_cast<QgsMarkerSymbol *>( symbol );
628 if ( Qgis::ScaleMethod::ScaleArea == method )
629 {
630 s->setDataDefinedSize( QgsProperty::fromExpression( "coalesce(sqrt(" + QString::number( s->size() ) + " * (" + field + ")),0)" ) );
631 }
632 else
633 {
634 s->setDataDefinedSize( QgsProperty::fromExpression( "coalesce(" + QString::number( s->size() ) + " * (" + field + "),0)" ) );
635 }
637 }
638 else if ( symbol->type() == Qgis::SymbolType::Line )
639 {
640 QgsLineSymbol *s = static_cast<QgsLineSymbol *>( symbol );
641 s->setDataDefinedWidth( QgsProperty::fromExpression( "coalesce(" + QString::number( s->width() ) + " * (" + field + "),0)" ) );
642 }
643}
644
645void QgsFeatureRenderer::convertSymbolRotation( QgsSymbol *symbol, const QString &field )
646{
647 if ( symbol->type() == Qgis::SymbolType::Marker )
648 {
649 QgsMarkerSymbol *s = static_cast<QgsMarkerSymbol *>( symbol );
651 ? QString::number( s->angle() ) + " + "
652 : QString() ) + field );
653 s->setDataDefinedAngle( dd );
654 }
655}
656
657void QgsFeatureRenderer::initPropertyDefinitions()
658{
659 if ( !sPropertyDefinitions.isEmpty() )
660 return;
661
662 QString origin = QStringLiteral( "renderer" );
663
664 sPropertyDefinitions = QgsPropertiesDefinition
665 {
666 { static_cast< int >( QgsFeatureRenderer::Property::HeatmapRadius ), QgsPropertyDefinition( "heatmapRadius", QObject::tr( "Radius" ), QgsPropertyDefinition::DoublePositive, origin )},
667 { static_cast< int >( QgsFeatureRenderer::Property::HeatmapMaximum ), QgsPropertyDefinition( "heatmapMaximum", QObject::tr( "Maximum" ), QgsPropertyDefinition::DoublePositive, origin )},
668 };
669}
670
672{
673 return mSymbol;
674}
675
677{
678 return mLayer;
679}
ScaleMethod
Scale methods.
Definition qgis.h:624
@ ScaleDiameter
Calculate scale by the diameter.
Definition qgis.h:626
@ ScaleArea
Calculate scale by the area.
Definition qgis.h:625
QFlags< FeatureRendererFlag > FeatureRendererFlags
Flags controlling behavior of vector feature renderers.
Definition qgis.h:838
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:358
@ Millimeters
Millimeters.
Definition qgis.h:5184
@ MapUnits
Map units.
Definition qgis.h:5185
VertexMarkerType
Editing vertex markers, used for showing vertices during a edit operation.
Definition qgis.h:1833
@ Marker
Marker symbol.
Definition qgis.h:611
@ Line
Line symbol.
Definition qgis.h:612
virtual bool readXml(const QDomElement &collectionElem, const QgsPropertiesDefinition &definitions)
Reads property collection state from an XML element.
static QgsPaintEffectRegistry * paintEffectRegistry()
Returns the application's paint effect registry, used for managing paint effects.
static QgsRendererRegistry * rendererRegistry()
Returns the application's renderer registry, used for managing vector layer renderers.
A legend node with a marker symbol.
Object that keeps configuration of appearance of marker symbol's data-defined size in legend.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
void setOrderBy(const QgsFeatureRequest::OrderBy &orderBy)
Define the order in which features shall be processed by this renderer.
void renderVertexMarkerPolyline(QPolygonF &pts, QgsRenderContext &context)
render editing vertex marker for a polyline
virtual bool canSkipRender()
Returns true if the renderer can be entirely skipped, i.e.
static QPointF _getPoint(QgsRenderContext &context, const QgsPoint &point)
Creates a point in screen coordinates from a wkb string in map coordinates.
virtual QDomElement writeSld(QDomDocument &doc, const QString &styleName, const QVariantMap &props=QVariantMap()) const
create the SLD UserStyle element following the SLD v1.1 specs with the given name
virtual QgsLegendSymbolList legendSymbolItems() const
Returns a list of symbology items for the legend.
void setOrderByEnabled(bool enabled)
Sets whether custom ordering should be applied before features are processed by this renderer.
virtual bool legendSymbolItemsCheckable() const
Returns true if symbology items in legend are checkable.
virtual void modifyRequestExtent(QgsRectangle &extent, QgsRenderContext &context)
Allows for a renderer to modify the extent of a feature request prior to rendering.
virtual bool legendSymbolItemChecked(const QString &key)
Returns true if the legend symbology item with the specified key is checked.
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the renderer.
void setPaintEffect(QgsPaintEffect *effect)
Sets the current paint effect for the renderer.
virtual void setLegendSymbolItem(const QString &key, QgsSymbol *symbol)
Sets the symbol to be used for a legend symbol item.
virtual void setEmbeddedRenderer(QgsFeatureRenderer *subRenderer)
Sets an embedded renderer (subrenderer) for this feature renderer.
virtual QList< QgsLayerTreeModelLegendNode * > createLegendNodes(QgsLayerTreeLayer *nodeLayer) const
Returns a list of legend nodes to be used for the legend for the renderer.
QgsFeatureRenderer(const QString &type)
static QgsFeatureRenderer * defaultRenderer(Qgis::GeometryType geomType)
Returns a new renderer - used by default in vector layers.
virtual QgsSymbolList symbolsForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns list of symbols used for rendering the feature.
void setForceRasterRender(bool forceRaster)
Sets whether the renderer should be rendered to a raster destination.
virtual QgsSymbolList symbols(QgsRenderContext &context) const
Returns list of symbols used by the renderer.
virtual Qgis::FeatureRendererFlags flags() const
Returns flags associated with the renderer.
virtual void stopRender(QgsRenderContext &context)
Must be called when a render cycle has finished, to allow the renderer to clean up.
Property
Data definable properties for renderers.
@ HeatmapRadius
Heatmap renderer radius.
@ HeatmapMaximum
Heatmap maximum value.
virtual QSet< QString > legendKeysForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns legend keys matching a specified feature.
QString type() const
double maximumExtentBuffer(QgsRenderContext &context) const
Returns the maximum extent buffer found in this renderer's symbols.
virtual bool usesEmbeddedSymbols() const
Returns true if the renderer uses embedded symbols for features.
void copyRendererData(QgsFeatureRenderer *destRenderer) const
Clones generic renderer data to another renderer.
virtual bool renderFeature(const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
Render a feature using this renderer in the given context.
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context)
Stores renderer properties to an XML element.
void setReferenceScale(double scale)
Sets the symbology reference scale.
virtual QString dump() const
Returns debug information about this renderer.
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the symbol property definitions.
void setUsingSymbolLevels(bool usingSymbolLevels)
virtual ~QgsFeatureRenderer()
virtual QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const =0
To be overridden.
virtual void checkLegendSymbolItem(const QString &key, bool state=true)
Sets whether the legend symbology item with the specified ley should be checked.
virtual QString legendKeyToExpression(const QString &key, QgsVectorLayer *layer, bool &ok) const
Attempts to convert the specified legend rule key to a QGIS expression matching the features displaye...
bool orderByEnabled() const
Returns whether custom ordering will be applied before features are processed by this renderer.
virtual bool filterNeedsGeometry() const
Returns true if this renderer requires the geometry to apply the filter.
virtual Q_DECL_DEPRECATED void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
Used from subclasses to create SLD Rule elements following SLD v1.1 specs.
static void convertSymbolRotation(QgsSymbol *symbol, const QString &field)
Converts old rotation expressions to symbol level data defined angles.
static QgsFeatureRenderer * load(QDomElement &symbologyElem, const QgsReadWriteContext &context)
create a renderer from XML element
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
QgsFeatureRequest::OrderBy mOrderBy
virtual QgsSymbol * originalSymbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns symbol for feature.
Qgis::VertexMarkerType mCurrentVertexMarkerType
The current type of editing marker.
QSet< QString > legendKeys() const
Returns the set of all legend keys used by the renderer.
virtual bool willRenderFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns whether the renderer will render a feature or not.
void saveRendererData(QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context)
Saves generic renderer data into the specified element.
void renderFeatureWithSymbol(const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
Render the feature with the symbol using context.
void renderVertexMarker(QPointF pt, QgsRenderContext &context)
render editing vertex marker at specified point
void renderVertexMarkerPolygon(QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
render editing vertex marker for a polygon
virtual const QgsFeatureRenderer * embeddedRenderer() const
Returns the current embedded renderer (subrenderer) for this feature renderer.
double mCurrentVertexMarkerSize
The current size of editing marker.
std::unique_ptr< QgsPaintEffect > mPaintEffect
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
void setDataDefinedProperty(Property key, const QgsProperty &property)
Sets a data defined property for the renderer.
static void convertSymbolSizeScale(QgsSymbol *symbol, Qgis::ScaleMethod method, const QString &field)
Converts old sizeScale expressions to symbol level data defined sizes.
void setVertexMarkerAppearance(Qgis::VertexMarkerType type, double size)
Sets type and size of editing vertex markers for subsequent rendering.
QgsFeatureRequest::OrderBy orderBy() const
Gets the order in which features shall be processed by this renderer.
static QgsFeatureRenderer * loadSld(const QDomNode &node, Qgis::GeometryType geomType, QString &errorMessage)
Create a new renderer according to the information contained in the UserStyle element of a SLD style ...
virtual QgsSymbolList originalSymbolsForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbol...
Represents a list of OrderByClauses, with the most important first and the least important last.
void CORE_EXPORT load(const QDomElement &elem)
Deserialize from XML.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Container of fields for a vector layer.
Definition qgsfields.h:46
Layer tree node points to a map layer.
Stores information about one class/rule of a vector layer renderer in a unified way that can be used ...
A line symbol type, for rendering LineString and MultiLineString geometries.
void setDataDefinedWidth(const QgsProperty &property) const
Set data defined width for whole symbol (including all symbol layers).
double width() const
Returns the estimated width for the whole symbol, which is the maximum width of all marker symbol lay...
A marker symbol type, for rendering Point and MultiPoint geometries.
void setScaleMethod(Qgis::ScaleMethod scaleMethod) const
Sets the method to use for scaling the marker's size.
double size() const
Returns the estimated size for the whole symbol, which is the maximum size of all marker symbol layer...
double angle() const
Returns the marker angle for the whole symbol.
void setDataDefinedSize(const QgsProperty &property) const
Set data defined size for whole symbol (including all symbol layers).
void setDataDefinedAngle(const QgsProperty &property)
Set data defined angle for whole symbol (including all symbol layers).
static QgsPaintEffect * defaultStack()
Returns a new effect stack consisting of a sensible selection of default effects.
static bool isDefaultStack(QgsPaintEffect *effect)
Tests whether a paint effect matches the default effects stack.
Base class for visual effects which can be applied to QPicture drawings.
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
Definition for a property.
Definition qgsproperty.h:45
@ DoublePositive
Positive double value (including 0).
Definition qgsproperty.h:56
A store for object properties.
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
A container for the context for various read/write operations on objects.
A rectangle specified with double values.
void grow(double delta)
Grows the rectangle in place by the specified amount.
Contains information about the context of a rendering operation.
double convertToMapUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to map units.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QPainter * painter()
Returns the destination QPainter for the render operation.
QgsExpressionContext & expressionContext()
Gets the expression context.
Stores metadata about one renderer class.
virtual QgsFeatureRenderer * createRenderer(QDomElement &elem, const QgsReadWriteContext &context)=0
Returns new instance of the renderer given the DOM element.
virtual QgsFeatureRenderer * createRendererFromSld(QDomElement &elem, Qgis::GeometryType geomType)
Returns a new instance of the renderer, converted from an SLD XML element.
QgsRendererAbstractMetadata * rendererMetadata(const QString &rendererName)
Returns the metadata for a specified renderer.
A feature renderer which renders all features with the same symbol.
Holds SLD export options and other information related to SLD export of a QGIS layer style.
void setExtraProperties(const QVariantMap &properties)
Sets the open ended set of properties that can drive/inform the SLD encoding.
void pushError(const QString &error)
Pushes a error message generated during the conversion.
An interface for classes which can visit style entity (e.g.
static void drawVertexMarker(double x, double y, QPainter &p, Qgis::VertexMarkerType type, int markerSize)
Draws a vertex symbol at (painter) coordinates x, y.
Implementation of legend node interface for displaying preview of vector symbols and their labels and...
int layer() const
The layer of this symbol level.
QgsSymbol * mSymbol
Definition qgsrenderer.h:85
QgsSymbol * symbol() const
The symbol of this symbol level.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
@ ExtentBuffer
Extent buffer.
Definition qgssymbol.h:272
void renderFeature(const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false, Qgis::VertexMarkerType currentVertexMarkerType=Qgis::VertexMarkerType::SemiTransparentCircle, double currentVertexMarkerSize=0.0)
Render a feature.
static QPointF _getPoint(QgsRenderContext &context, const QgsPoint &point)
Creates a point in screen coordinates from a QgsPoint in map coordinates.
Definition qgssymbol.h:948
Qgis::SymbolType type() const
Returns the symbol's type.
Definition qgssymbol.h:294
static QgsSymbol * defaultSymbol(Qgis::GeometryType geomType)
Returns a new default symbol for the specified geometry type.
Represents a vector layer which manages a vector based dataset.
QList< QgsLegendSymbolItem > QgsLegendSymbolList
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:61
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
#define RENDERER_TAG_NAME
Definition qgsrenderer.h:55
QList< QgsSymbol * > QgsSymbolList
Definition qgsrenderer.h:49