QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
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
131 {
133 };
134
139 static const QgsPropertiesDefinition &propertyDefinitions();
140
141 virtual ~QgsSymbol();
142
148 static QgsSymbol *defaultSymbol( Qgis::GeometryType geomType ) SIP_FACTORY;
149
153 Qgis::SymbolType type() const { return mType; }
154
155 // symbol layers handling
156
164 QgsSymbolLayerList symbolLayers() const { return mLayers; }
165
166#ifndef SIP_RUN
167
174 QgsSymbolLayer *symbolLayer( int layer );
175
182 const QgsSymbolLayer *symbolLayer( int layer ) const;
183#else
184
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
216 int symbolLayerCount() const { return mLayers.count(); }
217
218#ifdef SIP_RUN
219
223 int __len__() const;
224 % MethodCode
225 sipRes = sipCpp->symbolLayerCount();
226 % End
227
229 int __bool__() const;
230 % MethodCode
231 sipRes = true;
232 % End
233
244 SIP_PYOBJECT __getitem__( int index ) SIP_TYPEHINT( QgsSymbolLayer );
245 % MethodCode
246 const int count = sipCpp->symbolLayerCount();
247 if ( a0 < -count || a0 >= count )
248 {
249 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
250 sipIsErr = 1;
251 }
252 else if ( a0 >= 0 )
253 {
254 return sipConvertFromType( sipCpp->symbolLayer( a0 ), sipType_QgsSymbolLayer, NULL );
255 }
256 else
257 {
258 return sipConvertFromType( sipCpp->symbolLayer( count + a0 ), sipType_QgsSymbolLayer, NULL );
259 }
260 % End
261
272 void __delitem__( int index );
273 % MethodCode
274 const int count = sipCpp->symbolLayerCount();
275 if ( a0 >= 0 && a0 < count )
276 sipCpp->deleteSymbolLayer( a0 );
277 else if ( a0 < 0 && a0 >= -count )
278 sipCpp->deleteSymbolLayer( count + a0 );
279 else
280 {
281 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
282 sipIsErr = 1;
283 }
284 % End
285#endif
286
294 bool insertSymbolLayer( int index, QgsSymbolLayer *layer SIP_TRANSFER );
295
302 bool appendSymbolLayer( QgsSymbolLayer *layer SIP_TRANSFER );
303
307 bool deleteSymbolLayer( int index );
308
315 QgsSymbolLayer *takeSymbolLayer( int index ) SIP_TRANSFERBACK;
316
324 bool changeSymbolLayer( int index, QgsSymbolLayer *layer SIP_TRANSFER );
325
335 void startRender( QgsRenderContext &context, const QgsFields &fields = QgsFields() );
336
343 void stopRender( QgsRenderContext &context );
344
355 void setColor( const QColor &color ) const;
356
365 QColor color() const;
366
384 void drawPreviewIcon( QPainter *painter, QSize size, QgsRenderContext *customContext = nullptr, bool selected = false, const QgsExpressionContext *expressionContext = nullptr,
385 const QgsLegendPatchShape *patchShape = nullptr, const QgsScreenProperties &screen = QgsScreenProperties() );
386
396 void exportImage( const QString &path, const QString &format, QSize size );
397
407 QImage asImage( QSize size, QgsRenderContext *customContext = nullptr );
408
420 QImage bigSymbolPreviewImage( QgsExpressionContext *expressionContext = nullptr, Qgis::SymbolPreviewFlags flags = Qgis::SymbolPreviewFlag::FlagIncludeCrosshairsForMarkerSymbols, const QgsScreenProperties &screen = QgsScreenProperties() ) SIP_PYNAME( bigSymbolPreviewImageV2 );
421
425 Q_DECL_DEPRECATED QImage bigSymbolPreviewImage( QgsExpressionContext *expressionContext = nullptr, int flags = static_cast< int >( Qgis::SymbolPreviewFlag::FlagIncludeCrosshairsForMarkerSymbols ) ) SIP_DEPRECATED;
426
430 QString dump() const;
431
437 virtual QgsSymbol *clone() const = 0 SIP_FACTORY;
438
442 void toSld( QDomDocument &doc, QDomElement &element, QVariantMap props ) const;
443
452 Qgis::RenderUnit outputUnit() const;
453
459 bool usesMapUnits() const;
460
469 void setOutputUnit( Qgis::RenderUnit unit ) const;
470
480 QgsMapUnitScale mapUnitScale() const;
481
490 void setMapUnitScale( const QgsMapUnitScale &scale ) const;
491
497 qreal opacity() const { return mOpacity; }
498
504 void setOpacity( qreal opacity ) { mOpacity = opacity; }
505
510 void setRenderHints( Qgis::SymbolRenderHints hints ) { mRenderHints = hints; }
511
516 Qgis::SymbolRenderHints renderHints() const { return mRenderHints; }
517
524 void setFlags( Qgis::SymbolFlags flags ) { mSymbolFlags = flags; }
525
532 Qgis::SymbolFlags flags() const { return mSymbolFlags; }
533
543 void setClipFeaturesToExtent( bool clipFeaturesToExtent ) { mClipFeaturesToExtent = clipFeaturesToExtent; }
544
554 bool clipFeaturesToExtent() const { return mClipFeaturesToExtent; }
555
565 void setForceRHR( bool force ) { mForceRHR = force; }
566
576 bool forceRHR() const { return mForceRHR; }
577
584 QgsSymbolAnimationSettings &animationSettings();
585
592 const QgsSymbolAnimationSettings &animationSettings() const SIP_SKIP;
593
600 void setAnimationSettings( const QgsSymbolAnimationSettings &settings );
601
607 QSet<QString> usedAttributes( const QgsRenderContext &context ) const;
608
616 void setDataDefinedProperty( Property key, const QgsProperty &property );
617
624 QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
625
631 const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP
632
639 void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
640
645 bool hasDataDefinedProperties() const;
646
656 bool canCauseArtifactsBetweenAdjacentTiles() const;
657
662 Q_DECL_DEPRECATED void setLayer( const QgsVectorLayer *layer ) SIP_DEPRECATED;
663
667 Q_DECL_DEPRECATED const QgsVectorLayer *layer() const SIP_DEPRECATED;
668
673 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 );
674
680 QgsSymbolRenderContext *symbolRenderContext();
681
693 void startFeatureRender( const QgsFeature &feature, QgsRenderContext &context, int layer = -1 );
694
706 void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context, int layer = -1 );
707
708 protected:
709
715 QgsSymbol( Qgis::SymbolType type, const QgsSymbolLayerList &layers SIP_TRANSFER ); // can't be instantiated
716
720 static inline QPointF _getPoint( QgsRenderContext &context, const QgsPoint &point )
721 {
722 QPointF pt;
723 if ( context.coordinateTransform().isValid() )
724 {
725 double x = point.x();
726 double y = point.y();
727 double z = 0.0;
728 context.coordinateTransform().transformInPlace( x, y, z );
729 pt = QPointF( x, y );
730
731 }
732 else
733 pt = point.toQPointF();
734
735 context.mapToPixel().transformInPlace( pt.rx(), pt.ry() );
736 return pt;
737 }
738
742 static QPolygonF _getLineString( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent = true );
743
750 static QPolygonF _getPolygonRing( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent, bool isExteriorRing = false, bool correctRingOrientation = false );
751
759 static void _getPolygon( QPolygonF &pts, QVector<QPolygonF> &holes, QgsRenderContext &context, const QgsPolygon &polygon, bool clipToExtent = true, bool correctRingOrientation = false );
760
765 QgsSymbolLayerList cloneLayers() const SIP_FACTORY;
766
779 void renderUsingLayer( QgsSymbolLayer *layer, QgsSymbolRenderContext &context, Qgis::GeometryType geometryType = Qgis::GeometryType::Unknown, const QPolygonF *points = nullptr, const QVector<QPolygonF> *rings = nullptr );
780
785 void renderVertexMarker( QPointF pt, QgsRenderContext &context, Qgis::VertexMarkerType currentVertexMarkerType, double currentVertexMarkerSize );
786
787 Qgis::SymbolType mType;
789
791 qreal mOpacity = 1.0;
792
793 Qgis::SymbolRenderHints mRenderHints;
794
800 Qgis::SymbolFlags mSymbolFlags = Qgis::SymbolFlags();
801
802 bool mClipFeaturesToExtent = true;
803 bool mForceRHR = false;
804
805 QgsSymbolAnimationSettings mAnimationSettings;
806
807 Q_DECL_DEPRECATED const QgsVectorLayer *mLayer = nullptr; //current vectorlayer
808
809 private:
810#ifdef SIP_RUN
811 QgsSymbol( const QgsSymbol & );
812#endif
813
814 static void initPropertyDefinitions();
815
817 static QgsPropertiesDefinition sPropertyDefinitions;
818
823 bool mStarted = false;
824
826 std::unique_ptr< QgsSymbolRenderContext > mSymbolRenderContext;
827
828 QgsPropertyCollection mDataDefinedProperties;
829
833 static QPolygonF _getLineString2d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent = true );
834
838 static QPolygonF _getLineString3d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent = true );
839
846 static QPolygonF _getPolygonRing2d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent, bool isExteriorRing = false, bool correctRingOrientation = false );
847
854 static QPolygonF _getPolygonRing3d( QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent, bool isExteriorRing = false, bool correctRingOrientation = false );
855
856 Q_DISABLE_COPY( QgsSymbol )
857
858};
859
860#endif
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:255
@ FlagIncludeCrosshairsForMarkerSymbols
Include a crosshairs reference image in the background of marker symbol previews.
SymbolType
Attribute editing capabilities which may be supported by vector data providers.
Definition qgis.h:368
@ 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:36
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:56
Container of fields for a vector layer.
Definition qgsfields.h:45
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:34
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:639
void setRenderHints(Qgis::SymbolRenderHints hints)
Sets rendering hint flags for the symbol.
Definition qgssymbol.h:510
Qgis::SymbolRenderHints renderHints() const
Returns the rendering hint flags for the symbol.
Definition qgssymbol.h:516
Property
Data definable properties.
Definition qgssymbol.h:131
@ PropertyOpacity
Opacity.
Definition qgssymbol.h:132
Qgis::SymbolFlags flags() const
Returns flags for the symbol.
Definition qgssymbol.h:532
bool clipFeaturesToExtent() const
Returns whether features drawn by the symbol will be clipped to the render context's extent.
Definition qgssymbol.h:554
void setFlags(Qgis::SymbolFlags flags)
Sets flags for the symbol.
Definition qgssymbol.h:524
QgsSymbolLayerList symbolLayers() const
Returns the list of symbol layers contained in the symbol.
Definition qgssymbol.h:164
void setOpacity(qreal opacity)
Sets the opacity for the symbol.
Definition qgssymbol.h:504
int symbolLayerCount() const
Returns the total number of symbol layers contained in the symbol.
Definition qgssymbol.h:216
Qgis::SymbolType type() const
Returns the symbol's type.
Definition qgssymbol.h:153
const QgsPropertyCollection & dataDefinedProperties() const
Returns a reference to the symbol's property collection, used for data defined overrides.
Definition qgssymbol.h:631
bool forceRHR() const
Returns true if polygon features drawn by the symbol will be reoriented to follow the standard right-...
Definition qgssymbol.h:576
void setClipFeaturesToExtent(bool clipFeaturesToExtent)
Sets whether features drawn by the symbol should be clipped to the render context's extent.
Definition qgssymbol.h:543
void setForceRHR(bool force)
Sets whether polygon features drawn by the symbol should be reoriented to follow the standard right-h...
Definition qgssymbol.h:565
Represents a vector layer which manages a vector based data sets.
#define SIP_TYPEHINT(type)
Definition qgis_sip.h:227
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:186
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_SKIP
Definition qgis_sip.h:126
#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:198
#define SIP_END
Definition qgis_sip.h:203
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
QList< QgsSymbolLayer * > QgsSymbolLayerList
Definition qgssymbol.h:30