qgsvectortilerenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectortilerenderer.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 QGSVECTORTILERENDERER_H
#define QGSVECTORTILERENDERER_H
 
#include "qgis_core.h"
#include "qgsfeature.h"
#include "qgstiles.h"
 
class QgsRenderContext;
class QgsReadWriteContext;
class QgsProject;

typedef QMap<QString, QVector<QgsFeature> > QgsVectorTileFeatures SIP_SKIP;

class CORE_EXPORT QgsVectorTileRendererData
{
  public:
    explicit QgsVectorTileRendererData( QgsTileXYZ id )
      : mId( id )
      , mRenderZoomLevel( id.zoomLevel() )
    {}

    QgsTileXYZ id() const { return mId; }

    void setTilePolygon( QPolygon polygon ) { mTilePolygon = polygon; }
    QPolygon tilePolygon() const { return mTilePolygon; }

    void setRenderZoomLevel( int level ) { mRenderZoomLevel = level; }

    int renderZoomLevel() const { return mRenderZoomLevel; }

    void setFields( const QMap<QString, QgsFields> &fields ) { mFields = fields; }
    QMap<QString, QgsFields> fields() const { return mFields; }

    void setFeatures( const QgsVectorTileFeatures &features ) SIP_SKIP { mFeatures = features; }
    QgsVectorTileFeatures features() const SIP_SKIP { return mFeatures; }
    QStringList layers() const { return mFeatures.keys(); }
    QVector<QgsFeature> layerFeatures( const QString &layerName ) const { return mFeatures[layerName]; }
 
  private:
    QgsTileXYZ mId;

    int mRenderZoomLevel = -1;

    QMap<QString, QgsFields> mFields;
    QgsVectorTileFeatures mFeatures;
    QPolygon mTilePolygon;
};

class CORE_EXPORT QgsVectorTileRenderer
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
 
    const QString type = sipCpp->type();
 
    if ( type == QLatin1String( "basic" ) )
      sipType = sipType_QgsVectorTileBasicRenderer;
    else
      sipType = 0;
    SIP_END
#endif
 
  public:
    virtual ~QgsVectorTileRenderer() = default;

    virtual QString type() const = 0;

    virtual QgsVectorTileRenderer *clone() const = 0 SIP_FACTORY;

    virtual void startRender( QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange ) = 0;

    virtual QMap<QString, QSet<QString> > usedAttributes( const QgsRenderContext & ) SIP_SKIP { return QMap<QString, QSet<QString> >(); }
 
    //TODO QGIS 4.0 -- make pure virtual

    virtual QSet< QString > requiredLayers( QgsRenderContext &context, int tileZoom ) const { Q_UNUSED( context ); Q_UNUSED( tileZoom ); return QSet< QString >() << QString(); }

    virtual void stopRender( QgsRenderContext &context ) = 0;

    virtual void renderBackground( QgsRenderContext &context ) = 0;

    virtual void renderTile( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) = 0;

    virtual bool willRenderFeature( const QgsFeature &feature, int tileZoom, const QString &layerName, QgsRenderContext &context ) = 0;

    virtual void renderSelectedFeatures( const QList< QgsFeature > &selection, QgsRenderContext &context ) = 0;

    virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const = 0;
    virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) = 0;
    virtual void resolveReferences( const QgsProject &project ) { Q_UNUSED( project ) }
 
};
 
#endif // QGSVECTORTILERENDERER_H