QGIS API Documentation 3.39.0-Master (47f7b3a4989)
Loading...
Searching...
No Matches
qgssymbollayer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssymbollayer.h
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#ifndef QGSSYMBOLLAYER_H
16#define QGSSYMBOLLAYER_H
17
18#define DEG2RAD(x) ((x)*M_PI/180)
19#define DEFAULT_SCALE_METHOD Qgis::ScaleMethod::ScaleDiameter
20
21#include "qgis_core.h"
22#include "qgis.h"
23#include "qgsfields.h"
26
27#include <QColor>
28#include <QMap>
29#include <QPointF>
30#include <QSet>
31#include <QDomDocument>
32#include <QDomElement>
33#include <QPainterPath>
34#include <QImage>
35
36class QPainter;
37class QSize;
38class QPolygonF;
39
40class QgsDxfExport;
41class QgsExpression;
43class QgsPaintEffect;
45
46#ifndef SIP_RUN
47typedef QMap<QString, QString> QgsStringMap;
48#endif
49
54class CORE_EXPORT QgsSymbolLayer
55{
56#ifdef SIP_RUN
57#include <qgslinesymbollayer.h>
58#endif
59
60
61#ifdef SIP_RUN
63 switch ( sipCpp->type() )
64 {
66 if ( sipCpp->layerType() == "EllipseMarker" )
67 sipType = sipType_QgsEllipseSymbolLayer;
68 else if ( sipCpp->layerType() == "FontMarker" )
69 sipType = sipType_QgsFontMarkerSymbolLayer;
70 else if ( sipCpp->layerType() == "SimpleMarker" )
71 sipType = sipType_QgsSimpleMarkerSymbolLayer;
72 else if ( sipCpp->layerType() == "FilledMarker" )
73 sipType = sipType_QgsFilledMarkerSymbolLayer;
74 else if ( sipCpp->layerType() == "SvgMarker" )
75 sipType = sipType_QgsSvgMarkerSymbolLayer;
76 else if ( sipCpp->layerType() == "RasterMarker" )
77 sipType = sipType_QgsRasterMarkerSymbolLayer;
78 else if ( sipCpp->layerType() == "AnimatedMarker" )
79 sipType = sipType_QgsAnimatedMarkerSymbolLayer;
80 else if ( sipCpp->layerType() == "VectorField" )
81 sipType = sipType_QgsVectorFieldSymbolLayer;
82 else if ( sipCpp->layerType() == "MaskMarker" )
83 sipType = sipType_QgsMaskMarkerSymbolLayer;
84 else
85 sipType = sipType_QgsMarkerSymbolLayer;
86 break;
87
89 if ( sipCpp->layerType() == "MarkerLine" )
90 sipType = sipType_QgsMarkerLineSymbolLayer;
91 else if ( sipCpp->layerType() == "SimpleLine" )
92 sipType = sipType_QgsSimpleLineSymbolLayer;
93 else if ( sipCpp->layerType() == "HashLine" )
94 sipType = sipType_QgsHashedLineSymbolLayer;
95 else if ( sipCpp->layerType() == "ArrowLine" )
96 sipType = sipType_QgsArrowSymbolLayer;
97 else if ( sipCpp->layerType() == "InterpolatedLine" )
98 sipType = sipType_QgsInterpolatedLineSymbolLayer;
99 else if ( sipCpp->layerType() == "RasterLine" )
100 sipType = sipType_QgsRasterLineSymbolLayer;
101 else if ( sipCpp->layerType() == "Lineburst" )
102 sipType = sipType_QgsLineburstSymbolLayer;
103 else
104 sipType = sipType_QgsLineSymbolLayer;
105 break;
106
108 if ( sipCpp->layerType() == "SimpleFill" )
109 sipType = sipType_QgsSimpleFillSymbolLayer;
110 else if ( sipCpp->layerType() == "LinePatternFill" )
111 sipType = sipType_QgsLinePatternFillSymbolLayer;
112 else if ( sipCpp->layerType() == "PointPatternFill" )
113 sipType = sipType_QgsPointPatternFillSymbolLayer;
114 else if ( sipCpp->layerType() == "SVGFill" )
115 sipType = sipType_QgsSVGFillSymbolLayer;
116 else if ( sipCpp->layerType() == "RasterFill" )
117 sipType = sipType_QgsRasterFillSymbolLayer;
118 else if ( sipCpp->layerType() == "CentroidFill" )
119 sipType = sipType_QgsCentroidFillSymbolLayer;
120 else if ( sipCpp->layerType() == "GradientFill" )
121 sipType = sipType_QgsGradientFillSymbolLayer;
122 else if ( sipCpp->layerType() == "ShapeburstFill" )
123 sipType = sipType_QgsShapeburstFillSymbolLayer;
124 else if ( sipCpp->layerType() == "RandomMarkerFill" )
125 sipType = sipType_QgsRandomMarkerFillSymbolLayer;
126 else
127 sipType = sipType_QgsFillSymbolLayer;
128 break;
129
131 sipType = sipType_QgsGeometryGeneratorSymbolLayer;
132 break;
133 }
134 SIP_END
135#endif
136 public:
137
138 // *INDENT-OFF*
139
144 {
145 Size SIP_MONKEYPATCH_COMPAT_NAME( PropertySize ) = 0,
146 Angle SIP_MONKEYPATCH_COMPAT_NAME( PropertyAngle ),
147 Name SIP_MONKEYPATCH_COMPAT_NAME( PropertyName ),
148 FillColor SIP_MONKEYPATCH_COMPAT_NAME( PropertyFillColor ),
149 StrokeColor SIP_MONKEYPATCH_COMPAT_NAME( PropertyStrokeColor ),
150 StrokeWidth SIP_MONKEYPATCH_COMPAT_NAME( PropertyStrokeWidth ),
151 StrokeStyle SIP_MONKEYPATCH_COMPAT_NAME( PropertyStrokeStyle ),
152 Offset SIP_MONKEYPATCH_COMPAT_NAME( PropertyOffset ),
153 Character SIP_MONKEYPATCH_COMPAT_NAME( PropertyCharacter ),
154 Width SIP_MONKEYPATCH_COMPAT_NAME( PropertyWidth ),
155 Height SIP_MONKEYPATCH_COMPAT_NAME( PropertyHeight ),
156 PreserveAspectRatio SIP_MONKEYPATCH_COMPAT_NAME( PropertyPreserveAspectRatio ),
157 FillStyle SIP_MONKEYPATCH_COMPAT_NAME( PropertyFillStyle ),
158 JoinStyle SIP_MONKEYPATCH_COMPAT_NAME( PropertyJoinStyle ),
159 SecondaryColor SIP_MONKEYPATCH_COMPAT_NAME( PropertySecondaryColor ),
160 LineAngle SIP_MONKEYPATCH_COMPAT_NAME( PropertyLineAngle ),
161 LineDistance SIP_MONKEYPATCH_COMPAT_NAME( PropertyLineDistance ),
162 GradientType SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientType ),
163 CoordinateMode SIP_MONKEYPATCH_COMPAT_NAME( PropertyCoordinateMode ),
164 GradientSpread SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientSpread ),
165 GradientReference1X SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientReference1X ),
166 GradientReference1Y SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientReference1Y ),
167 GradientReference2X SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientReference2X ),
168 GradientReference2Y SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientReference2Y ),
169 GradientReference1IsCentroid SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientReference1IsCentroid ),
170 GradientReference2IsCentroid SIP_MONKEYPATCH_COMPAT_NAME( PropertyGradientReference2IsCentroid ),
171 BlurRadius SIP_MONKEYPATCH_COMPAT_NAME( PropertyBlurRadius ),
172 ShapeburstUseWholeShape SIP_MONKEYPATCH_COMPAT_NAME( PropertyShapeburstUseWholeShape ),
173 ShapeburstMaxDistance SIP_MONKEYPATCH_COMPAT_NAME( PropertyShapeburstMaxDistance ),
174 ShapeburstIgnoreRings SIP_MONKEYPATCH_COMPAT_NAME( PropertyShapeburstIgnoreRings ),
175 File SIP_MONKEYPATCH_COMPAT_NAME( PropertyFile ),
176 DistanceX SIP_MONKEYPATCH_COMPAT_NAME( PropertyDistanceX ),
177 DistanceY SIP_MONKEYPATCH_COMPAT_NAME( PropertyDistanceY ),
178 DisplacementX SIP_MONKEYPATCH_COMPAT_NAME( PropertyDisplacementX ),
179 DisplacementY SIP_MONKEYPATCH_COMPAT_NAME( PropertyDisplacementY ),
180 Opacity SIP_MONKEYPATCH_COMPAT_NAME( PropertyOpacity ),
181 CustomDash SIP_MONKEYPATCH_COMPAT_NAME( PropertyCustomDash ),
182 CapStyle SIP_MONKEYPATCH_COMPAT_NAME( PropertyCapStyle ),
183 Placement SIP_MONKEYPATCH_COMPAT_NAME( PropertyPlacement ),
184 Interval SIP_MONKEYPATCH_COMPAT_NAME( PropertyInterval ),
185 OffsetAlongLine SIP_MONKEYPATCH_COMPAT_NAME( PropertyOffsetAlongLine ),
186 AverageAngleLength SIP_MONKEYPATCH_COMPAT_NAME( PropertyAverageAngleLength ),
187 HorizontalAnchor SIP_MONKEYPATCH_COMPAT_NAME( PropertyHorizontalAnchor ),
188 VerticalAnchor SIP_MONKEYPATCH_COMPAT_NAME( PropertyVerticalAnchor ),
189 LayerEnabled SIP_MONKEYPATCH_COMPAT_NAME( PropertyLayerEnabled ),
190 ArrowWidth SIP_MONKEYPATCH_COMPAT_NAME( PropertyArrowWidth ),
191 ArrowStartWidth SIP_MONKEYPATCH_COMPAT_NAME( PropertyArrowStartWidth ),
192 ArrowHeadLength SIP_MONKEYPATCH_COMPAT_NAME( PropertyArrowHeadLength ),
193 ArrowHeadThickness SIP_MONKEYPATCH_COMPAT_NAME( PropertyArrowHeadThickness ),
194 ArrowHeadType SIP_MONKEYPATCH_COMPAT_NAME( PropertyArrowHeadType ),
195 ArrowType SIP_MONKEYPATCH_COMPAT_NAME( PropertyArrowType ),
196 OffsetX SIP_MONKEYPATCH_COMPAT_NAME( PropertyOffsetX ),
197 OffsetY SIP_MONKEYPATCH_COMPAT_NAME( PropertyOffsetY ),
198 PointCount SIP_MONKEYPATCH_COMPAT_NAME( PropertyPointCount ),
199 RandomSeed SIP_MONKEYPATCH_COMPAT_NAME( PropertyRandomSeed ),
200 ClipPoints SIP_MONKEYPATCH_COMPAT_NAME( PropertyClipPoints ),
201 DensityArea SIP_MONKEYPATCH_COMPAT_NAME( PropertyDensityArea ),
202 FontFamily SIP_MONKEYPATCH_COMPAT_NAME( PropertyFontFamily ),
203 FontStyle SIP_MONKEYPATCH_COMPAT_NAME( PropertyFontStyle ),
204 DashPatternOffset SIP_MONKEYPATCH_COMPAT_NAME( PropertyDashPatternOffset ),
205 TrimStart SIP_MONKEYPATCH_COMPAT_NAME( PropertyTrimStart ),
206 TrimEnd SIP_MONKEYPATCH_COMPAT_NAME( PropertyTrimEnd ),
207 LineStartWidthValue SIP_MONKEYPATCH_COMPAT_NAME( PropertyLineStartWidthValue ),
208 LineEndWidthValue SIP_MONKEYPATCH_COMPAT_NAME( PropertyLineEndWidthValue ),
209 LineStartColorValue SIP_MONKEYPATCH_COMPAT_NAME( PropertyLineStartColorValue ),
210 LineEndColorValue SIP_MONKEYPATCH_COMPAT_NAME( PropertyLineEndColorValue ),
211 MarkerClipping SIP_MONKEYPATCH_COMPAT_NAME( PropertyMarkerClipping ),
212 RandomOffsetX SIP_MONKEYPATCH_COMPAT_NAME( PropertyRandomOffsetX ),
213 RandomOffsetY SIP_MONKEYPATCH_COMPAT_NAME( PropertyRandomOffsetY ),
214 LineClipping SIP_MONKEYPATCH_COMPAT_NAME( PropertyLineClipping ),
215 };
216 // *INDENT-ON*
217
221 static const QgsPropertiesDefinition &propertyDefinitions();
222
224
226 QgsSymbolLayer( const QgsSymbolLayer &other ) = delete;
227
229 QgsSymbolLayer &operator=( const QgsSymbolLayer &other ) = delete;
230
236 virtual Qgis::SymbolLayerFlags flags() const;
237
242 bool enabled() const { return mEnabled; }
243
250 void setEnabled( bool enabled ) { mEnabled = enabled; }
251
258 Qgis::SymbolLayerUserFlags userFlags() const;
259
266 void setUserFlags( Qgis::SymbolLayerUserFlags flags );
267
282 virtual QColor color() const;
283
295 virtual void setColor( const QColor &color );
296
307 virtual void setStrokeColor( const QColor &color );
308
320 virtual QColor strokeColor() const;
321
332 virtual void setFillColor( const QColor &color );
333
345 virtual QColor fillColor() const;
346
351 virtual QString layerType() const = 0;
352
365 virtual void startRender( QgsSymbolRenderContext &context ) = 0;
366
378 virtual void stopRender( QgsSymbolRenderContext &context ) = 0;
379
398 virtual void startFeatureRender( const QgsFeature &feature, QgsRenderContext &context );
399
418 virtual void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context );
419
423 virtual QgsSymbolLayer *clone() const = 0 SIP_FACTORY;
424
426 virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const
427 { Q_UNUSED( props ) element.appendChild( doc.createComment( QStringLiteral( "SymbolLayerV2 %1 not implemented yet" ).arg( layerType() ) ) ); }
428
429 virtual QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const { Q_UNUSED( mmScaleFactor ) Q_UNUSED( mapUnitScaleFactor ); return QString(); }
430
436 virtual QVariantMap properties() const = 0;
437
438 virtual void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) = 0;
439
443 virtual QgsSymbol *subSymbol();
444
446 virtual bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER );
447
448 Qgis::SymbolType type() const { return mType; }
449
451 virtual bool isCompatibleWithSymbol( QgsSymbol *symbol ) const;
452
461 virtual bool canCauseArtifactsBetweenAdjacentTiles() const;
462
470 void setLocked( bool locked ) { mLocked = locked; }
471
477 bool isLocked() const { return mLocked; }
478
486 virtual double estimateMaxBleed( const QgsRenderContext &context ) const { Q_UNUSED( context ) return 0; }
487
496 virtual void setOutputUnit( Qgis::RenderUnit unit ) { Q_UNUSED( unit ) }
497
507
513 virtual bool usesMapUnits() const;
514
515 virtual void setMapUnitScale( const QgsMapUnitScale &scale ) { Q_UNUSED( scale ) }
516 virtual QgsMapUnitScale mapUnitScale() const { return QgsMapUnitScale(); }
517
524 void setRenderingPass( int renderingPass );
525
532 int renderingPass() const;
533
538 virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;
539
546 virtual void setDataDefinedProperty( Property key, const QgsProperty &property );
547
549 virtual bool writeDxf( QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift = QPointF( 0.0, 0.0 ) ) const;
550
552 virtual double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
553
555 virtual double dxfSize( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
556
558 virtual double dxfOffset( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
559
561 virtual QColor dxfColor( QgsSymbolRenderContext &context ) const;
562
564 virtual double dxfAngle( QgsSymbolRenderContext &context ) const;
565
567 virtual QVector<qreal> dxfCustomDashPattern( Qgis::RenderUnit &unit ) const;
568
570 virtual Qt::PenStyle dxfPenStyle() const;
571
573 virtual QColor dxfBrushColor( QgsSymbolRenderContext &context ) const;
574
576 virtual Qt::BrushStyle dxfBrushStyle() const;
577
583 QgsPaintEffect *paintEffect() const;
584
590 void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER );
591
597 virtual void prepareExpressions( const QgsSymbolRenderContext &context );
598
604 QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
605
610 const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP
611
617 void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
618
624 virtual bool hasDataDefinedProperties() const;
625
631 virtual QList<QgsSymbolLayerReference> masks() const;
632
640 virtual void prepareMasks( const QgsSymbolRenderContext &context );
641
647 void setId( const QString &id );
648
654 QString id() const;
655
671 bool installMasks( QgsRenderContext &context, bool recursive, const QRectF &rect = QRectF() );
672
673 protected:
674
680 QgsSymbolLayer( Qgis::SymbolType type, bool locked = false );
681
683
685 bool mEnabled = true;
686
689
690 bool mLocked = false;
691 QColor mColor;
692 int mRenderingPass = 0;
693 QString mId;
695
696 std::unique_ptr< QgsPaintEffect > mPaintEffect;
698
699 // clip path to be used during rendering
700 QPainterPath mClipPath;
701
702 // Configuration of selected symbology implementation
704 static const bool SELECTION_IS_OPAQUE = true;
706 static const bool SELECT_FILL_BORDER = false;
708 static const bool SELECT_FILL_STYLE = false;
709
713 void restoreOldDataDefinedProperties( const QVariantMap &stringMap );
714
719 void copyDataDefinedProperties( QgsSymbolLayer *destLayer ) const;
720
725 void copyPaintEffect( QgsSymbolLayer *destLayer ) const;
726
734 void removeMasks( QgsRenderContext &context, bool recursive );
735
742 bool shouldRenderUsingSelectionColor( const QgsSymbolRenderContext &context ) const;
743
744 private:
745 static void initPropertyDefinitions();
746
748 static QgsPropertiesDefinition sPropertyDefinitions;
749
750#ifdef SIP_RUN
751 QgsSymbolLayer( const QgsSymbolLayer &other );
752#endif
753
754};
755
757
763class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer
764{
765 public:
766
774
782
785
788
789 void startRender( QgsSymbolRenderContext &context ) override;
790
791 void stopRender( QgsSymbolRenderContext &context ) override;
792
799 virtual void renderPoint( QPointF point, QgsSymbolRenderContext &context ) = 0;
800
801 void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override;
802
809 void setAngle( double angle ) { mAngle = angle; }
810
815 double angle() const { return mAngle; }
816
825 void setLineAngle( double lineAngle ) { mLineAngle = lineAngle; }
826
834 virtual void setSize( double size ) { mSize = size; }
835
842 double size() const { return mSize; }
843
851 void setSizeUnit( Qgis::RenderUnit unit ) { mSizeUnit = unit; }
852
859 Qgis::RenderUnit sizeUnit() const { return mSizeUnit; }
860
868 void setSizeMapUnitScale( const QgsMapUnitScale &scale ) { mSizeMapUnitScale = scale; }
869
876 const QgsMapUnitScale &sizeMapUnitScale() const { return mSizeMapUnitScale; }
877
883 void setScaleMethod( Qgis::ScaleMethod scaleMethod ) { mScaleMethod = scaleMethod; }
884
889 Qgis::ScaleMethod scaleMethod() const { return mScaleMethod; }
890
899 void setOffset( QPointF offset ) { mOffset = offset; }
900
908 QPointF offset() const { return mOffset; }
909
917 void setOffsetUnit( Qgis::RenderUnit unit ) { mOffsetUnit = unit; }
918
925 Qgis::RenderUnit offsetUnit() const { return mOffsetUnit; }
926
934 void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
935
942 const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
943
951 void setHorizontalAnchorPoint( HorizontalAnchorPoint h ) { mHorizontalAnchorPoint = h; }
952
959 HorizontalAnchorPoint horizontalAnchorPoint() const { return mHorizontalAnchorPoint; }
960
968 void setVerticalAnchorPoint( VerticalAnchorPoint v ) { mVerticalAnchorPoint = v; }
969
976 VerticalAnchorPoint verticalAnchorPoint() const { return mVerticalAnchorPoint; }
977
978 void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override;
979
986 virtual void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const
987 { Q_UNUSED( props ) element.appendChild( doc.createComment( QStringLiteral( "QgsMarkerSymbolLayer %1 not implemented yet" ).arg( layerType() ) ) ); }
988
989 void setOutputUnit( Qgis::RenderUnit unit ) override;
990 Qgis::RenderUnit outputUnit() const override;
991 void setMapUnitScale( const QgsMapUnitScale &scale ) override;
992 QgsMapUnitScale mapUnitScale() const override;
993 virtual double dxfSize( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
994 virtual double dxfAngle( QgsSymbolRenderContext &context ) const override;
995
1001 virtual QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) = 0;
1002
1003 protected:
1004
1009 QgsMarkerSymbolLayer( bool locked = false );
1010
1018 void markerOffset( QgsSymbolRenderContext &context, double &offsetX, double &offsetY ) const;
1019
1030 void markerOffset( QgsSymbolRenderContext &context, double width, double height, double &offsetX, double &offsetY ) const SIP_PYNAME( markerOffsetWithWidthAndHeight );
1031
1033 void markerOffset( QgsSymbolRenderContext &context, double width, double height,
1034 Qgis::RenderUnit widthUnit, Qgis::RenderUnit heightUnit,
1035 double &offsetX, double &offsetY,
1036 const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale ) const SIP_PYNAME( markerOffset2 );
1037
1044 static QPointF _rotatedOffset( QPointF offset, double angle );
1045
1047 double mAngle = 0;
1049 double mLineAngle = 0;
1051 double mSize = 2.0;
1057 QPointF mOffset;
1065 HorizontalAnchorPoint mHorizontalAnchorPoint = HCenter;
1067 VerticalAnchorPoint mVerticalAnchorPoint = VCenter;
1068
1069 private:
1070 static QgsMarkerSymbolLayer::HorizontalAnchorPoint decodeHorizontalAnchorPoint( const QString &str );
1071 static QgsMarkerSymbolLayer::VerticalAnchorPoint decodeVerticalAnchorPoint( const QString &str );
1072
1073#ifdef SIP_RUN
1075#endif
1076};
1077
1082class CORE_EXPORT QgsLineSymbolLayer : public QgsSymbolLayer
1083{
1084 public:
1085
1093
1095 QgsLineSymbolLayer( const QgsLineSymbolLayer &other ) = delete;
1096
1099
1100 void setOutputUnit( Qgis::RenderUnit unit ) override;
1101 Qgis::RenderUnit outputUnit() const override;
1102 void setMapUnitScale( const QgsMapUnitScale &scale ) override;
1103 QgsMapUnitScale mapUnitScale() const override;
1104 void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override;
1105 double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
1106
1111 virtual void renderPolyline( const QPolygonF &points, QgsSymbolRenderContext &context ) = 0;
1112
1121 virtual void renderPolygonStroke( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );
1122
1136 virtual void setWidth( double width ) { mWidth = width; }
1137
1147 virtual double width() const { return mWidth; }
1148
1159 virtual double width( const QgsRenderContext &context ) const;
1160
1170 double offset() const { return mOffset; }
1171
1181 void setOffset( double offset ) { mOffset = offset; }
1182
1189 void setOffsetUnit( Qgis::RenderUnit unit ) { mOffsetUnit = unit; }
1190
1197 Qgis::RenderUnit offsetUnit() const { return mOffsetUnit; }
1198
1205 void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
1206
1213 const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
1214
1215 // TODO QGIS 4.0 - setWidthUnit(), widthUnit(), setWidthUnitScale(), widthUnitScale()
1216 // only apply to simple line symbol layers and do not belong here.
1217
1223 void setWidthUnit( Qgis::RenderUnit unit ) { mWidthUnit = unit; }
1224
1229 Qgis::RenderUnit widthUnit() const { return mWidthUnit; }
1230
1231 void setWidthMapUnitScale( const QgsMapUnitScale &scale ) { mWidthMapUnitScale = scale; }
1232 const QgsMapUnitScale &widthMapUnitScale() const { return mWidthMapUnitScale; }
1233
1244 RenderRingFilter ringFilter() const;
1245
1256 void setRingFilter( QgsLineSymbolLayer::RenderRingFilter filter );
1257
1258 protected:
1259 QgsLineSymbolLayer( bool locked = false );
1260
1261 double mWidth = 0;
1264 double mOffset = 0;
1267
1268 RenderRingFilter mRingFilter = AllRings;
1269
1270 private:
1271#ifdef SIP_RUN
1272 QgsLineSymbolLayer( const QgsLineSymbolLayer &other );
1273#endif
1274};
1275
1280class CORE_EXPORT QgsFillSymbolLayer : public QgsSymbolLayer
1281{
1282 public:
1283
1285 QgsFillSymbolLayer( const QgsFillSymbolLayer &other ) = delete;
1286
1289
1295 virtual void renderPolygon( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context ) = 0;
1296
1297 void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override;
1298
1306 void setAngle( double angle ) { mAngle = angle; }
1307
1315 double angle() const { return mAngle; }
1316
1327 virtual QImage toTiledPatternImage( ) const;
1328
1329 protected:
1330 QgsFillSymbolLayer( bool locked = false );
1332 void _renderPolygon( QPainter *p, const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );
1333
1334 double mAngle = 0.0;
1335
1336 private:
1337#ifdef SIP_RUN
1338 QgsFillSymbolLayer( const QgsFillSymbolLayer &other );
1339#endif
1340};
1341
1342class QgsSymbolLayerWidget; // why does SIP fail, when this isn't here
1343
1344#endif
ScaleMethod
Scale methods.
Definition qgis.h:434
@ ScaleDiameter
Calculate scale by the diameter.
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.
SymbolType
Symbol types.
Definition qgis.h:420
@ Marker
Marker symbol.
@ Line
Line symbol.
@ Fill
Fill symbol.
@ Hybrid
Hybrid symbol.
Exports QGIS layers to the DXF format.
Class for parsing and evaluation of expressions (formerly called "search strings").
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
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,...
double angle() const
Returns the rotation angle of the fill symbol, in degrees clockwise.
void setAngle(double angle)
Sets the rotation angle of the pattern, in degrees clockwise.
QgsFillSymbolLayer & operator=(const QgsFillSymbolLayer &other)=delete
QgsFillSymbolLayer cannot be copied.
QgsFillSymbolLayer(const QgsFillSymbolLayer &other)=delete
QgsFillSymbolLayer cannot be copied.
const QgsMapUnitScale & widthMapUnitScale() const
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.
QgsLineSymbolLayer & operator=(const QgsLineSymbolLayer &other)=delete
QgsLineSymbolLayer cannot be copied.
QgsMapUnitScale mWidthMapUnitScale
virtual void setWidth(double width)
Sets the width of the line symbol layer.
QgsLineSymbolLayer(const QgsLineSymbolLayer &other)=delete
QgsLineSymbolLayer cannot be copied.
void setWidthMapUnitScale(const QgsMapUnitScale &scale)
void setOffset(double offset)
Sets the line's offset.
virtual void renderPolyline(const QPolygonF &points, QgsSymbolRenderContext &context)=0
Renders the line symbol layer along the line joining points, using the given render context.
void setOffsetUnit(Qgis::RenderUnit unit)
Sets the unit for the line's offset.
void setWidthUnit(Qgis::RenderUnit unit)
Sets the units for the line's width.
virtual double width() const
Returns the estimated width for the line symbol layer.
QgsMapUnitScale mOffsetMapUnitScale
void setOffsetMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale for the line's offset.
double offset() const
Returns the line's offset.
const QgsMapUnitScale & offsetMapUnitScale() const
Returns the map unit scale for the line's offset.
Qgis::RenderUnit offsetUnit() const
Returns the units for the line's offset.
Qgis::RenderUnit widthUnit() const
Returns the units for the line's width.
Struct for storing maximum and minimum scales for measurements in map units.
Abstract base class for marker symbol layers.
virtual void setSize(double size)
Sets the symbol size.
virtual QRectF bounds(QPointF point, QgsSymbolRenderContext &context)=0
Returns the approximate bounding box of the marker symbol layer, taking into account any data defined...
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.
void setOffsetUnit(Qgis::RenderUnit unit)
Sets the units for the symbol's offset.
void setAngle(double angle)
Sets the rotation angle for the marker.
Qgis::ScaleMethod scaleMethod() const
Returns the method to use for scaling the marker's size.
void setVerticalAnchorPoint(VerticalAnchorPoint v)
Sets the vertical anchor point for positioning the symbol.
virtual void renderPoint(QPointF point, QgsSymbolRenderContext &context)=0
Renders a marker at the specified point.
QPointF mOffset
Marker offset.
void setHorizontalAnchorPoint(HorizontalAnchorPoint h)
Sets the horizontal anchor point for positioning the symbol.
const QgsMapUnitScale & sizeMapUnitScale() const
Returns the map unit scale for the symbol's size.
void setOffset(QPointF offset)
Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker...
void setSizeMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale for the symbol's size.
void setLineAngle(double lineAngle)
Sets the line angle modification for the symbol's angle.
double size() const
Returns the symbol size.
QgsMapUnitScale mOffsetMapUnitScale
Offset map unit scale.
QgsMarkerSymbolLayer(const QgsMarkerSymbolLayer &other)=delete
QgsMarkerSymbolLayer cannot be copied.
const QgsMapUnitScale & offsetMapUnitScale() const
Returns the map unit scale for the symbol's offset.
Qgis::RenderUnit offsetUnit() const
Returns the units for the symbol's offset.
void setScaleMethod(Qgis::ScaleMethod scaleMethod)
Sets the method to use for scaling the marker's size.
QgsMarkerSymbolLayer & operator=(const QgsMarkerSymbolLayer &other)=delete
QgsMarkerSymbolLayer cannot be copied.
VerticalAnchorPoint verticalAnchorPoint() const
Returns the vertical anchor point for positioning the symbol.
QgsMapUnitScale mSizeMapUnitScale
Marker size map unit scale.
Qgis::RenderUnit sizeUnit() const
Returns the units for the symbol's size.
HorizontalAnchorPoint horizontalAnchorPoint() const
Returns the horizontal anchor point for positioning the symbol.
void setSizeUnit(Qgis::RenderUnit unit)
Sets the units for the symbol's size.
VerticalAnchorPoint
Symbol vertical anchor points.
@ VCenter
Align to vertical center of symbol.
@ Bottom
Align to bottom of symbol.
@ Top
Align to top of symbol.
virtual void writeSldMarker(QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
Writes the symbol layer definition as a SLD XML element.
void setOffsetMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale for the symbol's offset.
double angle() const
Returns the rotation angle for the marker, in degrees clockwise from north.
Base class for visual effects which can be applied to QPicture drawings.
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
A store for object properties.
Contains information about the context of a rendering operation.
Type used to refer to a specific symbol layer in a symbol of a layer.
virtual QgsSymbolLayer * clone() const =0
Shall be reimplemented by subclasses to create a deep copy of the instance.
Qgis::SymbolType type() const
const QgsPropertyCollection & dataDefinedProperties() const
Returns a reference to the symbol layer's property collection, used for data defined overrides.
QPainterPath mClipPath
bool isLocked() const
Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color c...
virtual QgsMapUnitScale mapUnitScale() const
Qgis::SymbolType mType
Property
Data definable properties.
virtual void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
Saves the symbol layer as SLD.
virtual double estimateMaxBleed(const QgsRenderContext &context) const
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when ...
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.
void setEnabled(bool enabled)
Sets whether symbol layer is enabled and should be drawn.
virtual QVariantMap properties() const =0
Should be reimplemented by subclasses to return a string map that contains the configuration informat...
std::unique_ptr< QgsPaintEffect > mPaintEffect
bool enabled() const
Returns true if symbol layer is enabled and will be drawn.
virtual QString layerType() const =0
Returns a string that represents this layer type.
virtual void stopRender(QgsSymbolRenderContext &context)=0
Called after a set of rendering operations has finished on the supplied render context.
virtual QString ogrFeatureStyle(double mmScaleFactor, double mapUnitScaleFactor) const
virtual Qgis::RenderUnit outputUnit() const
Returns the units to use for sizes and widths within the symbol layer.
Qgis::SymbolLayerUserFlags mUserFlags
User controlled flags.
void setLocked(bool locked)
Sets whether the layer's colors are locked.
virtual void setMapUnitScale(const QgsMapUnitScale &scale)
virtual ~QgsSymbolLayer()
virtual void setOutputUnit(Qgis::RenderUnit unit)
Sets the units to use for sizes and widths within the symbol layer.
virtual void drawPreviewIcon(QgsSymbolRenderContext &context, QSize size)=0
QgsPropertyCollection mDataDefinedProperties
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the symbol layer's property collection, used for data defined overrides.
QgsSymbolLayer & operator=(const QgsSymbolLayer &other)=delete
QgsSymbolLayer cannot be copied.
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the symbol layer's property collection, used for data defined overrides.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:94
#define str(x)
Definition qgis.cpp:38
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_MONKEYPATCH_SCOPEENUM_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition qgis_sip.h:271
#define SIP_PYNAME(name)
Definition qgis_sip.h:81
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_END
Definition qgis_sip.h:208
#define SIP_MONKEYPATCH_COMPAT_NAME(FORMERNAME)
Definition qgis_sip.h:273
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
QMap< QString, QString > QgsStringMap