QGIS API Documentation  3.23.0-Master (22c16f2067)
Public Member Functions | List of all members
QgsMapBoxGlStyleConversionContext Class Reference

Context for a MapBox GL style conversion operation. More...

#include <qgsmapboxglstyleconverter.h>

Public Member Functions

void clearWarnings ()
 Clears the list of warning messages. More...
 
QString layerId () const
 Returns the layer ID of the layer currently being converted. More...
 
double pixelSizeConversionFactor () const
 Returns the pixel size conversion factor, used to scale the original pixel sizes when converting styles. More...
 
void pushWarning (const QString &warning)
 Pushes a warning message generated during the conversion. More...
 
void setLayerId (const QString &value)
 Sets the layer ID of the layer currently being converted. More...
 
void setPixelSizeConversionFactor (double sizeConversionFactor)
 Sets the pixel size conversion factor, used to scale the original pixel sizes when converting styles. More...
 
void setSprites (const QImage &image, const QString &definitions)
 Sets the sprite image and definitions JSON string to use during conversion. More...
 
void setSprites (const QImage &image, const QVariantMap &definitions)
 Sets the sprite image and definitions JSON to use during conversion. More...
 
void setTargetUnit (QgsUnitTypes::RenderUnit targetUnit)
 Sets the target unit type. More...
 
QVariantMap spriteDefinitions () const
 Returns the sprite definitions to use during conversion. More...
 
QImage spriteImage () const
 Returns the sprite image to use during conversion, or an invalid image if this is not set. More...
 
QgsUnitTypes::RenderUnit targetUnit () const
 Returns the target unit type. More...
 
QStringList warnings () const
 Returns a list of warning messages generated during the conversion. More...
 

Detailed Description

Context for a MapBox GL style conversion operation.

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

Definition at line 37 of file qgsmapboxglstyleconverter.h.

Member Function Documentation

◆ clearWarnings()

void QgsMapBoxGlStyleConversionContext::clearWarnings ( )
inline

Clears the list of warning messages.

Definition at line 54 of file qgsmapboxglstyleconverter.h.

◆ layerId()

QString QgsMapBoxGlStyleConversionContext::layerId ( ) const

Returns the layer ID of the layer currently being converted.

See also
setLayerId()

Definition at line 3263 of file qgsmapboxglstyleconverter.cpp.

◆ pixelSizeConversionFactor()

double QgsMapBoxGlStyleConversionContext::pixelSizeConversionFactor ( ) const

Returns the pixel size conversion factor, used to scale the original pixel sizes when converting styles.

See also
setPixelSizeConversionFactor()

Definition at line 3232 of file qgsmapboxglstyleconverter.cpp.

◆ pushWarning()

void QgsMapBoxGlStyleConversionContext::pushWarning ( const QString &  warning)

Pushes a warning message generated during the conversion.

Definition at line 3216 of file qgsmapboxglstyleconverter.cpp.

◆ setLayerId()

void QgsMapBoxGlStyleConversionContext::setLayerId ( const QString &  value)

Sets the layer ID of the layer currently being converted.

See also
layerId()

Definition at line 3268 of file qgsmapboxglstyleconverter.cpp.

◆ setPixelSizeConversionFactor()

void QgsMapBoxGlStyleConversionContext::setPixelSizeConversionFactor ( double  sizeConversionFactor)

Sets the pixel size conversion factor, used to scale the original pixel sizes when converting styles.

See also
pixelSizeConversionFactor()

Definition at line 3237 of file qgsmapboxglstyleconverter.cpp.

◆ setSprites() [1/2]

void QgsMapBoxGlStyleConversionContext::setSprites ( const QImage &  image,
const QString &  definitions 
)

Sets the sprite image and definitions JSON string to use during conversion.

See also
spriteImage()
spriteDefinitions()

Definition at line 3258 of file qgsmapboxglstyleconverter.cpp.

◆ setSprites() [2/2]

void QgsMapBoxGlStyleConversionContext::setSprites ( const QImage &  image,
const QVariantMap &  definitions 
)

Sets the sprite image and definitions JSON to use during conversion.

See also
spriteImage()
spriteDefinitions()

Definition at line 3252 of file qgsmapboxglstyleconverter.cpp.

◆ setTargetUnit()

void QgsMapBoxGlStyleConversionContext::setTargetUnit ( QgsUnitTypes::RenderUnit  targetUnit)

Sets the target unit type.

By default this is QgsUnitTypes::RenderPixels in order to exactly match the original style rendering. But rendering in pixels can cause issues on hidpi displays or with print layouts, so setting a target unit of QgsUnitTypes::Millimeters or another real-world unit type is often more appropriate.

If setting to a non-pixel unit, be sure to call setPixelSizeConversionFactor() in order to setup an appropriate pixel-to-unit conversion factor to scale converted sizes using. E.g. if the target unit is millimeters, the size conversion factor should be set to a pixel-to-millimeter value.

See also
targetUnit()

Definition at line 3227 of file qgsmapboxglstyleconverter.cpp.

◆ spriteDefinitions()

QVariantMap QgsMapBoxGlStyleConversionContext::spriteDefinitions ( ) const

Returns the sprite definitions to use during conversion.

See also
spriteImage()
setSprites()

Definition at line 3247 of file qgsmapboxglstyleconverter.cpp.

◆ spriteImage()

QImage QgsMapBoxGlStyleConversionContext::spriteImage ( ) const

Returns the sprite image to use during conversion, or an invalid image if this is not set.

See also
spriteDefinitions()
setSprites()

Definition at line 3242 of file qgsmapboxglstyleconverter.cpp.

◆ targetUnit()

QgsUnitTypes::RenderUnit QgsMapBoxGlStyleConversionContext::targetUnit ( ) const

Returns the target unit type.

By default this is QgsUnitTypes::RenderPixels in order to exactly match the original style rendering. But rendering in pixels can cause issues on hidpi displays or with print layouts, so setting a target unit of QgsUnitTypes::Millimeters or another real-world unit type is often more appropriate.

See also
setTargetUnit()

Definition at line 3222 of file qgsmapboxglstyleconverter.cpp.

◆ warnings()

QStringList QgsMapBoxGlStyleConversionContext::warnings ( ) const
inline

Returns a list of warning messages generated during the conversion.

Definition at line 49 of file qgsmapboxglstyleconverter.h.


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