qgsvectortilelayer.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectortilelayer.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 QGSVECTORTILELAYER_H
#define QGSVECTORTILELAYER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsfeatureid.h"
#include "qgsmaplayer.h"
#include "qgsvectortilematrixset.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsVectorTileRenderer;
class QgsVectorTileLabeling;
class QgsFeature;
class QgsGeometry;
class QgsSelectionContext;
class QgsVectorTileRawData;

class CORE_EXPORT QgsVectorTileLayer : public QgsMapLayer
{
    Q_OBJECT
 
  public:
    struct LayerOptions
    {
        explicit LayerOptions( const QgsCoordinateTransformContext &transformContext = QgsCoordinateTransformContext() )
          : transformContext( transformContext )
        {}

        QgsCoordinateTransformContext transformContext;
    };

    explicit QgsVectorTileLayer( const QString &path = QString(), const QString &baseName = QString(), const QgsVectorTileLayer::LayerOptions &options = QgsVectorTileLayer::LayerOptions() );
    ~QgsVectorTileLayer() override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsVectorTileLayer: '%1'>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
      // implementation of virtual functions from QgsMapLayer
 
      QgsVectorTileLayer *clone() const override SIP_FACTORY;
    QgsDataProvider *dataProvider() override;
    const QgsDataProvider *dataProvider() const override SIP_SKIP;
    QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override SIP_FACTORY;
    bool readXml( const QDomNode &layerNode, QgsReadWriteContext &context ) override;
    bool writeXml( QDomNode &layerNode, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    bool readSymbology( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) override;
    bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) const override;
    void setTransformContext( const QgsCoordinateTransformContext &transformContext ) override;
    QString loadDefaultStyle( bool &resultFlag SIP_OUT ) override;
    Qgis::MapLayerProperties properties() const override;

    bool loadDefaultStyle( QString &error, QStringList &warnings ) SIP_SKIP;

    bool loadDefaultStyleAndSubLayers( QString &error, QStringList &warnings, QList< QgsMapLayer * > &subLayers SIP_OUT SIP_TRANSFERBACK );
 
    QString loadDefaultMetadata( bool &resultFlag SIP_OUT ) override;
 
    QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const final;
    QString decodedSource( const QString &source, const QString &provider, const QgsReadWriteContext &context ) const final;
    QString htmlMetadata() const override;
 
    // new methods

    QgsVectorTileMatrixSet &tileMatrixSet() { return mMatrixSet; }

    QString sourceType() const { return mSourceType; }
    QString sourcePath() const;

    int sourceMinZoom() const { return mMatrixSet.minimumZoom(); }
    int sourceMaxZoom() const { return mMatrixSet.maximumZoom(); }

    QgsVectorTileRawData getRawTile( QgsTileXYZ tileID ) SIP_SKIP;

    void setRenderer( QgsVectorTileRenderer *r SIP_TRANSFER );
    QgsVectorTileRenderer *renderer() const;

    void setLabeling( QgsVectorTileLabeling *labeling SIP_TRANSFER );
    QgsVectorTileLabeling *labeling() const;

    bool labelsEnabled() const;

    void setLabelsEnabled( bool enabled );

    void setTileBorderRenderingEnabled( bool enabled ) { mTileBorderRendering = enabled; }
    bool isTileBorderRenderingEnabled() const { return mTileBorderRendering; }

    QList< QgsFeature > selectedFeatures() const;

    int selectedFeatureCount() const;

    void selectByGeometry(
      const QgsGeometry &geometry,
      const QgsSelectionContext &context,
      Qgis::SelectBehavior behavior = Qgis::SelectBehavior::SetSelection,
      Qgis::SelectGeometryRelationship relationship = Qgis::SelectGeometryRelationship::Intersect,
      Qgis::SelectionFlags flags = Qgis::SelectionFlags(),
      QgsRenderContext *renderContext = nullptr
    );
 
  public slots:

    void removeSelection();
 
  signals:

    void selectionChanged();
 
  private:
    bool loadDataSource();
 
  private:
    QString mSourceType;
 
    QgsVectorTileMatrixSet mMatrixSet;

    std::unique_ptr<QgsVectorTileRenderer> mRenderer;
    std::unique_ptr<QgsVectorTileLabeling> mLabeling;
    bool mLabelsEnabled = true;
    bool mTileBorderRendering = false;
 
    QgsCoordinateTransformContext mTransformContext;
 
    std::unique_ptr< QgsDataProvider > mDataProvider;
 
    QHash< QgsFeatureId, QgsFeature > mSelectedFeatures;
 
    void setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags ) override;
 
    bool loadDefaultStyleAndSubLayersPrivate( QString &error, QStringList &warnings, QList< QgsMapLayer * > *subLayers );
};
 
#endif // QGSVECTORTILELAYER_H