-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsfillsymbollayer.sip.in
2577 lines (1620 loc) · 65.6 KB
/
qgsfillsymbollayer.sip.in
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsfillsymbollayer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSimpleFillSymbolLayer : QgsFillSymbolLayer
{
%TypeHeaderCode
#include "qgsfillsymbollayer.h"
%End
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
);
~QgsSimpleFillSymbolLayer();
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a new QgsSimpleFillSymbolLayer using the specified ``properties`` map containing symbol properties (see :py:func:`~QgsSimpleFillSymbolLayer.properties`).
Caller takes ownership of the returned symbol layer.
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
virtual QString layerType() const;
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual void renderPolygon( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsSimpleFillSymbolLayer *clone() const /Factory/;
virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const;
virtual QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const;
Qt::BrushStyle brushStyle() const;
void setBrushStyle( Qt::BrushStyle style );
virtual QColor strokeColor() const;
virtual void setStrokeColor( const QColor &strokeColor );
virtual QColor fillColor() const;
virtual void setFillColor( const QColor &color );
Qt::PenStyle strokeStyle() const;
void setStrokeStyle( Qt::PenStyle strokeStyle );
double strokeWidth() const;
void setStrokeWidth( double strokeWidth );
Qt::PenJoinStyle penJoinStyle() const;
void setPenJoinStyle( Qt::PenJoinStyle style );
void setOffset( QPointF offset );
%Docstring
Sets an ``offset`` by which polygons will be translated during rendering.
Units are specified by :py:func:`~QgsSimpleFillSymbolLayer.offsetUnit`.
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`setOffsetUnit`
%End
QPointF offset();
%Docstring
Returns the offset by which polygons will be translated during rendering.
Units are specified by :py:func:`~QgsSimpleFillSymbolLayer.offsetUnit`.
.. seealso:: :py:func:`setOffset`
.. seealso:: :py:func:`offsetUnit`
%End
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units for the width of the fill's stroke.
:param unit: width units
.. seealso:: :py:func:`strokeWidthUnit`
%End
QgsUnitTypes::RenderUnit strokeWidthUnit() const;
%Docstring
Returns the units for the width of the fill's stroke.
.. seealso:: :py:func:`setStrokeWidthUnit`
%End
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale );
const QgsMapUnitScale &strokeWidthMapUnitScale() const;
void setOffsetUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the ``unit`` for the fill's offset.
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`offsetUnit`
%End
QgsUnitTypes::RenderUnit offsetUnit() const;
%Docstring
Returns the units for the fill's offset.
.. seealso:: :py:func:`setOffsetUnit`
.. seealso:: :py:func:`offset`
%End
void setOffsetMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for the fill's offset.
.. seealso:: :py:func:`setOffset`
.. seealso:: :py:func:`offsetMapUnitScale`
%End
const QgsMapUnitScale &offsetMapUnitScale() const;
%Docstring
Returns the map unit scale for the fill's offset.
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`setOffsetMapUnitScale`
%End
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
virtual QgsUnitTypes::RenderUnit outputUnit() const;
virtual bool usesMapUnits() const;
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
virtual double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
virtual QColor dxfColor( QgsSymbolRenderContext &context ) const;
virtual double dxfAngle( QgsSymbolRenderContext &context ) const;
virtual Qt::PenStyle dxfPenStyle() const;
virtual QColor dxfBrushColor( QgsSymbolRenderContext &context ) const;
virtual Qt::BrushStyle dxfBrushStyle() const;
protected:
};
class QgsGradientFillSymbolLayer : QgsFillSymbolLayer
{
%TypeHeaderCode
#include "qgsfillsymbollayer.h"
%End
public:
QgsGradientFillSymbolLayer( const QColor &color = DEFAULT_SIMPLEFILL_COLOR,
const QColor &color2 = Qt::white,
Qgis::GradientColorSource gradientColorType = Qgis::GradientColorSource::SimpleTwoColor,
Qgis::GradientType gradientType = Qgis::GradientType::Linear,
Qgis::SymbolCoordinateReference coordinateMode = Qgis::SymbolCoordinateReference::Feature,
Qgis::GradientSpread gradientSpread = Qgis::GradientSpread::Pad
);
%Docstring
Constructor for QgsGradientFillSymbolLayer.
%End
~QgsGradientFillSymbolLayer();
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a new QgsGradientFillSymbolLayer using the specified ``properties`` map containing symbol properties (see :py:func:`~QgsGradientFillSymbolLayer.properties`).
Caller takes ownership of the returned symbol layer.
%End
virtual QString layerType() const;
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual void renderPolygon( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsGradientFillSymbolLayer *clone() const /Factory/;
virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
virtual bool canCauseArtifactsBetweenAdjacentTiles() const;
Qgis::GradientType gradientType() const;
%Docstring
Returns the type of gradient, e.g., linear or radial.
.. seealso:: :py:func:`setGradientType`
%End
void setGradientType( Qgis::GradientType gradientType );
%Docstring
Sets the type of gradient, e.g., linear or radial.
.. seealso:: :py:func:`gradientType`
%End
Qgis::GradientColorSource gradientColorType() const;
%Docstring
Returns the gradient color mode, which controls how gradient color stops are created.
.. seealso:: :py:func:`setGradientColorType`
%End
void setGradientColorType( Qgis::GradientColorSource gradientColorType );
%Docstring
Sets the gradient color mode, which controls how gradient color stops are created.
.. seealso:: :py:func:`gradientColorType`
%End
QgsColorRamp *colorRamp();
%Docstring
Returns the color ramp used for the gradient fill. This is only
used if the gradient color type is set to ColorRamp.
.. seealso:: :py:func:`setColorRamp`
.. seealso:: :py:func:`gradientColorType`
%End
void setColorRamp( QgsColorRamp *ramp /Transfer/ );
%Docstring
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.
.. seealso:: :py:func:`colorRamp`
.. seealso:: :py:func:`setGradientColorType`
%End
QColor color2() const;
%Docstring
Returns the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
.. seealso:: :py:func:`setColor2`
%End
void setColor2( const QColor &color2 );
%Docstring
Sets the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
.. seealso:: :py:func:`color2`
%End
Qgis::SymbolCoordinateReference coordinateMode() const;
%Docstring
Returns the coordinate mode for gradient, which controls how the gradient stops are positioned.
.. seealso:: :py:func:`setCoordinateMode`
%End
void setCoordinateMode( Qgis::SymbolCoordinateReference coordinateMode );
%Docstring
Sets the coordinate mode for gradient, which controls how the gradient stops are positioned.
.. seealso:: :py:func:`coordinateMode`
%End
Qgis::GradientSpread gradientSpread() const;
%Docstring
Returns the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.
.. seealso:: :py:func:`setGradientSpread`
%End
void setGradientSpread( Qgis::GradientSpread gradientSpread );
%Docstring
Sets the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.
.. seealso:: :py:func:`gradientSpread`
%End
void setReferencePoint1( QPointF referencePoint );
%Docstring
Sets the starting point of gradient fill, in the range [0,0] - [1,1].
.. seealso:: :py:func:`referencePoint1`
%End
QPointF referencePoint1() const;
%Docstring
Returns the starting point of gradient fill, in the range [0,0] - [1,1].
.. seealso:: :py:func:`setReferencePoint1`
%End
void setReferencePoint1IsCentroid( bool isCentroid );
%Docstring
Sets whether the starting point for the gradient is taken from the feature centroid.
.. seealso:: :py:func:`referencePoint1IsCentroid`
%End
bool referencePoint1IsCentroid() const;
%Docstring
Returns whether the starting point for the gradient is taken from the feature centroid.
.. seealso:: :py:func:`setReferencePoint1IsCentroid`
%End
void setReferencePoint2( QPointF referencePoint );
%Docstring
Sets the end point of gradient fill, in the range [0,0] - [1,1].
.. seealso:: :py:func:`referencePoint2`
%End
QPointF referencePoint2() const;
%Docstring
Returns the end point of gradient fill, in the range [0,0] - [1,1].
.. seealso:: :py:func:`setReferencePoint2`
%End
void setReferencePoint2IsCentroid( bool isCentroid );
%Docstring
Sets whether the end point for the gradient is taken from the feature centroid.
.. seealso:: :py:func:`referencePoint2IsCentroid`
%End
bool referencePoint2IsCentroid() const;
%Docstring
Returns whether the end point for the gradient is taken from the feature centroid.
.. seealso:: :py:func:`setReferencePoint2IsCentroid`
%End
void setOffset( QPointF offset );
%Docstring
Sets an ``offset`` by which polygons will be translated during rendering.
Units are specified by :py:func:`~QgsGradientFillSymbolLayer.offsetUnit`.
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`setOffsetUnit`
%End
QPointF offset() const;
%Docstring
Returns the offset by which polygons will be translated during rendering.
Units are specified by :py:func:`~QgsGradientFillSymbolLayer.offsetUnit`.
.. seealso:: :py:func:`setOffset`
.. seealso:: :py:func:`offsetUnit`
%End
void setOffsetUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the ``unit`` for the fill's offset.
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`offsetUnit`
%End
QgsUnitTypes::RenderUnit offsetUnit() const;
%Docstring
Returns the units for the fill's offset.
.. seealso:: :py:func:`setOffsetUnit`
.. seealso:: :py:func:`offset`
%End
void setOffsetMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for the fill's offset.
.. seealso:: :py:func:`setOffset`
.. seealso:: :py:func:`offsetMapUnitScale`
%End
const QgsMapUnitScale &offsetMapUnitScale() const;
%Docstring
Returns the map unit scale for the fill's offset.
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`setOffsetMapUnitScale`
%End
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
virtual QgsUnitTypes::RenderUnit outputUnit() const;
virtual bool usesMapUnits() const;
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
protected:
};
class QgsShapeburstFillSymbolLayer : QgsFillSymbolLayer
{
%TypeHeaderCode
#include "qgsfillsymbollayer.h"
%End
public:
QgsShapeburstFillSymbolLayer( const QColor &color = DEFAULT_SIMPLEFILL_COLOR, const QColor &color2 = Qt::white,
Qgis::GradientColorSource colorType = Qgis::GradientColorSource::SimpleTwoColor,
int blurRadius = 0, bool useWholeShape = true, double maxDistance = 5 );
%Docstring
Constructor for QgsShapeburstFillSymbolLayer.
%End
~QgsShapeburstFillSymbolLayer();
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a new QgsShapeburstFillSymbolLayer using the specified ``properties`` map containing symbol properties (see :py:func:`~QgsShapeburstFillSymbolLayer.properties`).
Caller takes ownership of the returned symbol layer.
%End
virtual QString layerType() const;
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual void renderPolygon( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsShapeburstFillSymbolLayer *clone() const /Factory/;
virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
virtual bool canCauseArtifactsBetweenAdjacentTiles() const;
void setBlurRadius( int blurRadius );
%Docstring
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.
.. seealso:: :py:func:`blurRadius`
.. versionadded:: 2.3
%End
int blurRadius() const;
%Docstring
Returns the blur radius, which controls the amount of blurring applied to the fill.
:return: Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled.
.. seealso:: :py:func:`setBlurRadius`
.. versionadded:: 2.3
%End
void setUseWholeShape( bool useWholeShape );
%Docstring
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
.. seealso:: :py:func:`useWholeShape`
.. seealso:: :py:func:`setMaxDistance`
.. versionadded:: 2.3
%End
bool useWholeShape() const;
%Docstring
Returns whether the shapeburst fill is set to cover the entire shape.
:return: ``True`` if shapeburst fill will cover the entire shape. If ``False``, shapeburst is drawn to a distance of maxDistance from the polygon's boundary.
.. seealso:: :py:func:`setUseWholeShape`
.. seealso:: :py:func:`maxDistance`
.. versionadded:: 2.3
%End
void setMaxDistance( double maxDistance );
%Docstring
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.
.. seealso:: :py:func:`maxDistance`
.. seealso:: :py:func:`setUseWholeShape`
.. seealso:: :py:func:`setDistanceUnit`
.. versionadded:: 2.3
%End
double maxDistance() const;
%Docstring
Returns the maximum distance from the shape's boundary which is shaded. This parameter is only effective if useWholeShape is ``False``.
:return: the maximum distance from the polygon's boundary which is shaded. Distance units are indicated by distanceUnit.
.. seealso:: :py:func:`useWholeShape`
.. seealso:: :py:func:`setMaxDistance`
.. seealso:: :py:func:`distanceUnit`
.. versionadded:: 2.3
%End
void setDistanceUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
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
.. seealso:: :py:func:`setMaxDistance`
.. seealso:: :py:func:`distanceUnit`
.. versionadded:: 2.3
%End
QgsUnitTypes::RenderUnit distanceUnit() const;
%Docstring
Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
:return: distance unit for the maximum distance
.. seealso:: :py:func:`maxDistance`
.. seealso:: :py:func:`setDistanceUnit`
.. versionadded:: 2.3
%End
void setDistanceMapUnitScale( const QgsMapUnitScale &scale );
const QgsMapUnitScale &distanceMapUnitScale() const;
void setColorType( Qgis::GradientColorSource colorType );
%Docstring
Sets the color mode to use for the shapeburst fill. Shapeburst can either be drawn using a :py:class:`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
.. seealso:: :py:func:`colorType`
.. seealso:: :py:func:`setColor`
.. seealso:: :py:func:`setColor2`
.. seealso:: :py:func:`setColorRamp`
.. versionadded:: 2.3
%End
Qgis::GradientColorSource colorType() const;
%Docstring
Returns the color mode used for the shapeburst fill. Shapeburst can either be drawn using a :py:class:`QgsColorRamp` color ramp
or by simply specificing a start and end color.
:return: current color mode used for the shapeburst fill
.. seealso:: :py:func:`setColorType`
.. seealso:: :py:func:`color`
.. seealso:: :py:func:`color2`
.. seealso:: :py:func:`colorRamp`
.. versionadded:: 2.3
%End
void setColorRamp( QgsColorRamp *ramp /Transfer/ );
%Docstring
Sets the color ``ramp`` used to draw the shapeburst fill. Color ramps are only used if setColorType is set ShapeburstColorType.ColorRamp.
Ownership of ``ramp`` is transferred to the fill.
.. seealso:: :py:func:`setColorType`
.. seealso:: :py:func:`colorRamp`
.. versionadded:: 2.3
%End
QgsColorRamp *colorRamp();
%Docstring
Returns the color ramp used for the shapeburst fill. The color ramp is only used if the colorType is set to ShapeburstColorType.ColorRamp
:return: a :py:class:`QgsColorRamp` color ramp
.. seealso:: :py:func:`setColorRamp`
.. seealso:: :py:func:`colorType`
.. versionadded:: 2.3
%End
void setColor2( const QColor &color2 );
%Docstring
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
.. seealso:: :py:func:`setColorType`
.. seealso:: :py:func:`color2`
.. versionadded:: 2.3
%End
QColor color2() const;
%Docstring
Returns the color used for the endpoint of the shapeburst fill. This color is only used if the colorType is set to ShapeburstColorType.SimpleTwoColor
:return: a QColor indicating the color of the endpoint of the gradient
.. seealso:: :py:func:`setColor2`
.. seealso:: :py:func:`colorType`
.. versionadded:: 2.3
%End
void setIgnoreRings( bool ignoreRings );
%Docstring
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.
.. seealso:: :py:func:`ignoreRings`
.. versionadded:: 2.3
%End
bool ignoreRings() const;
%Docstring
Returns whether the shapeburst fill is set to ignore polygon interior rings.
:return: ``True`` if the shapeburst fill will ignore interior rings when calculating buffered shading.
.. seealso:: :py:func:`setIgnoreRings`
.. versionadded:: 2.3
%End
void setOffset( QPointF offset );
%Docstring
Sets the offset for the shapeburst fill.
:param offset: QPointF indicating the horizontal/vertical offset amount
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`setOffsetUnit`
.. versionadded:: 2.3
%End
QPointF offset() const;
%Docstring
Returns the offset for the shapeburst fill.
:return: a QPointF indicating the horizontal/vertical offset amount
.. seealso:: :py:func:`setOffset`
.. seealso:: :py:func:`offsetUnit`
.. versionadded:: 2.3
%End
void setOffsetUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units used for the offset for the shapeburst fill.
:param unit: units for fill offset
.. seealso:: :py:func:`setOffset`
.. seealso:: :py:func:`offsetUnit`
.. versionadded:: 2.3
%End
QgsUnitTypes::RenderUnit offsetUnit() const;
%Docstring
Returns the units used for the offset of the shapeburst fill.
:return: units used for the fill offset
.. seealso:: :py:func:`offset`
.. seealso:: :py:func:`setOffsetUnit`
.. versionadded:: 2.3
%End
void setOffsetMapUnitScale( const QgsMapUnitScale &scale );
const QgsMapUnitScale &offsetMapUnitScale() const;
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
virtual QgsUnitTypes::RenderUnit outputUnit() const;
virtual bool usesMapUnits() const;
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
private:
QgsShapeburstFillSymbolLayer( const QgsShapeburstFillSymbolLayer &other );
};
class QgsImageFillSymbolLayer: QgsFillSymbolLayer
{
%Docstring(signature="appended")
Base class for polygon renderers generating texture images
%End
%TypeHeaderCode
#include "qgsfillsymbollayer.h"
%End
public:
QgsImageFillSymbolLayer();
~QgsImageFillSymbolLayer();
virtual void renderPolygon( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );
virtual QgsSymbol *subSymbol();
virtual bool setSubSymbol( QgsSymbol *symbol /Transfer/ );
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the ``units`` fo the symbol's stroke width.
.. seealso:: :py:func:`strokeWidthUnit`
.. seealso:: :py:func:`setStrokeWidthMapUnitScale`
%End
QgsUnitTypes::RenderUnit strokeWidthUnit() const;
%Docstring
Returns the units for the symbol's stroke width.
.. seealso:: :py:func:`setStrokeWidthUnit`
.. seealso:: :py:func:`strokeWidthMapUnitScale`
%End
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the stroke width map unit ``scale``.
.. seealso:: :py:func:`strokeWidthMapUnitScale`
.. seealso:: :py:func:`setStrokeWidthUnit`
%End
const QgsMapUnitScale &strokeWidthMapUnitScale() const;
%Docstring
Returns the stroke width map unit scale.
.. seealso:: :py:func:`setStrokeWidthMapUnitScale`
.. seealso:: :py:func:`strokeWidthUnit`
.. versionadded:: 2.16
%End
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
virtual QgsUnitTypes::RenderUnit outputUnit() const;
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
virtual double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
virtual QColor dxfColor( QgsSymbolRenderContext &context ) const;
virtual Qt::PenStyle dxfPenStyle() const;
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;
virtual bool hasDataDefinedProperties() const;
protected:
virtual void applyDataDefinedSettings( QgsSymbolRenderContext &context );
%Docstring
Custom stroke
%End
virtual bool applyBrushTransformFromContext() const;
%Docstring
Returns ``True`` if the image brush should be transformed using the render context's texture origin.
.. versionadded:: 3.16
%End
private:
QgsImageFillSymbolLayer( const QgsImageFillSymbolLayer &other );
};
class QgsRasterFillSymbolLayer: QgsImageFillSymbolLayer
{
%Docstring(signature="appended")
A class for filling symbols with a repeated raster image.
.. versionadded:: 2.7
%End
%TypeHeaderCode
#include "qgsfillsymbollayer.h"
%End
public:
QgsRasterFillSymbolLayer( const QString &imageFilePath = QString() );
%Docstring
Constructor for QgsRasterFillSymbolLayer, using a raster fill from the
specified ``imageFilePath``.
%End
~QgsRasterFillSymbolLayer();
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a new QgsRasterFillSymbolLayer from a ``properties`` map. The caller takes
ownership of the returned object.
%End
static void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving );
%Docstring
Turns relative paths in properties map to absolute when reading and vice versa when writing.
Used internally when reading/writing symbols.
.. versionadded:: 3.0
%End
virtual QString layerType() const;
virtual void renderPolygon( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsRasterFillSymbolLayer *clone() const /Factory/;
virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
virtual bool usesMapUnits() const;
virtual QgsSymbol *subSymbol();
virtual bool setSubSymbol( QgsSymbol *symbol /Transfer/ );
void setImageFilePath( const QString &imagePath );
%Docstring
Sets the path to the raster image used for the fill.
:param imagePath: path to image file
.. seealso:: :py:func:`imageFilePath`
%End
QString imageFilePath() const;
%Docstring
The path to the raster image used for the fill.
:return: path to image file
.. seealso:: :py:func:`setImageFilePath`
%End
void setCoordinateMode( Qgis::SymbolCoordinateReference mode );
%Docstring
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
.. seealso:: :py:func:`coordinateMode`
%End
Qgis::SymbolCoordinateReference coordinateMode() const;
%Docstring
Coordinate mode for fill. Controls how the top left corner of the image
fill is positioned relative to the feature.
:return: coordinate mode
.. seealso:: :py:func:`setCoordinateMode`
%End
void setOpacity( double opacity );
%Docstring