qgsvectortiledataprovider.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectortiledataprovider.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 QGSVECTORTILEDATAPROVIDER_H
#define QGSVECTORTILEDATAPROVIDER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsdataprovider.h"
#include "qgstiles.h"
 
#include <QCache>
#include <QReadWriteLock>
 
class QgsTileMatrixSet;
class QgsTileXYZ;
class QgsVectorTileRawData;
class QgsVectorTileMatrixSet;
 
#define SIP_NO_FILE

class QgsVectorTileDataProviderSharedData
{
  public:
 
    QgsVectorTileDataProviderSharedData();

    bool getCachedTileData( QgsVectorTileRawData &data, QgsTileXYZ id );

    void storeCachedTileData( const QgsVectorTileRawData &data );
 
    QCache< QgsTileXYZ, QgsVectorTileRawData > mTileCache;
 
    // cannot use a read/write lock here -- see https://bugreports.qt.io/browse/QTBUG-19794
    QMutex mMutex; 
 
};

class CORE_EXPORT QgsVectorTileDataProvider : public QgsDataProvider
{
    Q_OBJECT
 
  public:

    static int DATA_COLUMN;
    static int DATA_ROW;
    static int DATA_ZOOM;
    static int DATA_SOURCE_ID;

    QgsVectorTileDataProvider( const QString &uri,
                               const QgsDataProvider::ProviderOptions &providerOptions,
                               Qgis::DataProviderReadFlags flags );
 
    QgsVectorTileDataProvider( const QgsVectorTileDataProvider &other );
    QgsVectorTileDataProvider &operator=( const QgsVectorTileDataProvider &other ) = delete;

    virtual Qgis::VectorTileProviderFlags providerFlags() const;

    virtual Qgis::VectorTileProviderCapabilities providerCapabilities() const;
 
    QgsRectangle extent() const override;
    bool renderInPreview( const QgsDataProvider::PreviewContext &context ) override;

    virtual QString sourcePath() const = 0;
 

    virtual QgsStringMap sourcePaths() const
    {
      return { { QString(), sourcePath() } };
    }
 

    virtual QgsVectorTileDataProvider *clone() const = 0 SIP_FACTORY;

    virtual const QgsVectorTileMatrixSet &tileMatrixSet() const = 0;

    virtual bool supportsAsync() const;

    virtual QgsVectorTileRawData readTile( const QgsTileMatrixSet &tileMatrixSet, const QgsTileXYZ &id, QgsFeedback *feedback = nullptr ) const = 0;

    virtual QList<QgsVectorTileRawData> readTiles( const QgsTileMatrixSet &tileMatrixSet, const QVector<QgsTileXYZ> &tiles, QgsFeedback *feedback = nullptr, Qgis::RendererUsage usage = Qgis::RendererUsage::Unknown ) const = 0;

    virtual QList<QNetworkRequest> tileRequests( const QgsTileMatrixSet &tileMatrixSet, const QgsTileXYZ &id, Qgis::RendererUsage usage ) const;

    virtual QVariantMap styleDefinition() const;

    virtual QString styleUrl() const;

    virtual QVariantMap spriteDefinition() const;

    virtual QImage spriteImage() const;
 
  protected:
 
    std::shared_ptr<QgsVectorTileDataProviderSharedData> mShared;  
 
};
 
 
 
#endif // QGSVECTORTILEDATAPROVIDER_H