QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Public Types | Static Public Member Functions | List of all members
QgsSymbolLayerUtils Class Reference
core library

#include <qgssymbollayerutils.h>

Public Types

enum  VertexMarkerType { SemiTransparentCircle, Cross, NoMarker }
 Editing vertex markers. More...
 

Static Public Member Functions

static void applyScaleDependency (QDomDocument &doc, QDomElement &ruleElem, QgsStringMap &props)
 Checks if the properties contain scaleMinDenom and scaleMaxDenom, if available, they are added into the SE Rule element. More...
 
static void blurImageInPlace (QImage &image, QRect rect, int radius, bool alphaOnly)
 Blurs an image in place, e.g. creating Qt-independent drop shadows. More...
 
static void clearSymbolMap (QgsSymbolMap &symbols)
 
static QColor colorFromMimeData (const QMimeData *data, bool &hasAlpha)
 Attempts to parse mime data as a color. More...
 
static QgsNamedColorList colorListFromMimeData (const QMimeData *data)
 Attempts to parse mime data as a list of named colors. More...
 
static QMimeData * colorListToMimeData (const QgsNamedColorList &colorList, bool allFormats=true)
 Creates mime data from a list of named colors. More...
 
static QIcon colorRampPreviewIcon (QgsColorRamp *ramp, QSize size, int padding=0)
 Returns an icon preview for a color ramp. More...
 
static QPixmap colorRampPreviewPixmap (QgsColorRamp *ramp, QSize size, int padding=0)
 Returns a pixmap preview for a color ramp. More...
 
static QVariant colorRampToVariant (const QString &name, QgsColorRamp *ramp)
 Saves a color ramp to a QVariantMap, wrapped in a QVariant. More...
 
static QMimeData * colorToMimeData (const QColor &color)
 Creates mime data from a color. More...
 
static QString colorToName (const QColor &color)
 Returns a friendly display name for a color. More...
 
static bool convertPolygonSymbolizerToPointMarker (QDomElement &element, QgsSymbolLayerList &layerList)
 
static void createAnchorPointElement (QDomDocument &doc, QDomElement &element, QPointF anchor)
 Creates a SE 1.1 anchor point element as a child of the specified element. More...
 
static void createDisplacementElement (QDomDocument &doc, QDomElement &element, QPointF offset)
 
static bool createExpressionElement (QDomDocument &doc, QDomElement &element, const QString &function)
 Creates a OGC Expression element based on the provided function expression. More...
 
static QgsSymbolLayer * createFillLayerFromSld (QDomElement &element)
 
static bool createFunctionElement (QDomDocument &doc, QDomElement &element, const QString &function)
 
static void createGeometryElement (QDomDocument &doc, QDomElement &element, const QString &geomFunc)
 
static QgsSymbolLayer * createLineLayerFromSld (QDomElement &element)
 
static QgsSymbolLayer * createMarkerLayerFromSld (QDomElement &element)
 
static void createOnlineResourceElement (QDomDocument &doc, QDomElement &element, const QString &path, const QString &format)
 
static void createOpacityElement (QDomDocument &doc, QDomElement &element, const QString &alphaFunc)
 
static void createRotationElement (QDomDocument &doc, QDomElement &element, const QString &rotationFunc)
 
static QDomElement createSvgParameterElement (QDomDocument &doc, const QString &name, const QString &value)
 
static bool createSymbolLayerListFromSld (QDomElement &element, QgsWkbTypes::GeometryType geomType, QgsSymbolLayerList &layers)
 
static QDomElement createVendorOptionElement (QDomDocument &doc, const QString &name, const QString &value)
 
static QgsArrowSymbolLayer::HeadType decodeArrowHeadType (const QVariant &value, bool *ok=nullptr)
 Decodes a value representing an arrow head type. More...
 
static QgsArrowSymbolLayer::ArrowType decodeArrowType (const QVariant &value, bool *ok=nullptr)
 Decodes a value representing an arrow type. More...
 
static QPainter::CompositionMode decodeBlendMode (const QString &s)
 
static Qt::BrushStyle decodeBrushStyle (const QString &str)
 
static QColor decodeColor (const QString &str)
 
static QgsMapUnitScale decodeMapUnitScale (const QString &str)
 
static Qt::PenCapStyle decodePenCapStyle (const QString &str)
 
static Qt::PenJoinStyle decodePenJoinStyle (const QString &str)
 
static Qt::PenStyle decodePenStyle (const QString &str)
 
static QPointF decodePoint (const QString &string)
 Decodes a QSizeF from a string. More...
 
static QVector< qreal > decodeRealVector (const QString &s)
 
static QgsSymbol::ScaleMethod decodeScaleMethod (const QString &str)
 
static QSizeF decodeSize (const QString &string)
 Decodes a QSizeF from a string. More...
 
static int decodeSldAlpha (const QString &str)
 
static Qt::BrushStyle decodeSldBrushStyle (const QString &str)
 
static QFont::Style decodeSldFontStyle (const QString &str)
 
static int decodeSldFontWeight (const QString &str)
 
static Qt::PenCapStyle decodeSldLineCapStyle (const QString &str)
 
static Qt::PenJoinStyle decodeSldLineJoinStyle (const QString &str)
 
static QVector< qreal > decodeSldRealVector (const QString &s)
 
static QgsUnitTypes::RenderUnit decodeSldUom (const QString &str, double *scaleFactor)
 Decodes a SLD unit of measure string to a render unit. More...
 
static bool displacementFromSldElement (QDomElement &element, QPointF &offset)
 
static void drawStippledBackground (QPainter *painter, QRect rect)
 
static void drawVertexMarker (double x, double y, QPainter &p, QgsSymbolLayerUtils::VertexMarkerType type, int markerSize)
 Draws a vertex symbol at (painter) coordinates x, y. More...
 
static QString encodeBrushStyle (Qt::BrushStyle style)
 
static QString encodeColor (const QColor &color)
 
static QString encodeMapUnitScale (const QgsMapUnitScale &mapUnitScale)
 
static QString encodePenCapStyle (Qt::PenCapStyle style)
 
static QString encodePenJoinStyle (Qt::PenJoinStyle style)
 
static QString encodePenStyle (Qt::PenStyle style)
 
static QString encodePoint (QPointF point)
 Encodes a QPointF to a string. More...
 
static QString encodeRealVector (const QVector< qreal > &v)
 
static QString encodeScaleMethod (QgsSymbol::ScaleMethod scaleMethod)
 
static QString encodeSize (QSizeF size)
 Encodes a QSizeF to a string. More...
 
static QString encodeSldAlpha (int alpha)
 
static QString encodeSldBrushStyle (Qt::BrushStyle style)
 
static QString encodeSldFontStyle (QFont::Style style)
 
static QString encodeSldFontWeight (int weight)
 
static QString encodeSldLineCapStyle (Qt::PenCapStyle style)
 
static QString encodeSldLineJoinStyle (Qt::PenJoinStyle style)
 
static QString encodeSldRealVector (const QVector< qreal > &v)
 
static QString encodeSldUom (QgsUnitTypes::RenderUnit unit, double *scaleFactor)
 Encodes a render unit into an SLD unit of measure string. More...
 
static double estimateMaxSymbolBleed (QgsSymbol *symbol, const QgsRenderContext &context)
 Returns the maximum estimated bleed for the symbol. More...
 
static bool externalGraphicFromSld (QDomElement &element, QString &path, QString &mime, QColor &color, double &size)
 
static void externalGraphicToSld (QDomDocument &doc, QDomElement &element, const QString &path, const QString &mime, const QColor &color, double size=-1)
 
static bool externalMarkerFromSld (QDomElement &element, QString &path, QString &format, int &markIndex, QColor &color, double &size)
 
static void externalMarkerToSld (QDomDocument &doc, QDomElement &element, const QString &path, const QString &format, int *markIndex=nullptr, const QColor &color=QColor(), double size=-1)
 
static QString fieldOrExpressionFromExpression (QgsExpression *expression)
 Returns a field name if the whole expression is just a name of the field . More...
 
static QgsExpression * fieldOrExpressionToExpression (const QString &fieldOrExpression)
 Returns a new valid expression instance for given field or expression string. More...
 
static bool fillFromSld (QDomElement &element, Qt::BrushStyle &brushStyle, QColor &color)
 
static void fillToSld (QDomDocument &doc, QDomElement &element, Qt::BrushStyle brushStyle, const QColor &color=QColor())
 
static bool functionFromSldElement (QDomElement &element, QString &function)
 
static bool geometryFromSldElement (QDomElement &element, QString &geomFunc)
 
static QgsStringMap getSvgParameterList (QDomElement &element)
 
static QString getSvgParametricPath (const QString &basePath, const QColor &fillColor, const QColor &strokeColor, double strokeWidth)
 Encodes a reference to a parametric SVG into a path with parameters according to the SVG Parameters spec. More...
 
static QgsStringMap getVendorOptionList (QDomElement &element)
 
static bool hasExternalGraphic (QDomElement &element)
 
static bool hasWellKnownMark (QDomElement &element)
 
static QgsNamedColorList importColorsFromGpl (QFile &file, bool &ok, QString &name)
 Imports colors from a gpl GIMP palette file. More...
 
static void labelTextToSld (QDomDocument &doc, QDomElement &element, const QString &label, const QFont &font, const QColor &color=QColor(), double size=-1)
 
static bool lineFromSld (QDomElement &element, Qt::PenStyle &penStyle, QColor &color, double &width, Qt::PenJoinStyle *penJoinStyle=nullptr, Qt::PenCapStyle *penCapStyle=nullptr, QVector< qreal > *customDashPattern=nullptr, double *dashOffset=nullptr)
 
static void lineToSld (QDomDocument &doc, QDomElement &element, Qt::PenStyle penStyle, const QColor &color, double width=-1, const Qt::PenJoinStyle *penJoinStyle=nullptr, const Qt::PenCapStyle *penCapStyle=nullptr, const QVector< qreal > *customDashPattern=nullptr, double dashOffset=0.0)
 
static QStringList listSvgFiles ()
 Returns a list of all available svg files. More...
 
static QStringList listSvgFilesAt (const QString &directory)
 Returns a list of svg files at the specified directory. More...
 
static QgsColorRamp * loadColorRamp (QDomElement &element)
 Creates a color ramp from the settings encoded in an XML element. More...
 
static QgsColorRamp * loadColorRamp (const QVariant &value)
 Load a color ramp from a QVariantMap, wrapped in a QVariant. More...
 
static QgsSymbol * loadSymbol (const QDomElement &element, const QgsReadWriteContext &context)
 Attempts to load a symbol from a DOM element. More...
 
template<class SymbolType >
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. More...
 
static QgsSymbolLayer * loadSymbolLayer (QDomElement &element, const QgsReadWriteContext &context)
 Reads and returns symbol layer from XML. Caller is responsible for deleting the returned object. More...
 
static QgsSymbolMap loadSymbols (QDomElement &element, const QgsReadWriteContext &context)
 Reads a collection of symbols from XML and returns them in a map. Caller is responsible for deleting returned symbols. More...
 
static void mergeScaleDependencies (double mScaleMinDenom, double mScaleMaxDenom, QgsStringMap &props)
 Merges the local scale limits, if any, with the ones already in the map, if any. More...
 
static void multiplyImageOpacity (QImage *image, qreal opacity)
 Multiplies opacity of image pixel values with a (global) transparency value. More...
 
static bool needEllipseMarker (QDomElement &element)
 
static bool needFontMarker (QDomElement &element)
 
static bool needLinePatternFill (QDomElement &element)
 
static bool needMarkerLine (QDomElement &element)
 
static bool needPointPatternFill (QDomElement &element)
 
static bool needSvgFill (QDomElement &element)
 
static bool needSvgMarker (QDomElement &element)
 
static QString ogrFeatureStyleBrush (const QColor &fillColr)
 Create ogr feature style string for brush. More...
 
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=nullptr)
 Create ogr feature style string for pen. More...
 
static bool onlineResourceFromSldElement (QDomElement &element, QString &path, QString &format)
 
static bool opacityFromSldElement (QDomElement &element, QString &alphaFunc)
 
static void parametricSvgToSld (QDomDocument &doc, QDomElement &graphicElem, const QString &path, const QColor &fillColor, double size, const QColor &strokeColor, double strokeWidth)
 Encodes a reference to a parametric SVG into SLD, as a succession of parametric SVG using URL parameters, a fallback SVG without parameters, and a final fallback as a mark with the right colors and stroke for systems that cannot do SVG at all. More...
 
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. More...
 
static QList< QColor > parseColorList (const QString &colorStr)
 Attempts to parse a string as a list of colors using a variety of common formats, including hex codes, rgb and rgba strings. More...
 
static QColor parseColorWithAlpha (const QString &colorStr, bool &containsAlpha, bool strictEval=false)
 Attempts to parse a string as a color using a variety of common formats, including hex codes, rgb and rgba strings. More...
 
static QgsStringMap parseProperties (QDomElement &element)
 
static bool pointInPolygon (const QPolygonF &points, QPointF point)
 Calculate whether a point is within of a QPolygonF. More...
 
static QPointF pointOnLineWithDistance (QPointF startPoint, QPointF directionPoint, double distance)
 Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point. More...
 
static QPointF polygonCentroid (const QPolygonF &points)
 Calculate the centroid point of a QPolygonF. More...
 
static QPointF polygonPointOnSurface (const QPolygonF &points, QList< QPolygonF > *rings=nullptr)
 Calculate a point on the surface of a QPolygonF. More...
 
static void premultiplyColor (QColor &rgb, int alpha)
 Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value. More...
 
static QList< double > prettyBreaks (double minimum, double maximum, int classes)
 Computes a sequence of about 'classes' equally spaced round values which cover the range of values from 'minimum' to 'maximum'. More...
 
static double rescaleUom (double size, QgsUnitTypes::RenderUnit unit, const QgsStringMap &props)
 Rescales the given size based on the uomScale found in the props, if any is found, otherwise returns the value un-modified. More...
 
static QPointF rescaleUom (QPointF point, QgsUnitTypes::RenderUnit unit, const QgsStringMap &props)
 Rescales the given point based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point. More...
 
static QVector< qreal > rescaleUom (const QVector< qreal > &array, QgsUnitTypes::RenderUnit unit, const QgsStringMap &props)
 Rescales the given array based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point. More...
 
static bool rotationFromSldElement (QDomElement &element, QString &rotationFunc)
 
static QDomElement saveColorRamp (const QString &name, QgsColorRamp *ramp, QDomDocument &doc)
 Encodes a color ramp's settings to an XML element. More...
 
static bool saveColorsToGpl (QFile &file, const QString &paletteName, const QgsNamedColorList &colors)
 Exports colors to a gpl GIMP palette file. More...
 
static void saveProperties (QgsStringMap props, QDomDocument &doc, QDomElement &element)
 
static QDomElement saveSymbol (const QString &symbolName, QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
 Writes a symbol definition to XML. More...
 
static QDomElement saveSymbols (QgsSymbolMap &symbols, const QString &tagName, QDomDocument &doc, const QgsReadWriteContext &context)
 Writes a collection of symbols to XML with specified tagName for the top-level element. More...
 
static double sizeInPixelsFromSldUom (const QString &uom, double size)
 Returns the size scaled in pixels according to the uom attribute. More...
 
static void sortVariantList (QList< QVariant > &list, Qt::SortOrder order)
 Sorts the passed list in requested order. More...
 
static QString svgSymbolNameToPath (const QString &name, const QgsPathResolver &pathResolver)
 Determines an SVG symbol's path from its name. More...
 
static QString svgSymbolPathToName (const QString &path, const QgsPathResolver &pathResolver)
 Determines an SVG symbol's name from its path. More...
 
static QgsSymbol * symbolFromMimeData (const QMimeData *data)
 Attempts to parse mime data as a symbol. More...
 
static QIcon symbolLayerPreviewIcon (QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit u, QSize size, const QgsMapUnitScale &scale=QgsMapUnitScale())
 Draws a symbol layer preview to an icon. More...
 
static QPicture symbolLayerPreviewPicture (QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit units, QSize size, const QgsMapUnitScale &scale=QgsMapUnitScale())
 Draws a symbol layer preview to a QPicture. More...
 
static QIcon symbolPreviewIcon (QgsSymbol *symbol, QSize size, int padding=0)
 Returns an icon preview for a color ramp. More...
 
static QPixmap symbolPreviewPixmap (QgsSymbol *symbol, QSize size, int padding=0, QgsRenderContext *customContext=nullptr)
 Returns a pixmap preview for a color ramp. More...
 
static QString symbolProperties (QgsSymbol *symbol)
 Returns a string representing the symbol. More...
 
static QMimeData * symbolToMimeData (QgsSymbol *symbol)
 Creates new mime data from a symbol. More...
 
static bool wellKnownMarkerFromSld (QDomElement &element, QString &name, QColor &color, QColor &strokeColor, Qt::PenStyle &strokeStyle, double &strokeWidth, double &size)
 
static void wellKnownMarkerToSld (QDomDocument &doc, QDomElement &element, const QString &name, const QColor &color, const QColor &strokeColor, Qt::PenStyle strokeStyle, double strokeWidth=-1, double size=-1)
 

Detailed Description

Definition at line 54 of file qgssymbollayerutils.h.

Member Enumeration Documentation

enum QgsSymbolLayerUtils::VertexMarkerType

Editing vertex markers.

Enumerator
SemiTransparentCircle 
Cross 
NoMarker 

Definition at line 59 of file qgssymbollayerutils.h.

Member Function Documentation

void QgsSymbolLayerUtils::applyScaleDependency ( QDomDocument &  doc,
QDomElement &  ruleElem,
QgsStringMap &  props 
)
static

Checks if the properties contain scaleMinDenom and scaleMaxDenom, if available, they are added into the SE Rule element.

Since
QGIS 3.0

Definition at line 4226 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::blurImageInPlace ( QImage &  image,
QRect  rect,
int  radius,
bool  alphaOnly 
)
static

Blurs an image in place, e.g. creating Qt-independent drop shadows.

Definition at line 3577 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::clearSymbolMap ( QgsSymbolMap &  symbols)
static

Definition at line 2908 of file qgssymbollayerutils.cpp.

QColor QgsSymbolLayerUtils::colorFromMimeData ( const QMimeData *  data,
bool &  hasAlpha 
)
static

Attempts to parse mime data as a color.

Parameters
datamime data to parse
hasAlphawill 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
Since
QGIS 2.5

Definition at line 3132 of file qgssymbollayerutils.cpp.

QgsNamedColorList QgsSymbolLayerUtils::colorListFromMimeData ( const QMimeData *  data)
static

Attempts to parse mime data as a list of named colors.

Parameters
datamime data to parse
Returns
list of parsed colors
Since
QGIS 2.5

Definition at line 3154 of file qgssymbollayerutils.cpp.

QMimeData * QgsSymbolLayerUtils::colorListToMimeData ( const QgsNamedColorList &  colorList,
bool  allFormats = true 
)
static

Creates mime data from a list of named colors.

Parameters
colorListlist of named colors
allFormatsset to true to include additional mime formats, include text/plain and application/x-color
Returns
mime data containing encoded colors
Since
QGIS 2.5

Definition at line 3267 of file qgssymbollayerutils.cpp.

QIcon QgsSymbolLayerUtils::colorRampPreviewIcon ( QgsColorRamp *  ramp,
QSize  size,
int  padding = 0 
)
static

Returns an icon preview for a color ramp.

Parameters
rampcolor ramp
sizetarget icon size
paddingspace between icon edge and color ramp
See also
colorRampPreviewPixmap()

Definition at line 744 of file qgssymbollayerutils.cpp.

QPixmap QgsSymbolLayerUtils::colorRampPreviewPixmap ( QgsColorRamp *  ramp,
QSize  size,
int  padding = 0 
)
static

Returns a pixmap preview for a color ramp.

Parameters
rampcolor ramp
sizetarget pixmap size
paddingspace between icon edge and color ramp
See also
colorRampPreviewIcon()

Definition at line 749 of file qgssymbollayerutils.cpp.

QVariant QgsSymbolLayerUtils::colorRampToVariant ( const QString &  name,
QgsColorRamp *  ramp 
)
static

Saves a color ramp to a QVariantMap, wrapped in a QVariant.

You can use QgsXmlUtils::writeVariant to save it to an XML document.

See also
loadColorRamp( const QVariant &value )

Definition at line 2992 of file qgssymbollayerutils.cpp.

QMimeData * QgsSymbolLayerUtils::colorToMimeData ( const QColor &  color)
static

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.

Parameters
colorcolor to encode as mime data
See also
colorFromMimeData
Since
QGIS 2.5

Definition at line 3122 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::colorToName ( const QColor &  color)
static

Returns a friendly display name for a color.

Parameters
colorsource color
Returns
display name for color
Since
QGIS 2.5

Definition at line 3043 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::convertPolygonSymbolizerToPointMarker ( QDomElement &  element,
QgsSymbolLayerList &  layerList 
)
static

Definition at line 1510 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::createAnchorPointElement ( QDomDocument &  doc,
QDomElement &  element,
QPointF  anchor 
)
static

Creates a SE 1.1 anchor point element as a child of the specified element.

Parameters
docThe document
elementThe parent element
anchorAn anchor specification, with values between 0 and 1

Definition at line 2410 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::createDisplacementElement ( QDomDocument &  doc,
QDomElement &  element,
QPointF  offset 
)
static

Definition at line 2392 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::createExpressionElement ( QDomDocument &  doc,
QDomElement &  element,
const QString &  function 
)
static

Creates a OGC Expression element based on the provided function expression.

Parameters
docThe document owning the element
elementThe element parent
functionThe expression to be encoded

Definition at line 2610 of file qgssymbollayerutils.cpp.

QgsSymbolLayer * QgsSymbolLayerUtils::createFillLayerFromSld ( QDomElement &  element)
static

Definition at line 1258 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::createFunctionElement ( QDomDocument &  doc,
QDomElement &  element,
const QString &  function 
)
static

Definition at line 2626 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::createGeometryElement ( QDomDocument &  doc,
QDomElement &  element,
const QString &  geomFunc 
)
static

Definition at line 2567 of file qgssymbollayerutils.cpp.

QgsSymbolLayer * QgsSymbolLayerUtils::createLineLayerFromSld ( QDomElement &  element)
static

Definition at line 1281 of file qgssymbollayerutils.cpp.

QgsSymbolLayer * QgsSymbolLayerUtils::createMarkerLayerFromSld ( QDomElement &  element)
static

Definition at line 1300 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::createOnlineResourceElement ( QDomDocument &  doc,
QDomElement &  element,
const QString &  path,
const QString &  format 
)
static

Definition at line 2678 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::createOpacityElement ( QDomDocument &  doc,
QDomElement &  element,
const QString &  alphaFunc 
)
static

Definition at line 2372 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::createRotationElement ( QDomDocument &  doc,
QDomElement &  element,
const QString &  rotationFunc 
)
static

Definition at line 2351 of file qgssymbollayerutils.cpp.

QDomElement QgsSymbolLayerUtils::createSvgParameterElement ( QDomDocument &  doc,
const QString &  name,
const QString &  value 
)
static

Definition at line 2712 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::createSymbolLayerListFromSld ( QDomElement &  element,
QgsWkbTypes::GeometryType  geomType,
QgsSymbolLayerList &  layers 
)
static

Definition at line 1108 of file qgssymbollayerutils.cpp.

QDomElement QgsSymbolLayerUtils::createVendorOptionElement ( QDomDocument &  doc,
const QString &  name,
const QString &  value 
)
static

Definition at line 2759 of file qgssymbollayerutils.cpp.

QgsArrowSymbolLayer::HeadType QgsSymbolLayerUtils::decodeArrowHeadType ( const QVariant &  value,
bool *  ok = nullptr 
)
static

Decodes a value representing an arrow head type.

Since
QGIS 3.2

Definition at line 374 of file qgssymbollayerutils.cpp.

QgsArrowSymbolLayer::ArrowType QgsSymbolLayerUtils::decodeArrowType ( const QVariant &  value,
bool *  ok = nullptr 
)
static

Decodes a value representing an arrow type.

Since
QGIS 3.2

Definition at line 399 of file qgssymbollayerutils.cpp.

QPainter::CompositionMode QgsSymbolLayerUtils::decodeBlendMode ( const QString &  s)
static

Definition at line 631 of file qgssymbollayerutils.cpp.

Qt::BrushStyle QgsSymbolLayerUtils::decodeBrushStyle ( const QString &  str)
static

Definition at line 302 of file qgssymbollayerutils.cpp.

QColor QgsSymbolLayerUtils::decodeColor ( const QString &  str)
static

Definition at line 53 of file qgssymbollayerutils.cpp.

QgsMapUnitScale QgsSymbolLayerUtils::decodeMapUnitScale ( const QString &  str)
static

Definition at line 460 of file qgssymbollayerutils.cpp.

Qt::PenCapStyle QgsSymbolLayerUtils::decodePenCapStyle ( const QString &  str)
static

Definition at line 232 of file qgssymbollayerutils.cpp.

Qt::PenJoinStyle QgsSymbolLayerUtils::decodePenJoinStyle ( const QString &  str)
static

Definition at line 186 of file qgssymbollayerutils.cpp.

Qt::PenStyle QgsSymbolLayerUtils::decodePenStyle ( const QString &  str)
static

Definition at line 160 of file qgssymbollayerutils.cpp.

QPointF QgsSymbolLayerUtils::decodePoint ( const QString &  string)
static

Decodes a QSizeF from a string.

See also
encodePoint()
decodeSize()

Definition at line 429 of file qgssymbollayerutils.cpp.

QVector< qreal > QgsSymbolLayerUtils::decodeRealVector ( const QString &  s)
static

Definition at line 556 of file qgssymbollayerutils.cpp.

QgsSymbol::ScaleMethod QgsSymbolLayerUtils::decodeScaleMethod ( const QString &  str)
static

Definition at line 615 of file qgssymbollayerutils.cpp.

QSizeF QgsSymbolLayerUtils::decodeSize ( const QString &  string)
static

Decodes a QSizeF from a string.

See also
encodeSize()
decodePoint()
Since
QGIS 3.0

Definition at line 442 of file qgssymbollayerutils.cpp.

int QgsSymbolLayerUtils::decodeSldAlpha ( const QString &  str)
static

Definition at line 79 of file qgssymbollayerutils.cpp.

Qt::BrushStyle QgsSymbolLayerUtils::decodeSldBrushStyle ( const QString &  str)
static

Definition at line 359 of file qgssymbollayerutils.cpp.

QFont::Style QgsSymbolLayerUtils::decodeSldFontStyle ( const QString &  str)
static

Definition at line 105 of file qgssymbollayerutils.cpp.

int QgsSymbolLayerUtils::decodeSldFontWeight ( const QString &  str)
static

Definition at line 125 of file qgssymbollayerutils.cpp.

Qt::PenCapStyle QgsSymbolLayerUtils::decodeSldLineCapStyle ( const QString &  str)
static

Definition at line 255 of file qgssymbollayerutils.cpp.

Qt::PenJoinStyle QgsSymbolLayerUtils::decodeSldLineJoinStyle ( const QString &  str)
static

Definition at line 209 of file qgssymbollayerutils.cpp.

QVector< qreal > QgsSymbolLayerUtils::decodeSldRealVector ( const QString &  s)
static

Definition at line 585 of file qgssymbollayerutils.cpp.

QgsUnitTypes::RenderUnit QgsSymbolLayerUtils::decodeSldUom ( const QString &  str,
double *  scaleFactor 
)
static

Decodes a SLD unit of measure string to a render unit.

Parameters
strstring to decode
scaleFactorif specified, will be set to scale factor for unit of measure
Returns
matching render unit
See also
encodeSldUom()

Definition at line 519 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::displacementFromSldElement ( QDomElement &  element,
QPointF &  offset 
)
static

Definition at line 2427 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::drawStippledBackground ( QPainter *  painter,
QRect  rect 
)
static

Definition at line 772 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::drawVertexMarker ( double  x,
double  y,
QPainter &  p,
QgsSymbolLayerUtils::VertexMarkerType  type,
int  markerSize 
)
static

Draws a vertex symbol at (painter) coordinates x, y.

(Useful to assist vertex editing.)

Since
QGIS 3.4.5

Definition at line 791 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeBrushStyle ( Qt::BrushStyle  style)
static

Definition at line 263 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeColor ( const QColor &  color)
static

Definition at line 48 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeMapUnitScale ( const QgsMapUnitScale &  mapUnitScale)
static

Definition at line 450 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodePenCapStyle ( Qt::PenCapStyle  style)
static

Definition at line 217 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodePenJoinStyle ( Qt::PenJoinStyle  style)
static

Definition at line 171 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodePenStyle ( Qt::PenStyle  style)
static

Definition at line 139 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodePoint ( QPointF  point)
static

Encodes a QPointF to a string.

See also
decodePoint()
encodeSize()

Definition at line 424 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeRealVector ( const QVector< qreal > &  v)
static

Definition at line 541 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeScaleMethod ( QgsSymbol::ScaleMethod  scaleMethod)
static

Definition at line 599 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSize ( QSizeF  size)
static

Encodes a QSizeF to a string.

See also
decodeSize()
encodePoint()
Since
QGIS 3.0

Definition at line 437 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldAlpha ( int  alpha)
static

Definition at line 72 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldBrushStyle ( Qt::BrushStyle  style)
static

Definition at line 322 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldFontStyle ( QFont::Style  style)
static

Definition at line 90 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldFontWeight ( int  weight)
static

Definition at line 113 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldLineCapStyle ( Qt::PenCapStyle  style)
static

Definition at line 240 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldLineJoinStyle ( Qt::PenJoinStyle  style)
static

Definition at line 194 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldRealVector ( const QVector< qreal > &  v)
static

Definition at line 570 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::encodeSldUom ( QgsUnitTypes::RenderUnit  unit,
double *  scaleFactor 
)
static

Encodes a render unit into an SLD unit of measure string.

Parameters
unitunit to encode
scaleFactorif specified, will be set to scale factor for unit of measure
Returns
encoded string
See also
decodeSldUom()

Definition at line 498 of file qgssymbollayerutils.cpp.

double QgsSymbolLayerUtils::estimateMaxSymbolBleed ( QgsSymbol *  symbol,
const QgsRenderContext &  context 
)
static

Returns the maximum estimated bleed for the symbol.

Definition at line 698 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::externalGraphicFromSld ( QDomElement &  element,
QString &  path,
QString &  mime,
QColor &  color,
double &  size 
)
static

Definition at line 2169 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::externalGraphicToSld ( QDomDocument &  doc,
QDomElement &  element,
const QString &  path,
const QString &  mime,
const QColor &  color,
double  size = -1 
)
static

Definition at line 2086 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::externalMarkerFromSld ( QDomElement &  element,
QString &  path,
QString &  format,
int &  markIndex,
QColor &  color,
double &  size 
)
static

Definition at line 2224 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::externalMarkerToSld ( QDomDocument &  doc,
QDomElement &  element,
const QString &  path,
const QString &  format,
int *  markIndex = nullptr,
const QColor &  color = QColor(),
double  size = -1 
)
static

Definition at line 2194 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::fieldOrExpressionFromExpression ( QgsExpression *  expression)
static

Returns 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.

Since
QGIS 2.2

Definition at line 3959 of file qgssymbollayerutils.cpp.

QgsExpression * QgsSymbolLayerUtils::fieldOrExpressionToExpression ( const QString &  fieldOrExpression)
static

Returns 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.

Since
QGIS 2.2

Definition at line 3943 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::fillFromSld ( QDomElement &  element,
Qt::BrushStyle &  brushStyle,
QColor &  color 
)
static

Definition at line 1817 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::fillToSld ( QDomDocument &  doc,
QDomElement &  element,
Qt::BrushStyle  brushStyle,
const QColor &  color = QColor() 
)
static

Definition at line 1766 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::functionFromSldElement ( QDomElement &  element,
QString &  function 
)
static

Definition at line 2641 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::geometryFromSldElement ( QDomElement &  element,
QString &  geomFunc 
)
static

Definition at line 2601 of file qgssymbollayerutils.cpp.

QgsStringMap QgsSymbolLayerUtils::getSvgParameterList ( QDomElement &  element)
static

Definition at line 2720 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::getSvgParametricPath ( const QString &  basePath,
const QColor &  fillColor,
const QColor &  strokeColor,
double  strokeWidth 
)
static

Encodes a reference to a parametric SVG into a path with parameters according to the SVG Parameters spec.

Since
QGIS 3.0

Definition at line 2134 of file qgssymbollayerutils.cpp.

QgsStringMap QgsSymbolLayerUtils::getVendorOptionList ( QDomElement &  element)
static

Definition at line 2767 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::hasExternalGraphic ( QDomElement &  element)
static

Definition at line 1323 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::hasWellKnownMark ( QDomElement &  element)
static

Definition at line 1364 of file qgssymbollayerutils.cpp.

QgsNamedColorList QgsSymbolLayerUtils::importColorsFromGpl ( QFile &  file,
bool &  ok,
QString &  name 
)
static

Imports colors from a gpl GIMP palette file.

Parameters
filesource gpl file
okwill be true if file was successfully read
namewill be set to palette name from gpl file, if present
Returns
list of imported colors
See also
saveColorsToGpl

Definition at line 3343 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::labelTextToSld ( QDomDocument &  doc,
QDomElement &  element,
const QString &  label,
const QFont &  font,
const QColor &  color = QColor(),
double  size = -1 
)
static

Definition at line 2456 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::lineFromSld ( QDomElement &  element,
Qt::PenStyle &  penStyle,
QColor &  color,
double &  width,
Qt::PenJoinStyle *  penJoinStyle = nullptr,
Qt::PenCapStyle *  penCapStyle = nullptr,
QVector< qreal > *  customDashPattern = nullptr,
double *  dashOffset = nullptr 
)
static

Definition at line 1955 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::lineToSld ( QDomDocument &  doc,
QDomElement &  element,
Qt::PenStyle  penStyle,
const QColor &  color,
double  width = -1,
const Qt::PenJoinStyle *  penJoinStyle = nullptr,
const Qt::PenCapStyle *  penCapStyle = nullptr,
const QVector< qreal > *  customDashPattern = nullptr,
double  dashOffset = 0.0 
)
static
Note
not available in Python bindings

Definition at line 1871 of file qgssymbollayerutils.cpp.

QStringList QgsSymbolLayerUtils::listSvgFiles ( )
static

Returns a list of all available svg files.

Definition at line 3698 of file qgssymbollayerutils.cpp.

QStringList QgsSymbolLayerUtils::listSvgFilesAt ( const QString &  directory)
static

Returns a list of svg files at the specified directory.

Definition at line 3722 of file qgssymbollayerutils.cpp.

QgsColorRamp * QgsSymbolLayerUtils::loadColorRamp ( QDomElement &  element)
static

Creates a color ramp from the settings encoded in an XML element.

Parameters
elementDOM element
Returns
new color ramp. Caller takes responsibility for deleting the returned value.
See also
saveColorRamp()

Definition at line 2957 of file qgssymbollayerutils.cpp.

QgsColorRamp * QgsSymbolLayerUtils::loadColorRamp ( const QVariant &  value)
static

Load a color ramp from a QVariantMap, wrapped in a QVariant.

You can use QgsXmlUtils::readVariant to load it from an XML document.

See also
colorRampToVariant()

Definition at line 3011 of file qgssymbollayerutils.cpp.

QgsSymbol * QgsSymbolLayerUtils::loadSymbol ( const QDomElement &  element,
const QgsReadWriteContext &  context 
)
static

Attempts to load a symbol from a DOM element.

Parameters
elementDOM element representing symbol
contextobject to transform relative to absolute paths
Returns
decoded symbol, if possible

Definition at line 915 of file qgssymbollayerutils.cpp.

template<class SymbolType >
static SymbolType* QgsSymbolLayerUtils::loadSymbol ( const QDomElement &  element,
const QgsReadWriteContext &  context 
)
inlinestatic

Attempts to load a symbol from a DOM element and cast it to a particular symbol type.

Parameters
elementDOM element representing symbol
contextobject to transform relative to absolute paths
Returns
decoded symbol cast to specified type, if possible
Note
not available in Python bindings

Definition at line 270 of file qgssymbollayerutils.h.

QgsSymbolLayer * QgsSymbolLayerUtils::loadSymbolLayer ( QDomElement &  element,
const QgsReadWriteContext &  context 
)
static

Reads and returns symbol layer from XML. Caller is responsible for deleting the returned object.

Definition at line 993 of file qgssymbollayerutils.cpp.

QgsSymbolMap QgsSymbolLayerUtils::loadSymbols ( QDomElement &  element,
const QgsReadWriteContext &  context 
)
static

Reads a collection of symbols from XML and returns them in a map. Caller is responsible for deleting returned symbols.

Definition at line 2816 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::mergeScaleDependencies ( double  mScaleMinDenom,
double  mScaleMaxDenom,
QgsStringMap &  props 
)
static

Merges the local scale limits, if any, with the ones already in the map, if any.

Since
QGIS 3.0

Definition at line 4243 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::multiplyImageOpacity ( QImage *  image,
qreal  opacity 
)
static

Multiplies opacity of image pixel values with a (global) transparency value.

Definition at line 3547 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::needEllipseMarker ( QDomElement &  element)
static

Definition at line 1424 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::needFontMarker ( QDomElement &  element)
static

Definition at line 1379 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::needLinePatternFill ( QDomElement &  element)
static

Definition at line 1455 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::needMarkerLine ( QDomElement &  element)
static

Definition at line 1442 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::needPointPatternFill ( QDomElement &  element)
static

Definition at line 1490 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::needSvgFill ( QDomElement &  element)
static

Definition at line 1496 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::needSvgMarker ( QDomElement &  element)
static

Definition at line 1419 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::ogrFeatureStyleBrush ( const QColor &  fillColr)
static

Create ogr feature style string for brush.

Parameters
fillColrfill color

Definition at line 2557 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::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 = nullptr 
)
static

Create ogr feature style string for pen.

Definition at line 2483 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::onlineResourceFromSldElement ( QDomElement &  element,
QString &  path,
QString &  format 
)
static

Definition at line 2693 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::opacityFromSldElement ( QDomElement &  element,
QString &  alphaFunc 
)
static

Definition at line 2382 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::parametricSvgToSld ( QDomDocument &  doc,
QDomElement &  graphicElem,
const QString &  path,
const QColor &  fillColor,
double  size,
const QColor &  strokeColor,
double  strokeWidth 
)
static

Encodes a reference to a parametric SVG into SLD, as a succession of parametric SVG using URL parameters, a fallback SVG without parameters, and a final fallback as a mark with the right colors and stroke for systems that cannot do SVG at all.

Since
QGIS 3.0

Definition at line 2106 of file qgssymbollayerutils.cpp.

QColor QgsSymbolLayerUtils::parseColor ( const QString &  colorStr,
bool  strictEval = false 
)
static

Attempts to parse a string as a color using a variety of common formats, including hex codes, rgb and rgba strings.

Parameters
colorStrstring representing the color
strictEvalset to true for stricter color parsing rules
Returns
parsed color
Since
QGIS 2.3

Definition at line 3424 of file qgssymbollayerutils.cpp.

QList< QColor > QgsSymbolLayerUtils::parseColorList ( const QString &  colorStr)
static

Attempts to parse a string as a list of colors using a variety of common formats, including hex codes, rgb and rgba strings.

Parameters
colorStrstring representing the color list
Returns
list of parsed colors
Since
QGIS 2.5

Definition at line 3055 of file qgssymbollayerutils.cpp.

QColor QgsSymbolLayerUtils::parseColorWithAlpha ( const QString &  colorStr,
bool &  containsAlpha,
bool  strictEval = false 
)
static

Attempts to parse a string as a color using a variety of common formats, including hex codes, rgb and rgba strings.

Parameters
colorStrstring representing the color
containsAlphaif colorStr contains an explicit alpha value then containsAlpha will be set to true
strictEvalset to true for stricter color parsing rules
Returns
parsed color
Since
QGIS 2.3

Definition at line 3430 of file qgssymbollayerutils.cpp.

QgsStringMap QgsSymbolLayerUtils::parseProperties ( QDomElement &  element)
static

Definition at line 2787 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::pointInPolygon ( const QPolygonF &  points,
QPointF  point 
)
static

Calculate whether a point is within of a QPolygonF.

Definition at line 3917 of file qgssymbollayerutils.cpp.

QPointF QgsSymbolLayerUtils::pointOnLineWithDistance ( QPointF  startPoint,
QPointF  directionPoint,
double  distance 
)
static

Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point.

Definition at line 3688 of file qgssymbollayerutils.cpp.

QPointF QgsSymbolLayerUtils::polygonCentroid ( const QPolygonF &  points)
static

Calculate the centroid point of a QPolygonF.

Definition at line 3848 of file qgssymbollayerutils.cpp.

QPointF QgsSymbolLayerUtils::polygonPointOnSurface ( const QPolygonF &  points,
QList< QPolygonF > *  rings = nullptr 
)
static

Calculate a point on the surface of a QPolygonF.

Definition at line 3880 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::premultiplyColor ( QColor &  rgb,
int  alpha 
)
static

Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value.

Since
QGIS 2.3

Definition at line 3653 of file qgssymbollayerutils.cpp.

QList< double > QgsSymbolLayerUtils::prettyBreaks ( double  minimum,
double  maximum,
int  classes 
)
static

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.

Since
QGIS 2.10

Definition at line 3969 of file qgssymbollayerutils.cpp.

double QgsSymbolLayerUtils::rescaleUom ( double  size,
QgsUnitTypes::RenderUnit  unit,
const QgsStringMap &  props 
)
static

Rescales the given size based on the uomScale found in the props, if any is found, otherwise returns the value un-modified.

Since
QGIS 3.0

Definition at line 4131 of file qgssymbollayerutils.cpp.

QPointF QgsSymbolLayerUtils::rescaleUom ( QPointF  point,
QgsUnitTypes::RenderUnit  unit,
const QgsStringMap &  props 
)
static

Rescales the given point based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point.

Since
QGIS 3.0

Definition at line 4208 of file qgssymbollayerutils.cpp.

QVector< qreal > QgsSymbolLayerUtils::rescaleUom ( const QVector< qreal > &  array,
QgsUnitTypes::RenderUnit  unit,
const QgsStringMap &  props 
)
static

Rescales the given array based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point.

Since
QGIS 3.0

Definition at line 4215 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::rotationFromSldElement ( QDomElement &  element,
QString &  rotationFunc 
)
static

Definition at line 2361 of file qgssymbollayerutils.cpp.

QDomElement QgsSymbolLayerUtils::saveColorRamp ( const QString &  name,
QgsColorRamp *  ramp,
QDomDocument &  doc 
)
static

Encodes a color ramp's settings to an XML element.

Parameters
namename of ramp
rampcolor ramp to save
docXML document
Returns
DOM element representing state of color ramp
See also
loadColorRamp()

Definition at line 2982 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::saveColorsToGpl ( QFile &  file,
const QString &  paletteName,
const QgsNamedColorList &  colors 
)
static

Exports colors to a gpl GIMP palette file.

Parameters
filedestination file
paletteNamename of palette, which is stored in gpl file
colorscolors to export
Returns
true if export was successful
See also
importColorsFromGpl

Definition at line 3308 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::saveProperties ( QgsStringMap  props,
QDomDocument &  doc,
QDomElement &  element 
)
static

Definition at line 2805 of file qgssymbollayerutils.cpp.

QDomElement QgsSymbolLayerUtils::saveSymbol ( const QString &  symbolName,
QgsSymbol *  symbol,
QDomDocument &  doc,
const QgsReadWriteContext &  context 
)
static

Writes a symbol definition to XML.

Definition at line 1052 of file qgssymbollayerutils.cpp.

QDomElement QgsSymbolLayerUtils::saveSymbols ( QgsSymbolMap &  symbols,
const QString &  tagName,
QDomDocument &  doc,
const QgsReadWriteContext &  context 
)
static

Writes a collection of symbols to XML with specified tagName for the top-level element.

Definition at line 2894 of file qgssymbollayerutils.cpp.

double QgsSymbolLayerUtils::sizeInPixelsFromSldUom ( const QString &  uom,
double  size 
)
static

Returns the size scaled in pixels according to the uom attribute.

Parameters
uomThe uom attribute from SLD 1.1 version
sizeThe original size
Returns
the size in pixels
Since
QGIS 3.0

Definition at line 4266 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::sortVariantList ( QList< QVariant > &  list,
Qt::SortOrder  order 
)
static

Sorts the passed list in requested order.

Definition at line 3674 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::svgSymbolNameToPath ( const QString &  name,
const QgsPathResolver &  pathResolver 
)
static

Determines an SVG symbol's path from its name.

If name is not an absolute path the file is scanned for in the SVG paths specified in settings svg/searchPathsForSVG.

See also
svgSymbolPathToName()

Definition at line 3747 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::svgSymbolPathToName ( const QString &  path,
const QgsPathResolver &  pathResolver 
)
static

Determines an SVG symbol's name from its path.

See also
svgSymbolNameToPath()

Definition at line 3813 of file qgssymbollayerutils.cpp.

QgsSymbol * QgsSymbolLayerUtils::symbolFromMimeData ( const QMimeData *  data)
static

Attempts to parse mime data as a symbol.

A new symbol instance will be returned if the data was successfully converted to a symbol.

See also
symbolToMimeData()
Since
QGIS 3.0

Definition at line 2932 of file qgssymbollayerutils.cpp.

QIcon QgsSymbolLayerUtils::symbolLayerPreviewIcon ( QgsSymbolLayer *  layer,
QgsUnitTypes::RenderUnit  u,
QSize  size,
const QgsMapUnitScale &  scale = QgsMapUnitScale() 
)
static

Draws a symbol layer preview to an icon.

Parameters
layersymbol layer to draw
usize units
sizetarget size of preview icon
scalemap unit scale for preview
Returns
icon containing symbol layer preview
See also
symbolLayerPreviewPicture()

Definition at line 725 of file qgssymbollayerutils.cpp.

QPicture QgsSymbolLayerUtils::symbolLayerPreviewPicture ( QgsSymbolLayer *  layer,
QgsUnitTypes::RenderUnit  units,
QSize  size,
const QgsMapUnitScale &  scale = QgsMapUnitScale() 
)
static

Draws a symbol layer preview to a QPicture.

Parameters
layersymbol layer to draw
unitssize units
sizetarget size of preview picture
scalemap unit scale for preview
Returns
QPicture containing symbol layer preview
See also
symbolLayerPreviewIcon()
Since
QGIS 2.9

Definition at line 711 of file qgssymbollayerutils.cpp.

QIcon QgsSymbolLayerUtils::symbolPreviewIcon ( QgsSymbol *  symbol,
QSize  size,
int  padding = 0 
)
static

Returns an icon preview for a color ramp.

Parameters
symbolsymbol
sizetarget pixmap size
paddingspace between icon edge and symbol
See also
symbolPreviewPixmap()

Definition at line 648 of file qgssymbollayerutils.cpp.

QPixmap QgsSymbolLayerUtils::symbolPreviewPixmap ( QgsSymbol *  symbol,
QSize  size,
int  padding = 0,
QgsRenderContext *  customContext = nullptr 
)
static

Returns a pixmap preview for a color ramp.

Parameters
symbolsymbol
sizetarget pixmap size
paddingspace between icon edge and symbol
customContextrender context to use when rendering symbol
Note
Parameter customContext added in QGIS 2.6
See also
symbolPreviewIcon()

Definition at line 653 of file qgssymbollayerutils.cpp.

QString QgsSymbolLayerUtils::symbolProperties ( QgsSymbol *  symbol)
static

Returns a string representing the symbol.

Can be used to test for equality between symbols.

Since
QGIS 2.12

Definition at line 1098 of file qgssymbollayerutils.cpp.

QMimeData * QgsSymbolLayerUtils::symbolToMimeData ( QgsSymbol *  symbol)
static

Creates new mime data from a symbol.

This also sets the mime color data to match the symbol's color, so that copied symbols can be paste in places where a color is expected.

See also
symbolFromMimeData()
Since
QGIS 3.0

Definition at line 2914 of file qgssymbollayerutils.cpp.

bool QgsSymbolLayerUtils::wellKnownMarkerFromSld ( QDomElement &  element,
QString &  name,
QColor &  color,
QColor &  strokeColor,
Qt::PenStyle &  strokeStyle,
double &  strokeWidth,
double &  size 
)
static
Note
available in Python as wellKnownMarkerFromSld2

Definition at line 2304 of file qgssymbollayerutils.cpp.

void QgsSymbolLayerUtils::wellKnownMarkerToSld ( QDomDocument &  doc,
QDomElement &  element,
const QString &  name,
const QColor &  color,
const QColor &  strokeColor,
Qt::PenStyle  strokeStyle,
double  strokeWidth = -1,
double  size = -1 
)
static

Definition at line 2268 of file qgssymbollayerutils.cpp.

The documentation for this class was generated from the following files:
Generated on Sun Jan 19 2020 15:27:13 for QGIS API Documentation by   doxygen 1.8.11