qgsprocessingparametertileextentmaxzoomlist.h

Go to the documentation of this file.

/***************************************************************************
  qgsprocessingparametertileextentmaxzoomlist.h
  ---------------------
  Date                 : September 2026
  Copyright            : (C) 2026 by Nyall Dawson
  Email                : nyall dot dawson 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 QGSPROCESSINGPARAMETERTILEEXTENTMAXZOOMLIST_H
#define QGSPROCESSINGPARAMETERTILEEXTENTMAXZOOMLIST_H
 
#include "qgsprocessingoutputs.h"
#include "qgsprocessingparameters.h"
#include "qgsprocessingparametertype.h"
#include "qgsreferencedgeometry.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

struct CORE_EXPORT QgsTileExtentMaxZoomRegion
{
    QgsReferencedRectangle extent;

    int maxZoom = 0;
};

class CORE_EXPORT QgsProcessingParameterTileExtentMaxZoomList : public QgsProcessingParameterDefinition
{
  public:
    explicit QgsProcessingParameterTileExtentMaxZoomList( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(), bool optional = false );
 
    QgsProcessingParameterTileExtentMaxZoomList *clone() const override SIP_FACTORY;
    QString type() const override;
    bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
    QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
 
    QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
    QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;

    static QString typeName() { return u"tileextentmaxzoomlist"_s; } // cppcheck-suppress duplInheritedMember

    QList<QgsTileExtentMaxZoomRegion> parameterAsRegionList( const QVariant &variant, QgsProcessingContext &context ) const;

    static QVariant toVariant( const QList<QgsTileExtentMaxZoomRegion> &regions );

    QgsTileExtentMaxZoomRegion regionFromVariant( const QVariant &variant, QgsProcessingContext &context ) const;

    static int maxZoomForTile( const QgsRectangle &tileExtent, const QList<QgsTileExtentMaxZoomRegion> &regions, int defaultMaxZoom );
 
  private:
    static QVariantMap regionToVariantMap( const QgsTileExtentMaxZoomRegion &region );
 
    QgsTileExtentMaxZoomRegion regionFromVariantMap( const QVariantMap &map, QgsProcessingContext &context ) const;
};
 
#ifndef SIP_RUN

class CORE_EXPORT QgsProcessingParameterTypeTileExtentMaxZoomList : public QgsProcessingParameterType
{
  public:
    QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY { return new QgsProcessingParameterTileExtentMaxZoomList( name ); }
 
    QString description() const override
    {
      return QCoreApplication::translate( "Processing", "An input for defining a list of spatial extents, each with an associated maximum zoom level override." );
    }
    QString name() const override { return QCoreApplication::translate( "Processing", "Tile Extent Maximum Zoom List" ); }
    QString id() const override { return QgsProcessingParameterTileExtentMaxZoomList::typeName(); }
    QString pythonImportString() const override { return u"from qgis.core import QgsProcessingParameterTileExtentMaxZoomList"_s; }
    QString className() const override { return u"QgsProcessingParameterTileExtentMaxZoomList"_s; }
    QStringList acceptedParameterTypes() const override { return { QgsProcessingParameterTileExtentMaxZoomList::typeName() }; }
    QStringList acceptedOutputTypes() const override { return {}; }
};

#endif
 
#endif // QGSPROCESSINGPARAMETERTILEEXTENTMAXZOOMLIST_H