class QgsSymbolLayerUtils
{
%TypeHeaderCode
#include <qgssymbollayerutils.h>
%End
public:
static QString encodeColor( const QColor& color );
static QColor decodeColor( const QString& str );
static QString encodeSldAlpha( int alpha );
static int decodeSldAlpha( const QString& str );
static QString encodeSldFontStyle( QFont::Style style );
static QFont::Style decodeSldFontStyle( const QString& str );
static QString encodeSldFontWeight( int weight );
static int decodeSldFontWeight( const QString& str );
static QString encodePenStyle( Qt::PenStyle style );
static Qt::PenStyle decodePenStyle( const QString& str );
static QString encodePenJoinStyle( Qt::PenJoinStyle style );
static Qt::PenJoinStyle decodePenJoinStyle( const QString& str );
static QString encodePenCapStyle( Qt::PenCapStyle style );
static Qt::PenCapStyle decodePenCapStyle( const QString& str );
static QString encodeSldLineJoinStyle( Qt::PenJoinStyle style );
static Qt::PenJoinStyle decodeSldLineJoinStyle( const QString& str );
static QString encodeSldLineCapStyle( Qt::PenCapStyle style );
static Qt::PenCapStyle decodeSldLineCapStyle( const QString& str );
static QString encodeBrushStyle( Qt::BrushStyle style );
static Qt::BrushStyle decodeBrushStyle( const QString& str );
static QString encodeSldBrushStyle( Qt::BrushStyle style );
static Qt::BrushStyle decodeSldBrushStyle( const QString& str );
static QString encodePoint( QPointF point );
static QPointF decodePoint( const QString& str );
static QString encodeMapUnitScale( const QgsMapUnitScale& mapUnitScale );
static QgsMapUnitScale decodeMapUnitScale( const QString& str );
static QString encodeRealVector( const QVector<qreal>& v );
static QVector<qreal> decodeRealVector( const QString& s );
static QString encodeSldRealVector( const QVector<qreal>& v );
static QVector<qreal> decodeSldRealVector( const QString& s );
/** Encodes a render unit into an SLD unit of measure string.
* @param unit unit to encode
* @param scaleFactor if specified, will be set to scale factor for unit of measure
* @returns encoded string
* @see decodeSldUom()
*/
static QString encodeSldUom( QgsUnitTypes::RenderUnit unit, double *scaleFactor );
/** Decodes a SLD unit of measure string to a render unit.
* @param str string to decode
* @param scaleFactor if specified, will be set to scale factor for unit of measure
* @returns matching render unit
* @see encodeSldUom()
*/
static QgsUnitTypes::RenderUnit decodeSldUom( const QString& str, double *scaleFactor );
static QString encodeScaleMethod( QgsSymbol::ScaleMethod scaleMethod );
static QgsSymbol::ScaleMethod decodeScaleMethod( const QString& str );
static QPainter::CompositionMode decodeBlendMode( const QString& s );
static QIcon symbolPreviewIcon( QgsSymbol* symbol, QSize size );
/** Draws a symbol layer preview to a QPicture
* @param layer symbol layer to draw
* @param units size units
* @param size target size of preview picture
* @param scale map unit scale for preview
* @returns QPicture containing symbol layer preview
* @note added in QGIS 2.9
* @see symbolLayerPreviewIcon()
*/
static QPicture symbolLayerPreviewPicture( QgsSymbolLayer* layer, QgsUnitTypes::RenderUnit units, QSize size, const QgsMapUnitScale& scale = QgsMapUnitScale() );
/** Draws a symbol layer preview to an icon.
* @param layer symbol layer to draw
* @param u size units
* @param size target size of preview icon
* @param scale map unit scale for preview
* @returns icon containing symbol layer preview
* @see symbolLayerPreviewPicture()
*/
static QIcon symbolLayerPreviewIcon( QgsSymbolLayer* layer, QgsUnitTypes::RenderUnit u, QSize size, const QgsMapUnitScale& scale = QgsMapUnitScale() );
static QIcon colorRampPreviewIcon( QgsVectorColorRampV2* ramp, QSize size );
static void drawStippledBackground( QPainter* painter, QRect rect );
//! @note customContext parameter added in 2.6
static QPixmap symbolPreviewPixmap( QgsSymbol* symbol, QSize size, QgsRenderContext* customContext = 0 );
static QPixmap colorRampPreviewPixmap( QgsVectorColorRampV2* ramp, QSize size );
/** Returns the maximum estimated bleed for the symbol */
static double estimateMaxSymbolBleed( QgsSymbol* symbol );
/** Attempts to load a symbol from a DOM element
* @param element DOM element representing symbol
* @returns decoded symbol, if possible
*/
static QgsSymbol* loadSymbol( const QDomElement& element ) /Factory/;
/** Attempts to load a symbol from a DOM element and cast it to a particular symbol
* type.
* @param element DOM element representing symbol
* @returns decoded symbol cast to specified type, if possible
* @note not available in python bindings
*/
//template <class SymbolType> static SymbolType* loadSymbol( const QDomElement& element );
static QgsSymbolLayer* loadSymbolLayer( QDomElement& element ) /Factory/;
static QDomElement saveSymbol( const QString& symbolName, QgsSymbol* symbol, QDomDocument& doc );
/** Returns a string representing the symbol. Can be used to test for equality
* between symbols.
* @note added in QGIS 2.12
*/
static QString symbolProperties( QgsSymbol* symbol );
static bool createSymbolLayerV2ListFromSld( QDomElement& element, QgsWkbTypes::GeometryType geomType, QgsSymbolLayerList &layers );
static QgsSymbolLayer* createFillLayerFromSld( QDomElement &element );
static QgsSymbolLayer* createLineLayerFromSld( QDomElement &element );
static QgsSymbolLayer* createMarkerLayerFromSld( QDomElement &element );
static bool convertPolygonSymbolizerToPointMarker( QDomElement &element, QgsSymbolLayerList &layerList );
static bool hasExternalGraphic( QDomElement &element );
static bool hasWellKnownMark( QDomElement &element );
static bool needFontMarker( QDomElement &element );
static bool needSvgMarker( QDomElement &element );
static bool needEllipseMarker( QDomElement &element );
static bool needMarkerLine( QDomElement &element );
static bool needLinePatternFill( QDomElement &element );
static bool needPointPatternFill( QDomElement &element );
static bool needSvgFill( QDomElement &element );
static void fillToSld( QDomDocument &doc, QDomElement &element,
Qt::BrushStyle brushStyle, const QColor& color = QColor() );
static bool fillFromSld( QDomElement &element,
Qt::BrushStyle &brushStyle, QColor &color );
//! @note not available in python bindings
/*
static void lineToSld( QDomDocument &doc, QDomElement &element,
Qt::PenStyle penStyle, const QColor& color, double width = -1,
const Qt::PenJoinStyle *penJoinStyle = 0, const Qt::PenCapStyle *penCapStyle = 0,
const QVector<qreal> *customDashPattern = 0, double dashOffset = 0.0 );
*/
static bool lineFromSld( QDomElement &element,
Qt::PenStyle &penStyle, QColor &color, double &width,
Qt::PenJoinStyle *penJoinStyle = 0, Qt::PenCapStyle *penCapStyle = 0,
QVector<qreal> *customDashPattern = 0, double *dashOffset = 0 );
static void externalGraphicToSld( QDomDocument &doc, QDomElement &element,
const QString& path, const QString& mime,
const QColor& color, double size = -1 );
static bool externalGraphicFromSld( QDomElement &element,
QString &path, QString &mime,
QColor &color, double &size );
/** @deprecated Use wellKnownMarkerToSld( QDomDocument &doc, QDomElement &element, QString name, QColor color, QColor borderColor, Qt::PenStyle borderStyle, double borderWidth, double size ) instead */
static void wellKnownMarkerToSld( QDomDocument &doc, QDomElement &element,
const QString& name, const QColor& color, const QColor& borderColor = QColor(),
double borderWidth = -1, double size = -1 ) /Deprecated/;
static void wellKnownMarkerToSld( QDomDocument &doc, QDomElement &element,
const QString& name, const QColor& color, const QColor& borderColor, Qt::PenStyle borderStyle,
double borderWidth = -1, double size = -1 );
/** @deprecated Use wellKnownMarkerFromSld( QDomElement &element, QString &name, QColor &color, QColor &borderColor, Qt::PenStyle &borderStyle, double &borderWidth, double &size ) instead */
static bool wellKnownMarkerFromSld( QDomElement &element,
QString &name, QColor &color, QColor &borderColor,
double &borderWidth, double &size ) /Deprecated/;
//! @note available in python as wellKnownMarkerFromSld2
static bool wellKnownMarkerFromSld( QDomElement &element,
QString &name, QColor &color, QColor &borderColor, Qt::PenStyle &borderStyle,
double &borderWidth, double &size ) /PyName=wellKnownMarkerFromSld2/;
static void externalMarkerToSld( QDomDocument &doc, QDomElement &element,
const QString& path, const QString& format, int *markIndex = 0,
const QColor& color = QColor(), double size = -1 );
static bool externalMarkerFromSld( QDomElement &element,
QString &path, QString &format, int &markIndex,
QColor &color, double &size );
static void labelTextToSld( QDomDocument &doc, QDomElement &element, const QString& label,
const QFont &font, const QColor& color = QColor(), double size = -1 );
/** Create ogr feature style string for pen */
static QString ogrFeatureStylePen( double width, double mmScaleFactor, double mapUnitsScaleFactor, const QColor& c,
Qt::PenJoinStyle joinStyle = Qt::MiterJoin,
Qt::PenCapStyle capStyle = Qt::FlatCap,
double offset = 0.0,
const QVector<qreal>* dashPattern = 0 );
/** Create ogr feature style string for brush
@param fillColr fill color*/
static QString ogrFeatureStyleBrush( const QColor& fillColr );
static void createRotationElement( QDomDocument &doc, QDomElement &element, const QString& rotationFunc );
static bool rotationFromSldElement( QDomElement &element, QString &rotationFunc );
static void createOpacityElement( QDomDocument &doc, QDomElement &element, const QString& alphaFunc );
static bool opacityFromSldElement( QDomElement &element, QString &alphaFunc );
static void createDisplacementElement( QDomDocument &doc, QDomElement &element, QPointF offset );
static bool displacementFromSldElement( QDomElement &element, QPointF &offset );
static void createOnlineResourceElement( QDomDocument &doc, QDomElement &element, const QString& path, const QString& format );
static bool onlineResourceFromSldElement( QDomElement &element, QString &path, QString &format );
static void createGeometryElement( QDomDocument &doc, QDomElement &element, const QString& geomFunc );
static bool geometryFromSldElement( QDomElement &element, QString &geomFunc );
static bool createFunctionElement( QDomDocument &doc, QDomElement &element, const QString& function );
static bool functionFromSldElement( QDomElement &element, QString &function );
static QDomElement createSvgParameterElement( QDomDocument &doc, const QString& name, const QString& value );
static QgsStringMap getSvgParameterList( QDomElement &element );
static QDomElement createVendorOptionElement( QDomDocument &doc, const QString& name, const QString& value );
static QgsStringMap getVendorOptionList( QDomElement &element );
static QgsStringMap parseProperties( QDomElement& element );
static void saveProperties( QgsStringMap props, QDomDocument& doc, QDomElement& element );
static QgsSymbolMap loadSymbols( QDomElement& element ) /Factory/;
static QDomElement saveSymbols( QgsSymbolMap& symbols, const QString& tagName, QDomDocument& doc );
static void clearSymbolMap( QgsSymbolMap& symbols );
static QgsVectorColorRampV2* loadColorRamp( QDomElement& element ) /Factory/;
static QDomElement saveColorRamp( const QString& name, QgsVectorColorRampV2* ramp, QDomDocument& doc );
/**
* Returns a friendly display name for a color
* @param color source color
* @returns display name for color
* @note added in 2.5
*/
static QString colorToName( const QColor& color );
/**
* Attempts to parse a string as a list of colors using a variety of common formats, including hex
* codes, rgb and rgba strings.
* @param colorStr string representing the color list
* @returns list of parsed colors
* @note added in 2.5
*/
static QList< QColor > parseColorList( const QString& colorStr );
/**
* Creates mime data from a color. Sets both the mime data's color data, and the
* mime data's text with the color's hex code.
* @param color color to encode as mime data
* @see colorFromMimeData
* @note added in 2.5
*/
static QMimeData *colorToMimeData( const QColor &color );
/**
* Attempts to parse mime data as a color
* @param data mime data to parse
* @param hasAlpha will be set to true if mime data was interpreted as a color containing
* an explicit alpha value
* @returns valid color if mimedata could be interpreted as a color, otherwise an
* invalid color
* @note added in 2.5
*/
static QColor colorFromMimeData( const QMimeData *data, bool& hasAlpha );
/**
* Attempts to parse mime data as a list of named colors
* @param data mime data to parse
* @returns list of parsed colors
* @note added in 2.5
*/
static QgsNamedColorList colorListFromMimeData( const QMimeData *data );
/**
* Creates mime data from a list of named colors
* @param colorList list of named colors
* @param allFormats set to true to include additional mime formats, include text/plain and application/x-color
* @returns mime data containing encoded colors
* @note added in 2.5
*/
static QMimeData* colorListToMimeData( const QgsNamedColorList& colorList, const bool allFormats = true );
/**
* Exports colors to a gpl GIMP palette file
* @param file destination file
* @param paletteName name of palette, which is stored in gpl file
* @param colors colors to export
* @returns true if export was successful
* @see importColorsFromGpl
*/
static bool saveColorsToGpl( QFile &file, const QString& paletteName, const QgsNamedColorList& colors );
/**
* Imports colors from a gpl GIMP palette file
* @param file source gpl file
* @param ok will be true if file was successfully read
* @param name will be set to palette name from gpl file, if present
* @returns list of imported colors
* @see saveColorsToGpl
*/
static QgsNamedColorList importColorsFromGpl( QFile &file, bool &ok, QString& name );
/**
* Attempts to parse a string as a color using a variety of common formats, including hex
* codes, rgb and rgba strings.
* @param colorStr string representing the color
* @param strictEval set to true for stricter color parsing rules
* @returns parsed color
* @note added in 2.3
*/
static QColor parseColor( const QString& colorStr, bool strictEval = false );
/**
* Attempts to parse a string as a color using a variety of common formats, including hex
* codes, rgb and rgba strings.
* @param colorStr string representing the color
* @param containsAlpha if colorStr contains an explicit alpha value then containsAlpha will be set to true
* @param strictEval set to true for stricter color parsing rules
* @returns parsed color
* @note added in 2.3
*/
static QColor parseColorWithAlpha( const QString& colorStr, bool &containsAlpha, bool strictEval = false );
/** Returns the line width scale factor depending on the unit and the paint device.
* Consider using convertToPainterUnits() instead, as convertToPainterUnits() respects the size limits specified by the scale
* parameter.
* @param c render context
* @param u units to convert from
* @param scale map unit scale, specifying limits for the map units to convert from
* @see convertToPainterUnits()
*/
static double lineWidthScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() );
/** Converts a size from the specied units to painter units. The conversion respects the limits
* specified by the optional scale parameter.
* @param c render context
* @param size size to convert
* @param unit units for specified size
* @param scale map unit scale
* @note added in QGIS 2.12
* @see lineWidthScaleFactor()
* @see convertToMapUnits()
*/
static double convertToPainterUnits( const QgsRenderContext&c, double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& scale = QgsMapUnitScale() );
/** Converts a size from the specied units to map units. The conversion respects the limits
* specified by the optional scale parameter.
* @param c render context
* @param size size to convert
* @param unit units for specified size
* @param scale map unit scale
* @note added in QGIS 2.16
* @see convertToPainterUnits()
*/
static double convertToMapUnits( const QgsRenderContext&c, double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& scale = QgsMapUnitScale() );
/** Returns scale factor painter units -> pixel dimensions*/
static double pixelSizeScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() );
/** Returns scale factor painter units -> map units*/
static double mapUnitScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() );
/** Creates a render context for a pixel based device*/
static QgsRenderContext createRenderContext( QPainter* p );
/** Multiplies opacity of image pixel values with a (global) transparency value*/
static void multiplyImageOpacity( QImage* image, qreal alpha );
/** Blurs an image in place, e.g. creating Qt-independent drop shadows */
static void blurImageInPlace( QImage& image, QRect rect, int radius, bool alphaOnly );
/** Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value
* @note added in 2.3
*/
static void premultiplyColor( QColor& rgb, int alpha );
/** Sorts the passed list in requested order*/
static void sortVariantList( QList<QVariant>& list, Qt::SortOrder order );
/** Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point*/
static QPointF pointOnLineWithDistance( QPointF startPoint, QPointF directionPoint, double distance );
//! Return a list of all available svg files
static QStringList listSvgFiles();
//! Return a list of svg files at the specified directory
static QStringList listSvgFilesAt( const QString& directory );
/** Get symbol's path from its name.
* If the name is not absolute path the file is searched in SVG paths specified
* in settings svg/searchPathsForSVG.
*/
static QString symbolNameToPath( QString name );
//! Get symbols's name from its path
static QString symbolPathToName( QString path );
//! Calculate the centroid point of a QPolygonF
static QPointF polygonCentroid( const QPolygonF& points );
//! Calculate a point within of a QPolygonF
static QPointF polygonPointOnSurface( const QPolygonF& points );
//! Calculate whether a point is within of a QPolygonF
static bool pointInPolygon( const QPolygonF &points, QPointF point );
/** Return a new valid expression instance for given field or expression string.
* If the input is not a valid expression, it is assumed that it is a field name and gets properly quoted.
* If the string is empty, returns null pointer.
* This is useful when accepting input which could be either a non-quoted field name or expression.
* @note added in 2.2
*/
static QgsExpression* fieldOrExpressionToExpression( const QString& fieldOrExpression ) /Factory/;
/** Return a field name if the whole expression is just a name of the field .
* Returns full expression string if the expression is more complex than just one field.
* Using just expression->expression() method may return quoted field name, but that is not
* wanted for saving (due to backward compatibility) or display in GUI.
* @note added in 2.2
*/
static QString fieldOrExpressionFromExpression( QgsExpression* expression );
/** Computes a sequence of about 'classes' equally spaced round values
* which cover the range of values from 'minimum' to 'maximum'.
* The values are chosen so that they are 1, 2 or 5 times a power of 10.
* @note added in 2.10
*/
static QList<double> prettyBreaks( double minimum, double maximum, int classes );
};