-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsmarkersymbollayer.h
1036 lines (857 loc) · 35.6 KB
/
qgsmarkersymbollayer.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
qgsmarkersymbollayer.h
---------------------
begin : November 2009
copyright : (C) 2009 by Martin Dobias
email : wonder dot sk at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSMARKERSYMBOLLAYER_H
#define QGSMARKERSYMBOLLAYER_H
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssymbollayer.h"
#define DEFAULT_SIMPLEMARKER_NAME "circle"
#define DEFAULT_SIMPLEMARKER_COLOR QColor(255,0,0)
#define DEFAULT_SIMPLEMARKER_BORDERCOLOR QColor( 35, 35, 35 )
#define DEFAULT_SIMPLEMARKER_JOINSTYLE Qt::BevelJoin
#define DEFAULT_SIMPLEMARKER_SIZE DEFAULT_POINT_SIZE
#define DEFAULT_SIMPLEMARKER_ANGLE 0
#include <QPen>
#include <QBrush>
#include <QPicture>
#include <QPolygonF>
#include <QFont>
/**
* \ingroup core
* \class QgsSimpleMarkerSymbolLayerBase
* \brief Abstract base class for simple marker symbol layers. Handles creation of the symbol shapes but
* leaves the actual drawing of the symbols to subclasses.
* \since QGIS 2.16
*/
class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer
{
public:
//! Marker symbol shapes
enum Shape
{
Square, //!< Square
Diamond, //!< Diamond
Pentagon, //!< Pentagon
Hexagon, //!< Hexagon
Triangle, //!< Triangle
EquilateralTriangle, //!< Equilateral triangle
Star, //!< Star
Arrow, //!< Arrow
Circle, //!< Circle
Cross, //!< Cross (lines only)
CrossFill, //!< Solid filled cross
Cross2, //!< Rotated cross (lines only), "x" shape
Line, //!< Vertical line
ArrowHead, //!< Right facing arrow head (unfilled, lines only)
ArrowHeadFilled, //!< Right facing filled arrow head
SemiCircle, //!< Semi circle (top half)
ThirdCircle, //!< One third circle (top left third)
QuarterCircle, //!< Quarter circle (top left quarter)
QuarterSquare, //!< Quarter square (top left quarter)
HalfSquare, //!< Half square (left half)
DiagonalHalfSquare, //!< Diagonal half square (bottom left half)
RightHalfTriangle, //!< Right half of triangle
LeftHalfTriangle, //!< Left half of triangle
};
//! Returns a list of all available shape types.
static QList< QgsSimpleMarkerSymbolLayerBase::Shape > availableShapes();
/**
* Returns TRUE if a symbol shape has a fill.
* \param shape shape to test
* \returns TRUE if shape uses a fill, or FALSE if shape uses lines only
*/
static bool shapeIsFilled( QgsSimpleMarkerSymbolLayerBase::Shape shape );
/**
* Constructor for QgsSimpleMarkerSymbolLayerBase.
* \param shape symbol shape for markers
* \param size symbol size (in mm)
* \param angle symbol rotation angle
* \param scaleMethod scaling method for data defined scaling
*/
QgsSimpleMarkerSymbolLayerBase( QgsSimpleMarkerSymbolLayerBase::Shape shape = Circle,
double size = DEFAULT_SIMPLEMARKER_SIZE,
double angle = DEFAULT_SIMPLEMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
/**
* Returns the shape for the rendered marker symbol.
* \see setShape()
*/
QgsSimpleMarkerSymbolLayerBase::Shape shape() const { return mShape; }
/**
* Sets the rendered marker shape.
* \param shape new marker shape
* \see shape()
*/
void setShape( QgsSimpleMarkerSymbolLayerBase::Shape shape ) { mShape = shape; }
/**
* Attempts to decode a string representation of a shape name to the corresponding
* shape.
* \param name encoded shape name
* \param ok if specified, will be set to TRUE if shape was successfully decoded
* \returns decoded name
* \see encodeShape()
*/
static QgsSimpleMarkerSymbolLayerBase::Shape decodeShape( const QString &name, bool *ok = nullptr );
/**
* Encodes a shape to its string representation.
* \param shape shape to encode
* \returns encoded string
* \see decodeShape()
*/
static QString encodeShape( QgsSimpleMarkerSymbolLayerBase::Shape shape );
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;
QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;
protected:
/**
* Prepares the layer for drawing the specified shape (QPolygonF version)
*/
bool prepareMarkerShape( Shape shape );
/**
* Prepares the layer for drawing the specified shape (QPainterPath version)
*/
bool prepareMarkerPath( Shape symbol );
/**
* Creates a polygon representing the specified shape.
* \param shape shape to create
* \param polygon destination polygon for shape
* \returns TRUE if shape was successfully stored in polygon
*/
bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;
/**
* Calculates the desired size of the marker, considering data defined size overrides.
* \param context symbol render context
* \param hasDataDefinedSize will be set to TRUE if marker uses data defined sizes
* \returns marker size, in original size units
*/
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
/**
* Calculates the marker offset and rotation.
* \param context symbol render context
* \param scaledSize size of symbol to render
* \param hasDataDefinedRotation will be set to TRUE if marker has data defined rotation
* \param offset will be set to calculated marker offset (in painter units)
* \param angle will be set to calculated marker angle
*/
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;
//! Polygon of points in shape. If polygon is empty then shape is using mPath.
QPolygonF mPolygon;
//! Painter path representing shape. If mPolygon is empty then the shape is stored in mPath.
QPainterPath mPath;
//! Symbol shape
Shape mShape;
private:
/**
* Derived classes must implement draw() to handle drawing the generated shape onto the painter surface.
* \param context symbol render context
* \param shape shape to draw
* \param polygon polygon representing transformed marker shape. May be empty, in which case the shape will be specified
* in the path argument.
* \param path transformed painter path representing shape to draw
*/
virtual void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path ) = 0 SIP_FORCE;
};
/**
* \ingroup core
* \class QgsSimpleMarkerSymbolLayer
* \brief Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke.
*/
class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayerBase
{
public:
/**
* Constructor for QgsSimpleMarkerSymbolLayer.
* \param shape symbol shape
* \param size symbol size (in mm)
* \param angle symbol rotation angle
* \param scaleMethod scaling method for data defined scaling
* \param color fill color for symbol
* \param strokeColor stroke color for symbol
* \param penJoinStyle join style for stroke pen
*/
QgsSimpleMarkerSymbolLayer( QgsSimpleMarkerSymbolLayerBase::Shape shape = Circle,
double size = DEFAULT_SIMPLEMARKER_SIZE,
double angle = DEFAULT_SIMPLEMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD,
const QColor &color = DEFAULT_SIMPLEMARKER_COLOR,
const QColor &strokeColor = DEFAULT_SIMPLEMARKER_BORDERCOLOR,
Qt::PenJoinStyle penJoinStyle = DEFAULT_SIMPLEMARKER_JOINSTYLE );
// static methods
/**
* Creates a new QgsSimpleMarkerSymbolLayer.
* \param properties a property map containing symbol properties (see properties())
* \returns new QgsSimpleMarkerSymbolLayer
*/
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
/**
* Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element.
* \param element XML element containing SLD definition of symbol
* \returns new QgsSimpleMarkerSymbolLayer
*/
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
// reimplemented from base classes
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;
QVariantMap properties() const override;
QgsSimpleMarkerSymbolLayer *clone() const override SIP_FACTORY;
void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override;
QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const override;
bool writeDxf( QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift = QPointF( 0.0, 0.0 ) ) const override;
void setOutputUnit( QgsUnitTypes::RenderUnit unit ) override;
QgsUnitTypes::RenderUnit outputUnit() const override;
void setMapUnitScale( const QgsMapUnitScale &scale ) override;
QgsMapUnitScale mapUnitScale() const override;
bool usesMapUnits() const override;
QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;
QColor fillColor() const override { return mColor; }
void setFillColor( const QColor &color ) override { mColor = color; }
void setColor( const QColor &color ) override;
QColor color() const override;
// new methods
/**
* Returns the marker's stroke color.
* \see setStrokeColor()
* \see strokeStyle()
* \see penJoinStyle()
*/
QColor strokeColor() const override { return mStrokeColor; }
/**
* Sets the marker's stroke color.
* \param color stroke color
* \see strokeColor()
* \see setStrokeStyle()
* \see setPenJoinStyle()
*/
void setStrokeColor( const QColor &color ) override { mStrokeColor = color; }
/**
* Returns the marker's stroke style (e.g., solid, dashed, etc)
* \see setStrokeStyle()
* \see strokeColor()
* \see penJoinStyle()
* \since QGIS 2.4
*/
Qt::PenStyle strokeStyle() const { return mStrokeStyle; }
/**
* Sets the marker's stroke style (e.g., solid, dashed, etc)
* \param strokeStyle style
* \see strokeStyle()
* \see setStrokeColor()
* \see setPenJoinStyle()
* \since QGIS 2.4
*/
void setStrokeStyle( Qt::PenStyle strokeStyle ) { mStrokeStyle = strokeStyle; }
/**
* Returns the marker's stroke join style (e.g., miter, bevel, etc).
* \see setPenJoinStyle()
* \see strokeColor()
* \see strokeStyle()
* \since QGIS 2.16
*/
Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; }
/**
* Sets the marker's stroke join style (e.g., miter, bevel, etc).
* \param style join style
* \see penJoinStyle()
* \see setStrokeColor()
* \see setStrokeStyle()
* \since QGIS 2.16
*/
void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; }
/**
* Returns the width of the marker's stroke.
* \see setStrokeWidth()
* \see strokeWidthUnit()
* \see strokeWidthMapUnitScale()
*/
double strokeWidth() const { return mStrokeWidth; }
/**
* Sets the width of the marker's stroke.
* \param w stroke width. See strokeWidthUnit() for units.
* \see strokeWidth()
* \see setStrokeWidthUnit()
* \see setStrokeWidthMapUnitScale()
*/
void setStrokeWidth( double w ) { mStrokeWidth = w; }
/**
* Sets the unit for the width of the marker's stroke.
* \param u stroke width unit
* \see strokeWidthUnit()
* \see setStrokeWidth()
* \see setStrokeWidthMapUnitScale()
*/
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit u ) { mStrokeWidthUnit = u; }
/**
* Returns the unit for the width of the marker's stroke.
* \see setStrokeWidthUnit()
* \see strokeWidth()
* \see strokeWidthMapUnitScale()
*/
QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }
/**
* Sets the map scale for the width of the marker's stroke.
* \param scale stroke width map unit scale
* \see strokeWidthMapUnitScale()
* \see setStrokeWidth()
* \see setStrokeWidthUnit()
*/
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }
/**
* Returns the map scale for the width of the marker's stroke.
* \see setStrokeWidthMapUnitScale()
* \see strokeWidth()
* \see strokeWidthUnit()
*/
const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; }
protected:
/**
* Draws the marker shape in the specified painter.
* \param p destination QPainter
* \param context symbol context
* \note this method does not handle setting the painter pen or brush to match the symbol's fill or stroke
*/
void drawMarker( QPainter *p, QgsSymbolRenderContext &context );
/**
* Prepares cache image
* \returns TRUE in case of success, FALSE if cache image size too large
*/
bool prepareCache( QgsSymbolRenderContext &context );
//! Stroke color
QColor mStrokeColor;
//! Stroke style
Qt::PenStyle mStrokeStyle = Qt::SolidLine;
//! Stroke width
double mStrokeWidth = 0;
//! Stroke width units
QgsUnitTypes::RenderUnit mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters;
//! Stroke width map unit scale
QgsMapUnitScale mStrokeWidthMapUnitScale;
//! Stroke pen join style
Qt::PenJoinStyle mPenJoinStyle;
//! QPen corresponding to marker's stroke style
QPen mPen;
//! QBrush corresponding to marker's fill style
QBrush mBrush;
//! Cached image of marker, if using cached version
QImage mCache;
//! QPen to use as stroke of selected symbols
QPen mSelPen;
//! QBrush to use as fill of selected symbols
QBrush mSelBrush;
//! Cached image of selected marker, if using cached version
QImage mSelCache;
/**
* TRUE if using cached images of markers for drawing. This is faster, but cannot
* be used when data defined properties are present
*/
bool mUsingCache = false;
//! Maximum width/height of cache image
static const int MAXIMUM_CACHE_WIDTH = 3000;
private:
// cppcheck-suppress unusedPrivateFunction
void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path ) override SIP_FORCE;
double mCachedOpacity = 1.0;
};
/**
* \ingroup core
* \class QgsFilledMarkerSymbolLayer
* \brief Filled marker symbol layer, consisting of a shape which is rendered using a QgsFillSymbol. This allows
* the symbol to support advanced styling of the interior and stroke of the shape.
* \since QGIS 2.16
*/
class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayerBase
{
public:
/**
* Constructor for QgsFilledMarkerSymbolLayer.
* \param shape symbol shape
* \param size symbol size (in mm)
* \param angle symbol rotation angle
* \param scaleMethod size scaling method
*/
QgsFilledMarkerSymbolLayer( QgsSimpleMarkerSymbolLayerBase::Shape shape = Circle,
double size = DEFAULT_SIMPLEMARKER_SIZE,
double angle = DEFAULT_SIMPLEMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
/**
* Creates a new QgsFilledMarkerSymbolLayer.
* \param properties a property map containing symbol properties (see properties())
* \returns new QgsFilledMarkerSymbolLayer
*/
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
QVariantMap properties() const override;
QgsFilledMarkerSymbolLayer *clone() const override SIP_FACTORY;
QgsSymbol *subSymbol() override;
bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override;
double estimateMaxBleed( const QgsRenderContext &context ) const override;
QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
bool hasDataDefinedProperties() const override;
void setColor( const QColor &c ) override;
QColor color() const override;
bool usesMapUnits() const override;
private:
#ifdef SIP_RUN
QgsFilledMarkerSymbolLayer( const QgsFilledMarkerSymbolLayer & );
#endif
// cppcheck-suppress unusedPrivateFunction
void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path ) override SIP_FORCE;
//! Fill subsymbol
std::unique_ptr< QgsFillSymbol > mFill;
};
//////////
#define DEFAULT_SVGMARKER_SIZE 2*DEFAULT_POINT_SIZE
#define DEFAULT_SVGMARKER_ANGLE 0
/**
* \ingroup core
* \class QgsSvgMarkerSymbolLayer
*/
class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
{
public:
//! Constructs SVG marker symbol layer with picture from given absolute path to a SVG file
QgsSvgMarkerSymbolLayer( const QString &path,
double size = DEFAULT_SVGMARKER_SIZE,
double angle = DEFAULT_SVGMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
// static stuff
//! Creates the symbol
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
/**
* Turns relative paths in properties map to absolute when reading and vice versa when writing.
* Used internally when reading/writing symbols.
* \since QGIS 3.0
*/
static void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving );
// implemented from base classes
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;
QVariantMap properties() const override;
bool usesMapUnits() const override;
QgsSvgMarkerSymbolLayer *clone() const override SIP_FACTORY;
void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override;
/**
* Returns the marker SVG path.
* \see setPath()
*/
QString path() const { return mPath; }
/**
* Set the marker SVG path.
* \param path SVG path
* \see path()
*/
void setPath( const QString &path );
/**
* Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
* \see updateDefaultAspectRatio()
*/
double defaultAspectRatio() const { return mDefaultAspectRatio; }
/**
* Calculates the default marker aspect ratio between width and height.
* \returns the default aspect ratio value
* \see defaultAspectRatio()
*/
double updateDefaultAspectRatio();
/**
* Returns the preserved aspect ratio value, TRUE if fixed aspect ratio has been lower or equal to 0.
* \see setPreservedAspectRatio()
*/
bool preservedAspectRatio() const { return mFixedAspectRatio <= 0.0; }
/**
* Set preserved the marker aspect ratio between width and height.
* \param par Preserved Aspect Ratio
* \returns the preserved aspect ratio value, TRUE if fixed aspect ratio has been lower or equal to 0
* \see preservedAspectRatio()
*/
bool setPreservedAspectRatio( bool par );
/**
* Returns the marker aspect ratio between width and height to be used in rendering,
* if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering
* \see setFixedAspectRatio() QgsSvgCache
*/
double fixedAspectRatio() const { return mFixedAspectRatio; }
/**
* Set the marker aspect ratio between width and height to be used in rendering,
* if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering
* \param ratio Fixed Aspect Ratio
* \see fixedAspectRatio() QgsSvgCache
*/
void setFixedAspectRatio( double ratio ) { mFixedAspectRatio = ratio; }
QColor fillColor() const override { return color(); }
void setFillColor( const QColor &color ) override { setColor( color ); }
QColor strokeColor() const override { return mStrokeColor; }
void setStrokeColor( const QColor &c ) override { mStrokeColor = c; }
double strokeWidth() const { return mStrokeWidth; }
void setStrokeWidth( double w ) { mStrokeWidth = w; }
/**
* Returns the dynamic SVG parameters
* \since QGIS 3.18
*/
QMap<QString, QgsProperty> parameters() const { return mParameters; }
/**
* Sets the dynamic SVG parameters
* \since QGIS 3.18
*/
void setParameters( const QMap<QString, QgsProperty> ¶meters );
/**
* Sets the units for the stroke width.
* \param unit width units
* \see strokeWidthUnit()
*/
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; }
/**
* Returns the units for the stroke width.
* \see strokeWidthUnit()
*/
QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }
const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; }
void setOutputUnit( QgsUnitTypes::RenderUnit unit ) override;
QgsUnitTypes::RenderUnit outputUnit() const override;
void setMapUnitScale( const QgsMapUnitScale &scale ) override;
QgsMapUnitScale mapUnitScale() const override;
bool writeDxf( QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift = QPointF( 0.0, 0.0 ) ) const override;
QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;
protected:
/**
* Calculates the marker aspect ratio between width and height.
* \param context symbol render context
* \param scaledSize size of symbol to render
* \param hasDataDefinedAspectRatio will be set to TRUE if marker has data defined aspectRatio
*/
double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;
QString mPath;
//! The marker default aspect ratio
double mDefaultAspectRatio = 0.0;
//! The marker fixed aspect ratio
double mFixedAspectRatio = 0.0;
//param(fill), param(stroke), param(stroke-width) are going
//to be replaced in memory
bool mHasFillParam = false;
QColor mStrokeColor;
double mStrokeWidth;
QMap<QString, QgsProperty> mParameters;
QgsUnitTypes::RenderUnit mStrokeWidthUnit;
QgsMapUnitScale mStrokeWidthMapUnitScale;
private:
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledWidth, double scaledHeight, QPointF &offset, double &angle ) const;
};
//////////
#define DEFAULT_RASTERMARKER_SIZE 2*DEFAULT_POINT_SIZE
#define DEFAULT_RASTERMARKER_ANGLE 0
/**
* \ingroup core
* \class QgsRasterMarkerSymbolLayer
* \brief Raster marker symbol layer class.
* \since QGIS 3.6
*/
class CORE_EXPORT QgsRasterMarkerSymbolLayer : public QgsMarkerSymbolLayer
{
public:
//! Constructs raster marker symbol layer with picture from given absolute path to a raster image file
QgsRasterMarkerSymbolLayer( const QString &path = QString(),
double size = DEFAULT_SVGMARKER_SIZE,
double angle = DEFAULT_SVGMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
// static stuff
/**
* Creates a raster marker symbol layer from a string map of properties.
* \param properties QVariantMap properties object
*/
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
/**
* Turns relative paths in properties map to absolute when reading and vice versa when writing.
* Used internally when reading/writing symbols.
* \since QGIS 3.0
*/
static void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving );
// implemented from base classes
QString layerType() const override;
void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;
QVariantMap properties() const override;
QgsRasterMarkerSymbolLayer *clone() const override SIP_FACTORY;
bool usesMapUnits() const override;
/**
* Calculates the marker aspect ratio between width and height.
* \param context symbol render context
* \param scaledSize size of symbol to render
* \param hasDataDefinedAspectRatio will be set to TRUE if marker has data defined aspectRatio
*/
double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;
/**
* Returns the marker raster image path.
* \see setPath()
*/
QString path() const { return mPath; }
/**
* Set the marker raster image path.
* \param path raster image path
* \see path()
*/
void setPath( const QString &path );
/**
* Returns the marker opacity.
* \returns opacity value between 0 (fully transparent) and 1 (fully opaque)
* \see setOpacity()
*/
double opacity() const { return mOpacity; }
/**
* Set the marker opacity.
* \param opacity opacity value between 0 (fully transparent) and 1 (fully opaque)
* \see opacity()
*/
void setOpacity( double opacity ) { mOpacity = opacity; }
/**
* Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
* \see updateDefaultAspectRatio()
*/
double defaultAspectRatio() const { return mDefaultAspectRatio; }
/**
* Calculates the default marker aspect ratio between width and height.
* \returns the default aspect ratio value
* \see defaultAspectRatio()
*/
double updateDefaultAspectRatio();
/**
* Returns the preserved aspect ratio value, TRUE if fixed aspect ratio has been lower or equal to 0.
* \see setPreservedAspectRatio()
*/
bool preservedAspectRatio() const { return mFixedAspectRatio <= 0.0; }
/**
* Set preserved the marker aspect ratio between width and height.
* \param par Preserved Aspect Ratio
* \returns the preserved aspect ratio value, TRUE if fixed aspect ratio has been lower or equal to 0
* \see preservedAspectRatio()
*/
bool setPreservedAspectRatio( bool par );
/**
* Returns the marker aspect ratio between width and height to be used in rendering,
* if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering
* \see setFixedAspectRatio() QgsSvgCache
*/
double fixedAspectRatio() const { return mFixedAspectRatio; }
/**
* Set the marker aspect ratio between width and height to be used in rendering,
* if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering
* \param ratio Fixed Aspect Ratio
* \see fixedAspectRatio() QgsSvgCache
*/
void setFixedAspectRatio( double ratio ) { mFixedAspectRatio = ratio; }
void setMapUnitScale( const QgsMapUnitScale &scale ) override;
QgsMapUnitScale mapUnitScale() const override;
QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;
protected:
QString mPath;
//! The marker default opacity
double mOpacity = 1.0;
//! The marker default aspect ratio
double mDefaultAspectRatio = 0.0;
//! The marker fixed aspect ratio
double mFixedAspectRatio = 0.0;
private:
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledWidth, double scaledHeight, QPointF &offset, double &angle ) const;
};
//////////
#define POINT2MM(x) ( (x) * 25.4 / 72 ) // point is 1/72 of inch
#define MM2POINT(x) ( (x) * 72 / 25.4 )
#define DEFAULT_FONTMARKER_FONT "Dingbats"
#define DEFAULT_FONTMARKER_CHR QChar('A')
#define DEFAULT_FONTMARKER_SIZE POINT2MM(12)
#define DEFAULT_FONTMARKER_COLOR QColor( 35, 35, 35 )
#define DEFAULT_FONTMARKER_BORDERCOLOR QColor(Qt::white)
#define DEFAULT_FONTMARKER_JOINSTYLE Qt::MiterJoin
#define DEFAULT_FONTMARKER_ANGLE 0
/**
* \ingroup core
* \class QgsFontMarkerSymbolLayer
*/
class CORE_EXPORT QgsFontMarkerSymbolLayer : public QgsMarkerSymbolLayer
{
public:
//! Constructs a font marker symbol layer.
QgsFontMarkerSymbolLayer( const QString &fontFamily = DEFAULT_FONTMARKER_FONT,
QString chr = DEFAULT_FONTMARKER_CHR,
double pointSize = DEFAULT_FONTMARKER_SIZE,
const QColor &color = DEFAULT_FONTMARKER_COLOR,
double angle = DEFAULT_FONTMARKER_ANGLE );
// static stuff
/**
* Creates a new QgsFontMarkerSymbolLayer from a property map (see properties())
*/
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
/**
* Creates a new QgsFontMarkerSymbolLayer from an SLD XML \a element.
*/
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
// implemented from base classes
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;
QVariantMap properties() const override;
QgsFontMarkerSymbolLayer *clone() const override SIP_FACTORY;
void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override;
bool usesMapUnits() const override;
// new methods
/**
* Returns the font family name for the associated font which will be used to render the point.
*
* \see setFontFamily()
*/
QString fontFamily() const { return mFontFamily; }
/**
* Sets the font \a family for the font which will be used to render the point.
*
* \see fontFamily()
*/
void setFontFamily( const QString &family ) { mFontFamily = family; }
/**
* Returns the font style for the associated font which will be used to render the point.
*
* \see setFontStyle()
* \since QGIS 3.14
*/
QString fontStyle() const { return mFontStyle; }
/**
* Sets the font \a style for the font which will be used to render the point.
*
* \see fontStyle()
* \since QGIS 3.14
*/
void setFontStyle( const QString &style ) { mFontStyle = style; }
/**
* Returns the character(s) used when rendering points.
*
* \see setCharacter()
*/
QString character() const { return mString; }
/**
* Sets the character(s) used when rendering points.
*
* \see character()
*/
void setCharacter( QString chr ) { mString = chr; }
QColor strokeColor() const override { return mStrokeColor; }
void setStrokeColor( const QColor &color ) override { mStrokeColor = color; }
/**
* Returns the marker's stroke width. Units are retrieved by strokeWidthUnit()
*
* \see setStrokeWidth()
* \see strokeWidthUnit()
* \see strokeWidthMapUnitScale()
*
* \since QGIS 2.16
*/
double strokeWidth() const { return mStrokeWidth; }
/**
* Set's the marker's stroke \a width. Units are set by setStrokeWidthUnit().
*
* \see strokeWidth()
* \see setStrokeWidthUnit()
* \see setStrokeWidthMapUnitScale()
*
* \since QGIS 2.16
*/
void setStrokeWidth( double width ) { mStrokeWidth = width; }
/**
* Returns the stroke width unit.
*
* \see setStrokeWidthUnit()
* \see strokeWidth()
* \see strokeWidthMapUnitScale()
*
* \since QGIS 2.16
*/
QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }
/**
* Sets the stroke width \a unit.
*
* \see strokeWidthUnit()
* \see setStrokeWidth()
* \see setStrokeWidthMapUnitScale()
* \since QGIS 2.16
*/
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; }
/**
* Returns the stroke width map unit scale.
*
* \see setStrokeWidthMapUnitScale()
* \see strokeWidth()
* \see strokeWidthUnit()
*
* \since QGIS 2.16
*/
const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; }
/**
* Sets the stroke width map unit \a scale.
*
* \see strokeWidthMapUnitScale()
* \see setStrokeWidth()
* \see setStrokeWidthUnit()
*
* \since QGIS 2.16
*/
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }
/**
* Returns the stroke join style.
*
* \see setPenJoinStyle()
*
* \since QGIS 2.16
*/
Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; }
/**
* Sets the stroke join \a style.
*
* \see penJoinStyle()
*
* \since QGIS 2.16
*/
void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; }
QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;
private: