-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsfillsymbollayer.h
1565 lines (1263 loc) · 55.3 KB
/
qgsfillsymbollayer.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
/***************************************************************************
qgsfillsymbollayer.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 QGSFILLSYMBOLLAYERV2_H
#define QGSFILLSYMBOLLAYERV2_H
#include "qgis_core.h"
#include "qgis.h"
#include "qgssymbollayer.h"
#define DEFAULT_SIMPLEFILL_COLOR QColor(0,0,255)
#define DEFAULT_SIMPLEFILL_STYLE Qt::SolidPattern
#define DEFAULT_SIMPLEFILL_BORDERCOLOR QColor( 35, 35, 35 )
#define DEFAULT_SIMPLEFILL_BORDERSTYLE Qt::SolidLine
#define DEFAULT_SIMPLEFILL_BORDERWIDTH DEFAULT_LINE_WIDTH
#define DEFAULT_SIMPLEFILL_JOINSTYLE Qt::BevelJoin
#define INF 1E20
#include <QPen>
#include <QBrush>
/**
* \ingroup core
* \class QgsSimpleFillSymbolLayer
*/
class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer
{
public:
QgsSimpleFillSymbolLayer( const QColor &color = DEFAULT_SIMPLEFILL_COLOR,
Qt::BrushStyle style = DEFAULT_SIMPLEFILL_STYLE,
const QColor &strokeColor = DEFAULT_SIMPLEFILL_BORDERCOLOR,
Qt::PenStyle strokeStyle = DEFAULT_SIMPLEFILL_BORDERSTYLE,
double strokeWidth = DEFAULT_SIMPLEFILL_BORDERWIDTH,
Qt::PenJoinStyle penJoinStyle = DEFAULT_SIMPLEFILL_JOINSTYLE
);
// static stuff
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
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 renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context ) override;
QgsStringMap properties() const override;
QgsSimpleFillSymbolLayer *clone() const override SIP_FACTORY;
void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const override;
QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const override;
Qt::BrushStyle brushStyle() const { return mBrushStyle; }
void setBrushStyle( Qt::BrushStyle style ) { mBrushStyle = style; }
QColor strokeColor() const override { return mStrokeColor; }
void setStrokeColor( const QColor &strokeColor ) override { mStrokeColor = strokeColor; }
QColor fillColor() const override { return color(); }
void setFillColor( const QColor &color ) override { setColor( color ); }
Qt::PenStyle strokeStyle() const { return mStrokeStyle; }
void setStrokeStyle( Qt::PenStyle strokeStyle ) { mStrokeStyle = strokeStyle; }
double strokeWidth() const { return mStrokeWidth; }
void setStrokeWidth( double strokeWidth ) { mStrokeWidth = strokeWidth; }
Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; }
void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; }
void setOffset( QPointF offset ) { mOffset = offset; }
QPointF offset() { return mOffset; }
/**
* Sets the units for the width of the fill's stroke.
* \param unit width units
* \see strokeWidthUnit()
*/
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; }
/**
* Returns the units for the width of the fill's stroke.
* \see setStrokeWidthUnit()
*/
QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }
const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; }
/**
* Sets the units for the fill's offset.
* \param unit offset units
* \see offsetUnit()
*/
void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; }
/**
* Returns the units for the fill's offset.
* \see setOffsetUnit()
*/
QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; }
void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
void setOutputUnit( QgsUnitTypes::RenderUnit unit ) override;
QgsUnitTypes::RenderUnit outputUnit() const override;
void setMapUnitScale( const QgsMapUnitScale &scale ) override;
QgsMapUnitScale mapUnitScale() const override;
double estimateMaxBleed( const QgsRenderContext &context ) const override;
double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
QColor dxfColor( QgsSymbolRenderContext &context ) const override;
double dxfAngle( QgsSymbolRenderContext &context ) const override;
Qt::PenStyle dxfPenStyle() const override;
QColor dxfBrushColor( QgsSymbolRenderContext &context ) const override;
Qt::BrushStyle dxfBrushStyle() const override;
protected:
QBrush mBrush;
QBrush mSelBrush;
Qt::BrushStyle mBrushStyle;
QColor mStrokeColor;
Qt::PenStyle mStrokeStyle;
double mStrokeWidth;
QgsUnitTypes::RenderUnit mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mStrokeWidthMapUnitScale;
Qt::PenJoinStyle mPenJoinStyle;
QPen mPen;
QPen mSelPen;
QPointF mOffset;
QgsUnitTypes::RenderUnit mOffsetUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mOffsetMapUnitScale;
private:
//helper functions for data defined symbology
void applyDataDefinedSymbology( QgsSymbolRenderContext &context, QBrush &brush, QPen &pen, QPen &selPen );
};
class QgsColorRamp;
/**
* \ingroup core
* \class QgsGradientFillSymbolLayer
*/
class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer
{
public:
enum GradientColorType
{
SimpleTwoColor,
ColorRamp
};
enum GradientType
{
Linear,
Radial,
Conical
};
enum GradientCoordinateMode
{
Feature,
Viewport
};
enum GradientSpread
{
Pad,
Reflect,
Repeat
};
QgsGradientFillSymbolLayer( const QColor &color = DEFAULT_SIMPLEFILL_COLOR,
const QColor &color2 = Qt::white,
GradientColorType gradientColorType = SimpleTwoColor,
GradientType gradientType = Linear,
GradientCoordinateMode coordinateMode = Feature,
GradientSpread gradientSpread = Pad
);
~QgsGradientFillSymbolLayer() override;
// static stuff
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
// implemented from base classes
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context ) override;
QgsStringMap properties() const override;
QgsGradientFillSymbolLayer *clone() const override SIP_FACTORY;
double estimateMaxBleed( const QgsRenderContext &context ) const override;
//! Type of gradient, e.g., linear or radial
GradientType gradientType() const { return mGradientType; }
void setGradientType( GradientType gradientType ) { mGradientType = gradientType; }
//! Gradient color mode, controls how gradient color stops are created
GradientColorType gradientColorType() const { return mGradientColorType; }
void setGradientColorType( GradientColorType gradientColorType ) { mGradientColorType = gradientColorType; }
/**
* Returns the color ramp used for the gradient fill. This is only
* used if the gradient color type is set to ColorRamp.
* \see setColorRamp()
* \see gradientColorType()
*/
QgsColorRamp *colorRamp() { return mGradientRamp; }
/**
* Sets the color ramp used for the gradient fill. This is only
* used if the gradient color type is set to ColorRamp.
* \param ramp color ramp. Ownership is transferred.
* \see colorRamp()
* \see setGradientColorType()
*/
void setColorRamp( QgsColorRamp *ramp );
//! Color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor
QColor color2() const { return mColor2; }
void setColor2( const QColor &color2 ) { mColor2 = color2; }
//! Coordinate mode for gradient. Controls how the gradient stops are positioned.
GradientCoordinateMode coordinateMode() const { return mCoordinateMode; }
void setCoordinateMode( GradientCoordinateMode coordinateMode ) { mCoordinateMode = coordinateMode; }
//! Gradient spread mode. Controls how the gradient behaves outside of the predefined stops
GradientSpread gradientSpread() const { return mGradientSpread; }
void setGradientSpread( GradientSpread gradientSpread ) { mGradientSpread = gradientSpread; }
//! Starting point of gradient fill, in the range [0,0] - [1,1]
void setReferencePoint1( QPointF referencePoint ) { mReferencePoint1 = referencePoint; }
QPointF referencePoint1() const { return mReferencePoint1; }
//! Sets the starting point of the gradient to be the feature centroid
void setReferencePoint1IsCentroid( bool isCentroid ) { mReferencePoint1IsCentroid = isCentroid; }
bool referencePoint1IsCentroid() const { return mReferencePoint1IsCentroid; }
//! End point of gradient fill, in the range [0,0] - [1,1]
void setReferencePoint2( QPointF referencePoint ) { mReferencePoint2 = referencePoint; }
QPointF referencePoint2() const { return mReferencePoint2; }
//! Sets the end point of the gradient to be the feature centroid
void setReferencePoint2IsCentroid( bool isCentroid ) { mReferencePoint2IsCentroid = isCentroid; }
bool referencePoint2IsCentroid() const { return mReferencePoint2IsCentroid; }
//! Offset for gradient fill
void setOffset( QPointF offset ) { mOffset = offset; }
QPointF offset() const { return mOffset; }
//! Units for gradient fill offset
void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; }
QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; }
void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
void setOutputUnit( QgsUnitTypes::RenderUnit unit ) override;
QgsUnitTypes::RenderUnit outputUnit() const override;
void setMapUnitScale( const QgsMapUnitScale &scale ) override;
QgsMapUnitScale mapUnitScale() const override;
protected:
QBrush mBrush;
QBrush mSelBrush;
GradientColorType mGradientColorType;
QColor mColor2;
QgsColorRamp *mGradientRamp = nullptr;
GradientType mGradientType;
GradientCoordinateMode mCoordinateMode;
GradientSpread mGradientSpread;
QPointF mReferencePoint1;
bool mReferencePoint1IsCentroid = false;
QPointF mReferencePoint2;
bool mReferencePoint2IsCentroid = false;
QPointF mOffset;
QgsUnitTypes::RenderUnit mOffsetUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mOffsetMapUnitScale;
private:
//helper functions for data defined symbology
void applyDataDefinedSymbology( QgsSymbolRenderContext &context, const QPolygonF &points );
//! Applies the gradient to a brush
void applyGradient( const QgsSymbolRenderContext &context, QBrush &brush, const QColor &color, const QColor &color2,
GradientColorType gradientColorType, QgsColorRamp *gradientRamp, GradientType gradientType,
GradientCoordinateMode coordinateMode, GradientSpread gradientSpread,
QPointF referencePoint1, QPointF referencePoint2, double angle );
//! Rotates a reference point by a specified angle around the point (0.5, 0.5)
QPointF rotateReferencePoint( QPointF refPoint, double angle );
};
/**
* \ingroup core
* \class QgsShapeburstFillSymbolLayer
*/
class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer
{
public:
enum ShapeburstColorType
{
SimpleTwoColor,
ColorRamp
};
QgsShapeburstFillSymbolLayer( const QColor &color = DEFAULT_SIMPLEFILL_COLOR, const QColor &color2 = Qt::white,
ShapeburstColorType colorType = SimpleTwoColor,
int blurRadius = 0, bool useWholeShape = true, double maxDistance = 5 );
~QgsShapeburstFillSymbolLayer() override;
/**
* QgsShapeburstFillSymbolLayer cannot be copied.
* \see clone()
*/
QgsShapeburstFillSymbolLayer( const QgsShapeburstFillSymbolLayer &other ) = delete;
/**
* QgsShapeburstFillSymbolLayer cannot be copied.
* \see clone()
*/
QgsShapeburstFillSymbolLayer &operator=( const QgsShapeburstFillSymbolLayer &other ) = delete;
// static stuff
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
// implemented from base classes
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context ) override;
QgsStringMap properties() const override;
QgsShapeburstFillSymbolLayer *clone() const override SIP_FACTORY;
double estimateMaxBleed( const QgsRenderContext &context ) const override;
/**
* Sets the blur radius, which controls the amount of blurring applied to the fill.
* \param blurRadius Radius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur.
* \see blurRadius
* \since QGIS 2.3
*/
void setBlurRadius( int blurRadius ) { mBlurRadius = blurRadius; }
/**
* Returns the blur radius, which controls the amount of blurring applied to the fill.
* \returns Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled.
* \see setBlurRadius
* \since QGIS 2.3
*/
int blurRadius() const { return mBlurRadius; }
/**
* Sets whether the shapeburst fill should be drawn using the entire shape.
* \param useWholeShape Set to true if shapeburst should cover entire shape. If false, setMaxDistance is used to calculate how far from the boundary of the shape should
* be shaded
* \see useWholeShape
* \see setMaxDistance
* \since QGIS 2.3
*/
void setUseWholeShape( bool useWholeShape ) { mUseWholeShape = useWholeShape; }
/**
* Returns whether the shapeburst fill is set to cover the entire shape.
* \returns True if shapeburst fill will cover the entire shape. If false, shapeburst is drawn to a distance of maxDistance from the polygon's boundary.
* \see setUseWholeShape
* \see maxDistance
* \since QGIS 2.3
*/
bool useWholeShape() const { return mUseWholeShape; }
/**
* Sets the maximum distance to shape inside of the shape from the polygon's boundary.
* \param maxDistance distance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit.
* \see maxDistance
* \see setUseWholeShape
* \see setDistanceUnit
* \since QGIS 2.3
*/
void setMaxDistance( double maxDistance ) { mMaxDistance = maxDistance; }
/**
* Returns the maximum distance from the shape's boundary which is shaded. This parameter is only effective if useWholeShape is false.
* \returns the maximum distance from the polygon's boundary which is shaded. Distance units are indicated by distanceUnit.
* \see useWholeShape
* \see setMaxDistance
* \see distanceUnit
* \since QGIS 2.3
*/
double maxDistance() const { return mMaxDistance; }
/**
* Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
* \param unit distance unit for the maximum distance
* \see setMaxDistance
* \see distanceUnit
* \since QGIS 2.3
*/
void setDistanceUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceUnit = unit; }
/**
* Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
* \returns distance unit for the maximum distance
* \see maxDistance
* \see setDistanceUnit
* \since QGIS 2.3
*/
QgsUnitTypes::RenderUnit distanceUnit() const { return mDistanceUnit; }
void setDistanceMapUnitScale( const QgsMapUnitScale &scale ) { mDistanceMapUnitScale = scale; }
const QgsMapUnitScale &distanceMapUnitScale() const { return mDistanceMapUnitScale; }
/**
* Sets the color mode to use for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp
* or by simply specificing a start and end color. setColorType is used to specify which mode to use for the fill.
* \param colorType color type to use for shapeburst fill
* \see colorType
* \see setColor
* \see setColor2
* \see setColorRamp
* \since QGIS 2.3
*/
void setColorType( ShapeburstColorType colorType ) { mColorType = colorType; }
/**
* Returns the color mode used for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp
* or by simply specificing a start and end color.
* \returns current color mode used for the shapeburst fill
* \see setColorType
* \see color
* \see color2
* \see colorRamp
* \since QGIS 2.3
*/
ShapeburstColorType colorType() const { return mColorType; }
/**
* Sets the color ramp used to draw the shapeburst fill. Color ramps are only used if setColorType is set ShapeburstColorType::ColorRamp.
* \param ramp color ramp to use for shapeburst fill
* \see setColorType
* \see colorRamp
* \since QGIS 2.3
*/
void setColorRamp( QgsColorRamp *ramp );
/**
* Returns the color ramp used for the shapeburst fill. The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp
* \returns a QgsColorRamp color ramp
* \see setColorRamp
* \see colorType
* \since QGIS 2.3
*/
QgsColorRamp *colorRamp() { return mGradientRamp.get(); }
/**
* Sets the color for the endpoint of the shapeburst fill. This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor.
* \param color2 QColor to use for endpoint of gradient
* \see setColorType
* \see color2
* \since QGIS 2.3
*/
void setColor2( const QColor &color2 ) { mColor2 = color2; }
/**
* Returns the color used for the endpoint of the shapeburst fill. This color is only used if the colorType is set to ShapeburstColorType::SimpleTwoColor
* \returns a QColor indicating the color of the endpoint of the gradient
* \see setColor2
* \see colorType
* \since QGIS 2.3
*/
QColor color2() const { return mColor2; }
/**
* Sets whether the shapeburst fill should ignore polygon rings when calculating
* the buffered shading.
* \param ignoreRings Set to true if buffers should ignore interior rings for polygons.
* \see ignoreRings
* \since QGIS 2.3
*/
void setIgnoreRings( bool ignoreRings ) { mIgnoreRings = ignoreRings; }
/**
* Returns whether the shapeburst fill is set to ignore polygon interior rings.
* \returns True if the shapeburst fill will ignore interior rings when calculating buffered shading.
* \see setIgnoreRings
* \since QGIS 2.3
*/
bool ignoreRings() const { return mIgnoreRings; }
/**
* Sets the offset for the shapeburst fill.
* \param offset QPointF indicating the horizontal/vertical offset amount
* \see offset
* \see setOffsetUnit
* \since QGIS 2.3
*/
void setOffset( QPointF offset ) { mOffset = offset; }
/**
* Returns the offset for the shapeburst fill.
* \returns a QPointF indicating the horizontal/vertical offset amount
* \see setOffset
* \see offsetUnit
* \since QGIS 2.3
*/
QPointF offset() const { return mOffset; }
/**
* Sets the units used for the offset for the shapeburst fill.
* \param unit units for fill offset
* \see setOffset
* \see offsetUnit
* \since QGIS 2.3
*/
void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; }
/**
* Returns the units used for the offset of the shapeburst fill.
* \returns units used for the fill offset
* \see offset
* \see setOffsetUnit
* \since QGIS 2.3
*/
QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; }
void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
void setOutputUnit( QgsUnitTypes::RenderUnit unit ) override;
QgsUnitTypes::RenderUnit outputUnit() const override;
void setMapUnitScale( const QgsMapUnitScale &scale ) override;
QgsMapUnitScale mapUnitScale() const override;
private:
QBrush mBrush;
QBrush mSelBrush;
int mBlurRadius = 0;
bool mUseWholeShape = true;
double mMaxDistance = 5.0;
QgsUnitTypes::RenderUnit mDistanceUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mDistanceMapUnitScale;
ShapeburstColorType mColorType = SimpleTwoColor;
QColor mColor2;
bool mIgnoreRings = false;
QPointF mOffset;
QgsUnitTypes::RenderUnit mOffsetUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mOffsetMapUnitScale;
std::unique_ptr< QgsColorRamp > mGradientRamp;
//helper functions for data defined symbology
void applyDataDefinedSymbology( QgsSymbolRenderContext &context, QColor &color, QColor &color2, int &blurRadius, bool &useWholeShape,
double &maxDistance, bool &ignoreRings );
/* distance transform of a 1d function using squared distance */
void distanceTransform1d( double *f, int n, int *v, double *z, double *d );
/* distance transform of 2d function using squared distance */
void distanceTransform2d( double *im, int width, int height );
/* distance transform of a binary QImage */
double *distanceTransform( QImage *im );
/* fills a QImage with values from an array of doubles containing squared distance transform values */
void dtArrayToQImage( double *array, QImage *im, QgsColorRamp *ramp, double layerAlpha = 1, bool useWholeShape = true, int maxPixelDistance = 0 );
#ifdef SIP_RUN
QgsShapeburstFillSymbolLayer( const QgsShapeburstFillSymbolLayer &other );
#endif
};
/**
* \ingroup core
* Base class for polygon renderers generating texture images*/
class CORE_EXPORT QgsImageFillSymbolLayer: public QgsFillSymbolLayer
{
public:
QgsImageFillSymbolLayer();
void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context ) override;
QgsSymbol *subSymbol() override { return mStroke.get(); }
bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override;
/**
* Sets the \a units fo the symbol's stroke width.
* \see strokeWidthUnit()
* \see setStrokeWidthMapUnitScale()
*/
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; }
/**
* Returns the units for the symbol's stroke width.
* \see setStrokeWidthUnit()
* \see strokeWidthMapUnitScale()
*/
QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }
/**
* Sets the stroke width map unit \a scale.
*
* \see strokeWidthMapUnitScale()
* \see setStrokeWidth()
* \see setStrokeWidthUnit()
*/
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }
/**
* Returns the stroke width map unit scale.
*
* \see setStrokeWidthMapUnitScale()
* \see strokeWidth()
* \see strokeWidthUnit()
*
* \since QGIS 2.16
*/
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;
double estimateMaxBleed( const QgsRenderContext &context ) const override;
double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
QColor dxfColor( QgsSymbolRenderContext &context ) const override;
Qt::PenStyle dxfPenStyle() const override;
QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
protected:
QBrush mBrush;
double mNextAngle = 0.0; // mAngle / data defined angle
//! Stroke width
double mStrokeWidth = 0.0;
QgsUnitTypes::RenderUnit mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mStrokeWidthMapUnitScale;
//! Custom stroke
std::unique_ptr< QgsLineSymbol > mStroke;
virtual void applyDataDefinedSettings( QgsSymbolRenderContext &context ) { Q_UNUSED( context ); }
private:
#ifdef SIP_RUN
QgsImageFillSymbolLayer( const QgsImageFillSymbolLayer &other );
#endif
};
/**
* \ingroup core
* \class QgsRasterFillSymbolLayer
* \brief A class for filling symbols with a repeated raster image.
* \since QGIS 2.7
*/
class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer
{
public:
//! Fill coordinate modes, dictates fill tiling behavior
enum FillCoordinateMode
{
Feature, //!< Tiling is based on feature bounding box
Viewport, //!< Tiling is based on complete map viewport
};
/**
* Constructor for QgsRasterFillSymbolLayer, using a raster fill from the
* specified \a imageFilePath.
*/
QgsRasterFillSymbolLayer( const QString &imageFilePath = QString() );
/**
* Creates a new QgsRasterFillSymbolLayer from a \a properties map. The caller takes
* ownership of the returned object.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) 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( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );
// implemented from base classes
QString layerType() const override;
void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context ) override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
QgsStringMap properties() const override;
QgsRasterFillSymbolLayer *clone() const override SIP_FACTORY;
double estimateMaxBleed( const QgsRenderContext &context ) const override;
//override QgsImageFillSymbolLayer's support for sub symbols
QgsSymbol *subSymbol() override { return nullptr; }
bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override;
/**
* Sets the path to the raster image used for the fill.
* \param imagePath path to image file
* \see imageFilePath
*/
void setImageFilePath( const QString &imagePath );
/**
* The path to the raster image used for the fill.
* \returns path to image file
* \see setImageFilePath
*/
QString imageFilePath() const { return mImageFilePath; }
/**
* Set the coordinate mode for fill. Controls how the top left corner of the image
* fill is positioned relative to the feature.
* \param mode coordinate mode
* \see coordinateMode
*/
void setCoordinateMode( FillCoordinateMode mode );
/**
* Coordinate mode for fill. Controls how the top left corner of the image
* fill is positioned relative to the feature.
* \returns coordinate mode
* \see setCoordinateMode
*/
FillCoordinateMode coordinateMode() const { return mCoordinateMode; }
/**
* Sets the \a opacity for the raster image used in the fill.
* \param opacity opacity value between 0 (fully transparent) and 1 (fully opaque)
* \see opacity()
*/
void setOpacity( double opacity );
/**
* Returns the opacity for the raster image used in the fill.
* \returns opacity value between 0 (fully transparent) and 1 (fully opaque)
* \see setOpacity()
*/
double opacity() const { return mOpacity; }
/**
* Sets the offset for the fill.
* \param offset offset for fill
* \see offset
* \see setOffsetUnit
* \see setOffsetMapUnitScale
*/
void setOffset( QPointF offset ) { mOffset = offset; }
/**
* Returns the offset for the fill.
* \returns offset for fill
* \see setOffset
* \see offsetUnit
* \see offsetMapUnitScale
*/
QPointF offset() const { return mOffset; }
/**
* Sets the units for the fill's offset.
* \param unit units for offset
* \see offsetUnit
* \see setOffset
* \see setOffsetMapUnitScale
*/
void setOffsetUnit( const QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; }
/**
* Returns the units for the fill's offset.
* \returns units for offset
* \see setOffsetUnit
* \see offset
* \see offsetMapUnitScale
*/
QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; }
/**
* Sets the map unit scale for the fill's offset.
* \param scale map unit scale for offset
* \see offsetMapUnitScale
* \see setOffset
* \see setOffsetUnit
*/
void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
/**
* Returns the map unit scale for the fill's offset.
* \returns map unit scale for offset
* \see setOffsetMapUnitScale
* \see offset
* \see offsetUnit
*/
const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
/**
* Sets the width for scaling the image used in the fill. The image's height will also be
* scaled to maintain the image's aspect ratio.
* \param width width for scaling the image
* \see width
* \see setWidthUnit
* \see setWidthMapUnitScale
*/
void setWidth( const double width ) { mWidth = width; }
/**
* Returns the width used for scaling the image used in the fill. The image's height is
* scaled to maintain the image's aspect ratio.
* \returns width used for scaling the image
* \see setWidth
* \see widthUnit
* \see widthMapUnitScale
*/
double width() const { return mWidth; }
/**
* Sets the units for the image's width.
* \param unit units for width
* \see widthUnit
* \see setWidth
* \see setWidthMapUnitScale
*/
void setWidthUnit( const QgsUnitTypes::RenderUnit unit ) { mWidthUnit = unit; }
/**
* Returns the units for the image's width.
* \returns units for width
* \see setWidthUnit
* \see width
* \see widthMapUnitScale
*/
QgsUnitTypes::RenderUnit widthUnit() const { return mWidthUnit; }
/**
* Sets the map unit scale for the image's width.
* \param scale map unit scale for width
* \see widthMapUnitScale
* \see setWidth
* \see setWidthUnit
*/
void setWidthMapUnitScale( const QgsMapUnitScale &scale ) { mWidthMapUnitScale = scale; }
/**
* Returns the map unit scale for the image's width.
* \returns map unit scale for width
* \see setWidthMapUnitScale
* \see width
* \see widthUnit
*/
const QgsMapUnitScale &widthMapUnitScale() const { return mWidthMapUnitScale; }
protected:
void applyDataDefinedSettings( QgsSymbolRenderContext &context ) override;
private:
//! Path to the image file
QString mImageFilePath;
FillCoordinateMode mCoordinateMode = QgsRasterFillSymbolLayer::Feature;
double mOpacity = 1.0;
QPointF mOffset;
QgsUnitTypes::RenderUnit mOffsetUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mOffsetMapUnitScale;
double mWidth = 0.0;
QgsUnitTypes::RenderUnit mWidthUnit = QgsUnitTypes::RenderPixels;
QgsMapUnitScale mWidthMapUnitScale;
//! Applies the image pattern to the brush
void applyPattern( QBrush &brush, const QString &imageFilePath, double width, double opacity,
const QgsSymbolRenderContext &context );
};
/**
* \ingroup core
* A class for filling symbols with a repeated SVG file.
*/
class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer
{
public:
/**
* Constructor for QgsSVGFillSymbolLayer, using the SVG picture at the specified absolute file path.
*/
QgsSVGFillSymbolLayer( const QString &svgFilePath, double width = 20, double rotation = 0.0 );
/**
* Constructor for QgsSVGFillSymbolLayer, using the specified SVG picture data.
*/
QgsSVGFillSymbolLayer( const QByteArray &svgData, double width = 20, double rotation = 0.0 );
/**
* Creates a new QgsSVGFillSymbolLayer from a \a properties map. The caller takes
* ownership of the returned object.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
/**
* Creates a new QgsSVGFillSymbolLayer from a SLD \a element. The caller takes
* ownership of the returned object.
*/
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( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );
// implemented from base classes
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
QgsStringMap properties() const override;
QgsSVGFillSymbolLayer *clone() const override SIP_FACTORY;
void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const override;
/**
* Sets the path to the SVG file to render in the fill.
*
* This is usually an absolute file path. Other supported options include
* - relative paths to folders from the user's SVG search paths
* - base64 encoded content, prefixed with a 'base64:' string
* - http(s) paths
*
* \see svgFilePath()
*/
void setSvgFilePath( const QString &svgPath );
/**
* Returns the path to the SVG file used to render the fill.
*
* \see setSvgFilePath()
*/
QString svgFilePath() const { return mSvgFilePath; }
/**
* Sets the \a width to render the SVG content as within the fill (i.e. the pattern repeat/tile size).
*
* Units are specified by setPatternWidthUnit()
*
* \see patternWidth()