QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
qgssymbol.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssymbol.h
3 ---------------------
4 begin : November 2009
5 copyright : (C) 2009 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSSYMBOL_H
17#define QGSSYMBOL_H
18
19#include "qgis_core.h"
20#include "qgis.h"
22#include "qgsrendercontext.h"
23#include "qgsscreenproperties.h"
24
25class QgsSymbolLayer;
29
30typedef QList<QgsSymbolLayer *> QgsSymbolLayerList;
31
41{
42 public:
43
53 void setIsAnimated( bool animated ) { mIsAnimated = animated; }
54
64 bool isAnimated() const { return mIsAnimated; }
65
71 void setFrameRate( double rate ) { mFrameRate = rate; }
72
78 double frameRate() const { return mFrameRate; }
79
80 private:
81
82 bool mIsAnimated = false;
83 double mFrameRate = 10;
84
85};
86
93class CORE_EXPORT QgsSymbol
94{
95
96#ifdef SIP_RUN
98 switch ( sipCpp->type() )
99 {
100 case Qgis::SymbolType::Marker: sipType = sipType_QgsMarkerSymbol; break;
101 case Qgis::SymbolType::Line: sipType = sipType_QgsLineSymbol; break;
102 case Qgis::SymbolType::Fill: sipType = sipType_QgsFillSymbol; break;
103 default: sipType = 0; break;
104 }
105 SIP_END
106#endif
107
108 friend class QgsFeatureRenderer;
109
110 public:
111
117 static QString symbolTypeToString( Qgis::SymbolType type );
118
124 static Qgis::SymbolType symbolTypeForGeometryType( Qgis::GeometryType type );
125
126 // *INDENT-OFF*
127
133 {
134 Opacity SIP_MONKEYPATCH_COMPAT_NAME( PropertyOpacity ),
135 };
136 // *INDENT-ON*
137
142 static const QgsPropertiesDefinition &propertyDefinitions();
143
144 virtual ~QgsSymbol();
145
151 static QgsSymbol *defaultSymbol( Qgis::GeometryType geomType ) SIP_FACTORY;
152
156 Qgis::SymbolType type() const { return mType; }
157
158 // symbol layers handling
159
166 QgsSymbolLayerList symbolLayers() const { return mLayers; }
167
168#ifndef SIP_RUN
169
175 QgsSymbolLayer *symbolLayer( int layer );
176
183 const QgsSymbolLayer *symbolLayer( int layer ) const;
184#else
185
194 SIP_PYOBJECT symbolLayer( int layer ) SIP_TYPEHINT( QgsSymbolLayer );
195 % MethodCode
196 const int count = sipCpp->symbolLayerCount();
197 if ( a0 < 0 || a0 >= count )
198 {
199 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
200 sipIsErr = 1;
201 }
202 else
203 {
204 sipRes = sipConvertFromType( sipCpp->symbolLayer( a0 ), sipType_QgsSymbolLayer, NULL );
205 }
206 % End
207#endif
208
215 int symbolLayerCount() const { return mLayers.count(); }
216
217#ifdef SIP_RUN
218
222 int __len__() const;
223 % MethodCode
224 sipRes = sipCpp->symbolLayerCount();
225 % End
226
228 int __bool__() const;
229 % MethodCode
230 sipRes = true;
231 % End
232
243 SIP_PYOBJECT __getitem__( int index ) SIP_TYPEHINT( QgsSymbolLayer );
244 % MethodCode
245 const int count = sipCpp->symbolLayerCount();
246 if ( a0 < -count || a0 >= count )
247 {
248 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
249 sipIsErr = 1;
250 }
251 else if ( a0 >= 0 )
252 {
253 return sipConvertFromType( sipCpp->symbolLayer( a0 ), sipType_QgsSymbolLayer, NULL );
254 }
255 else
256 {
257 return sipConvertFromType( sipCpp->symbolLayer( count + a0 ), sipType_QgsSymbolLayer, NULL );
258 }
259 % End
260
271 void __delitem__( int index );
272 % MethodCode
273 const int count = sipCpp->symbolLayerCount();
274 if ( a0 >= 0 && a0 < count )
275 sipCpp->deleteSymbolLayer( a0 );
276 else if ( a0 < 0 && a0 >= -count )
277 sipCpp->deleteSymbolLayer( count + a0 );
278 else
279 {
280 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
281 sipIsErr = 1;
282 }
283 % End
284#endif
285
293 bool insertSymbolLayer( int index, QgsSymbolLayer *layer SIP_TRANSFER );
294
301 bool appendSymbolLayer( QgsSymbolLayer *layer SIP_TRANSFER );
302
306 bool deleteSymbolLayer( int index );
307
314 QgsSymbolLayer *takeSymbolLayer( int index ) SIP_TRANSFERBACK;
315
323 bool changeSymbolLayer( int index, QgsSymbolLayer *layer SIP_TRANSFER );
324
334 void startRender( QgsRenderContext &context, const QgsFields &fields = QgsFields() );
335
342 void stopRender( QgsRenderContext &context );
343
354 void setColor( const QColor &color ) const;
355
364 QColor color() const;
365
382 void drawPreviewIcon( QPainter *painter, QSize size, QgsRenderContext *customContext = nullptr, bool selected = false, const QgsExpressionContext *expressionContext = nullptr,
383 const QgsLegendPatchShape *patchShape = nullptr, const QgsScreenProperties &screen = QgsScreenProperties() );
384
394 void exportImage( const QString &path, const QString &format, QSize size );
395
405 QImage asImage( QSize size, QgsRenderContext *customContext = nullptr );
406
418 QImage bigSymbolPreviewImage( QgsExpressionContext *expressionContext = nullptr, Qgis::SymbolPreviewFlags flags = Qgis::SymbolPreviewFlag::FlagIncludeCrosshairsForMarkerSymbols, const QgsScreenProperties &screen = QgsScreenProperties() ) SIP_PYNAME( bigSymbolPreviewImageV2 );
419
423 Q_DECL_DEPRECATED QImage bigSymbolPreviewImage( QgsExpressionContext *expressionContext = nullptr, int flags = static_cast< int >( Qgis::SymbolPreviewFlag::FlagIncludeCrosshairsForMarkerSymbols ) ) SIP_DEPRECATED;
424
428 QString dump() const;
429
435 virtual QgsSymbol *clone() const = 0 SIP_FACTORY;
436
440 void toSld( QDomDocument &doc, QDomElement &element, QVariantMap props ) const;
441
450 Qgis::RenderUnit outputUnit() const;
451
457 bool usesMapUnits() const;
458
467 void setOutputUnit( Qgis::RenderUnit unit ) const;
468
478 QgsMapUnitScale mapUnitScale() const;
479
488 void setMapUnitScale( const QgsMapUnitScale &scale ) const;
489
495 qreal opacity() const { return mOpacity; }
496
502 void setOpacity( qreal opacity ) { mOpacity = opacity; }
503
508 void setRenderHints( Qgis::SymbolRenderHints hints ) { mRenderHints = hints; }
509
514 Qgis::SymbolRenderHints renderHints() const { return mRenderHints; }
515
522 void setFlags( Qgis::SymbolFlags flags ) { mSymbolFlags = flags; }
523
530 Qgis::SymbolFlags flags() const { return mSymbolFlags; }
531
540 void setClipFeaturesToExtent( bool clipFeaturesToExtent ) { mClipFeaturesToExtent = clipFeaturesToExtent; }
541
550 bool clipFeaturesToExtent() const { return mClipFeaturesToExtent; }
551
561 void setForceRHR( bool force ) { mForceRHR = force; }
562
572 bool forceRHR() const { return mForceRHR; }
573
580 QgsSymbolAnimationSettings &animationSettings();
581
588 const QgsSymbolAnimationSettings &animationSettings() const SIP_SKIP;
589
596 void setAnimationSettings( const QgsSymbolAnimationSettings &settings );
597
603 QSet<QString> usedAttributes( const QgsRenderContext &context ) const;
604
612 void setDataDefinedProperty( Property key, const QgsProperty &property );
613
620 QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
621
627 const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP
628
635 void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
636
640 bool hasDataDefinedProperties() const;
641
651 bool canCauseArtifactsBetweenAdjacentTiles() const;
652
657 Q_DECL_DEPRECATED void setLayer( const QgsVectorLayer *layer ) SIP_DEPRECATED;
658
662 Q_DECL_DEPRECATED const QgsVectorLayer *layer() const SIP_DEPRECATED;
663
668 void renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false, Qgis::VertexMarkerType currentVertexMarkerType = Qgis::VertexMarkerType::SemiTransparentCircle, double currentVertexMarkerSize = 0.0 ) SIP_THROW( QgsCsException );
669
675 QgsSymbolRenderContext *symbolRenderContext();
676
688 void startFeatureRender( const QgsFeature &feature, QgsRenderContext &context, int layer = -1 );
689
701 void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context, int layer = -1 );
702
703 protected:
704
710 QgsSymbol( Qgis::SymbolType type, const QgsSymbolLayerList &layers SIP_TRANSFER ); // can't be instantiated
711
715 static inline QPointF _getPoint( QgsRenderContext &context, const QgsPoint &point )
716 {
717 QPointF pt;
718 if ( context.coordinateTransform().isValid() )
719 {
720 double x = point.x();
721 double y = point.y();
722 double z = 0.0;
723 context.coordinateTransform().transformInPlace( x, y, z );
724 pt = QPointF( x, y );
725
726 }
727 else
728 pt = point.toQPointF();
729
730 context.mapToPixel().transformInPlace( pt.rx(), pt.ry() );
731 return pt;
732 }
733
737 static QPolygonF _getLineString( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent = true );
738
745 static QPolygonF _getPolygonRing( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent, bool isExteriorRing = false, bool correctRingOrientation = false );
746
754 static void _getPolygon( QPolygonF &pts, QVector<QPolygonF> &holes, QgsRenderContext &context, const QgsPolygon &polygon, bool clipToExtent = true, bool correctRingOrientation = false );
755
760 QgsSymbolLayerList cloneLayers() const SIP_FACTORY;
761
774 void renderUsingLayer( QgsSymbolLayer *layer, QgsSymbolRenderContext &context, Qgis::GeometryType geometryType = Qgis::GeometryType::Unknown, const QPolygonF *points = nullptr, const QVector<QPolygonF> *rings = nullptr );
775
779 void renderVertexMarker( QPointF pt, QgsRenderContext &context, Qgis::VertexMarkerType currentVertexMarkerType, double currentVertexMarkerSize );
780
781 Qgis::SymbolType mType;
783
785 qreal mOpacity = 1.0;
786
787 Qgis::SymbolRenderHints mRenderHints;
788
794 Qgis::SymbolFlags mSymbolFlags = Qgis::SymbolFlags();
795
796 bool mClipFeaturesToExtent = true;
797 bool mForceRHR = false;
798
799 QgsSymbolAnimationSettings mAnimationSettings;
800
801 Q_DECL_DEPRECATED const QgsVectorLayer *mLayer = nullptr; //current vectorlayer
802
803 private:
804#ifdef SIP_RUN
805 QgsSymbol( const QgsSymbol & );
806#endif
807
808 static void initPropertyDefinitions();
809
811 static QgsPropertiesDefinition sPropertyDefinitions;
812
817 bool mStarted = false;
818
820 std::unique_ptr< QgsSymbolRenderContext > mSymbolRenderContext;
821
822 QgsPropertyCollection mDataDefinedProperties;
823
827 static QPolygonF _getLineString2d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent = true );
828
832 static QPolygonF _getLineString3d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent = true );
833
840 static QPolygonF _getPolygonRing2d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent, bool isExteriorRing = false, bool correctRingOrientation = false );
841
848 static QPolygonF _getPolygonRing3d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent, bool isExteriorRing = false, bool correctRingOrientation = false );
849
850 Q_DISABLE_COPY( QgsSymbol )
851
852};
853
854#endif
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
QFlags< SymbolPreviewFlag > SymbolPreviewFlags
Symbol preview flags.
Definition qgis.h:624
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:274
@ FlagIncludeCrosshairsForMarkerSymbols
Include a crosshairs reference image in the background of marker symbol previews.
QFlags< SymbolRenderHint > SymbolRenderHints
Symbol render hints.
Definition qgis.h:584
QFlags< SymbolFlag > SymbolFlags
Symbol flags.
Definition qgis.h:610
SymbolType
Symbol types.
Definition qgis.h:420
@ Marker
Marker symbol.
@ Line
Line symbol.
@ Fill
Fill symbol.
Custom exception class for Coordinate Reference System related exceptions.
Abstract base class for curved geometry type.
Definition qgscurve.h:35
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Container of fields for a vector layer.
Definition qgsfields.h:46
Represents a patch shape for use in map legends.
Struct for storing maximum and minimum scales for measurements in map units.
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
Polygon geometry type.
Definition qgspolygon.h:33
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
A store for object properties.
Contains information about the context of a rendering operation.
Stores properties relating to a screen.
Contains settings relating to symbol animation.
Definition qgssymbol.h:41
bool isAnimated() const
Returns true if the symbol is animated.
Definition qgssymbol.h:64
void setIsAnimated(bool animated)
Sets whether the symbol is animated.
Definition qgssymbol.h:53
void setFrameRate(double rate)
Sets the symbol animation frame rate (in frames per second).
Definition qgssymbol.h:71
double frameRate() const
Returns the symbol animation frame rate (in frames per second).
Definition qgssymbol.h:78
Abstract base class for all rendered symbols.
Definition qgssymbol.h:94
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the symbol's property collection, used for data defined overrides.
Definition qgssymbol.h:635
Property
Data definable properties.
Definition qgssymbol.h:133
void setRenderHints(Qgis::SymbolRenderHints hints)
Sets rendering hint flags for the symbol.
Definition qgssymbol.h:508
Qgis::SymbolRenderHints renderHints() const
Returns the rendering hint flags for the symbol.
Definition qgssymbol.h:514
Qgis::SymbolFlags flags() const
Returns flags for the symbol.
Definition qgssymbol.h:530
bool clipFeaturesToExtent() const
Returns whether features drawn by the symbol will be clipped to the render context's extent.
Definition qgssymbol.h:550
void setFlags(Qgis::SymbolFlags flags)
Sets flags for the symbol.
Definition qgssymbol.h:522
QgsSymbolLayerList symbolLayers() const
Returns the list of symbol layers contained in the symbol.
Definition qgssymbol.h:166
void setOpacity(qreal opacity)
Sets the opacity for the symbol.
Definition qgssymbol.h:502
int symbolLayerCount() const
Returns the total number of symbol layers contained in the symbol.
Definition qgssymbol.h:215
Qgis::SymbolType type() const
Returns the symbol's type.
Definition qgssymbol.h:156
const QgsPropertyCollection & dataDefinedProperties() const
Returns a reference to the symbol's property collection, used for data defined overrides.
Definition qgssymbol.h:627
bool forceRHR() const
Returns true if polygon features drawn by the symbol will be reoriented to follow the standard right-...
Definition qgssymbol.h:572
void setClipFeaturesToExtent(bool clipFeaturesToExtent)
Sets whether features drawn by the symbol should be clipped to the render context's extent.
Definition qgssymbol.h:540
void setForceRHR(bool force)
Sets whether polygon features drawn by the symbol should be reoriented to follow the standard right-h...
Definition qgssymbol.h:561
Represents a vector layer which manages a vector based data sets.
#define SIP_TYPEHINT(type)
Definition qgis_sip.h:232
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_MONKEYPATCH_SCOPEENUM_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition qgis_sip.h:271
#define SIP_PYNAME(name)
Definition qgis_sip.h:81
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_TRANSFERBACK
Definition qgis_sip.h:48
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_THROW(name,...)
Definition qgis_sip.h:203
#define SIP_END
Definition qgis_sip.h:208
#define SIP_MONKEYPATCH_COMPAT_NAME(FORMERNAME)
Definition qgis_sip.h:273
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
QList< QgsSymbolLayer * > QgsSymbolLayerList
Definition qgssymbol.h:30