/
qgsmarkersymbollayer.sip.in
1111 lines (716 loc) · 28.7 KB
/
qgsmarkersymbollayer.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/qgsmarkersymbollayer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSimpleMarkerSymbolLayerBase : QgsMarkerSymbolLayer
{
%Docstring
Abstract base class for simple marker symbol layers. Handles creation of the symbol shapes but
leaves the actual drawing of the symbols to subclasses.
.. versionadded:: 2.16
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
%End
public:
enum Shape
{
Square,
Diamond,
Pentagon,
Hexagon,
Triangle,
EquilateralTriangle,
Star,
Arrow,
Circle,
Cross,
CrossFill,
Cross2,
Line,
ArrowHead,
ArrowHeadFilled,
SemiCircle,
ThirdCircle,
QuarterCircle,
QuarterSquare,
HalfSquare,
DiagonalHalfSquare,
RightHalfTriangle,
LeftHalfTriangle,
Octagon,
SquareWithCorners,
AsteriskFill,
};
static QList< QgsSimpleMarkerSymbolLayerBase::Shape > availableShapes();
%Docstring
Returns a list of all available shape types.
%End
static bool shapeIsFilled( QgsSimpleMarkerSymbolLayerBase::Shape shape );
%Docstring
Returns ``True`` if a symbol shape has a fill.
:param shape: shape to test
:return: ``True`` if shape uses a fill, or ``False`` if shape uses lines only
%End
QgsSimpleMarkerSymbolLayerBase( QgsSimpleMarkerSymbolLayerBase::Shape shape = Circle,
double size = DEFAULT_SIMPLEMARKER_SIZE,
double angle = DEFAULT_SIMPLEMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
%Docstring
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
%End
QgsSimpleMarkerSymbolLayerBase::Shape shape() const;
%Docstring
Returns the shape for the rendered marker symbol.
.. seealso:: :py:func:`setShape`
%End
void setShape( QgsSimpleMarkerSymbolLayerBase::Shape shape );
%Docstring
Sets the rendered marker shape.
:param shape: new marker shape
.. seealso:: :py:func:`shape`
%End
static QgsSimpleMarkerSymbolLayerBase::Shape decodeShape( const QString &name, bool *ok = 0 );
%Docstring
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
:return: decoded name
.. seealso:: :py:func:`encodeShape`
%End
static QString encodeShape( QgsSimpleMarkerSymbolLayerBase::Shape shape );
%Docstring
Encodes a shape to its string representation.
:param shape: shape to encode
:return: encoded string
.. seealso:: :py:func:`decodeShape`
%End
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual void renderPoint( QPointF point, QgsSymbolRenderContext &context );
virtual QRectF bounds( QPointF point, QgsSymbolRenderContext &context );
protected:
bool prepareMarkerShape( Shape shape );
%Docstring
Prepares the layer for drawing the specified shape (QPolygonF version)
%End
bool prepareMarkerPath( Shape symbol );
%Docstring
Prepares the layer for drawing the specified shape (QPainterPath version)
%End
bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;
%Docstring
Creates a polygon representing the specified shape.
:param shape: shape to create
:param polygon: destination polygon for shape
:return: ``True`` if shape was successfully stored in polygon
%End
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
%Docstring
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
:return: marker size, in original size units
%End
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;
%Docstring
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
%End
private:
virtual void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path ) = 0;
%Docstring
Derived classes must implement :py:func:`~QgsSimpleMarkerSymbolLayerBase.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
%End
};
class QgsSimpleMarkerSymbolLayer : QgsSimpleMarkerSymbolLayerBase
{
%Docstring
Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke.
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
%End
public:
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 );
%Docstring
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
%End
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a new QgsSimpleMarkerSymbolLayer.
:param properties: a property map containing symbol properties (see :py:func:`~QgsSimpleMarkerSymbolLayer.properties`)
:return: new QgsSimpleMarkerSymbolLayer
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
%Docstring
Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element.
:param element: XML element containing SLD definition of symbol
:return: new QgsSimpleMarkerSymbolLayer
%End
virtual QString layerType() const;
virtual void startRender( QgsSymbolRenderContext &context );
virtual void renderPoint( QPointF point, QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsSimpleMarkerSymbolLayer *clone() const /Factory/;
virtual void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const;
virtual QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const;
virtual bool writeDxf( QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift = QPointF( 0.0, 0.0 ) ) const;
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
virtual QgsUnitTypes::RenderUnit outputUnit() const;
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
virtual bool usesMapUnits() const;
virtual QRectF bounds( QPointF point, QgsSymbolRenderContext &context );
virtual QColor fillColor() const;
virtual void setFillColor( const QColor &color );
virtual void setColor( const QColor &color );
virtual QColor color() const;
virtual QColor strokeColor() const;
%Docstring
Returns the marker's stroke color.
.. seealso:: :py:func:`setStrokeColor`
.. seealso:: :py:func:`strokeStyle`
.. seealso:: :py:func:`penJoinStyle`
%End
virtual void setStrokeColor( const QColor &color );
%Docstring
Sets the marker's stroke color.
:param color: stroke color
.. seealso:: :py:func:`strokeColor`
.. seealso:: :py:func:`setStrokeStyle`
.. seealso:: :py:func:`setPenJoinStyle`
%End
Qt::PenStyle strokeStyle() const;
%Docstring
Returns the marker's stroke style (e.g., solid, dashed, etc)
.. seealso:: :py:func:`setStrokeStyle`
.. seealso:: :py:func:`strokeColor`
.. seealso:: :py:func:`penJoinStyle`
.. versionadded:: 2.4
%End
void setStrokeStyle( Qt::PenStyle strokeStyle );
%Docstring
Sets the marker's stroke style (e.g., solid, dashed, etc)
:param strokeStyle: style
.. seealso:: :py:func:`strokeStyle`
.. seealso:: :py:func:`setStrokeColor`
.. seealso:: :py:func:`setPenJoinStyle`
.. versionadded:: 2.4
%End
Qt::PenJoinStyle penJoinStyle() const;
%Docstring
Returns the marker's stroke join style (e.g., miter, bevel, etc).
.. seealso:: :py:func:`setPenJoinStyle`
.. seealso:: :py:func:`strokeColor`
.. seealso:: :py:func:`strokeStyle`
.. versionadded:: 2.16
%End
void setPenJoinStyle( Qt::PenJoinStyle style );
%Docstring
Sets the marker's stroke join style (e.g., miter, bevel, etc).
:param style: join style
.. seealso:: :py:func:`penJoinStyle`
.. seealso:: :py:func:`setStrokeColor`
.. seealso:: :py:func:`setStrokeStyle`
.. versionadded:: 2.16
%End
double strokeWidth() const;
%Docstring
Returns the width of the marker's stroke.
.. seealso:: :py:func:`setStrokeWidth`
.. seealso:: :py:func:`strokeWidthUnit`
.. seealso:: :py:func:`strokeWidthMapUnitScale`
%End
void setStrokeWidth( double w );
%Docstring
Sets the width of the marker's stroke.
:param w: stroke width. See :py:func:`~QgsSimpleMarkerSymbolLayer.strokeWidthUnit` for units.
.. seealso:: :py:func:`strokeWidth`
.. seealso:: :py:func:`setStrokeWidthUnit`
.. seealso:: :py:func:`setStrokeWidthMapUnitScale`
%End
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit u );
%Docstring
Sets the unit for the width of the marker's stroke.
:param u: stroke width unit
.. seealso:: :py:func:`strokeWidthUnit`
.. seealso:: :py:func:`setStrokeWidth`
.. seealso:: :py:func:`setStrokeWidthMapUnitScale`
%End
QgsUnitTypes::RenderUnit strokeWidthUnit() const;
%Docstring
Returns the unit for the width of the marker's stroke.
.. seealso:: :py:func:`setStrokeWidthUnit`
.. seealso:: :py:func:`strokeWidth`
.. seealso:: :py:func:`strokeWidthMapUnitScale`
%End
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map scale for the width of the marker's stroke.
:param scale: stroke width map unit scale
.. seealso:: :py:func:`strokeWidthMapUnitScale`
.. seealso:: :py:func:`setStrokeWidth`
.. seealso:: :py:func:`setStrokeWidthUnit`
%End
const QgsMapUnitScale &strokeWidthMapUnitScale() const;
%Docstring
Returns the map scale for the width of the marker's stroke.
.. seealso:: :py:func:`setStrokeWidthMapUnitScale`
.. seealso:: :py:func:`strokeWidth`
.. seealso:: :py:func:`strokeWidthUnit`
%End
protected:
void drawMarker( QPainter *p, QgsSymbolRenderContext &context );
%Docstring
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
%End
bool prepareCache( QgsSymbolRenderContext &context );
%Docstring
Prepares cache image
:return: ``True`` in case of success, ``False`` if cache image size too large
%End
private:
virtual void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path );
};
class QgsFilledMarkerSymbolLayer : QgsSimpleMarkerSymbolLayerBase
{
%Docstring
Filled marker symbol layer, consisting of a shape which is rendered using a :py:class:`QgsFillSymbol`. This allows
the symbol to support advanced styling of the interior and stroke of the shape.
.. versionadded:: 2.16
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
%End
public:
QgsFilledMarkerSymbolLayer( QgsSimpleMarkerSymbolLayerBase::Shape shape = Circle,
double size = DEFAULT_SIMPLEMARKER_SIZE,
double angle = DEFAULT_SIMPLEMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
%Docstring
Constructor for QgsFilledMarkerSymbolLayer.
:param shape: symbol shape
:param size: symbol size (in mm)
:param angle: symbol rotation angle
:param scaleMethod: size scaling method
%End
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a new QgsFilledMarkerSymbolLayer.
:param properties: a property map containing symbol properties (see :py:func:`~QgsFilledMarkerSymbolLayer.properties`)
:return: new QgsFilledMarkerSymbolLayer
%End
virtual QString layerType() const;
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsFilledMarkerSymbolLayer *clone() const /Factory/;
virtual QgsSymbol *subSymbol();
virtual bool setSubSymbol( QgsSymbol *symbol /Transfer/ );
virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;
virtual bool hasDataDefinedProperties() const;
virtual void setColor( const QColor &c );
virtual QColor color() const;
virtual bool usesMapUnits() const;
private:
QgsFilledMarkerSymbolLayer( const QgsFilledMarkerSymbolLayer & );
virtual void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path );
};
class QgsSvgMarkerSymbolLayer : QgsMarkerSymbolLayer
{
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
%End
public:
QgsSvgMarkerSymbolLayer( const QString &path,
double size = DEFAULT_SVGMARKER_SIZE,
double angle = DEFAULT_SVGMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
%Docstring
Constructs SVG marker symbol layer with picture from given absolute path to a SVG file
%End
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates the symbol
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
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 startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual void renderPoint( QPointF point, QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual bool usesMapUnits() const;
virtual QgsSvgMarkerSymbolLayer *clone() const /Factory/;
virtual void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const;
QString path() const;
%Docstring
Returns the marker SVG path.
.. seealso:: :py:func:`setPath`
%End
void setPath( const QString &path );
%Docstring
Set the marker SVG path.
:param path: SVG path
.. seealso:: :py:func:`path`
%End
double defaultAspectRatio() const;
%Docstring
Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
.. seealso:: :py:func:`updateDefaultAspectRatio`
%End
double updateDefaultAspectRatio();
%Docstring
Calculates the default marker aspect ratio between width and height.
:return: the default aspect ratio value
.. seealso:: :py:func:`defaultAspectRatio`
%End
bool preservedAspectRatio() const;
%Docstring
Returns the preserved aspect ratio value, ``True`` if fixed aspect ratio has been lower or equal to 0.
.. seealso:: :py:func:`setPreservedAspectRatio`
%End
bool setPreservedAspectRatio( bool par );
%Docstring
Set preserved the marker aspect ratio between width and height.
:param par: Preserved Aspect Ratio
:return: the preserved aspect ratio value, ``True`` if fixed aspect ratio has been lower or equal to 0
.. seealso:: :py:func:`preservedAspectRatio`
%End
double fixedAspectRatio() const;
%Docstring
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
.. seealso:: :py:func:`setFixedAspectRatio`
%End
void setFixedAspectRatio( double ratio );
%Docstring
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
.. seealso:: :py:func:`fixedAspectRatio`
%End
virtual QColor fillColor() const;
virtual void setFillColor( const QColor &color );
virtual QColor strokeColor() const;
virtual void setStrokeColor( const QColor &c );
double strokeWidth() const;
void setStrokeWidth( double w );
QMap<QString, QgsProperty> parameters() const;
%Docstring
Returns the dynamic SVG parameters
.. versionadded:: 3.18
%End
void setParameters( const QMap<QString, QgsProperty> ¶meters );
%Docstring
Sets the dynamic SVG parameters
.. versionadded:: 3.18
%End
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units for the stroke width.
:param unit: width units
.. seealso:: :py:func:`strokeWidthUnit`
%End
QgsUnitTypes::RenderUnit strokeWidthUnit() const;
%Docstring
Returns the units for the stroke width.
.. seealso:: :py:func:`strokeWidthUnit`
%End
void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale );
const QgsMapUnitScale &strokeWidthMapUnitScale() const;
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
virtual QgsUnitTypes::RenderUnit outputUnit() const;
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
virtual bool writeDxf( QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift = QPointF( 0.0, 0.0 ) ) const;
virtual QRectF bounds( QPointF point, QgsSymbolRenderContext &context );
virtual void prepareExpressions( const QgsSymbolRenderContext &context );
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;
protected:
double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;
%Docstring
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
%End
};
class QgsRasterMarkerSymbolLayer : QgsMarkerSymbolLayer
{
%Docstring
Raster marker symbol layer class.
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
%End
public:
QgsRasterMarkerSymbolLayer( const QString &path = QString(),
double size = DEFAULT_SVGMARKER_SIZE,
double angle = DEFAULT_SVGMARKER_ANGLE,
QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );
%Docstring
Constructs raster marker symbol layer with picture from given absolute path to a raster image file
%End
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a raster marker symbol layer from a string map of properties.
:param properties: QVariantMap properties 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 renderPoint( QPointF point, QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsRasterMarkerSymbolLayer *clone() const /Factory/;
virtual bool usesMapUnits() const;
double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;
%Docstring
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
%End
QString path() const;
%Docstring
Returns the marker raster image path.
.. seealso:: :py:func:`setPath`
%End
void setPath( const QString &path );
%Docstring
Set the marker raster image path.
:param path: raster image path
.. seealso:: :py:func:`path`
%End
double opacity() const;
%Docstring
Returns the marker opacity.
:return: opacity value between 0 (fully transparent) and 1 (fully opaque)
.. seealso:: :py:func:`setOpacity`
%End
void setOpacity( double opacity );
%Docstring
Set the marker opacity.
:param opacity: opacity value between 0 (fully transparent) and 1 (fully opaque)
.. seealso:: :py:func:`opacity`
%End
double defaultAspectRatio() const;
%Docstring
Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
.. seealso:: :py:func:`updateDefaultAspectRatio`
%End
double updateDefaultAspectRatio();
%Docstring
Calculates the default marker aspect ratio between width and height.
:return: the default aspect ratio value
.. seealso:: :py:func:`defaultAspectRatio`
%End
bool preservedAspectRatio() const;
%Docstring
Returns the preserved aspect ratio value, ``True`` if fixed aspect ratio has been lower or equal to 0.
.. seealso:: :py:func:`setPreservedAspectRatio`
%End
bool setPreservedAspectRatio( bool par );
%Docstring
Set preserved the marker aspect ratio between width and height.
:param par: Preserved Aspect Ratio
:return: the preserved aspect ratio value, ``True`` if fixed aspect ratio has been lower or equal to 0
.. seealso:: :py:func:`preservedAspectRatio`
%End
double fixedAspectRatio() const;
%Docstring
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
.. seealso:: :py:func:`setFixedAspectRatio`
%End
void setFixedAspectRatio( double ratio );
%Docstring
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
.. seealso:: :py:func:`fixedAspectRatio`
%End
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
virtual QRectF bounds( QPointF point, QgsSymbolRenderContext &context );
protected:
};
class QgsFontMarkerSymbolLayer : QgsMarkerSymbolLayer
{
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
%End
public:
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 );
%Docstring
Constructs a font marker symbol layer.
%End
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates a new QgsFontMarkerSymbolLayer from a property map (see :py:func:`~QgsFontMarkerSymbolLayer.properties`)
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
%Docstring
Creates a new QgsFontMarkerSymbolLayer from an SLD XML ``element``.
%End
virtual QString layerType() const;
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual void renderPoint( QPointF point, QgsSymbolRenderContext &context );
virtual QVariantMap properties() const;
virtual QgsFontMarkerSymbolLayer *clone() const /Factory/;
virtual void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const;
virtual bool usesMapUnits() const;
QString fontFamily() const;
%Docstring
Returns the font family name for the associated font which will be used to render the point.
.. seealso:: :py:func:`setFontFamily`
%End
void setFontFamily( const QString &family );
%Docstring
Sets the font ``family`` for the font which will be used to render the point.
.. seealso:: :py:func:`fontFamily`
%End
QString fontStyle() const;
%Docstring
Returns the font style for the associated font which will be used to render the point.
.. seealso:: :py:func:`setFontStyle`
.. versionadded:: 3.14
%End
void setFontStyle( const QString &style );
%Docstring
Sets the font ``style`` for the font which will be used to render the point.
.. seealso:: :py:func:`fontStyle`
.. versionadded:: 3.14
%End
QString character() const;
%Docstring
Returns the character(s) used when rendering points.
.. seealso:: :py:func:`setCharacter`
%End
void setCharacter( QString chr );
%Docstring
Sets the character(s) used when rendering points.
.. seealso:: :py:func:`character`
%End
virtual QColor strokeColor() const;
virtual void setStrokeColor( const QColor &color );