QGIS API Documentation  3.21.0-Master (402cf1129e)
qgssymbollayerutils.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgssymbollayerutils.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 
17 #ifndef QGSSYMBOLLAYERUTILS_H
18 #define QGSSYMBOLLAYERUTILS_H
19 
20 #include "qgis_core.h"
21 #include "qgis_sip.h"
22 #include <QMap>
23 #include <QFont>
24 #include <QColor>
25 #include <QPainter>
26 #include "qgis.h"
27 #include "qgsmapunitscale.h"
28 #include "qgscolorramp.h"
29 #include "qgsarrowsymbollayer.h"
30 #include "qgssymbol.h"
31 
32 #include <QFile>
33 
34 class QgsExpression;
35 class QgsPathResolver;
37 class QgsSymbolLayer;
38 
39 typedef QMap<QString, QString> QgsStringMap;
40 typedef QMap<QString, QgsSymbol * > QgsSymbolMap;
41 typedef QList< QPair< QColor, QString > > QgsNamedColorList SIP_SKIP;
42 
43 class QDomDocument;
44 class QDomElement;
45 class QIcon;
46 class QPixmap;
47 class QPointF;
48 class QSize;
49 class QMimeData;
50 class QgsFeatureRenderer;
51 class QgsSymbolLayerId;
52 
57 class CORE_EXPORT QgsSymbolLayerUtils
58 {
59  public:
60 
61  static QString encodeColor( const QColor &color );
62  static QColor decodeColor( const QString &str );
63 
64  static QString encodeSldAlpha( int alpha );
65  static int decodeSldAlpha( const QString &str );
66 
67  static QString encodeSldFontStyle( QFont::Style style );
68  static QFont::Style decodeSldFontStyle( const QString &str );
69 
70  static QString encodeSldFontWeight( int weight );
71  static int decodeSldFontWeight( const QString &str );
72 
73  static QString encodePenStyle( Qt::PenStyle style );
74  static Qt::PenStyle decodePenStyle( const QString &str );
75 
76  static QString encodePenJoinStyle( Qt::PenJoinStyle style );
77  static Qt::PenJoinStyle decodePenJoinStyle( const QString &str );
78 
79  static QString encodePenCapStyle( Qt::PenCapStyle style );
80  static Qt::PenCapStyle decodePenCapStyle( const QString &str );
81 
82  static QString encodeSldLineJoinStyle( Qt::PenJoinStyle style );
83  static Qt::PenJoinStyle decodeSldLineJoinStyle( const QString &str );
84 
85  static QString encodeSldLineCapStyle( Qt::PenCapStyle style );
86  static Qt::PenCapStyle decodeSldLineCapStyle( const QString &str );
87 
88  static QString encodeBrushStyle( Qt::BrushStyle style );
89  static Qt::BrushStyle decodeBrushStyle( const QString &str );
90 
91  static QString encodeSldBrushStyle( Qt::BrushStyle style );
92  static Qt::BrushStyle decodeSldBrushStyle( const QString &str );
93 
98  static QgsArrowSymbolLayer::HeadType decodeArrowHeadType( const QVariant &value, bool *ok SIP_OUT = nullptr );
99 
104  static QgsArrowSymbolLayer::ArrowType decodeArrowType( const QVariant &value, bool *ok SIP_OUT = nullptr );
105 
111  static QString encodePoint( QPointF point );
112 
118  static QPointF decodePoint( const QString &string );
119 
132  static QPointF toPoint( const QVariant &value, bool *ok SIP_OUT = nullptr );
133 
140  static QString encodeSize( QSizeF size );
141 
148  static QSizeF decodeSize( const QString &string );
149 
162  static QSizeF toSize( const QVariant &value, bool *ok SIP_OUT = nullptr );
163 
164  static QString encodeMapUnitScale( const QgsMapUnitScale &mapUnitScale );
165  static QgsMapUnitScale decodeMapUnitScale( const QString &str );
166 
167  static QString encodeRealVector( const QVector<qreal> &v );
168  static QVector<qreal> decodeRealVector( const QString &s );
169 
170  static QString encodeSldRealVector( const QVector<qreal> &v );
171  static QVector<qreal> decodeSldRealVector( const QString &s );
172 
180  static QString encodeSldUom( QgsUnitTypes::RenderUnit unit, double *scaleFactor );
181 
189  static QgsUnitTypes::RenderUnit decodeSldUom( const QString &str, double *scaleFactor = nullptr );
190 
198  static double sizeInPixelsFromSldUom( const QString &uom, double size );
199 
205  static QString encodeScaleMethod( Qgis::ScaleMethod scaleMethod );
206 
212  static Qgis::ScaleMethod decodeScaleMethod( const QString &str );
213 
214  static QPainter::CompositionMode decodeBlendMode( const QString &s );
215 
224  static QIcon symbolPreviewIcon( const QgsSymbol *symbol, QSize size, int padding = 0, QgsLegendPatchShape *shape = nullptr );
225 
241  static QPixmap symbolPreviewPixmap( const QgsSymbol *symbol, QSize size, int padding = 0, QgsRenderContext *customContext = nullptr, bool selected = false,
242  const QgsExpressionContext *expressionContext = nullptr,
243  const QgsLegendPatchShape *shape = nullptr );
244 
255  static QPicture symbolLayerPreviewPicture( const QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit units, QSize size, const QgsMapUnitScale &scale = QgsMapUnitScale() );
256 
266  static QIcon symbolLayerPreviewIcon( const QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit u, QSize size, const QgsMapUnitScale &scale = QgsMapUnitScale() );
267 
275  static QIcon colorRampPreviewIcon( QgsColorRamp *ramp, QSize size, int padding = 0 );
276 
289  static QPixmap colorRampPreviewPixmap( QgsColorRamp *ramp, QSize size, int padding = 0, Qt::Orientation direction = Qt::Horizontal,
290  bool flipDirection = false, bool drawTransparentBackground = true );
291 
292  static void drawStippledBackground( QPainter *painter, QRect rect );
293 
298  static void drawVertexMarker( double x, double y, QPainter &p, Qgis::VertexMarkerType type, int markerSize );
299 
301  static double estimateMaxSymbolBleed( QgsSymbol *symbol, const QgsRenderContext &context );
302 
309  static QgsSymbol *loadSymbol( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
310 
319  template <class SymbolType> static SymbolType *loadSymbol( const QDomElement &element, const QgsReadWriteContext &context ) SIP_SKIP
320  {
321  QgsSymbol *tmpSymbol = QgsSymbolLayerUtils::loadSymbol( element, context );
322  SymbolType *symbolCastToType = dynamic_cast<SymbolType *>( tmpSymbol );
323 
324  if ( symbolCastToType )
325  {
326  return symbolCastToType;
327  }
328  else
329  {
330  //could not cast
331  delete tmpSymbol;
332  return nullptr;
333  }
334  }
335 
337  static QgsSymbolLayer *loadSymbolLayer( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
339  static QDomElement saveSymbol( const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context );
340 
346  static QString symbolProperties( QgsSymbol *symbol );
347 
351  static bool createSymbolLayerListFromSld( QDomElement &element, QgsWkbTypes::GeometryType geomType, QList<QgsSymbolLayer *> &layers );
352 
353  static QgsSymbolLayer *createFillLayerFromSld( QDomElement &element ) SIP_FACTORY;
354  static QgsSymbolLayer *createLineLayerFromSld( QDomElement &element ) SIP_FACTORY;
355  static QgsSymbolLayer *createMarkerLayerFromSld( QDomElement &element ) SIP_FACTORY;
356 
360  static bool convertPolygonSymbolizerToPointMarker( QDomElement &element, QList<QgsSymbolLayer *> &layerList );
361  static bool hasExternalGraphic( QDomElement &element );
362  static bool hasWellKnownMark( QDomElement &element );
363 
364  static bool needFontMarker( QDomElement &element );
365  static bool needSvgMarker( QDomElement &element );
366  static bool needEllipseMarker( QDomElement &element );
367  static bool needMarkerLine( QDomElement &element );
368  static bool needLinePatternFill( QDomElement &element );
369  static bool needPointPatternFill( QDomElement &element );
370  static bool needSvgFill( QDomElement &element );
371 
372  static void fillToSld( QDomDocument &doc, QDomElement &element,
373  Qt::BrushStyle brushStyle, const QColor &color = QColor() );
374  static bool fillFromSld( QDomElement &element,
375  Qt::BrushStyle &brushStyle, QColor &color );
376 
378  static void lineToSld( QDomDocument &doc, QDomElement &element,
379  Qt::PenStyle penStyle, const QColor &color, double width = -1,
380  const Qt::PenJoinStyle *penJoinStyle = nullptr, const Qt::PenCapStyle *penCapStyle = nullptr,
381  const QVector<qreal> *customDashPattern = nullptr, double dashOffset = 0.0 ) SIP_SKIP;
382  static bool lineFromSld( QDomElement &element,
383  Qt::PenStyle &penStyle, QColor &color, double &width,
384  Qt::PenJoinStyle *penJoinStyle = nullptr, Qt::PenCapStyle *penCapStyle = nullptr,
385  QVector<qreal> *customDashPattern = nullptr, double *dashOffset = nullptr );
386 
387  static void externalGraphicToSld( QDomDocument &doc, QDomElement &element,
388  const QString &path, const QString &mime,
389  const QColor &color, double size = -1 );
390  static bool externalGraphicFromSld( QDomElement &element,
391  QString &path, QString &mime,
392  QColor &color, double &size );
393 
394  static void wellKnownMarkerToSld( QDomDocument &doc, QDomElement &element,
395  const QString &name, const QColor &color, const QColor &strokeColor, Qt::PenStyle strokeStyle,
396  double strokeWidth = -1, double size = -1 );
397 
399  static bool wellKnownMarkerFromSld( QDomElement &element,
400  QString &name, QColor &color, QColor &strokeColor, Qt::PenStyle &strokeStyle,
401  double &strokeWidth, double &size ) SIP_PYNAME( wellKnownMarkerFromSld2 );
402 
403  static void externalMarkerToSld( QDomDocument &doc, QDomElement &element,
404  const QString &path, const QString &format, int *markIndex = nullptr,
405  const QColor &color = QColor(), double size = -1 );
406  static bool externalMarkerFromSld( QDomElement &element,
407  QString &path, QString &format, int &markIndex,
408  QColor &color, double &size );
409 
410 
411  static void labelTextToSld( QDomDocument &doc, QDomElement &element, const QString &label,
412  const QFont &font, const QColor &color = QColor(), double size = -1 );
413 
415  static QString ogrFeatureStylePen( double width, double mmScaleFactor, double mapUnitsScaleFactor, const QColor &c,
416  Qt::PenJoinStyle joinStyle = Qt::MiterJoin,
417  Qt::PenCapStyle capStyle = Qt::FlatCap,
418  double offset = 0.0,
419  const QVector<qreal> *dashPattern = nullptr );
420 
425  static QString ogrFeatureStyleBrush( const QColor &fillColr );
426 
427  static void createRotationElement( QDomDocument &doc, QDomElement &element, const QString &rotationFunc );
428  static bool rotationFromSldElement( QDomElement &element, QString &rotationFunc );
429 
430  static void createOpacityElement( QDomDocument &doc, QDomElement &element, const QString &alphaFunc );
431  static bool opacityFromSldElement( QDomElement &element, QString &alphaFunc );
432 
433  static void createDisplacementElement( QDomDocument &doc, QDomElement &element, QPointF offset );
434  static bool displacementFromSldElement( QDomElement &element, QPointF &offset );
435 
442  static void createAnchorPointElement( QDomDocument &doc, QDomElement &element, QPointF anchor );
443 
444  static void createOnlineResourceElement( QDomDocument &doc, QDomElement &element, const QString &path, const QString &format );
445  static bool onlineResourceFromSldElement( QDomElement &element, QString &path, QString &format );
446 
447  static void createGeometryElement( QDomDocument &doc, QDomElement &element, const QString &geomFunc );
448  static bool geometryFromSldElement( QDomElement &element, QString &geomFunc );
449 
456  static bool createExpressionElement( QDomDocument &doc, QDomElement &element, const QString &function );
457  static bool createFunctionElement( QDomDocument &doc, QDomElement &element, const QString &function );
458  static bool functionFromSldElement( QDomElement &element, QString &function );
459 
460  static QDomElement createSvgParameterElement( QDomDocument &doc, const QString &name, const QString &value );
461  static QgsStringMap getSvgParameterList( QDomElement &element );
462 
463  static QDomElement createVendorOptionElement( QDomDocument &doc, const QString &name, const QString &value );
464  static QgsStringMap getVendorOptionList( QDomElement &element );
465 
467  static QVariantMap parseProperties( const QDomElement &element );
469  static void saveProperties( QVariantMap props, QDomDocument &doc, QDomElement &element );
470 
472  static QgsSymbolMap loadSymbols( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
474  static QDomElement saveSymbols( QgsSymbolMap &symbols, const QString &tagName, QDomDocument &doc, const QgsReadWriteContext &context );
475 
476  static void clearSymbolMap( QgsSymbolMap &symbols );
477 
485  static QMimeData *symbolToMimeData( const QgsSymbol *symbol ) SIP_FACTORY;
486 
493  static QgsSymbol *symbolFromMimeData( const QMimeData *data ) SIP_FACTORY;
494 
501  static QgsColorRamp *loadColorRamp( QDomElement &element ) SIP_FACTORY;
502 
511  static QDomElement saveColorRamp( const QString &name, QgsColorRamp *ramp, QDomDocument &doc );
512 
519  static QVariant colorRampToVariant( const QString &name, QgsColorRamp *ramp );
520 
527  static QgsColorRamp *loadColorRamp( const QVariant &value ) SIP_FACTORY;
528 
535  static QString colorToName( const QColor &color );
536 
544  static QList< QColor > parseColorList( const QString &colorStr );
545 
553  static QMimeData *colorToMimeData( const QColor &color ) SIP_FACTORY;
554 
563  static QColor colorFromMimeData( const QMimeData *data, bool &hasAlpha SIP_OUT );
564 
571  static QgsNamedColorList colorListFromMimeData( const QMimeData *data );
572 
580  static QMimeData *colorListToMimeData( const QgsNamedColorList &colorList, bool allFormats = true ) SIP_FACTORY;
581 
590  static bool saveColorsToGpl( QFile &file, const QString &paletteName, const QgsNamedColorList &colors );
591 
600  static QgsNamedColorList importColorsFromGpl( QFile &file, bool &ok, QString &name );
601 
610  static QColor parseColor( const QString &colorStr, bool strictEval = false );
611 
621  static QColor parseColorWithAlpha( const QString &colorStr, bool &containsAlpha, bool strictEval = false );
622 
626  static void multiplyImageOpacity( QImage *image, qreal opacity );
627 
629  static void blurImageInPlace( QImage &image, QRect rect, int radius, bool alphaOnly );
630 
635  static void premultiplyColor( QColor &rgb, int alpha );
636 
649  static bool condenseFillAndOutline( QgsFillSymbolLayer *fill, QgsLineSymbolLayer *outline );
650 
652  static void sortVariantList( QList<QVariant> &list, Qt::SortOrder order );
654  static QPointF pointOnLineWithDistance( QPointF startPoint, QPointF directionPoint, double distance );
655 
657  static QStringList listSvgFiles();
658 
660  static QStringList listSvgFilesAt( const QString &directory );
661 
668  static QString svgSymbolNameToPath( const QString &name, const QgsPathResolver &pathResolver );
669 
674  static QString svgSymbolPathToName( const QString &path, const QgsPathResolver &pathResolver );
675 
677  static QPointF polygonCentroid( const QPolygonF &points );
678 
680  static QPointF polygonPointOnSurface( const QPolygonF &points, const QVector<QPolygonF> *rings = nullptr );
681 
683  static bool pointInPolygon( const QPolygonF &points, QPointF point );
684 
690  static double polylineLength( const QPolygonF &polyline );
691 
704  static QPolygonF polylineSubstring( const QPolygonF &polyline, double startOffset, double endOffset );
705 
713  static bool isSharpCorner( QPointF p1, QPointF p2, QPointF p3 );
714 
722  static void appendPolyline( QPolygonF &target, const QPolygonF &line );
723 
731  static QgsExpression *fieldOrExpressionToExpression( const QString &fieldOrExpression ) SIP_FACTORY;
732 
740  static QString fieldOrExpressionFromExpression( QgsExpression *expression );
741 
748  static QList<double> prettyBreaks( double minimum, double maximum, int classes );
749 
755  static double rescaleUom( double size, QgsUnitTypes::RenderUnit unit, const QVariantMap &props );
756 
762  static QPointF rescaleUom( QPointF point, QgsUnitTypes::RenderUnit unit, const QVariantMap &props ) SIP_PYNAME( rescalePointUom );
763 
769  static QVector<qreal> rescaleUom( const QVector<qreal> &array, QgsUnitTypes::RenderUnit unit, const QVariantMap &props ) SIP_PYNAME( rescaleArrayUom );
770 
775  static void applyScaleDependency( QDomDocument &doc, QDomElement &ruleElem, QVariantMap &props );
776 
781  static void mergeScaleDependencies( double mScaleMinDenom, double mScaleMaxDenom, QVariantMap &props );
782 
789  static void parametricSvgToSld( QDomDocument &doc, QDomElement &graphicElem,
790  const QString &path,
791  const QColor &fillColor, double size, const QColor &strokeColor, double strokeWidth );
792 
797  static QString getSvgParametricPath( const QString &basePath, const QColor &fillColor, const QColor &strokeColor, double strokeWidth );
798 
803  static QSet<const QgsSymbolLayer *> toSymbolLayerPointers( QgsFeatureRenderer *renderer, const QSet<QgsSymbolLayerId> &symbolLayerIds );
804 
815  static QgsSymbol *restrictedSizeSymbol( const QgsSymbol *s, double minSize, double maxSize, QgsRenderContext *context, double &width, double &height );
816 
821  static QgsStringMap evaluatePropertiesMap( const QMap<QString, QgsProperty> &propertiesMap, const QgsExpressionContext &context );
822 
824 #ifndef SIP_RUN
825  static QgsProperty rotateWholeSymbol( double additionalRotation, const QgsProperty &property )
826  {
827  QString exprString = property.asExpression();
828  return QgsProperty::fromExpression( QString::number( additionalRotation ) + " + (" + exprString + ')' );
829  }
830 
831  static QgsProperty scaleWholeSymbol( double scaleFactor, const QgsProperty &property )
832  {
833  QString exprString = property.asExpression();
834  return QgsProperty::fromExpression( QString::number( scaleFactor ) + "*(" + exprString + ')' );
835  }
836 
837  static QgsProperty scaleWholeSymbol( double scaleFactorX, double scaleFactorY, const QgsProperty &property )
838  {
839  QString exprString = property.asExpression();
841  ( !qgsDoubleNear( scaleFactorX, 0.0 ) ? "tostring(" + QString::number( scaleFactorX ) + "*(" + exprString + "))" : QStringLiteral( "'0'" ) ) +
842  "|| ',' || " +
843  ( !qgsDoubleNear( scaleFactorY, 0.0 ) ? "tostring(" + QString::number( scaleFactorY ) + "*(" + exprString + "))" : QStringLiteral( "'0'" ) ) );
844  }
845 #endif
847 
848 };
849 
850 class QPolygonF;
851 
853 QList<QPolygonF> offsetLine( QPolygonF polyline, double dist, QgsWkbTypes::GeometryType geometryType ) SIP_SKIP;
854 
855 #endif
856 
857 
ScaleMethod
Scale methods.
Definition: qgis.h:183
VertexMarkerType
Editing vertex markers, used for showing vertices during a edit operation.
Definition: qgis.h:517
HeadType
Possible head types.
ArrowType
Possible arrow types.
Abstract base class for color ramps.
Definition: qgscolorramp.h:32
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Class for parsing and evaluation of expressions (formerly called "search strings").
Represents a patch shape for use in map legends.
Struct for storing maximum and minimum scales for measurements in map units.
Resolves relative paths into absolute paths and vice versa.
A store for object properties.
Definition: qgsproperty.h:232
QString asExpression() const
Returns an expression string representing the state of the property, or an empty string if the proper...
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
We may need stable references to symbol layers, when pointers to symbol layers is not usable (when a ...
static SymbolType * loadSymbol(const QDomElement &element, const QgsReadWriteContext &context)
Attempts to load a symbol from a DOM element and cast it to a particular symbol type.
static QgsSymbol * loadSymbol(const QDomElement &element, const QgsReadWriteContext &context)
Attempts to load a symbol from a DOM element.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:38
Helper functions for various unit types.
Definition: qgsunittypes.h:39
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:168
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:141
QList< QPair< QColor, QString > > QgsNamedColorList
List of colors paired with a friendly display name identifying the color.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define str(x)
Definition: qgis.cpp:37
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition: qgis.h:763
QMap< QString, QString > QgsStringMap
Definition: qgis.h:1206
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_PYNAME(name)
Definition: qgis_sip.h:81
#define SIP_OUT
Definition: qgis_sip.h:58
#define SIP_FACTORY
Definition: qgis_sip.h:76
QMap< QString, QgsSymbol * > QgsSymbolMap
Definition: qgsrenderer.h:44
QList< QPolygonF > offsetLine(QPolygonF polyline, double dist, QgsWkbTypes::GeometryType geometryType)
calculate geometry shifted by a specified distance
QMap< QString, QgsSymbol * > QgsSymbolMap
QMap< QString, QString > QgsStringMap