qgsvectortilebasicrenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectortilebasicrenderer.h
  --------------------------------------
  Date                 : March 2020
  Copyright            : (C) 2020 by Martin Dobias
  Email                : wonder dot sk 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 QGSVECTORTILEBASICRENDERER_H
#define QGSVECTORTILEBASICRENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsvectortilerenderer.h"
 
class QgsLineSymbol;
class QgsFillSymbol;
class QgsMarkerSymbol;
 
class QgsSymbol;

class CORE_EXPORT QgsVectorTileBasicRendererStyle
{
  public:
    QgsVectorTileBasicRendererStyle( const QString &stName = QString(), const QString &laName = QString(), Qgis::GeometryType geomType = Qgis::GeometryType::Unknown );
 
    QgsVectorTileBasicRendererStyle( const QgsVectorTileBasicRendererStyle &other );
    QgsVectorTileBasicRendererStyle &operator=( const QgsVectorTileBasicRendererStyle &other );
    ~QgsVectorTileBasicRendererStyle();

    void setStyleName( const QString &name ) { mStyleName = name; }
    QString styleName() const { return mStyleName; }

    void setLayerName( const QString &name ) { mLayerName = name; }
    QString layerName() const { return mLayerName; }

    void setGeometryType( Qgis::GeometryType geomType ) { mGeometryType = geomType; }
    Qgis::GeometryType geometryType() const { return mGeometryType; }

    void setFilterExpression( const QString &expr ) { mExpression = expr; }
    QString filterExpression() const { return mExpression; }

    void setSymbol( QgsSymbol *sym SIP_TRANSFER );
    QgsSymbol *symbol() const { return mSymbol.get(); }

    void setEnabled( bool enabled ) { mEnabled = enabled; }
    bool isEnabled() const { return mEnabled; }

    void setMinZoomLevel( int minZoom ) { mMinZoomLevel = minZoom; }

    int minZoomLevel() const { return mMinZoomLevel; }

    void setMaxZoomLevel( int maxZoom ) { mMaxZoomLevel = maxZoom; }

    int maxZoomLevel() const { return mMaxZoomLevel; }

    bool isActive( int zoomLevel ) const { return mEnabled && ( mMinZoomLevel == -1 || zoomLevel >= mMinZoomLevel ) && ( mMaxZoomLevel == -1 || zoomLevel <= mMaxZoomLevel ); }

    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
 
  private:
    QString mStyleName;
    QString mLayerName;
    Qgis::GeometryType mGeometryType;
    std::unique_ptr<QgsSymbol> mSymbol;
    bool mEnabled = true;
    QString mExpression;
    int mMinZoomLevel = -1;
    int mMaxZoomLevel = -1;
};
 

class CORE_EXPORT QgsVectorTileBasicRenderer : public QgsVectorTileRenderer
{
  public:
    QgsVectorTileBasicRenderer();
 
    QString type() const override;
    QgsVectorTileBasicRenderer *clone() const override SIP_FACTORY;
    void startRender( QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange ) override;
    QMap<QString, QSet<QString> > usedAttributes( const QgsRenderContext & ) override SIP_SKIP;
    QSet< QString > requiredLayers( QgsRenderContext &context, int tileZoom ) const override;
    void stopRender( QgsRenderContext &context ) override;
    void renderBackground( QgsRenderContext &context ) override;
    void renderTile( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) override;
    void renderSelectedFeatures( const QList< QgsFeature > &selection, QgsRenderContext &context ) override;
    bool willRenderFeature( const QgsFeature &feature, int tileZoom, const QString &layerName, QgsRenderContext &context ) override;
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;

    void setStyles( const QList<QgsVectorTileBasicRendererStyle> &styles );
    QList<QgsVectorTileBasicRendererStyle> styles() const;
    void setStyle( int index, const QgsVectorTileBasicRendererStyle &style ) { mStyles[index] = style; }
    QgsVectorTileBasicRendererStyle style( int index ) const { return mStyles[index]; }

    static QList<QgsVectorTileBasicRendererStyle> simpleStyle(
      const QColor &polygonFillColor,
      const QColor &polygonStrokeColor,
      double polygonStrokeWidth,
      const QColor &lineStrokeColor,
      double lineStrokeWidth,
      const QColor &pointFillColor,
      const QColor &pointStrokeColor,
      double pointSize
    );

    static QList<QgsVectorTileBasicRendererStyle> simpleStyleWithRandomColors();
 
  private:
    void setDefaultStyle();
 
  private:
    QList<QgsVectorTileBasicRendererStyle> mStyles;
 
    // temporary bits

    QMap<QString, QSet<QString> > mRequiredFields;
};
 
#endif // QGSVECTORTILEBASICRENDERER_H