qgsmapboxglstyleconverter.h

Go to the documentation of this file.

/***************************************************************************
  qgsmapboxglstyleconverter.h
  --------------------------------------
  Date                 : September 2020
  Copyright            : (C) 2020 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSMAPBOXGLSTYLECONVERTER_H
#define QGSMAPBOXGLSTYLECONVERTER_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsproperty.h"
#include "qgspropertycollection.h"
 
#include <QImage>
#include <QVariantMap>
 
class QgsVectorTileRenderer;
class QgsVectorTileLabeling;
class QgsVectorTileBasicRendererStyle;
class QgsVectorTileBasicLabelingStyle;
class QgsMapLayer;
class QgsRasterLayer;

class CORE_EXPORT QgsMapBoxGlStyleConversionContext
{
  public:
    void pushWarning( const QString &warning );

    QStringList warnings() const { return mWarnings; }

    void clearWarnings() { mWarnings.clear(); }

    Qgis::RenderUnit targetUnit() const;

    void setTargetUnit( Qgis::RenderUnit targetUnit );

    double pixelSizeConversionFactor() const;

    void setPixelSizeConversionFactor( double sizeConversionFactor );

    QStringList spriteCategories() const;

    QImage spriteImage( const QString &category = QString() ) const;

    QVariantMap spriteDefinitions( const QString &category = QString() ) const;

    void setSprites( const QImage &image, const QVariantMap &definitions, const QString &category = QString() );

    void setSprites( const QImage &image, const QString &definitions, const QString &category = QString() );

    QString layerId() const;

    void setLayerId( const QString &value );
 
  private:
    QStringList mWarnings;
 
    QString mLayerId;
 
    Qgis::RenderUnit mTargetUnit = Qgis::RenderUnit::Pixels;
 
    double mSizeConversionFactor = 1.0;
 
    QMap<QString, QImage> mSpriteImage;
    QMap<QString, QVariantMap> mSpriteDefinitions;
};
 

class CORE_EXPORT QgsMapBoxGlStyleAbstractSource
{
  public:
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
 
    switch ( sipCpp->type() )
    {
      case Qgis::MapBoxGlStyleSourceType::Raster:
        sipType = sipType_QgsMapBoxGlStyleRasterSource;
        break;
      default:
        sipType = 0;
        break;
    }
    SIP_END
#endif

    QgsMapBoxGlStyleAbstractSource( const QString &name );
 
    virtual ~QgsMapBoxGlStyleAbstractSource();

    virtual Qgis::MapBoxGlStyleSourceType type() const = 0;

    virtual bool setFromJson( const QVariantMap &json, QgsMapBoxGlStyleConversionContext *context ) = 0;

    QString name() const;
 
  private:
    QString mName;
};
 

class CORE_EXPORT QgsMapBoxGlStyleRasterSource : public QgsMapBoxGlStyleAbstractSource
{
  public:
    QgsMapBoxGlStyleRasterSource( const QString &name );
 
    Qgis::MapBoxGlStyleSourceType type() const override;
    bool setFromJson( const QVariantMap &json, QgsMapBoxGlStyleConversionContext *context ) override;

    QString attribution() const { return mAttribution; }

    int minimumZoom() const { return mMinZoom; }

    int maximumZoom() const { return mMaxZoom; }

    int tileSize() const { return mTileSize; }

    QStringList tiles() const { return mTiles; }

    QgsRasterLayer *toRasterLayer() const SIP_FACTORY;
 
  private:
    QStringList mTiles;
    QString mAttribution;
    int mMinZoom = 0;
    int mMaxZoom = 22;
    int mTileSize = 512;
};
 

class CORE_EXPORT QgsMapBoxGlStyleRasterSubLayer
{
  public:
    QgsMapBoxGlStyleRasterSubLayer( const QString &id, const QString &source );

    QString id() const { return mId; }

    QString source() const { return mSource; }

    QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }

    const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; }
 
  private:
    QString mId;
    QString mSource;
    QgsPropertyCollection mDataDefinedProperties;
};
 

class CORE_EXPORT QgsMapBoxGlStyleConverter
{
    Q_GADGET
 
  public:
    QgsMapBoxGlStyleConverter();
 
    QgsMapBoxGlStyleConverter( const QgsMapBoxGlStyleConverter &other ) = delete;
    QgsMapBoxGlStyleConverter &operator=( const QgsMapBoxGlStyleConverter &other ) = delete;
 
    ~QgsMapBoxGlStyleConverter();

    enum Result
    {
      Success = 0,     
      NoLayerList = 1, 
    };

    enum class PropertyType
    {
      Color,        
      Numeric,      
      Opacity,      
      Point,        
      NumericArray, 
      DashArray,    
    };
    Q_ENUM( PropertyType )
 
    
    enum class InterpolationType
    {
      Linear,      
      Exponential, 
      CubicBezier, 
    };
    Q_ENUM( InterpolationType )
 
    
    Result convert( const QVariantMap &style, QgsMapBoxGlStyleConversionContext *context = nullptr );

    Result convert( const QString &style, QgsMapBoxGlStyleConversionContext *context = nullptr );

    QString errorMessage() const { return mError; }

    QStringList warnings() const { return mWarnings; }

    QgsVectorTileRenderer *renderer() const SIP_FACTORY;

    QgsVectorTileLabeling *labeling() const SIP_FACTORY;

    QList< QgsMapBoxGlStyleAbstractSource * > sources();

    QList< QgsMapBoxGlStyleRasterSubLayer > rasterSubLayers() const;

    QList< QgsMapLayer * > createSubLayers() const SIP_FACTORY;
 
  protected:
    void parseSources( const QVariantMap &sources, QgsMapBoxGlStyleConversionContext *context = nullptr );

    void parseRasterSource( const QVariantMap &source, const QString &name, QgsMapBoxGlStyleConversionContext *context = nullptr );

    void parseLayers( const QVariantList &layers, QgsMapBoxGlStyleConversionContext *context = nullptr );

    static bool parseFillLayer( const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &style SIP_OUT, QgsMapBoxGlStyleConversionContext &context, bool isBackgroundStyle = false );

    static bool parseLineLayer( const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &style SIP_OUT, QgsMapBoxGlStyleConversionContext &context );

    static bool parseCircleLayer( const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &style SIP_OUT, QgsMapBoxGlStyleConversionContext &context );

    static void parseSymbolLayer(
      const QVariantMap &jsonLayer,
      QgsVectorTileBasicRendererStyle &rendererStyle SIP_OUT,
      bool &hasRenderer SIP_OUT,
      QgsVectorTileBasicLabelingStyle &labelingStyle SIP_OUT,
      bool &hasLabeling SIP_OUT,
      QgsMapBoxGlStyleConversionContext &context
    );

    static bool parseSymbolLayerAsRenderer( const QVariantMap &jsonLayer, QgsVectorTileBasicRendererStyle &rendererStyle SIP_OUT, QgsMapBoxGlStyleConversionContext &context );

    static QgsProperty parseInterpolateColorByZoom(
      const QVariantMap &json,
      QgsMapBoxGlStyleConversionContext &context,
      QColor *defaultColor SIP_OUT = nullptr,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential
    );

    static QgsProperty parseInterpolateByZoom(
      const QVariantMap &json,
      QgsMapBoxGlStyleConversionContext &context,
      double multiplier = 1,
      double *defaultNumber SIP_OUT = nullptr,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential
    );

    static QgsProperty parseInterpolateOpacityByZoom(
      const QVariantMap &json,
      int maxOpacity,
      QgsMapBoxGlStyleConversionContext *contextPtr = nullptr,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential
    );

    static QString parseOpacityStops(
      double base,
      const QVariantList &stops,
      int maxOpacity,
      QgsMapBoxGlStyleConversionContext &context,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential,
      double x1 = 0,
      double y1 = 0,
      double x2 = 1,
      double y2 = 1
    );

    static QgsProperty parseInterpolatePointByZoom(
      const QVariantMap &json,
      QgsMapBoxGlStyleConversionContext &context,
      double multiplier = 1,
      QPointF *defaultPoint SIP_OUT = nullptr,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential
    );

    static QgsProperty parseInterpolateStringByZoom( const QVariantMap &json, QgsMapBoxGlStyleConversionContext &context, const QVariantMap &conversionMap, QString *defaultString SIP_OUT = nullptr );

    static QString parsePointStops(
      double base,
      const QVariantList &stops,
      QgsMapBoxGlStyleConversionContext &context,
      double multiplier = 1,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential,
      double x1 = 0,
      double y1 = 0,
      double x2 = 0,
      double y2 = 0
    );

    static QString parseArrayStops( const QVariantList &stops, QgsMapBoxGlStyleConversionContext &context, double multiplier = 1 );

    static QString parseStops(
      double base,
      const QVariantList &stops,
      double multiplier,
      QgsMapBoxGlStyleConversionContext &context,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential,
      double x1 = 0,
      double y1 = 0,
      double x2 = 1,
      double y2 = 1
    );

    static QString parseStringStops( const QVariantList &stops, QgsMapBoxGlStyleConversionContext &context, const QVariantMap &conversionMap, QString *defaultString SIP_OUT = nullptr );
 

    static QString parseLabelStops( const QVariantList &stops, QgsMapBoxGlStyleConversionContext &context );

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

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

    static QgsProperty parseStepList(
      const QVariantList &json,
      PropertyType type,
      QgsMapBoxGlStyleConversionContext &context,
      double multiplier = 1,
      int maxOpacity = 255,
      QColor *defaultColor SIP_OUT = nullptr,
      double *defaultNumber SIP_OUT = nullptr
    );

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

    static QString parseColorExpression( const QVariant &colorExpression, QgsMapBoxGlStyleConversionContext &context );

    static QColor parseColor( const QVariant &color, QgsMapBoxGlStyleConversionContext &context );

    static void colorAsHslaComponents( const QColor &color, int &hue, int &saturation, int &lightness, int &alpha );

    static QString interpolateExpression(
      double zoomMin,
      double zoomMax,
      QVariant valueMin,
      QVariant valueMax,
      double base,
      double multiplier = 1,
      double x1 = 0,
      double y1 = 0,
      double x2 = 1,
      double y2 = 1,
      QgsMapBoxGlStyleConverter::InterpolationType type = QgsMapBoxGlStyleConverter::InterpolationType::Exponential,
      QgsMapBoxGlStyleConversionContext *contextPtr = nullptr
    );

    static Qt::PenCapStyle parseCapStyle( const QString &style );

    static Qt::PenJoinStyle parseJoinStyle( const QString &style );

    static QString parseExpression( const QVariantList &expression, QgsMapBoxGlStyleConversionContext &context, bool colorExpected = false );

    static QImage retrieveSprite( const QString &name, QgsMapBoxGlStyleConversionContext &context, QSize &spriteSize );

    static QString retrieveSpriteAsBase64( const QVariant &value, QgsMapBoxGlStyleConversionContext &context )
    {
      QSize spriteSize;
      QString spriteProperty;
      QString spriteSizeProperty;
      return retrieveSpriteAsBase64WithProperties( value, context, spriteSize, spriteProperty, spriteSizeProperty );
    }

    static QString retrieveSpriteAsBase64WithProperties(
      const QVariant &value, QgsMapBoxGlStyleConversionContext &context, QSize &spriteSize SIP_OUT, QString &spriteProperty SIP_OUT, QString &spriteSizeProperty SIP_OUT
    );
 
  private:
#ifdef SIP_RUN
    QgsMapBoxGlStyleConverter( const QgsMapBoxGlStyleConverter &other );
#endif
 
    static QString parseValue( const QVariant &value, QgsMapBoxGlStyleConversionContext &context, bool colorExpected = false );
 
    static QString parseKey( const QVariant &value, QgsMapBoxGlStyleConversionContext &context );
 
    static QString processLabelField( const QString &string, bool &isExpression );

    static bool numericArgumentsOnly( const QVariant &bottomVariant, const QVariant &topVariant, double &bottom, double &top );
 
    QString mError;
    QStringList mWarnings;
 
    std::unique_ptr< QgsVectorTileRenderer > mRenderer;
    std::unique_ptr< QgsVectorTileLabeling > mLabeling;
 
    QList< QgsMapBoxGlStyleAbstractSource * > mSources;
    QList< QgsMapBoxGlStyleRasterSubLayer> mRasterSubLayers;
 
    friend class QgsSymbolConverterMapBoxGl;
};
 
#endif // QGSMAPBOXGLSTYLECONVERTER_H