qgsmaphittest.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaphittest.h
    ---------------------
    begin                : September 2014
    copyright            : (C) 2014 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 QGSMAPHITTEST_H
#define QGSMAPHITTEST_H
 
#include <utility>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscoordinatetransform.h"
#include "qgsgeometry.h"
#include "qgslayertreefiltersettings.h"
#include "qgsmapsettings.h"
#include "qgsmeshlayer.h"
#include "qgsrasterdataprovider.h"
#include "qgsrasterminmaxorigin.h"
#include "qgstaskmanager.h"
 
#include <QSet>
 
class QgsRenderContext;
class QgsSymbol;
class QgsVectorLayer;
class QgsExpression;
class QgsAbstractFeatureSource;
class QgsFeatureRenderer;
class QgsLayerTreeFilterSettings;

class CORE_EXPORT QgsMapHitTest
{
  public:
    typedef QMap<QString, QString> LayerFilterExpression;

    QgsMapHitTest( const QgsMapSettings &settings, const QgsGeometry &polygon = QgsGeometry(), const QgsMapHitTest::LayerFilterExpression &layerFilterExpression = QgsMapHitTest::LayerFilterExpression() );

    QgsMapHitTest( const QgsMapSettings &settings, const QgsMapHitTest::LayerFilterExpression &layerFilterExpression );

    QgsMapHitTest( const QgsLayerTreeFilterSettings &settings );

    void run();

    QMap<QString, QSet<QString>> results() const SIP_SKIP;


    QMap<QString, QList<QString>> resultsPy() const SIP_PYNAME( results );

    QMap<QString, std::pair<double, double>> resultsRenderersUpdatedCanvas() const SIP_SKIP { return mHitTestRenderersUpdatedCanvas; }
 
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT resultsRenderersUpdatedCanvasPy() const SIP_PYNAME( resultsRenderersUpdatedCanvas ) SIP_TYPEHINT( Dict[str, Tuple[float, float]] );
    % MethodCode
    QMap<QString, std::pair<double, double>> results = sipCpp->resultsRenderersUpdatedCanvas();
    sipRes = PyDict_New();
 
    for ( auto it = results.constBegin(); it != results.constEnd(); ++it )
    {
      PyObject *tuple = PyTuple_New( 2 );
      PyTuple_SET_ITEM( tuple, 0, PyFloat_FromDouble( it.value().first ) );
      PyTuple_SET_ITEM( tuple, 1, PyFloat_FromDouble( it.value().second ) );
      PyDict_SetItem( sipRes, PyUnicode_FromString( it.key().toUtf8().constData() ), tuple );
      Py_DECREF( tuple );
    }
    % End
// clang-format on
#endif

      bool symbolVisible( QgsSymbol *symbol, QgsVectorLayer *layer ) const;

    bool legendKeyVisible( const QString &ruleKey, QgsVectorLayer *layer ) const;
 
  private:
    typedef QSet<QString> SymbolSet;

    typedef QMap<QString, SymbolSet> HitTest;

    void runHitTestFeatureSource(
      QgsAbstractFeatureSource *source,
      const QString &layerId,
      const QgsFields &fields,
      const QgsFeatureRenderer *renderer,
      SymbolSet &usedSymbols,
      SymbolSet &usedSymbolsRuleKey,
      QgsRenderContext &context,
      QgsFeedback *feedback,
      const QgsGeometry &visibleExtent
    );

    void runHitTestRasterSource(
      QgsRasterDataProvider *provider,
      const QString &layerId,
      const int band,
      const QgsRasterMinMaxOrigin minMaxOrigin,
      const Qgis::RasterRangeLimit rangeLimit,
      const QgsRenderContext &context,
      QgsFeedback *feedback,
      const QgsGeometry &visibleExtent
    );

    void runHitTestMeshSource( QgsMeshLayer *layer, const QString &layerId, const QgsMeshDatasetIndex datasetIndex, const QgsRenderContext &context, QgsFeedback *feedback, const QgsGeometry &visibleExtent );
    HitTest mHitTest;

    HitTest mHitTestRuleKey;
 
    QgsLayerTreeFilterSettings mSettings;
 
    QMap<QString, std::pair<double, double>> mHitTestRenderersUpdatedCanvas;
 
    friend class QgsMapHitTestTask;
};
 

class CORE_EXPORT QgsMapHitTestTask : public QgsTask
{
    Q_OBJECT
 
  public:
    QgsMapHitTestTask( const QgsLayerTreeFilterSettings &settings );

    QMap<QString, QSet<QString>> results() const SIP_SKIP;


    QMap<QString, QList<QString>> resultsPy() const SIP_PYNAME( results );
 
    void cancel() override;

    QMap<QString, std::pair<double, double>> resultsRenderersUpdatedCanvas() const SIP_SKIP { return mResultsRenderersUpdatedCanvas; };
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT resultsRenderersUpdatedCanvasPy() const SIP_PYNAME( resultsRenderersUpdatedCanvas ) SIP_TYPEHINT( Dict[str, Tuple[float, float]] );
    % MethodCode
    QMap<QString, std::pair<double, double>> results = sipCpp->resultsRenderersUpdatedCanvas();
    sipRes = PyDict_New();
 
    for ( auto it = results.constBegin(); it != results.constEnd(); ++it )
    {
      PyObject *tuple = PyTuple_New( 2 );
      PyTuple_SET_ITEM( tuple, 0, PyFloat_FromDouble( it.value().first ) );
      PyTuple_SET_ITEM( tuple, 1, PyFloat_FromDouble( it.value().second ) );
      PyDict_SetItem( sipRes, PyUnicode_FromString( it.key().toUtf8().constData() ), tuple );
      Py_DECREF( tuple );
    }
    % End
// clang-format on
#endif
 
    // clang-format off
    protected:
    // clang-format on
 
    bool run() override;
 
  private:
    void prepare();
 
    struct PreparedLayerData
    {
        std::unique_ptr< QgsAbstractFeatureSource > source;
        QString layerId;
        QgsFields fields;
        std::unique_ptr< QgsFeatureRenderer > renderer;
        QgsGeometry extent;
        QgsCoordinateTransform transform;
        std::unique_ptr< QgsExpressionContextScope > layerScope;
    };
 
    struct PreparedRasterData
    {
        std::unique_ptr< QgsRasterDataProvider > provider;
        QString layerId;
        int band;
        QgsRasterMinMaxOrigin minMaxOrigin;
        Qgis::RasterRangeLimit rangeLimit;
        QgsCoordinateTransform transform;
        QgsGeometry extent;
    };
 
    struct PreparedMeshData
    {
        std::unique_ptr< QgsMeshLayer > layer;
        QString layerId;
        QgsMeshDatasetIndex datasetIndex;
        QgsCoordinateTransform transform;
        QgsGeometry extent;
    };
 
    std::vector< PreparedLayerData > mPreparedData;
 
    std::vector< PreparedRasterData > mPreparedRasterData;
 
    std::vector< PreparedMeshData > mPreparedMeshData;
 
    QgsLayerTreeFilterSettings mSettings;
 
    QMap<QString, QSet<QString>> mResults;
 
    QMap<QString, std::pair<double, double>> mResultsRenderersUpdatedCanvas;
 
    std::unique_ptr< QgsFeedback > mFeedback;
};
 
#endif // QGSMAPHITTEST_H