qgsvectortilelabeling.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectortilelabeling.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 QGSVECTORTILELABELING_H
#define QGSVECTORTILELABELING_H
 
#include "qgis_core.h"
#include "qgsvectorlayerlabelprovider.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsVectorTileLayer;
class QgsVectorTileRendererData;
 
#ifndef SIP_RUN

class QgsVectorTileLabelProvider : public QgsVectorLayerLabelProvider
{
  public:
    explicit QgsVectorTileLabelProvider( QgsVectorTileLayer *layer );

    virtual QMap<QString, QSet<QString> > usedAttributes( const QgsRenderContext &context, int tileZoom ) const = 0;
 
    //TODO QGIS 5.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 setFields( const QMap<QString, QgsFields> &perLayerFields ) = 0;

    virtual void registerTileFeatures( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) = 0;
};
 
#endif

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

    virtual QString type() const = 0;

    virtual QgsVectorTileLabeling *clone() const = 0 SIP_FACTORY;

    virtual QgsVectorTileLabelProvider *provider( QgsVectorTileLayer *layer ) const SIP_SKIP { Q_UNUSED( layer ) return nullptr; }

    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 // QGSVECTORTILELABELING_H