QGIS API Documentation 3.39.0-Master (47f7b3a4989)
Loading...
Searching...
No Matches
qgssymbollayer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgssymbollayer.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 "qgssymbollayer.h"
17#include "qgsrendercontext.h"
18#include "qgsdxfexport.h"
20#include "qgspainteffect.h"
22#include "qgsproperty.h"
24#include "qgssymbollayerutils.h"
25#include "qgslegendpatchshape.h"
26#include "qgsstyle.h"
28#include "qgssymbol.h"
30#include "qgsgeos.h"
31
32#include <QSize>
33#include <QPainter>
34#include <QPointF>
35#include <QPolygonF>
36#include <QUuid>
37
38QgsPropertiesDefinition QgsSymbolLayer::sPropertyDefinitions;
39
40void QgsSymbolLayer::initPropertyDefinitions()
41{
42 if ( !sPropertyDefinitions.isEmpty() )
43 return;
44
45 QString origin = QStringLiteral( "symbol" );
46
47 sPropertyDefinitions = QgsPropertiesDefinition
48 {
49 { static_cast< int >( QgsSymbolLayer::Property::Size ), QgsPropertyDefinition( "size", QObject::tr( "Symbol size" ), QgsPropertyDefinition::Size, origin ) },
50 { static_cast< int >( QgsSymbolLayer::Property::Angle ), QgsPropertyDefinition( "angle", QObject::tr( "Rotation angle" ), QgsPropertyDefinition::Rotation, origin ) },
51 { static_cast< int >( QgsSymbolLayer::Property::Name ), QgsPropertyDefinition( "name", QObject::tr( "Symbol name" ), QgsPropertyDefinition::String, origin ) },
52 { static_cast< int >( QgsSymbolLayer::Property::FillColor ), QgsPropertyDefinition( "fillColor", QObject::tr( "Symbol fill color" ), QgsPropertyDefinition::ColorWithAlpha, origin ) },
53 { static_cast< int >( QgsSymbolLayer::Property::StrokeColor ), QgsPropertyDefinition( "outlineColor", QObject::tr( "Symbol stroke color" ), QgsPropertyDefinition::ColorWithAlpha, origin ) },
54 { static_cast< int >( QgsSymbolLayer::Property::StrokeWidth ), QgsPropertyDefinition( "outlineWidth", QObject::tr( "Symbol stroke width" ), QgsPropertyDefinition::StrokeWidth, origin ) },
55 { static_cast< int >( QgsSymbolLayer::Property::StrokeStyle ), QgsPropertyDefinition( "outlineStyle", QObject::tr( "Symbol stroke style" ), QgsPropertyDefinition::LineStyle, origin )},
56 { static_cast< int >( QgsSymbolLayer::Property::Offset ), QgsPropertyDefinition( "offset", QObject::tr( "Symbol offset" ), QgsPropertyDefinition::Offset, origin )},
57 { static_cast< int >( QgsSymbolLayer::Property::Character ), QgsPropertyDefinition( "char", QObject::tr( "Marker character(s)" ), QgsPropertyDefinition::String, origin )},
58 { static_cast< int >( QgsSymbolLayer::Property::FontFamily ), QgsPropertyDefinition( "fontFamily", QObject::tr( "Font family" ), QgsPropertyDefinition::String, origin )},
59 { static_cast< int >( QgsSymbolLayer::Property::FontStyle ), QgsPropertyDefinition( "fontStyle", QObject::tr( "Font style" ), QgsPropertyDefinition::String, origin )},
60 { static_cast< int >( QgsSymbolLayer::Property::Width ), QgsPropertyDefinition( "width", QObject::tr( "Symbol width" ), QgsPropertyDefinition::DoublePositive, origin )},
61 { static_cast< int >( QgsSymbolLayer::Property::Height ), QgsPropertyDefinition( "height", QObject::tr( "Symbol height" ), QgsPropertyDefinition::DoublePositive, origin )},
62 { static_cast< int >( QgsSymbolLayer::Property::PreserveAspectRatio ), QgsPropertyDefinition( "preserveAspectRatio", QObject::tr( "Preserve aspect ratio between width and height" ), QgsPropertyDefinition::Boolean, origin )},
63 { static_cast< int >( QgsSymbolLayer::Property::FillStyle ), QgsPropertyDefinition( "fillStyle", QObject::tr( "Symbol fill style" ), QgsPropertyDefinition::FillStyle, origin )},
64 { static_cast< int >( QgsSymbolLayer::Property::JoinStyle ), QgsPropertyDefinition( "joinStyle", QObject::tr( "Outline join style" ), QgsPropertyDefinition::PenJoinStyle, origin )},
65 { static_cast< int >( QgsSymbolLayer::Property::SecondaryColor ), QgsPropertyDefinition( "color2", QObject::tr( "Secondary fill color" ), QgsPropertyDefinition::ColorWithAlpha, origin )},
66 { static_cast< int >( QgsSymbolLayer::Property::LineAngle ), QgsPropertyDefinition( "lineAngle", QObject::tr( "Angle for line fills" ), QgsPropertyDefinition::Rotation, origin )},
67 { static_cast< int >( QgsSymbolLayer::Property::GradientType ), QgsPropertyDefinition( "gradientType", QgsPropertyDefinition::DataTypeString, QObject::tr( "Gradient type" ), QObject::tr( "string " ) + QLatin1String( "[<b>linear</b>|<b>radial</b>|<b>conical</b>]" ), origin )},
68 { static_cast< int >( QgsSymbolLayer::Property::CoordinateMode ), QgsPropertyDefinition( "gradientMode", QgsPropertyDefinition::DataTypeString, QObject::tr( "Gradient mode" ), QObject::tr( "string " ) + QLatin1String( "[<b>feature</b>|<b>viewport</b>]" ), origin )},
69 { static_cast< int >( QgsSymbolLayer::Property::GradientSpread ), QgsPropertyDefinition( "gradientSpread", QgsPropertyDefinition::DataTypeString, QObject::tr( "Gradient spread" ), QObject::tr( "string " ) + QLatin1String( "[<b>pad</b>|<b>repeat</b>|<b>reflect</b>]" ), origin )},
70 { static_cast< int >( QgsSymbolLayer::Property::GradientReference1X ), QgsPropertyDefinition( "gradientRef1X", QObject::tr( "Reference point 1 (X)" ), QgsPropertyDefinition::Double0To1, origin )},
71 { static_cast< int >( QgsSymbolLayer::Property::GradientReference1Y ), QgsPropertyDefinition( "gradientRef1Y", QObject::tr( "Reference point 1 (Y)" ), QgsPropertyDefinition::Double0To1, origin )},
72 { static_cast< int >( QgsSymbolLayer::Property::GradientReference2X ), QgsPropertyDefinition( "gradientRef2X", QObject::tr( "Reference point 2 (X)" ), QgsPropertyDefinition::Double0To1, origin )},
73 { static_cast< int >( QgsSymbolLayer::Property::GradientReference2Y ), QgsPropertyDefinition( "gradientRef2Y", QObject::tr( "Reference point 2 (Y)" ), QgsPropertyDefinition::Double0To1, origin )},
74 { static_cast< int >( QgsSymbolLayer::Property::GradientReference1IsCentroid ), QgsPropertyDefinition( "gradientRef1Centroid", QObject::tr( "Reference point 1 follows feature centroid" ), QgsPropertyDefinition::Boolean, origin )},
75 { static_cast< int >( QgsSymbolLayer::Property::GradientReference2IsCentroid ), QgsPropertyDefinition( "gradientRef2Centroid", QObject::tr( "Reference point 2 follows feature centroid" ), QgsPropertyDefinition::Boolean, origin )},
76 { static_cast< int >( QgsSymbolLayer::Property::BlurRadius ), QgsPropertyDefinition( "blurRadius", QgsPropertyDefinition::DataTypeNumeric, QObject::tr( "Blur radius" ), QObject::tr( "Integer between 0 and 18" ), origin )},
77 { static_cast< int >( QgsSymbolLayer::Property::LineDistance ), QgsPropertyDefinition( "lineDistance", QObject::tr( "Distance between lines" ), QgsPropertyDefinition::DoublePositive, origin )},
78 { static_cast< int >( QgsSymbolLayer::Property::ShapeburstUseWholeShape ), QgsPropertyDefinition( "shapeburstWholeShape", QObject::tr( "Shade whole shape" ), QgsPropertyDefinition::Boolean, origin )},
79 { static_cast< int >( QgsSymbolLayer::Property::ShapeburstMaxDistance ), QgsPropertyDefinition( "shapeburstMaxDist", QObject::tr( "Maximum distance for shapeburst fill" ), QgsPropertyDefinition::DoublePositive, origin )},
80 { static_cast< int >( QgsSymbolLayer::Property::ShapeburstIgnoreRings ), QgsPropertyDefinition( "shapeburstIgnoreRings", QObject::tr( "Ignore rings in feature" ), QgsPropertyDefinition::Boolean, origin )},
81 { static_cast< int >( QgsSymbolLayer::Property::File ), QgsPropertyDefinition( "file", QObject::tr( "Symbol file path" ), QgsPropertyDefinition::String, origin )},
82 { static_cast< int >( QgsSymbolLayer::Property::DistanceX ), QgsPropertyDefinition( "distanceX", QObject::tr( "Horizontal distance between markers" ), QgsPropertyDefinition::DoublePositive, origin )},
83 { static_cast< int >( QgsSymbolLayer::Property::DistanceY ), QgsPropertyDefinition( "distanceY", QObject::tr( "Vertical distance between markers" ), QgsPropertyDefinition::DoublePositive, origin )},
84 { static_cast< int >( QgsSymbolLayer::Property::DisplacementX ), QgsPropertyDefinition( "displacementX", QObject::tr( "Horizontal displacement between rows" ), QgsPropertyDefinition::DoublePositive, origin )},
85 { static_cast< int >( QgsSymbolLayer::Property::DisplacementY ), QgsPropertyDefinition( "displacementY", QObject::tr( "Vertical displacement between columns" ), QgsPropertyDefinition::DoublePositive, origin )},
86 { static_cast< int >( QgsSymbolLayer::Property::OffsetX ), QgsPropertyDefinition( "offsetX", QObject::tr( "Horizontal offset" ), QgsPropertyDefinition::Double, origin )},
87 { static_cast< int >( QgsSymbolLayer::Property::OffsetY ), QgsPropertyDefinition( "offsetY", QObject::tr( "Vertical offset" ), QgsPropertyDefinition::Double, origin )},
88 { static_cast< int >( QgsSymbolLayer::Property::Opacity ), QgsPropertyDefinition( "alpha", QObject::tr( "Opacity" ), QgsPropertyDefinition::Opacity, origin )},
89 { static_cast< int >( QgsSymbolLayer::Property::CustomDash ), QgsPropertyDefinition( "customDash", QgsPropertyDefinition::DataTypeString, QObject::tr( "Custom dash pattern" ), QObject::tr( "[<b><dash>;<space></b>] e.g. '8;2;1;2'" ), origin )},
90 { static_cast< int >( QgsSymbolLayer::Property::CapStyle ), QgsPropertyDefinition( "capStyle", QObject::tr( "Line cap style" ), QgsPropertyDefinition::CapStyle, origin )},
91 { static_cast< int >( QgsSymbolLayer::Property::Placement ), QgsPropertyDefinition( "placement", QgsPropertyDefinition::DataTypeString, QObject::tr( "Marker placement" ), QObject::tr( "string " ) + "[<b>interval</b>|<b>innervertices</b>|<b>vertex</b>|<b>lastvertex</b>|<b>firstvertex</b>|<b>centerpoint</b>|<b>curvepoint</b>|<b>segmentcenter</b>]", origin )},
92 { static_cast< int >( QgsSymbolLayer::Property::Interval ), QgsPropertyDefinition( "interval", QObject::tr( "Marker interval" ), QgsPropertyDefinition::DoublePositive, origin )},
93 { static_cast< int >( QgsSymbolLayer::Property::OffsetAlongLine ), QgsPropertyDefinition( "offsetAlongLine", QObject::tr( "Offset along line" ), QgsPropertyDefinition::Double, origin )},
94 { static_cast< int >( QgsSymbolLayer::Property::AverageAngleLength ), QgsPropertyDefinition( "averageAngleLength", QObject::tr( "Average line angles over" ), QgsPropertyDefinition::DoublePositive, origin )},
95 { static_cast< int >( QgsSymbolLayer::Property::HorizontalAnchor ), QgsPropertyDefinition( "hAnchor", QObject::tr( "Horizontal anchor point" ), QgsPropertyDefinition::HorizontalAnchor, origin )},
96 { static_cast< int >( QgsSymbolLayer::Property::VerticalAnchor ), QgsPropertyDefinition( "vAnchor", QObject::tr( "Vertical anchor point" ), QgsPropertyDefinition::VerticalAnchor, origin )},
97 { static_cast< int >( QgsSymbolLayer::Property::LayerEnabled ), QgsPropertyDefinition( "enabled", QObject::tr( "Layer enabled" ), QgsPropertyDefinition::Boolean, origin )},
98 { static_cast< int >( QgsSymbolLayer::Property::ArrowWidth ), QgsPropertyDefinition( "arrowWidth", QObject::tr( "Arrow line width" ), QgsPropertyDefinition::StrokeWidth, origin )},
99 { static_cast< int >( QgsSymbolLayer::Property::ArrowStartWidth ), QgsPropertyDefinition( "arrowStartWidth", QObject::tr( "Arrow line start width" ), QgsPropertyDefinition::StrokeWidth, origin )},
100 { static_cast< int >( QgsSymbolLayer::Property::ArrowHeadLength ), QgsPropertyDefinition( "arrowHeadLength", QObject::tr( "Arrow head length" ), QgsPropertyDefinition::DoublePositive, origin )},
101 { static_cast< int >( QgsSymbolLayer::Property::ArrowHeadThickness ), QgsPropertyDefinition( "arrowHeadThickness", QObject::tr( "Arrow head thickness" ), QgsPropertyDefinition::DoublePositive, origin )},
102 { static_cast< int >( QgsSymbolLayer::Property::ArrowHeadType ), QgsPropertyDefinition( "arrowHeadType", QgsPropertyDefinition::DataTypeString, QObject::tr( "Arrow head type" ), QObject::tr( "string " ) + QLatin1String( "[<b>single</b>|<b>reversed</b>|<b>double</b>]" ), origin )},
103 { static_cast< int >( QgsSymbolLayer::Property::ArrowType ), QgsPropertyDefinition( "arrowType", QgsPropertyDefinition::DataTypeString, QObject::tr( "Arrow type" ), QObject::tr( "string " ) + QLatin1String( "[<b>plain</b>|<b>lefthalf</b>|<b>righthalf</b>]" ), origin )},
104 { static_cast< int >( QgsSymbolLayer::Property::PointCount ), QgsPropertyDefinition( "pointCount", QObject::tr( "Point count" ), QgsPropertyDefinition::IntegerPositive, origin )},
105 { static_cast< int >( QgsSymbolLayer::Property::RandomSeed ), QgsPropertyDefinition( "randomSeed", QgsPropertyDefinition::DataTypeNumeric, QObject::tr( "Random number seed" ), QObject::tr( "integer > 0, or 0 for completely random sequence" ), origin )},
106 { static_cast< int >( QgsSymbolLayer::Property::ClipPoints ), QgsPropertyDefinition( "clipPoints", QObject::tr( "Clip markers" ), QgsPropertyDefinition::Boolean, origin )},
107 { static_cast< int >( QgsSymbolLayer::Property::DensityArea ), QgsPropertyDefinition( "densityArea", QObject::tr( "Density area" ), QgsPropertyDefinition::DoublePositive, origin )},
108 { static_cast< int >( QgsSymbolLayer::Property::DashPatternOffset ), QgsPropertyDefinition( "dashPatternOffset", QObject::tr( "Dash pattern offset" ), QgsPropertyDefinition::DoublePositive, origin )},
109 { static_cast< int >( QgsSymbolLayer::Property::TrimStart ), QgsPropertyDefinition( "trimStart", QObject::tr( "Start trim distance" ), QgsPropertyDefinition::DoublePositive, origin )},
110 { static_cast< int >( QgsSymbolLayer::Property::TrimEnd ), QgsPropertyDefinition( "trimEnd", QObject::tr( "End trim distance" ), QgsPropertyDefinition::DoublePositive, origin )},
111 { static_cast< int >( QgsSymbolLayer::Property::LineStartWidthValue ), QgsPropertyDefinition( "lineStartWidthValue", QObject::tr( "Line start width value" ), QgsPropertyDefinition::Double, origin )},
112 { static_cast< int >( QgsSymbolLayer::Property::LineEndWidthValue ), QgsPropertyDefinition( "lineEndWidthValue", QObject::tr( "Line end width value" ), QgsPropertyDefinition::Double, origin )},
113 { static_cast< int >( QgsSymbolLayer::Property::LineStartColorValue ), QgsPropertyDefinition( "lineStartColorValue", QObject::tr( "Line start color value" ), QgsPropertyDefinition::Double, origin )},
114 { static_cast< int >( QgsSymbolLayer::Property::LineEndColorValue ), QgsPropertyDefinition( "lineEndColorValue", QObject::tr( "Line end color value" ), QgsPropertyDefinition::Double, origin )},
115 { static_cast< int >( QgsSymbolLayer::Property::MarkerClipping ), QgsPropertyDefinition( "markerClipping", QgsPropertyDefinition::DataTypeString, QObject::tr( "Marker clipping mode" ), QObject::tr( "string " ) + QLatin1String( "[<b>no</b>|<b>shape</b>|<b>centroid_within</b>|<b>completely_within</b>]" ), origin )},
116 { static_cast< int >( QgsSymbolLayer::Property::RandomOffsetX ), QgsPropertyDefinition( "randomOffsetX", QObject::tr( "Horizontal random offset" ), QgsPropertyDefinition::Double, origin )},
117 { static_cast< int >( QgsSymbolLayer::Property::RandomOffsetY ), QgsPropertyDefinition( "randomOffsetY", QObject::tr( "Vertical random offset" ), QgsPropertyDefinition::Double, origin )},
118 { static_cast< int >( QgsSymbolLayer::Property::LineClipping ), QgsPropertyDefinition( "lineClipping", QgsPropertyDefinition::DataTypeString, QObject::tr( "Line clipping mode" ), QObject::tr( "string " ) + QLatin1String( "[<b>no</b>|<b>during_render</b>|<b>before_render</b>]" ), origin )},
119 };
120}
121
126
128{
129 installMasks( context, false );
130
131 if ( QgsSymbol *lSubSymbol = subSymbol() )
132 lSubSymbol->startFeatureRender( feature, context );
133}
134
136{
137 if ( QgsSymbol *lSubSymbol = subSymbol() )
138 lSubSymbol->stopFeatureRender( feature, context );
139
140 removeMasks( context, false );
141}
142
144{
145 return nullptr;
146}
147
149{
150 delete symbol;
151 return false;
152}
153
154bool QgsSymbolLayer::writeDxf( QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift ) const
155{
156 Q_UNUSED( e )
157 Q_UNUSED( mmMapUnitScaleFactor )
158 Q_UNUSED( layerName )
159 Q_UNUSED( context )
160 Q_UNUSED( shift )
161 return false;
162}
163
165{
166 Q_UNUSED( e )
167 Q_UNUSED( context )
168 return 1.0;
169}
170
172{
173 Q_UNUSED( e )
174 Q_UNUSED( context )
175 return 1.0;
176}
177
179{
180 Q_UNUSED( e )
181 Q_UNUSED( context )
182 return 0.0;
183}
184
186{
187 Q_UNUSED( context )
188 return color();
189}
190
192{
193 Q_UNUSED( context )
194 return 0.0;
195}
196
198{
199 Q_UNUSED( unit )
200 return QVector<qreal>();
201}
202
203Qt::PenStyle QgsSymbolLayer::dxfPenStyle() const
204{
205 return Qt::SolidLine;
206}
207
209{
210 Q_UNUSED( context )
211 return color();
212}
213
214Qt::BrushStyle QgsSymbolLayer::dxfBrushStyle() const
215{
216 return Qt::NoBrush;
217}
218
220{
221 return mPaintEffect.get();
222}
223
225{
226 if ( effect == mPaintEffect.get() )
227 return;
228
229 mPaintEffect.reset( effect );
230}
231
233 : mType( type )
234 , mLocked( locked )
235 , mId( QUuid::createUuid().toString() )
236{
237}
238
243
248
253
255{
256 return mColor;
257}
258
259void QgsSymbolLayer::setColor( const QColor &color )
260{
261 mColor = color;
262}
263
264void QgsSymbolLayer::setStrokeColor( const QColor & )
265{
266
267}
268
270{
271 return QColor();
272}
273
274void QgsSymbolLayer::setFillColor( const QColor & )
275{
276}
277
279{
280 return QColor();
281}
282
284{
286
287 if ( !context.fields().isEmpty() )
288 {
289 //QgsFields is implicitly shared, so it's cheap to make a copy
290 mFields = context.fields();
291 }
292}
293
298
300{
301 QgsSymbolLayer::initPropertyDefinitions();
302 return sPropertyDefinitions;
303}
304
306
308{
310 return true;
311
312 return symbol->type() == mType;
313}
314
316{
317 return false;
318}
319
321{
322 return false;
323}
324
325void QgsSymbolLayer::setRenderingPass( int renderingPass )
326{
328}
329
331{
332 return mRenderingPass;
333}
334
335QSet<QString> QgsSymbolLayer::usedAttributes( const QgsRenderContext &context ) const
336{
337 // calling referencedFields() with ignoreContext=true because in our expression context
338 // we do not have valid QgsFields yet - because of that the field names from expressions
339 // wouldn't get reported
340 QSet<QString> columns = mDataDefinedProperties.referencedFields( context.expressionContext(), true );
341 return columns;
342}
343
344QgsProperty propertyFromMap( const QVariantMap &map, const QString &baseName )
345{
346 QString prefix;
347 if ( !baseName.isEmpty() )
348 {
349 prefix.append( QStringLiteral( "%1_dd_" ).arg( baseName ) );
350 }
351
352 if ( !map.contains( QStringLiteral( "%1expression" ).arg( prefix ) ) )
353 {
354 //requires at least the expression value
355 return QgsProperty();
356 }
357
358 bool active = ( map.value( QStringLiteral( "%1active" ).arg( prefix ), QStringLiteral( "1" ) ) != QLatin1String( "0" ) );
359 QString expression = map.value( QStringLiteral( "%1expression" ).arg( prefix ) ).toString();
360 bool useExpression = ( map.value( QStringLiteral( "%1useexpr" ).arg( prefix ), QStringLiteral( "1" ) ) != QLatin1String( "0" ) );
361 QString field = map.value( QStringLiteral( "%1field" ).arg( prefix ), QString() ).toString();
362
363 if ( useExpression )
364 return QgsProperty::fromExpression( expression, active );
365 else
366 return QgsProperty::fromField( field, active );
367}
368
369void QgsSymbolLayer::restoreOldDataDefinedProperties( const QVariantMap &stringMap )
370{
371 // property string to type upgrade map
372 static const QMap < QString, int > OLD_PROPS
373 {
374 { "color", static_cast< int >( QgsSymbolLayer::Property::FillColor ) },
375 { "arrow_width", static_cast< int >( QgsSymbolLayer::Property::ArrowWidth ) },
376 { "arrow_start_width", static_cast< int >( QgsSymbolLayer::Property::ArrowStartWidth ) },
377 { "head_length", static_cast< int >( QgsSymbolLayer::Property::ArrowHeadLength ) },
378 { "head_thickness", static_cast< int >( QgsSymbolLayer::Property::ArrowHeadThickness ) },
379 { "offset", static_cast< int >( QgsSymbolLayer::Property::Offset ) },
380 { "head_type", static_cast< int >( QgsSymbolLayer::Property::ArrowHeadType ) },
381 { "arrow_type", static_cast< int >( QgsSymbolLayer::Property::ArrowType ) },
382 { "width_field", static_cast< int >( QgsSymbolLayer::Property::Width ) },
383 { "height_field", static_cast< int >( QgsSymbolLayer::Property::Height ) },
384 { "rotation_field", static_cast< int >( QgsSymbolLayer::Property::Angle ) },
385 { "outline_width_field", static_cast< int >( QgsSymbolLayer::Property::StrokeWidth ) },
386 { "fill_color_field", static_cast< int >( QgsSymbolLayer::Property::FillColor ) },
387 { "outline_color_field", static_cast< int >( QgsSymbolLayer::Property::StrokeColor ) },
388 { "symbol_name_field", static_cast< int >( QgsSymbolLayer::Property::Name ) },
389 { "outline_width", static_cast< int >( QgsSymbolLayer::Property::StrokeWidth ) },
390 { "outline_style", static_cast< int >( QgsSymbolLayer::Property::StrokeStyle ) },
391 { "join_style", static_cast< int >( QgsSymbolLayer::Property::JoinStyle ) },
392 { "fill_color", static_cast< int >( QgsSymbolLayer::Property::FillColor ) },
393 { "outline_color", static_cast< int >( QgsSymbolLayer::Property::StrokeColor ) },
394 { "width", static_cast< int >( QgsSymbolLayer::Property::Width ) },
395 { "height", static_cast< int >( QgsSymbolLayer::Property::Height ) },
396 { "symbol_name", static_cast< int >( QgsSymbolLayer::Property::Name ) },
397 { "angle", static_cast< int >( QgsSymbolLayer::Property::Angle ) },
398 { "fill_style", static_cast< int >( QgsSymbolLayer::Property::FillStyle ) },
399 { "color_border", static_cast< int >( QgsSymbolLayer::Property::StrokeColor ) },
400 { "width_border", static_cast< int >( QgsSymbolLayer::Property::StrokeWidth ) },
401 { "border_color", static_cast< int >( QgsSymbolLayer::Property::StrokeColor ) },
402 { "border_style", static_cast< int >( QgsSymbolLayer::Property::StrokeStyle ) },
403 { "color2", static_cast< int >( QgsSymbolLayer::Property::SecondaryColor ) },
404 { "gradient_type", static_cast< int >( QgsSymbolLayer::Property::GradientType ) },
405 { "coordinate_mode", static_cast< int >( QgsSymbolLayer::Property::CoordinateMode )},
406 { "spread", static_cast< int >( QgsSymbolLayer::Property::GradientSpread ) },
407 { "reference1_x", static_cast< int >( QgsSymbolLayer::Property::GradientReference1X ) },
408 { "reference1_y", static_cast< int >( QgsSymbolLayer::Property::GradientReference1Y ) },
409 { "reference2_x", static_cast< int >( QgsSymbolLayer::Property::GradientReference2X ) },
410 { "reference2_y", static_cast< int >( QgsSymbolLayer::Property::GradientReference2Y )},
411 { "reference1_iscentroid", static_cast< int >( QgsSymbolLayer::Property::GradientReference1IsCentroid )},
412 { "reference2_iscentroid", static_cast< int >( QgsSymbolLayer::Property::GradientReference2IsCentroid )},
413 { "blur_radius", static_cast< int >( QgsSymbolLayer::Property::BlurRadius ) },
414 { "use_whole_shape", static_cast< int >( QgsSymbolLayer::Property::ShapeburstUseWholeShape ) },
415 { "max_distance", static_cast< int >( QgsSymbolLayer::Property::ShapeburstMaxDistance ) },
416 { "ignore_rings", static_cast< int >( QgsSymbolLayer::Property::ShapeburstIgnoreRings ) },
417 { "svgFillColor", static_cast< int >( QgsSymbolLayer::Property::FillColor ) },
418 { "svgOutlineColor", static_cast< int >( QgsSymbolLayer::Property::StrokeColor ) },
419 { "svgOutlineWidth", static_cast< int >( QgsSymbolLayer::Property::StrokeWidth ) },
420 { "svgFile", static_cast< int >( QgsSymbolLayer::Property::File ) },
421 { "lineangle", static_cast< int >( QgsSymbolLayer::Property::LineAngle ) },
422 { "distance", static_cast< int >( QgsSymbolLayer::Property::LineDistance )},
423 { "distance_x", static_cast< int >( QgsSymbolLayer::Property::DistanceX )},
424 { "distance_y", static_cast< int >( QgsSymbolLayer::Property::DistanceY ) },
425 { "displacement_x", static_cast< int >( QgsSymbolLayer::Property::DisplacementX )},
426 { "displacement_y", static_cast< int >( QgsSymbolLayer::Property::DisplacementY ) },
427 { "file", static_cast< int >( QgsSymbolLayer::Property::File ) },
428 { "alpha", static_cast< int >( QgsSymbolLayer::Property::Opacity )},
429 { "customdash", static_cast< int >( QgsSymbolLayer::Property::CustomDash ) },
430 { "line_style", static_cast< int >( QgsSymbolLayer::Property::StrokeStyle ) },
431 { "joinstyle", static_cast< int >( QgsSymbolLayer::Property::JoinStyle ) },
432 { "capstyle", static_cast< int >( QgsSymbolLayer::Property::CapStyle ) },
433 { "placement", static_cast< int >( QgsSymbolLayer::Property::Placement ) },
434 { "interval", static_cast< int >( QgsSymbolLayer::Property::Interval ) },
435 { "offset_along_line", static_cast< int >( QgsSymbolLayer::Property::OffsetAlongLine ) },
436 { "name", static_cast< int >( QgsSymbolLayer::Property::Name ) },
437 { "size", static_cast< int >( QgsSymbolLayer::Property::Size ) },
438 { "fill", static_cast< int >( QgsSymbolLayer::Property::FillColor ) },
439 { "outline", static_cast< int >( QgsSymbolLayer::Property::StrokeColor )},
440 { "char", static_cast< int >( QgsSymbolLayer::Property::Character )},
441 { "enabled", static_cast< int >( QgsSymbolLayer::Property::LayerEnabled ) },
442 { "rotation", static_cast< int >( QgsSymbolLayer::Property::Angle )},
443 { "horizontal_anchor_point", static_cast< int >( QgsSymbolLayer::Property::HorizontalAnchor ) },
444 { "vertical_anchor_point", static_cast< int >( QgsSymbolLayer::Property::VerticalAnchor ) },
445 };
446
447 QVariantMap::const_iterator propIt = stringMap.constBegin();
448 for ( ; propIt != stringMap.constEnd(); ++propIt )
449 {
450 std::unique_ptr<QgsProperty> prop;
451 QString propertyName;
452
453 if ( propIt.key().endsWith( QLatin1String( "_dd_expression" ) ) )
454 {
455 //found a data defined property
456
457 //get data defined property name by stripping "_dd_expression" from property key
458 propertyName = propIt.key().left( propIt.key().length() - 14 );
459
460 prop = std::make_unique<QgsProperty>( propertyFromMap( stringMap, propertyName ) );
461 }
462 else if ( propIt.key().endsWith( QLatin1String( "_expression" ) ) )
463 {
464 //old style data defined property, upgrade
465
466 //get data defined property name by stripping "_expression" from property key
467 propertyName = propIt.key().left( propIt.key().length() - 11 );
468
469 prop = std::make_unique<QgsProperty>( QgsProperty::fromExpression( propIt.value().toString() ) );
470 }
471
472 if ( !prop || !OLD_PROPS.contains( propertyName ) )
473 continue;
474
475 int key = OLD_PROPS.value( propertyName );
476
477 if ( type() == Qgis::SymbolType::Line )
478 {
479 //these keys had different meaning for line symbol layers
480 if ( propertyName == QLatin1String( "width" ) )
481 key = static_cast< int >( QgsSymbolLayer::Property::StrokeWidth );
482 else if ( propertyName == QLatin1String( "color" ) )
483 key = static_cast< int >( QgsSymbolLayer::Property::StrokeColor );
484 }
485
486 setDataDefinedProperty( static_cast< QgsSymbolLayer::Property >( key ), QgsProperty( *prop.get() ) );
487 }
488}
489
491{
492 if ( !destLayer )
493 return;
494
496}
497
499{
500 if ( !destLayer || !mPaintEffect )
501 return;
502
504 destLayer->setPaintEffect( mPaintEffect->clone() );
505 else
506 destLayer->setPaintEffect( nullptr );
507}
508
510 : QgsSymbolLayer( Qgis::SymbolType::Marker, locked )
511{
512
513}
514
516 : QgsSymbolLayer( Qgis::SymbolType::Line, locked )
517{
518}
519
524
526{
527 mRingFilter = filter;
528}
529
531 : QgsSymbolLayer( Qgis::SymbolType::Fill, locked )
532{
533}
534
536{
537 Q_UNUSED( context )
538}
539
541{
542 Q_UNUSED( context )
543}
544
546{
547 startRender( context );
548 QgsPaintEffect *effect = paintEffect();
549
550 QPolygonF points = context.patchShape() ? context.patchShape()->toQPolygonF( Qgis::SymbolType::Marker, size ).value( 0 ).value( 0 )
552
553 std::unique_ptr< QgsEffectPainter > effectPainter;
554 if ( effect && effect->enabled() )
555 effectPainter = std::make_unique< QgsEffectPainter >( context.renderContext(), effect );
556
557 for ( QPointF point : std::as_const( points ) )
558 renderPoint( point, context );
559
560 effectPainter.reset();
561
562 stopRender( context );
563}
564
565void QgsMarkerSymbolLayer::markerOffset( QgsSymbolRenderContext &context, double &offsetX, double &offsetY ) const
566{
568}
569
570void QgsMarkerSymbolLayer::markerOffset( QgsSymbolRenderContext &context, double width, double height, double &offsetX, double &offsetY ) const
571{
572 markerOffset( context, width, height, mSizeUnit, mSizeUnit, offsetX, offsetY, mSizeMapUnitScale, mSizeMapUnitScale );
573}
574
575void QgsMarkerSymbolLayer::markerOffset( QgsSymbolRenderContext &context, double width, double height,
576 Qgis::RenderUnit widthUnit, Qgis::RenderUnit heightUnit,
577 double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale ) const
578{
579 offsetX = mOffset.x();
580 offsetY = mOffset.y();
581
583 {
586 bool ok = false;
587 const QPointF offset = QgsSymbolLayerUtils::toPoint( exprVal, &ok );
588 if ( ok )
589 {
590 offsetX = offset.x();
591 offsetY = offset.y();
592 }
593 }
594
597
601 {
603 if ( !QgsVariantUtils::isNull( exprVal ) )
604 {
605 horizontalAnchorPoint = decodeHorizontalAnchorPoint( exprVal.toString() );
606 }
607 }
609 {
611 if ( !QgsVariantUtils::isNull( exprVal ) )
612 {
613 verticalAnchorPoint = decodeVerticalAnchorPoint( exprVal.toString() );
614 }
615 }
616
617 //correct horizontal position according to anchor point
619 {
620 return;
621 }
622
623 double anchorPointCorrectionX = context.renderContext().convertToPainterUnits( width, widthUnit, widthMapUnitScale ) / 2.0;
625 {
626 // rendering for symbol previews -- an size in meters in map units can't be calculated, so treat the size as millimeters
627 // and clamp it to a reasonable range. It's the best we can do in this situation!
628 anchorPointCorrectionX = std::min( std::max( context.renderContext().convertToPainterUnits( width, Qgis::RenderUnit::Millimeters ), 3.0 ), 100.0 ) / 2.0;
629 }
630
631 double anchorPointCorrectionY = context.renderContext().convertToPainterUnits( height, heightUnit, heightMapUnitScale ) / 2.0;
633 {
634 // rendering for symbol previews -- an size in meters in map units can't be calculated, so treat the size as millimeters
635 // and clamp it to a reasonable range. It's the best we can do in this situation!
636 anchorPointCorrectionY = std::min( std::max( context.renderContext().convertToPainterUnits( height, Qgis::RenderUnit::Millimeters ), 3.0 ), 100.0 ) / 2.0;
637 }
638
640 {
641 offsetX += anchorPointCorrectionX;
642 }
643 else if ( horizontalAnchorPoint == Right )
644 {
645 offsetX -= anchorPointCorrectionX;
646 }
647
648//correct vertical position according to anchor point
649 if ( verticalAnchorPoint == Top )
650 {
651 offsetY += anchorPointCorrectionY;
652 }
653 else if ( verticalAnchorPoint == Bottom )
654 {
655 offsetY -= anchorPointCorrectionY;
656 }
657}
658
659QPointF QgsMarkerSymbolLayer::_rotatedOffset( QPointF offset, double angle )
660{
661 angle = DEG2RAD( angle );
662 double c = std::cos( angle ), s = std::sin( angle );
663 return QPointF( offset.x() * c - offset.y() * s, offset.x() * s + offset.y() * c );
664}
665
666QgsMarkerSymbolLayer::HorizontalAnchorPoint QgsMarkerSymbolLayer::decodeHorizontalAnchorPoint( const QString &str )
667{
668 if ( str.compare( QLatin1String( "left" ), Qt::CaseInsensitive ) == 0 )
669 {
671 }
672 else if ( str.compare( QLatin1String( "right" ), Qt::CaseInsensitive ) == 0 )
673 {
675 }
676 else
677 {
679 }
680}
681
682QgsMarkerSymbolLayer::VerticalAnchorPoint QgsMarkerSymbolLayer::decodeVerticalAnchorPoint( const QString &str )
683{
684 if ( str.compare( QLatin1String( "top" ), Qt::CaseInsensitive ) == 0 )
685 {
687 }
688 else if ( str.compare( QLatin1String( "bottom" ), Qt::CaseInsensitive ) == 0 )
689 {
691 }
692 else
693 {
695 }
696}
697
699{
700 mSizeUnit = unit;
701 mOffsetUnit = unit;
702}
703
705{
706 if ( mOffsetUnit != mSizeUnit )
707 {
709 }
710 return mOffsetUnit;
711}
712
718
727
729{
730 mWidthUnit = unit;
731 mOffsetUnit = unit;
732}
733
738
743
748
749
751{
752 const QList< QList< QPolygonF > > points = context.patchShape() ? context.patchShape()->toQPolygonF( Qgis::SymbolType::Line, size )
754 startRender( context );
755 QgsPaintEffect *effect = paintEffect();
756
757 std::unique_ptr< QgsEffectPainter > effectPainter;
758 if ( effect && effect->enabled() )
759 effectPainter = std::make_unique< QgsEffectPainter >( context.renderContext(), effect );
760
761 for ( const QList< QPolygonF > &line : points )
762 renderPolyline( line.value( 0 ), context );
763
764 effectPainter.reset();
765
766 stopRender( context );
767}
768
769void QgsLineSymbolLayer::renderPolygonStroke( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context )
770{
771 QgsExpressionContextScope *scope = nullptr;
772 std::unique_ptr< QgsExpressionContextScopePopper > scopePopper;
774 {
775 scope = new QgsExpressionContextScope();
776 scopePopper = std::make_unique< QgsExpressionContextScopePopper >( context.renderContext().expressionContext(), scope );
777 }
778
779 switch ( mRingFilter )
780 {
781 case AllRings:
782 case ExteriorRingOnly:
783 {
784 if ( scope )
786 renderPolyline( points, context );
787 break;
788 }
790 break;
791 }
792
793 if ( rings )
794 {
795 switch ( mRingFilter )
796 {
797 case AllRings:
799 {
800 int ringIndex = 1;
801 for ( const QPolygonF &ring : std::as_const( *rings ) )
802 {
803 if ( scope )
805
806 renderPolyline( ring, context );
807 ringIndex++;
808 }
809 }
810 break;
811 case ExteriorRingOnly:
812 break;
813 }
814 }
815}
816
817double QgsLineSymbolLayer::width( const QgsRenderContext &context ) const
818{
820}
821
823{
824 Q_UNUSED( context )
826}
827
828
830{
831 const QList< QList< QPolygonF > > polys = context.patchShape() ? context.patchShape()->toQPolygonF( Qgis::SymbolType::Fill, size )
833
834 startRender( context );
835 QgsPaintEffect *effect = paintEffect();
836
837 std::unique_ptr< QgsEffectPainter > effectPainter;
838 if ( effect && effect->enabled() )
839 effectPainter = std::make_unique< QgsEffectPainter >( context.renderContext(), effect );
840
841 for ( const QList< QPolygonF > &poly : polys )
842 {
843 QVector< QPolygonF > rings;
844 for ( int i = 1; i < poly.size(); ++i )
845 rings << poly.at( i );
846 renderPolygon( poly.value( 0 ), &rings, context );
847 }
848
849 effectPainter.reset();
850
851 stopRender( context );
852}
853
855{
856 return QImage();
857}
858
859void QgsFillSymbolLayer::_renderPolygon( QPainter *p, const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context )
860{
861 if ( !p )
862 {
863 return;
864 }
865
866 // Disable 'Antialiasing' if the geometry was generalized in the current RenderContext (We known that it must have least #5 points).
867 if ( points.size() <= 5 &&
870 ( p->renderHints() & QPainter::Antialiasing ) )
871 {
872 p->setRenderHint( QPainter::Antialiasing, false );
873 p->drawRect( points.boundingRect() );
874 p->setRenderHint( QPainter::Antialiasing, true );
875 return;
876 }
877
878 // polygons outlines are sometimes rendered wrongly with drawPolygon, when
879 // clipped (see #13343), so use drawPath instead.
880 if ( !rings && p->pen().style() == Qt::NoPen )
881 {
882 // simple polygon without holes
883 p->drawPolygon( points );
884 }
885 else
886 {
887 // polygon with holes must be drawn using painter path
888 QPainterPath path;
889 path.addPolygon( points );
890
891 if ( rings )
892 {
893 for ( auto it = rings->constBegin(); it != rings->constEnd(); ++it )
894 {
895 QPolygonF ring = *it;
896 path.addPolygon( ring );
897 }
898 }
899
900 p->drawPath( path );
901 }
902}
903
904void QgsMarkerSymbolLayer::toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const
905{
906 QDomElement symbolizerElem = doc.createElement( QStringLiteral( "se:PointSymbolizer" ) );
907 if ( !props.value( QStringLiteral( "uom" ), QString() ).toString().isEmpty() )
908 symbolizerElem.setAttribute( QStringLiteral( "uom" ), props.value( QStringLiteral( "uom" ), QString() ).toString() );
909 element.appendChild( symbolizerElem );
910
911 // <Geometry>
912 QgsSymbolLayerUtils::createGeometryElement( doc, symbolizerElem, props.value( QStringLiteral( "geom" ), QString() ).toString() );
913
914 writeSldMarker( doc, symbolizerElem, props );
915}
916
917QList<QgsSymbolLayerReference> QgsSymbolLayer::masks() const
918{
919 return {};
920}
921
923{
924 double size = mSize;
926 {
927 bool ok = false;
929
930 if ( ok )
931 {
932 switch ( mScaleMethod )
933 {
935 size = std::sqrt( size );
936 break;
938 break;
939 }
940 }
941 }
943}
944
955
956QPainterPath generateClipPath( const QgsRenderContext &renderContext, const QString &id, const QRectF *rect, bool &foundGeometries )
957{
958 foundGeometries = false;
959 const QVector<QgsGeometry> clipGeometries = rect
961 : renderContext.symbolLayerClipGeometries( id );
962 if ( !clipGeometries.empty() )
963 {
964 foundGeometries = true;
965 QgsGeometry mergedGeom = QgsGeometry::unaryUnion( clipGeometries );
966 if ( renderContext.maskSettings().simplifyTolerance() > 0 )
967 {
968 QgsGeos geos( mergedGeom.constGet() );
969 mergedGeom = QgsGeometry( geos.simplify( renderContext.maskSettings().simplifyTolerance() ) );
970 }
971#if GEOS_VERSION_MAJOR==3 && GEOS_VERSION_MINOR<10
972 // structure would be better, but too old GEOS
973 mergedGeom = mergedGeom.makeValid( Qgis::MakeValidMethod::Linework );
974#else
975 mergedGeom = mergedGeom.makeValid( Qgis::MakeValidMethod::Structure );
976#endif
977 if ( !mergedGeom.isEmpty() )
978 {
979 const QgsGeometry exterior = rect
980 ? QgsGeometry::fromRect( *rect )
982 QgsRectangle( 0, 0,
983 renderContext.outputSize().width(),
984 renderContext.outputSize().height() ) );
985 const QgsGeometry maskGeom = exterior.difference( mergedGeom );
986 if ( !maskGeom.isNull() )
987 {
988 return maskGeom.constGet()->asQPainterPath();
989 }
990 }
991 }
992 return QPainterPath();
993}
994
996{
997 const QgsRenderContext &renderContext = context.renderContext();
998
999 bool foundGeometries = false;
1000 mClipPath = generateClipPath( renderContext, id(), nullptr, foundGeometries );
1001}
1002
1003bool QgsSymbolLayer::installMasks( QgsRenderContext &context, bool recursive, const QRectF &rect )
1004{
1005 bool res = false;
1006 if ( !mClipPath.isEmpty() )
1007 {
1008 context.painter()->save();
1009 context.painter()->setClipPath( mClipPath, Qt::IntersectClip );
1010 res = true;
1011 }
1012 else if ( rect.isValid() )
1013 {
1014 // find just the clip geometries within the area the symbol layer will be drawn over
1015 bool foundGeometries = false;
1016 const QPainterPath clipPath = generateClipPath( context, id(), &rect, foundGeometries );
1017 if ( !clipPath.isEmpty() )
1018 {
1019 context.painter()->setClipPath( clipPath, context.painter()->clipPath().isEmpty() ? Qt::ReplaceClip : Qt::IntersectClip );
1020 res = true;
1021 }
1022 }
1023
1024 if ( QgsSymbol *lSubSymbol = recursive ? subSymbol() : nullptr )
1025 {
1026 const QList<QgsSymbolLayer *> layers = lSubSymbol->symbolLayers();
1027 for ( QgsSymbolLayer *sl : layers )
1028 res = sl->installMasks( context, true ) || res;
1029 }
1030
1031 return res;
1032}
1033
1034void QgsSymbolLayer::removeMasks( QgsRenderContext &context, bool recursive )
1035{
1036 if ( !mClipPath.isEmpty() )
1037 {
1038 context.painter()->restore();
1039 }
1040
1041 if ( QgsSymbol *lSubSymbol = recursive ? subSymbol() : nullptr )
1042 {
1043 const QList<QgsSymbolLayer *> layers = lSubSymbol->symbolLayers();
1044 for ( QgsSymbolLayer *sl : layers )
1045 sl->removeMasks( context, true );
1046 }
1047}
1048
1053
1054void QgsSymbolLayer::setId( const QString &id )
1055{
1056 mId = id;
1057}
1058
1059QString QgsSymbolLayer::id() const
1060{
1061 return mId;
1062}
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
@ AntialiasingSimplification
The geometries can be rendered with 'AntiAliasing' disabled because of it is '1-pixel size'.
@ ScaleDiameter
Calculate scale by the diameter.
@ ScaleArea
Calculate scale by the area.
QFlags< SymbolLayerFlag > SymbolLayerFlags
Symbol layer flags.
Definition qgis.h:644
QFlags< SymbolLayerUserFlag > SymbolLayerUserFlags
Symbol layer user flags.
Definition qgis.h:667
RenderUnit
Rendering size units.
Definition qgis.h:4494
@ Millimeters
Millimeters.
@ Unknown
Mixed or unknown units.
@ MetersInMapUnits
Meters value as Map units.
@ RenderSymbolPreview
The render is for a symbol preview only and map based properties may not be available,...
@ Linework
Combines all rings into a set of noded lines and then extracts valid polygons from that linework.
@ Structure
Structured method, first makes all rings valid and then merges shells and subtracts holes from shells...
@ DisableSelectionRecoloring
If present, indicates that the symbol layer should not be recolored when rendering selected features.
SymbolType
Symbol types.
Definition qgis.h:420
@ Marker
Marker symbol.
@ Line
Line symbol.
@ Fill
Fill symbol.
static bool isGeneralizableByDeviceBoundingBox(const QgsRectangle &envelope, float mapToPixelTol=1.0f)
Returns whether the device-envelope can be replaced by its BBOX when is applied the specified toleran...
virtual QPainterPath asQPainterPath() const =0
Returns the geometry represented as a QPainterPath.
double valueAsDouble(int key, const QgsExpressionContext &context, double defaultValue=0.0, bool *ok=nullptr) const
Calculates the current value of the property with the specified key and interprets it as a double.
Exports QGIS layers to the DXF format.
static double mapUnitScaleFactor(double scale, Qgis::RenderUnit symbolUnits, Qgis::DistanceUnit mapUnits, double mapUnitsPerPixel=1.0)
Returns scale factor for conversion to map units.
Qgis::DistanceUnit mapUnits() const
Retrieve map units.
double symbologyScale() const
Returns the reference scale for output.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static const QString EXPR_GEOMETRY_RING_NUM
Inbuilt variable name for geometry ring number variable.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
bool isEmpty
Definition qgsfields.h:49
virtual void renderPolygon(const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)=0
Renders the fill symbol layer for the polygon whose outer ring is defined by points,...
void _renderPolygon(QPainter *p, const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)
Default method to render polygon.
virtual QImage toTiledPatternImage() const
Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons,...
void drawPreviewIcon(QgsSymbolRenderContext &context, QSize size) override
QgsFillSymbolLayer(const QgsFillSymbolLayer &other)=delete
QgsFillSymbolLayer cannot be copied.
A geometry is the spatial representation of a feature.
static QgsGeometry fromRect(const QgsRectangle &rect)
Creates a new geometry from a QgsRectangle.
QgsGeometry difference(const QgsGeometry &geometry, const QgsGeometryParameters &parameters=QgsGeometryParameters()) const
Returns a geometry representing the points making up this geometry that do not make up other.
QgsGeometry makeValid(Qgis::MakeValidMethod method=Qgis::MakeValidMethod::Linework, bool keepCollapsed=false) const
Attempts to make an invalid geometry valid without losing vertices.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
bool isEmpty() const
Returns true if the geometry is empty (eg a linestring with no vertices, or a collection with no geom...
static QgsGeometry unaryUnion(const QVector< QgsGeometry > &geometries, const QgsGeometryParameters &parameters=QgsGeometryParameters())
Compute the unary union on a list of geometries.
Does vector analysis using the geos library and handles import, export, exception handling*.
Definition qgsgeos.h:137
QList< QList< QPolygonF > > toQPolygonF(Qgis::SymbolType type, QSizeF size) const
Converts the patch shape to a set of QPolygonF objects representing how the patch should be drawn for...
Qgis::RenderUnit mOffsetUnit
RenderRingFilter
Options for filtering rings when the line symbol layer is being used to render a polygon's rings.
@ ExteriorRingOnly
Render the exterior ring only.
@ InteriorRingsOnly
Render the interior rings only.
@ AllRings
Render both exterior and interior rings.
QgsMapUnitScale mWidthMapUnitScale
RenderRingFilter ringFilter() const
Returns the line symbol layer's ring filter, which controls which rings are rendered when the line sy...
void drawPreviewIcon(QgsSymbolRenderContext &context, QSize size) override
QgsLineSymbolLayer(const QgsLineSymbolLayer &other)=delete
QgsLineSymbolLayer cannot be copied.
void setOutputUnit(Qgis::RenderUnit unit) override
Sets the units to use for sizes and widths within the symbol layer.
Qgis::RenderUnit outputUnit() const override
Returns the units to use for sizes and widths within the symbol layer.
virtual void renderPolygonStroke(const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)
Renders the line symbol layer along the outline of polygon, using the given render context.
Qgis::RenderUnit mWidthUnit
virtual void renderPolyline(const QPolygonF &points, QgsSymbolRenderContext &context)=0
Renders the line symbol layer along the line joining points, using the given render context.
RenderRingFilter mRingFilter
virtual double width() const
Returns the estimated width for the line symbol layer.
double dxfWidth(const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
Gets line width.
QgsMapUnitScale mapUnitScale() const override
void setRingFilter(QgsLineSymbolLayer::RenderRingFilter filter)
Sets the line symbol layer's ring filter, which controls which rings are rendered when the line symbo...
void setMapUnitScale(const QgsMapUnitScale &scale) override
Qgis::RenderUnit widthUnit() const
Returns the units for the line's width.
double mapUnitsPerPixel() const
Returns the current map units per pixel.
Struct for storing maximum and minimum scales for measurements in map units.
double mSize
Marker size.
void drawPreviewIcon(QgsSymbolRenderContext &context, QSize size) override
Qgis::RenderUnit mOffsetUnit
Offset units.
QPointF offset() const
Returns the marker's offset, which is the horizontal and vertical displacement which the rendered mar...
HorizontalAnchorPoint
Symbol horizontal anchor points.
@ Right
Align to right side of symbol.
@ HCenter
Align to horizontal center of symbol.
@ Left
Align to left side of symbol.
Qgis::RenderUnit outputUnit() const override
Returns the units to use for sizes and widths within the symbol layer.
virtual void renderPoint(QPointF point, QgsSymbolRenderContext &context)=0
Renders a marker at the specified point.
QPointF mOffset
Marker offset.
QgsMapUnitScale mapUnitScale() const override
double size() const
Returns the symbol size.
QgsMapUnitScale mOffsetMapUnitScale
Offset map unit scale.
HorizontalAnchorPoint mHorizontalAnchorPoint
Horizontal anchor point.
QgsMarkerSymbolLayer(const QgsMarkerSymbolLayer &other)=delete
QgsMarkerSymbolLayer cannot be copied.
static QPointF _rotatedOffset(QPointF offset, double angle)
Adjusts a marker offset to account for rotation.
virtual double dxfAngle(QgsSymbolRenderContext &context) const override
Gets angle.
Qgis::ScaleMethod mScaleMethod
Marker size scaling method.
virtual double dxfSize(const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
Gets marker size.
void stopRender(QgsSymbolRenderContext &context) override
Called after a set of rendering operations has finished on the supplied render context.
VerticalAnchorPoint verticalAnchorPoint() const
Returns the vertical anchor point for positioning the symbol.
QgsMapUnitScale mSizeMapUnitScale
Marker size map unit scale.
Qgis::RenderUnit mSizeUnit
Marker size unit.
void setOutputUnit(Qgis::RenderUnit unit) override
Sets the units to use for sizes and widths within the symbol layer.
HorizontalAnchorPoint horizontalAnchorPoint() const
Returns the horizontal anchor point for positioning the symbol.
VerticalAnchorPoint
Symbol vertical anchor points.
@ VCenter
Align to vertical center of symbol.
@ Bottom
Align to bottom of symbol.
@ Top
Align to top of symbol.
void markerOffset(QgsSymbolRenderContext &context, double &offsetX, double &offsetY) const
Calculates the required marker offset, including both the symbol offset and any displacement required...
VerticalAnchorPoint mVerticalAnchorPoint
Vertical anchor point.
void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
Saves the symbol layer as SLD.
virtual void writeSldMarker(QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
Writes the symbol layer definition as a SLD XML element.
double mAngle
Marker rotation angle, in degrees clockwise from north.
void startRender(QgsSymbolRenderContext &context) override
Called before a set of rendering operations commences on the supplied render context.
double angle() const
Returns the rotation angle for the marker, in degrees clockwise from north.
void setMapUnitScale(const QgsMapUnitScale &scale) override
double simplifyTolerance() const
Returns the simplification tolerance (in painter units) to use for on-the-fly simplification of mask ...
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.
bool enabled() const
Returns whether the effect is enabled.
QVariant value(int key, const QgsExpressionContext &context, const QVariant &defaultValue=QVariant()) const final
Returns the calculated value of the property with the specified key from within the collection.
void setProperty(int key, const QgsProperty &property)
Adds a property to the collection and takes ownership of it.
bool isActive(int key) const final
Returns true if the collection contains an active property with the specified key.
bool prepare(const QgsExpressionContext &context=QgsExpressionContext()) const final
Prepares the collection against a specified expression context.
bool hasActiveProperties() const final
Returns true if the collection has any active properties, or false if all properties within the colle...
QSet< QString > referencedFields(const QgsExpressionContext &context=QgsExpressionContext(), bool ignoreContext=false) const final
Returns the set of any fields referenced by the active properties from the collection.
Definition for a property.
Definition qgsproperty.h:45
@ HorizontalAnchor
Horizontal anchor point.
Definition qgsproperty.h:73
@ Double
Double value (including negative values)
Definition qgsproperty.h:55
@ VerticalAnchor
Vertical anchor point.
Definition qgsproperty.h:74
@ Double0To1
Double value between 0-1 (inclusive)
Definition qgsproperty.h:57
@ FillStyle
Fill style (eg solid, lines)
Definition qgsproperty.h:71
@ StrokeWidth
Line stroke width.
Definition qgsproperty.h:70
@ LineStyle
Line style (eg solid/dashed)
Definition qgsproperty.h:69
@ String
Any string value.
Definition qgsproperty.h:59
@ Boolean
Boolean value.
Definition qgsproperty.h:51
@ PenJoinStyle
Pen join style.
Definition qgsproperty.h:64
@ IntegerPositive
Positive integer values (including 0)
Definition qgsproperty.h:53
@ Opacity
Opacity (0-100)
Definition qgsproperty.h:60
@ CapStyle
Line cap style (eg round)
Definition qgsproperty.h:72
@ Rotation
Rotation (value between 0-360 degrees)
Definition qgsproperty.h:58
@ Size
1D size (eg marker radius, or square marker height/width)
Definition qgsproperty.h:67
@ ColorWithAlpha
Color with alpha channel.
Definition qgsproperty.h:62
@ DoublePositive
Positive double value (including 0)
Definition qgsproperty.h:56
@ DataTypeString
Property requires a string value.
Definition qgsproperty.h:90
@ DataTypeNumeric
Property requires a numeric value.
Definition qgsproperty.h:97
A store for object properties.
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
static QgsProperty fromField(const QString &fieldName, bool isActive=true)
Returns a new FieldBasedProperty created from the specified field name.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
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.
QSize outputSize() const
Returns the size of the resulting rendered image, in pixels.
const QgsVectorSimplifyMethod & vectorSimplifyMethod() const
Returns the simplification settings to use when rendering vector layers.
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
QVector< QgsGeometry > symbolLayerClipGeometries(const QString &symbolLayerId) const
Returns clipping geometries to be applied to the symbolLayer before rendering.
Qgis::RenderContextFlags flags() const
Returns combination of flags used for rendering.
const QgsMaskRenderSettings & maskSettings() const
Returns a reference to the mask render settings, which control how masks are drawn and behave during ...
static QgsStyle * defaultStyle(bool initialize=true)
Returns the default application-wide style.
Definition qgsstyle.cpp:145
QList< QList< QPolygonF > > defaultPatchAsQPolygonF(Qgis::SymbolType type, QSizeF size) const
Returns the default patch geometry for the given symbol type and size as a set of QPolygonF objects (...
static QPointF toPoint(const QVariant &value, bool *ok=nullptr)
Converts a value to a point.
static QVector< QgsGeometry > collectSymbolLayerClipGeometries(const QgsRenderContext &context, const QString &symbolLayerId, const QRectF &bounds)
Returns a list of the symbol layer clip geometries to be used for the symbol layer with the specified...
static void createGeometryElement(QDomDocument &doc, QDomElement &element, const QString &geomFunc)
static QString encodePoint(QPointF point)
Encodes a QPointF to a string.
virtual bool setSubSymbol(QgsSymbol *symbol)
Sets layer's subsymbol. takes ownership of the passed symbol.
bool shouldRenderUsingSelectionColor(const QgsSymbolRenderContext &context) const
Returns true if the symbol layer should be rendered using the selection color from the render context...
Qgis::SymbolType type() const
virtual void startFeatureRender(const QgsFeature &feature, QgsRenderContext &context)
Called before the layer will be rendered for a particular feature.
virtual QColor fillColor() const
Returns the fill color for the symbol layer.
void setId(const QString &id)
Set symbol layer identifier This id has to be unique in the whole project.
virtual void setStrokeColor(const QColor &color)
Sets the stroke color for the symbol layer.
QPainterPath mClipPath
bool installMasks(QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF())
When rendering, install masks on context painter.
virtual double dxfSize(const QgsDxfExport &e, QgsSymbolRenderContext &context) const
Gets marker size.
virtual double dxfOffset(const QgsDxfExport &e, QgsSymbolRenderContext &context) const
Gets offset.
virtual QColor dxfBrushColor(QgsSymbolRenderContext &context) const
Gets brush/fill color.
Qgis::SymbolType mType
void removeMasks(QgsRenderContext &context, bool recursive)
When rendering, remove previously installed masks from context painter if recursive is true masks are...
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const
Returns the set of attributes referenced by the layer.
void copyDataDefinedProperties(QgsSymbolLayer *destLayer) const
Copies all data defined properties of this layer to another symbol layer.
Property
Data definable properties.
@ ArrowHeadLength
Arrow head length.
@ GradientType
Gradient fill type.
@ SecondaryColor
Secondary color (eg for gradient fills)
@ File
Filename, eg for svg files.
@ VerticalAnchor
Vertical anchor point.
@ GradientReference2Y
Gradient reference point 2 y.
@ GradientReference1X
Gradient reference point 1 x.
@ OffsetY
Vertical offset.
@ OffsetX
Horizontal offset.
@ GradientReference1Y
Gradient reference point 1 y.
@ ArrowWidth
Arrow tail width.
@ PointCount
Point count.
@ DashPatternOffset
Dash pattern offset,.
@ GradientSpread
Gradient spread mode.
@ OffsetAlongLine
Offset along line.
@ ArrowHeadType
Arrow head type.
@ CustomDash
Custom dash pattern.
@ ShapeburstMaxDistance
Shapeburst fill from edge distance.
@ HorizontalAnchor
Horizontal anchor point.
@ StrokeStyle
Stroke style (eg solid, dashed)
@ Name
Name, eg shape name for simple markers.
@ DistanceY
Vertical distance between points.
@ LineEndColorValue
End line color for interpolated line renderer (since QGIS 3.22)
@ DensityArea
Density area.
@ ClipPoints
Whether markers should be clipped to polygon boundaries.
@ ArrowHeadThickness
Arrow head thickness.
@ LineClipping
Line clipping mode (since QGIS 3.24)
@ ShapeburstIgnoreRings
Shapeburst ignore rings.
@ Character
Character, eg for font marker symbol layers.
@ ShapeburstUseWholeShape
Shapeburst use whole shape.
@ DisplacementX
Horizontal displacement.
@ CoordinateMode
Gradient coordinate mode.
@ FillStyle
Fill style (eg solid, dots)
@ GradientReference2X
Gradient reference point 2 x.
@ StrokeColor
Stroke color.
@ TrimStart
Trim distance from start of line (since QGIS 3.20)
@ ArrowStartWidth
Arrow tail start width.
@ CapStyle
Line cap style.
@ BlurRadius
Shapeburst blur radius.
@ Placement
Line marker placement.
@ MarkerClipping
Marker clipping mode (since QGIS 3.24)
@ RandomSeed
Random number seed.
@ LineAngle
Line angle, or angle of hash lines for hash line symbols.
@ JoinStyle
Line join style.
@ RandomOffsetY
Random offset Y (since QGIS 3.24)
@ DisplacementY
Vertical displacement.
@ PreserveAspectRatio
Preserve aspect ratio between width and height.
@ LineStartColorValue
Start line color for interpolated line renderer (since QGIS 3.22)
@ DistanceX
Horizontal distance between points.
@ AverageAngleLength
Length to average symbol angles over.
@ LineEndWidthValue
End line width for interpolated line renderer (since QGIS 3.22)
@ GradientReference1IsCentroid
Gradient reference point 1 is centroid.
@ Interval
Line marker interval.
@ StrokeWidth
Stroke width.
@ FontFamily
Font family.
@ GradientReference2IsCentroid
Gradient reference point 2 is centroid.
@ LineStartWidthValue
Start line width for interpolated line renderer (since QGIS 3.22)
@ LineDistance
Distance between lines, or length of lines for hash line symbols.
@ Offset
Symbol offset.
@ RandomOffsetX
Random offset X (since QGIS 3.24)
@ TrimEnd
Trim distance from end of line (since QGIS 3.20)
@ Height
Symbol height.
@ LayerEnabled
Whether symbol layer is enabled.
void restoreOldDataDefinedProperties(const QVariantMap &stringMap)
Restores older data defined properties from string map.
void setPaintEffect(QgsPaintEffect *effect)
Sets the current paint effect for the layer.
void setRenderingPass(int renderingPass)
Specifies the rendering pass in which this symbol layer should be rendered.
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the layer.
virtual void startRender(QgsSymbolRenderContext &context)=0
Called before a set of rendering operations commences on the supplied render context.
QgsSymbolLayer(const QgsSymbolLayer &other)=delete
QgsSymbolLayer cannot be copied.
std::unique_ptr< QgsPaintEffect > mPaintEffect
virtual Qt::PenStyle dxfPenStyle() const
Gets pen style.
virtual void setFillColor(const QColor &color)
Sets the fill color for the symbol layer.
virtual void prepareExpressions(const QgsSymbolRenderContext &context)
Prepares all data defined property expressions for evaluation.
void setUserFlags(Qgis::SymbolLayerUserFlags flags)
Sets user-controlled flags which control the symbol layer's behavior.
virtual QColor dxfColor(QgsSymbolRenderContext &context) const
Gets color.
int renderingPass() const
Specifies the rendering pass in which this symbol layer should be rendered.
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.
QString id() const
Returns symbol layer identifier This id is unique in the whole project.
virtual void setDataDefinedProperty(Property key, const QgsProperty &property)
Sets a data defined property for the layer.
virtual void setColor(const QColor &color)
Sets the "representative" color for the symbol layer.
virtual QgsSymbol * subSymbol()
Returns the symbol's sub symbol, if present.
Qgis::SymbolLayerUserFlags userFlags() const
Returns user-controlled flags which control the symbol layer's behavior.
virtual QColor color() const
Returns the "representative" color of the symbol layer.
virtual void prepareMasks(const QgsSymbolRenderContext &context)
Prepares all mask internal objects according to what is defined in context This should be called prio...
virtual void stopFeatureRender(const QgsFeature &feature, QgsRenderContext &context)
Called after the layer has been rendered for a particular feature.
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the symbol layer property definitions.
virtual double dxfWidth(const QgsDxfExport &e, QgsSymbolRenderContext &context) const
Gets line width.
virtual QColor strokeColor() const
Returns the stroke color for the symbol layer.
virtual double dxfAngle(QgsSymbolRenderContext &context) const
Gets angle.
Qgis::SymbolLayerUserFlags mUserFlags
User controlled flags.
virtual bool canCauseArtifactsBetweenAdjacentTiles() const
Returns true if the symbol layer rendering can cause visible artifacts across a single feature when t...
virtual ~QgsSymbolLayer()
virtual bool usesMapUnits() const
Returns true if the symbol layer has any components which use map unit based sizes.
virtual bool writeDxf(QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
write as DXF
void copyPaintEffect(QgsSymbolLayer *destLayer) const
Copies paint effect of this layer to another symbol layer.
virtual Qgis::SymbolLayerFlags flags() const
Returns flags which control the symbol layer's behavior.
QgsPropertyCollection mDataDefinedProperties
virtual QList< QgsSymbolLayerReference > masks() const
Returns masks defined by this symbol layer.
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the symbol layer's property collection, used for data defined overrides.
virtual Qt::BrushStyle dxfBrushStyle() const
Gets brush/fill style.
virtual QVector< qreal > dxfCustomDashPattern(Qgis::RenderUnit &unit) const
Gets dash pattern.
virtual bool hasDataDefinedProperties() const
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the symbol layer's property collection, used for data defined overrides.
QgsFields fields() const
Fields of the layer.
bool selected() const
Returns true if symbols should be rendered using the selected symbol coloring and style.
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for data defined symbology.
const QgsLegendPatchShape * patchShape() const
Returns the symbol patch shape, to use if rendering symbol preview icons.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:94
Qgis::SymbolType type() const
Returns the symbol's type.
Definition qgssymbol.h:156
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Qgis::VectorRenderingSimplificationFlags simplifyHints() const
Gets the simplification hints of the vector layer managed.
float threshold() const
Gets the simplification threshold of the vector layer managed.
Contains geos related utilities and functions.
Definition qgsgeos.h:75
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define str(x)
Definition qgis.cpp:38
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
QgsProperty propertyFromMap(const QVariantMap &map, const QString &baseName)
QPainterPath generateClipPath(const QgsRenderContext &renderContext, const QString &id, const QRectF *rect, bool &foundGeometries)
#define DEG2RAD(x)
Single variable definition for use within a QgsExpressionContextScope.