qgsvectortilebasiclabeling.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectortilebasiclabeling.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 QGSVECTORTILEBASICLABELING_H
#define QGSVECTORTILEBASICLABELING_H
 
 
#include "qgsvectortilelabeling.h"
 
class QgsPalLayerSettings;

class CORE_EXPORT QgsVectorTileBasicLabelingStyle
{
  public:

    void setLabelSettings( const QgsPalLayerSettings &settings ) { mLabelSettings = settings; }
    QgsPalLayerSettings labelSettings() const { return mLabelSettings; }

    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 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 = Qgis::GeometryType::Unknown;
    bool mEnabled = true;
    QString mExpression;
    int mMinZoomLevel = -1;
    int mMaxZoomLevel = -1;
 
    QgsPalLayerSettings mLabelSettings;
};
 

class CORE_EXPORT QgsVectorTileBasicLabeling : public QgsVectorTileLabeling
{
  public:
    QgsVectorTileBasicLabeling();
 
    QString type() const override;
    QgsVectorTileLabeling *clone() const override SIP_FACTORY;
    QgsVectorTileLabelProvider *provider( QgsVectorTileLayer *layer ) const override SIP_SKIP;
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;

    void setStyles( const QList<QgsVectorTileBasicLabelingStyle> &styles ) { mStyles = styles; }
    QList<QgsVectorTileBasicLabelingStyle> styles() const { return mStyles; }
    void setStyle( int index, const QgsVectorTileBasicLabelingStyle &style ) { mStyles[index] = style; }
    QgsVectorTileBasicLabelingStyle style( int index ) const { return mStyles[index]; }
 
  private:
    QList<QgsVectorTileBasicLabelingStyle> mStyles;
};
 
 
#ifndef SIP_RUN

class QgsVectorTileBasicLabelProvider : public QgsVectorTileLabelProvider
{
  public:
    QgsVectorTileBasicLabelProvider( QgsVectorTileLayer *layer, const QList<QgsVectorTileBasicLabelingStyle> &styles );
 
    QList<QgsAbstractLabelProvider *> subProviders() override;
    bool prepare( QgsRenderContext &context, QSet<QString> &attributeNames ) override;
 
    // virtual functions from QgsVectorTileLabelProvider
    void registerTileFeatures( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) override;
    QMap<QString, QSet<QString> > usedAttributes( const QgsRenderContext &context, int tileZoom ) const override;
    QSet< QString > requiredLayers( QgsRenderContext &context, int tileZoom ) const override;
    void setFields( const QMap<QString, QgsFields> &perLayerFields ) override;
 
  private:
    QList<QgsVectorTileBasicLabelingStyle> mStyles;

    QList<QgsVectorLayerLabelProvider *> mSubProviders;
 
  public:
    QMap<QString, QgsFields> mPerLayerFields;
};
 
#endif
 
 
#endif // QGSVECTORTILEBASICLABELING_H