qgsvectortilewriter.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectortilewriter.h
  --------------------------------------
  Date                 : April 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 QGSVECTORTILEWRITER_H
#define QGSVECTORTILEWRITER_H
 
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransformcontext.h"
#include "qgsrectangle.h"
#include "qgstiles.h"
 
#include <QCoreApplication>
 
class QgsFeedback;
class QgsTileMatrix;
class QgsTileXYZ;
class QgsVectorLayer;
 

class CORE_EXPORT QgsVectorTileWriter
{
    Q_DECLARE_TR_FUNCTIONS( QgsVectorTileWriter )
 
  public:
    QgsVectorTileWriter();

    class Layer
    {
      public:
        explicit Layer( QgsVectorLayer *layer )
          : mLayer( layer )
        {
        }

        QgsVectorLayer *layer() const { return mLayer; }

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

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

        int minZoom() const { return mMinZoom; }
        void setMinZoom( int minzoom ) { mMinZoom = minzoom; }

        int maxZoom() const { return mMaxZoom; }
        void setMaxZoom( int maxzoom ) { mMaxZoom = maxzoom; }
 
      private:
        QgsVectorLayer *mLayer;
        QString mFilterExpression;
        QString mLayerName;
        int mMinZoom = -1;
        int mMaxZoom = -1;
    };

    void setDestinationUri( const QString &uri ) { mDestinationUri = uri; }

    void setExtent( const QgsRectangle &extent ) { mExtent = extent; }

    void setMinZoom( int minZoom ) { mMinZoom = minZoom; }
    void setMaxZoom( int maxZoom ) { mMaxZoom = maxZoom; }

    void setLayers( const QList<QgsVectorTileWriter::Layer> &layers ) { mLayers = layers; }

    void setMetadata( const QVariantMap &metadata ) { mMetadata = metadata; }

    void setTransformContext( const QgsCoordinateTransformContext &transformContext ) { mTransformContext = transformContext; }

    bool setRootTileMatrix( const QgsTileMatrix &tileMatrix );

    bool writeTiles( QgsFeedback *feedback = nullptr );

    QString errorMessage() const { return mErrorMessage; }

    QgsRectangle fullExtent() const;

    QByteArray writeSingleTile( QgsTileXYZ tileID, QgsFeedback *feedback = nullptr, int buffer = 256, int resolution = 4096 ) const;
 
  private:
    bool writeTileFileXYZ( const QString &sourcePath, QgsTileXYZ tileID, const QgsTileMatrix &tileMatrix, const QByteArray &tileData );
    QString mbtilesJsonSchema() const;
 
  private:
    QgsTileMatrix mRootTileMatrix;
    QgsRectangle mExtent;
    int mMinZoom = 0;
    int mMaxZoom = 4;
    QList<Layer> mLayers;
    QString mDestinationUri;
    QVariantMap mMetadata;
    QgsCoordinateTransformContext mTransformContext;
 
    QString mErrorMessage;
};
 
#endif // QGSVECTORTILEWRITER_H