QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
QgsMapBoxGlStyleConverter Class Reference

Handles conversion of MapBox GL styles to QGIS vector tile renderers and labeling settings. More...

#include <qgsmapboxglstyleconverter.h>

Public Types

enum  Result { Success = 0 , NoLayerList = 1 }
 Result of conversion. More...
 

Public Member Functions

 QgsMapBoxGlStyleConverter ()
 Constructor for QgsMapBoxGlStyleConverter. More...
 
 QgsMapBoxGlStyleConverter (const QgsMapBoxGlStyleConverter &other)=delete
 QgsMapBoxGlStyleConverter cannot be copied. More...
 
 ~QgsMapBoxGlStyleConverter ()
 
Result convert (const QString &style, QgsMapBoxGlStyleConversionContext *context=nullptr)
 Converts a JSON style string, and returns the resultant status of the conversion. More...
 
Result convert (const QVariantMap &style, QgsMapBoxGlStyleConversionContext *context=nullptr)
 Converts a JSON style map, and returns the resultant status of the conversion. More...
 
QString errorMessage () const
 Returns a descriptive error message if an error was encountered during the style conversion, or an empty string if no error was encountered. More...
 
QgsVectorTileLabelinglabeling () const
 Returns a new instance of a vector tile labeling representing the converted style, or nullptr if the style could not be converted successfully. More...
 
QgsMapBoxGlStyleConverteroperator= (const QgsMapBoxGlStyleConverter &other)=delete
 QgsMapBoxGlStyleConverter cannot be copied. More...
 
QgsVectorTileRendererrenderer () const
 Returns a new instance of a vector tile renderer representing the converted style, or nullptr if the style could not be converted successfully. More...
 
QStringList warnings () const
 Returns a list of user-friendly warnings generated during the conversion, e.g. More...
 

Protected Types

enum  PropertyType { Color , Numeric , Opacity , Point }
 Property types, for interpolated value conversion. More...
 

Protected Member Functions

void parseLayers (const QVariantList &layers, QgsMapBoxGlStyleConversionContext *context=nullptr)
 Parse list of layers from JSON. More...
 

Static Protected Member Functions

static void colorAsHslaComponents (const QColor &color, int &hue, int &saturation, int &lightness, int &alpha)
 Takes a QColor object and returns HSLA components in required format for QGIS color_hsla() expression function. More...
 
static QString interpolateExpression (double zoomMin, double zoomMax, QVariant valueMin, QVariant valueMax, double base, double multiplier=1, QgsMapBoxGlStyleConversionContext *contextPtr=0)
 Generates an interpolation for values between valueMin and valueMax, scaled between the ranges zoomMin to zoomMax. More...
 
static QString parseArrayStops (const QVariantList &stops, QgsMapBoxGlStyleConversionContext &context, double multiplier=1)
 Takes numerical arrays from stops. More...
 
static Qt::PenCapStyle parseCapStyle (const QString &style)
 Converts a value to Qt::PenCapStyle enum from JSON value. More...
 
static bool parseCircleLayer (const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &style, QgsMapBoxGlStyleConversionContext &context)
 Parses a circle layer. More...
 
static QColor parseColor (const QVariant &color, QgsMapBoxGlStyleConversionContext &context)
 Parses a color in one of these supported formats: More...
 
static QString parseColorExpression (const QVariant &colorExpression, QgsMapBoxGlStyleConversionContext &context)
 Converts an expression representing a color to a string (can be color string or an expression where a color is expected) More...
 
static QString parseExpression (const QVariantList &expression, QgsMapBoxGlStyleConversionContext &context, bool colorExpected=false)
 Converts a MapBox GL expression to a QGIS expression. More...
 
static bool parseFillLayer (const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &style, QgsMapBoxGlStyleConversionContext &context, bool isBackgroundStyle=false)
 Parses a fill layer. More...
 
static QgsProperty parseInterpolateByZoom (const QVariantMap &json, QgsMapBoxGlStyleConversionContext &context, double multiplier=1, double *defaultNumber=nullptr)
 Parses a numeric value which is interpolated by zoom range. More...
 
static QgsProperty parseInterpolateColorByZoom (const QVariantMap &json, QgsMapBoxGlStyleConversionContext &context, QColor *defaultColor=nullptr)
 Parses a color value which is interpolated by zoom range. More...
 
static QgsProperty parseInterpolateListByZoom (const QVariantList &json, PropertyType type, QgsMapBoxGlStyleConversionContext &context, double multiplier=1, int maxOpacity=255, QColor *defaultColor=nullptr, double *defaultNumber=nullptr)
 Interpolates a list which starts with the interpolate function. More...
 
static QgsProperty parseInterpolateOpacityByZoom (const QVariantMap &json, int maxOpacity, QgsMapBoxGlStyleConversionContext *contextPtr=0)
 Interpolates opacity with either scale_linear() or scale_exp() (depending on base value). More...
 
static QgsProperty parseInterpolatePointByZoom (const QVariantMap &json, QgsMapBoxGlStyleConversionContext &context, double multiplier=1, QPointF *defaultPoint=nullptr)
 Interpolates a point/offset with either scale_linear() or scale_exp() (depending on base value). More...
 
static QgsProperty parseInterpolateStringByZoom (const QVariantMap &json, QgsMapBoxGlStyleConversionContext &context, const QVariantMap &conversionMap, QString *defaultString=nullptr)
 Interpolates a string by zoom. More...
 
static Qt::PenJoinStyle parseJoinStyle (const QString &style)
 Converts a value to Qt::PenJoinStyle enum from JSON value. More...
 
static bool parseLineLayer (const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &style, QgsMapBoxGlStyleConversionContext &context)
 Parses a line layer. More...
 
static QgsProperty parseMatchList (const QVariantList &json, PropertyType type, QgsMapBoxGlStyleConversionContext &context, double multiplier=1, int maxOpacity=255, QColor *defaultColor=nullptr, double *defaultNumber=nullptr)
 Parses and converts a match function value list. More...
 
static QString parseOpacityStops (double base, const QVariantList &stops, int maxOpacity, QgsMapBoxGlStyleConversionContext &context)
 Takes values from stops and uses either scale_linear() or scale_exp() functions to interpolate alpha component of color. More...
 
static QString parsePointStops (double base, const QVariantList &stops, QgsMapBoxGlStyleConversionContext &context, double multiplier=1)
 Takes values from stops and uses either scale_linear() or scale_exp() functions to interpolate point/offset values. More...
 
static QString parseStops (double base, const QVariantList &stops, double multiplier, QgsMapBoxGlStyleConversionContext &context)
 Parses a list of interpolation stops. More...
 
static QString parseStringStops (const QVariantList &stops, QgsMapBoxGlStyleConversionContext &context, const QVariantMap &conversionMap, QString *defaultString=nullptr)
 Parses a list of interpolation stops containing string values. More...
 
static void parseSymbolLayer (const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &rendererStyle, bool &hasRenderer, QgsVectorTileBasicLabelingStyle &labelingStyle, bool &hasLabeling, QgsMapBoxGlStyleConversionContext &context)
 Parses a symbol layer as renderer or labeling. More...
 
static bool parseSymbolLayerAsRenderer (const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &rendererStyle, QgsMapBoxGlStyleConversionContext &context)
 Parses a symbol layer as a renderer. More...
 
static QgsProperty parseValueList (const QVariantList &json, PropertyType type, QgsMapBoxGlStyleConversionContext &context, double multiplier=1, int maxOpacity=255, QColor *defaultColor=nullptr, double *defaultNumber=nullptr)
 Parses and converts a value list (e.g. More...
 
static QImage retrieveSprite (const QString &name, QgsMapBoxGlStyleConversionContext &context, QSize &spriteSize)
 Retrieves the sprite image with the specified name, taken from the specified context. More...
 
static QString retrieveSpriteAsBase64 (const QVariant &value, QgsMapBoxGlStyleConversionContext &context, QSize &spriteSize, QString &spriteProperty, QString &spriteSizeProperty)
 Retrieves the sprite image with the specified name, taken from the specified context as a base64 encoded value. More...
 

Detailed Description

Handles conversion of MapBox GL styles to QGIS vector tile renderers and labeling settings.

Conversions are performed by calling convert() with either a JSON map or JSON string value, and then retrieving the results by calling renderer() or labeling() respectively.

Since
QGIS 3.16

Definition at line 172 of file qgsmapboxglstyleconverter.h.

Member Enumeration Documentation

◆ PropertyType

Property types, for interpolated value conversion.

Warning
This is private API only, and may change in future QGIS versions
Enumerator
Color 

Color property.

Numeric 

Numeric property (e.g. line width, text size)

Opacity 

Opacity property.

Point 

Point/offset property.

Definition at line 255 of file qgsmapboxglstyleconverter.h.

◆ Result

Result of conversion.

Enumerator
Success 

Conversion was successful.

NoLayerList 

No layer list was found in JSON input.

Definition at line 189 of file qgsmapboxglstyleconverter.h.

Constructor & Destructor Documentation

◆ QgsMapBoxGlStyleConverter() [1/2]

QgsMapBoxGlStyleConverter::QgsMapBoxGlStyleConverter ( )

Constructor for QgsMapBoxGlStyleConverter.

Definition at line 43 of file qgsmapboxglstyleconverter.cpp.

◆ QgsMapBoxGlStyleConverter() [2/2]

QgsMapBoxGlStyleConverter::QgsMapBoxGlStyleConverter ( const QgsMapBoxGlStyleConverter other)
delete

QgsMapBoxGlStyleConverter cannot be copied.

◆ ~QgsMapBoxGlStyleConverter()

QgsMapBoxGlStyleConverter::~QgsMapBoxGlStyleConverter ( )
default

Member Function Documentation

◆ colorAsHslaComponents()

void QgsMapBoxGlStyleConverter::colorAsHslaComponents ( const QColor &  color,
int &  hue,
int &  saturation,
int &  lightness,
int &  alpha 
)
staticprotected

Takes a QColor object and returns HSLA components in required format for QGIS color_hsla() expression function.

Parameters
colorinput color
huean integer value from 0 to 360
saturationan integer value from 0 to 100
lightnessan integer value from 0 to 100
alphaan integer value from 0 (completely transparent) to 255 (opaque).
Warning
This is private API only, and may change in future QGIS versions

Definition at line 2666 of file qgsmapboxglstyleconverter.cpp.

◆ convert() [1/2]

QgsMapBoxGlStyleConverter::Result QgsMapBoxGlStyleConverter::convert ( const QString &  style,
QgsMapBoxGlStyleConversionContext context = nullptr 
)

Converts a JSON style string, and returns the resultant status of the conversion.

If an error occurs during conversion then a descriptive error message can be retrieved by calling errorMessage().

After conversion, the resultant labeling and style rules can be retrieved by calling renderer() or labeling() respectively.

The optional context argument can be set to use a specific context during the conversion.

Definition at line 63 of file qgsmapboxglstyleconverter.cpp.

◆ convert() [2/2]

QgsMapBoxGlStyleConverter::Result QgsMapBoxGlStyleConverter::convert ( const QVariantMap &  style,
QgsMapBoxGlStyleConversionContext context = nullptr 
)

Converts a JSON style map, and returns the resultant status of the conversion.

If an error occurs during conversion then a descriptive error message can be retrieved by calling errorMessage().

After conversion, the resultant labeling and style rules can be retrieved by calling renderer() or labeling() respectively.

The optional context argument can be set to use a specific context during the conversion.

Definition at line 47 of file qgsmapboxglstyleconverter.cpp.

◆ errorMessage()

QString QgsMapBoxGlStyleConverter::errorMessage ( ) const
inline

Returns a descriptive error message if an error was encountered during the style conversion, or an empty string if no error was encountered.

See also
warnings()

Definition at line 227 of file qgsmapboxglstyleconverter.h.

◆ interpolateExpression()

QString QgsMapBoxGlStyleConverter::interpolateExpression ( double  zoomMin,
double  zoomMax,
QVariant  valueMin,
QVariant  valueMax,
double  base,
double  multiplier = 1,
QgsMapBoxGlStyleConversionContext contextPtr = 0 
)
staticprotected

Generates an interpolation for values between valueMin and valueMax, scaled between the ranges zoomMin to zoomMax.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2674 of file qgsmapboxglstyleconverter.cpp.

◆ labeling()

QgsVectorTileLabeling * QgsMapBoxGlStyleConverter::labeling ( ) const

Returns a new instance of a vector tile labeling representing the converted style, or nullptr if the style could not be converted successfully.

Definition at line 3196 of file qgsmapboxglstyleconverter.cpp.

◆ operator=()

QgsMapBoxGlStyleConverter& QgsMapBoxGlStyleConverter::operator= ( const QgsMapBoxGlStyleConverter other)
delete

QgsMapBoxGlStyleConverter cannot be copied.

◆ parseArrayStops()

QString QgsMapBoxGlStyleConverter::parseArrayStops ( const QVariantList &  stops,
QgsMapBoxGlStyleConversionContext context,
double  multiplier = 1 
)
staticprotected

Takes numerical arrays from stops.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2349 of file qgsmapboxglstyleconverter.cpp.

◆ parseCapStyle()

Qt::PenCapStyle QgsMapBoxGlStyleConverter::parseCapStyle ( const QString &  style)
staticprotected

Converts a value to Qt::PenCapStyle enum from JSON value.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2734 of file qgsmapboxglstyleconverter.cpp.

◆ parseCircleLayer()

bool QgsMapBoxGlStyleConverter::parseCircleLayer ( const QVariantMap &  jsonLayer,
QgsVectorTileBasicRendererStyle style,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Parses a circle layer.

Warning
This is private API only, and may change in future QGIS versions
Parameters
jsonLayercircle layer to parse
stylegenerated QGIS vector tile style
contextconversion context
Returns
true if the layer was successfully parsed.

Definition at line 723 of file qgsmapboxglstyleconverter.cpp.

◆ parseColor()

QColor QgsMapBoxGlStyleConverter::parseColor ( const QVariant &  color,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Parses a color in one of these supported formats:

  • #fff or #ffffff
  • hsl(30, 19%, 90%) or hsla(30, 19%, 90%, 0.4)
  • rgb(10, 20, 30) or rgba(10, 20, 30, 0.5)

Returns an invalid color if the color could not be parsed.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2655 of file qgsmapboxglstyleconverter.cpp.

◆ parseColorExpression()

QString QgsMapBoxGlStyleConverter::parseColorExpression ( const QVariant &  colorExpression,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Converts an expression representing a color to a string (can be color string or an expression where a color is expected)

Parameters
colorExpressionthe color expression
contextthe style conversion context
Returns
the QGIS expression string since QGIS 3.22

Definition at line 2646 of file qgsmapboxglstyleconverter.cpp.

◆ parseExpression()

QString QgsMapBoxGlStyleConverter::parseExpression ( const QVariantList &  expression,
QgsMapBoxGlStyleConversionContext context,
bool  colorExpected = false 
)
staticprotected

Converts a MapBox GL expression to a QGIS expression.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2754 of file qgsmapboxglstyleconverter.cpp.

◆ parseFillLayer()

bool QgsMapBoxGlStyleConverter::parseFillLayer ( const QVariantMap &  jsonLayer,
QgsVectorTileBasicRendererStyle style,
QgsMapBoxGlStyleConversionContext context,
bool  isBackgroundStyle = false 
)
staticprotected

Parses a fill layer.

Warning
This is private API only, and may change in future QGIS versions
Parameters
jsonLayerfill layer to parse
stylegenerated QGIS vector tile style
contextconversion context
isBackgroundStyleset to true if the layer should be parsed as background layer
Returns
true if the layer was successfully parsed.

Definition at line 184 of file qgsmapboxglstyleconverter.cpp.

◆ parseInterpolateByZoom()

QgsProperty QgsMapBoxGlStyleConverter::parseInterpolateByZoom ( const QVariantMap &  json,
QgsMapBoxGlStyleConversionContext context,
double  multiplier = 1,
double *  defaultNumber = nullptr 
)
staticprotected

Parses a numeric value which is interpolated by zoom range.

Parameters
jsondefinition of interpolation
contextconversion context
multiplieroptional multiplication factor
defaultNumberoptional storage for a reasonable "default" number representing the overall property.
Returns
QgsProperty representing interpolation settings

Definition at line 2180 of file qgsmapboxglstyleconverter.cpp.

◆ parseInterpolateColorByZoom()

QgsProperty QgsMapBoxGlStyleConverter::parseInterpolateColorByZoom ( const QVariantMap &  json,
QgsMapBoxGlStyleConversionContext context,
QColor *  defaultColor = nullptr 
)
staticprotected

Parses a color value which is interpolated by zoom range.

Parameters
jsondefinition of color interpolation
contextconversion context
defaultColoroptional storage for a reasonable "default" color representing the overall property.
Returns
QgsProperty representing interpolation settings

Definition at line 2084 of file qgsmapboxglstyleconverter.cpp.

◆ parseInterpolateListByZoom()

QgsProperty QgsMapBoxGlStyleConverter::parseInterpolateListByZoom ( const QVariantList &  json,
PropertyType  type,
QgsMapBoxGlStyleConversionContext context,
double  multiplier = 1,
int  maxOpacity = 255,
QColor *  defaultColor = nullptr,
double *  defaultNumber = nullptr 
)
staticprotected

Interpolates a list which starts with the interpolate function.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2588 of file qgsmapboxglstyleconverter.cpp.

◆ parseInterpolateOpacityByZoom()

QgsProperty QgsMapBoxGlStyleConverter::parseInterpolateOpacityByZoom ( const QVariantMap &  json,
int  maxOpacity,
QgsMapBoxGlStyleConversionContext contextPtr = 0 
)
staticprotected

Interpolates opacity with either scale_linear() or scale_exp() (depending on base value).

For json with intermediate stops it uses parseOpacityStops() function. It uses QGIS set_color_part() function to set alpha component of color.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2206 of file qgsmapboxglstyleconverter.cpp.

◆ parseInterpolatePointByZoom()

QgsProperty QgsMapBoxGlStyleConverter::parseInterpolatePointByZoom ( const QVariantMap &  json,
QgsMapBoxGlStyleConversionContext context,
double  multiplier = 1,
QPointF *  defaultPoint = nullptr 
)
staticprotected

Interpolates a point/offset with either scale_linear() or scale_exp() (depending on base value).

For json with intermediate stops it uses parsePointStops() function.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2271 of file qgsmapboxglstyleconverter.cpp.

◆ parseInterpolateStringByZoom()

QgsProperty QgsMapBoxGlStyleConverter::parseInterpolateStringByZoom ( const QVariantMap &  json,
QgsMapBoxGlStyleConversionContext context,
const QVariantMap &  conversionMap,
QString *  defaultString = nullptr 
)
staticprotected

Interpolates a string by zoom.

For json with intermediate stops it uses parseStringStops() function.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2303 of file qgsmapboxglstyleconverter.cpp.

◆ parseJoinStyle()

Qt::PenJoinStyle QgsMapBoxGlStyleConverter::parseJoinStyle ( const QString &  style)
staticprotected

Converts a value to Qt::PenJoinStyle enum from JSON value.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2744 of file qgsmapboxglstyleconverter.cpp.

◆ parseLayers()

void QgsMapBoxGlStyleConverter::parseLayers ( const QVariantList &  layers,
QgsMapBoxGlStyleConversionContext context = nullptr 
)
protected

Parse list of layers from JSON.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 70 of file qgsmapboxglstyleconverter.cpp.

◆ parseLineLayer()

bool QgsMapBoxGlStyleConverter::parseLineLayer ( const QVariantMap &  jsonLayer,
QgsVectorTileBasicRendererStyle style,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Parses a line layer.

Warning
This is private API only, and may change in future QGIS versions
Parameters
jsonLayerline layer to parse
stylegenerated QGIS vector tile style
contextconversion context
Returns
true if the layer was successfully parsed.

Definition at line 423 of file qgsmapboxglstyleconverter.cpp.

◆ parseMatchList()

QgsProperty QgsMapBoxGlStyleConverter::parseMatchList ( const QVariantList &  json,
QgsMapBoxGlStyleConverter::PropertyType  type,
QgsMapBoxGlStyleConversionContext context,
double  multiplier = 1,
int  maxOpacity = 255,
QColor *  defaultColor = nullptr,
double *  defaultNumber = nullptr 
)
staticprotected

Parses and converts a match function value list.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2483 of file qgsmapboxglstyleconverter.cpp.

◆ parseOpacityStops()

QString QgsMapBoxGlStyleConverter::parseOpacityStops ( double  base,
const QVariantList &  stops,
int  maxOpacity,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Takes values from stops and uses either scale_linear() or scale_exp() functions to interpolate alpha component of color.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2239 of file qgsmapboxglstyleconverter.cpp.

◆ parsePointStops()

QString QgsMapBoxGlStyleConverter::parsePointStops ( double  base,
const QVariantList &  stops,
QgsMapBoxGlStyleConversionContext context,
double  multiplier = 1 
)
staticprotected

Takes values from stops and uses either scale_linear() or scale_exp() functions to interpolate point/offset values.

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2315 of file qgsmapboxglstyleconverter.cpp.

◆ parseStops()

QString QgsMapBoxGlStyleConverter::parseStops ( double  base,
const QVariantList &  stops,
double  multiplier,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Parses a list of interpolation stops.

Parameters
baseinterpolation exponent base
stopsdefinition of interpolation stops
multiplieroptional multiplication factor
contextconversion context

Definition at line 2394 of file qgsmapboxglstyleconverter.cpp.

◆ parseStringStops()

QString QgsMapBoxGlStyleConverter::parseStringStops ( const QVariantList &  stops,
QgsMapBoxGlStyleConversionContext context,
const QVariantMap &  conversionMap,
QString *  defaultString = nullptr 
)
staticprotected

Parses a list of interpolation stops containing string values.

Parameters
stopsdefinition of interpolation stops
contextconversion context
conversionMapmap of input string to output expression value
defaultStringreasonable default value taken from stops
Returns
converted expression

Definition at line 2431 of file qgsmapboxglstyleconverter.cpp.

◆ parseSymbolLayer()

void QgsMapBoxGlStyleConverter::parseSymbolLayer ( const QVariantMap &  jsonLayer,
QgsVectorTileBasicRendererStyle rendererStyle,
bool &  hasRenderer,
QgsVectorTileBasicLabelingStyle labelingStyle,
bool &  hasLabeling,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Parses a symbol layer as renderer or labeling.

Warning
This is private API only, and may change in future QGIS versions
Parameters
jsonLayersymbol layer to parse
rendererStylegenerated QGIS vector tile style
hasRendererwill be set to true if symbol layer generated a renderer style
labelingStylegenerated QGIS vector tile labeling
hasLabelingwill be set to true if symbol layer generated a labeling style
contextconversion context

Definition at line 969 of file qgsmapboxglstyleconverter.cpp.

◆ parseSymbolLayerAsRenderer()

bool QgsMapBoxGlStyleConverter::parseSymbolLayerAsRenderer ( const QVariantMap &  jsonLayer,
QgsVectorTileBasicRendererStyle rendererStyle,
QgsMapBoxGlStyleConversionContext context 
)
staticprotected

Parses a symbol layer as a renderer.

Warning
This is private API only, and may change in future QGIS versions
Parameters
jsonLayerfill layer to parse
rendererStylegenerated QGIS vector tile style
contextconversion context
Returns
true if symbol layer was converted to renderer

Definition at line 1781 of file qgsmapboxglstyleconverter.cpp.

◆ parseValueList()

QgsProperty QgsMapBoxGlStyleConverter::parseValueList ( const QVariantList &  json,
QgsMapBoxGlStyleConverter::PropertyType  type,
QgsMapBoxGlStyleConversionContext context,
double  multiplier = 1,
int  maxOpacity = 255,
QColor *  defaultColor = nullptr,
double *  defaultNumber = nullptr 
)
staticprotected

Parses and converts a value list (e.g.

an interpolate list).

Warning
This is private API only, and may change in future QGIS versions

Definition at line 2466 of file qgsmapboxglstyleconverter.cpp.

◆ renderer()

QgsVectorTileRenderer * QgsMapBoxGlStyleConverter::renderer ( ) const

Returns a new instance of a vector tile renderer representing the converted style, or nullptr if the style could not be converted successfully.

Definition at line 3191 of file qgsmapboxglstyleconverter.cpp.

◆ retrieveSprite()

QImage QgsMapBoxGlStyleConverter::retrieveSprite ( const QString &  name,
QgsMapBoxGlStyleConversionContext context,
QSize &  spriteSize 
)
staticprotected

Retrieves the sprite image with the specified name, taken from the specified context.

The context must have valid sprite definitions and images set via QgsMapBoxGlStyleConversionContext::setSprites() prior to conversion.

Definition at line 2916 of file qgsmapboxglstyleconverter.cpp.

◆ retrieveSpriteAsBase64()

QString QgsMapBoxGlStyleConverter::retrieveSpriteAsBase64 ( const QVariant &  value,
QgsMapBoxGlStyleConversionContext context,
QSize &  spriteSize,
QString &  spriteProperty,
QString &  spriteSizeProperty 
)
staticprotected

Retrieves the sprite image with the specified name, taken from the specified context as a base64 encoded value.

The context must have valid sprite definitions and images set via QgsMapBoxGlStyleConversionContext::setSprites() prior to conversion.

Definition at line 2945 of file qgsmapboxglstyleconverter.cpp.

◆ warnings()

QStringList QgsMapBoxGlStyleConverter::warnings ( ) const
inline

Returns a list of user-friendly warnings generated during the conversion, e.g.

as a result of MapBox GL style settings which cannot be translated to QGIS styles.

See also
errorMessage()

Definition at line 235 of file qgsmapboxglstyleconverter.h.


The documentation for this class was generated from the following files: