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 "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmapsettings.h"
#include "qgsgeometry.h"
#include "qgstaskmanager.h"
#include "qgscoordinatetransform.h"
 
#include <QSet>
 
class QgsRenderContext;
class QgsSymbol;
class QgsVectorLayer;
class QgsExpression;
class QgsAbstractFeatureSource;
class QgsFeatureRenderer;
 
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 );
 
    void run();
 
    QMap<QString, QSet<QString>> results() const SIP_SKIP;
 
 
    QMap<QString, QList<QString>> resultsPy() const SIP_PYNAME( results );
 
    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 QgsCoordinateReferenceSystem &crs,
                                  const QgsFields &fields,
                                  const QgsFeatureRenderer *renderer,
                                  SymbolSet &usedSymbols,
                                  SymbolSet &usedSymbolsRuleKey,
                                  QgsRenderContext &context,
                                  QgsFeedback *feedback );
 
    QgsMapSettings mSettings;
 
    HitTest mHitTest;
 
    HitTest mHitTestRuleKey;
 
    QgsMapHitTest::LayerFilterExpression mLayerFilterExpression;
 
    QgsGeometry mPolygon;
 
    bool mOnlyExpressions;
 
    friend class QgsMapHitTestTask;
};
 
 
class CORE_EXPORT QgsMapHitTestTask : public QgsTask
{
    Q_OBJECT
 
  public:
 
    QgsMapHitTestTask( const QgsMapSettings &settings, const QgsGeometry &polygon = QgsGeometry(), const QgsMapHitTest::LayerFilterExpression &layerFilterExpression = QgsMapHitTest::LayerFilterExpression() );
 
    QgsMapHitTestTask( const QgsMapSettings &settings, const QgsMapHitTest::LayerFilterExpression &layerFilterExpression );
 
    QMap<QString, QSet<QString>> results() const SIP_SKIP;
 
 
    QMap<QString, QList<QString>> resultsPy() const SIP_PYNAME( results );
 
    void cancel() override;
 
  protected:
 
    bool run() override;
 
  private:
 
    void prepare();
 
    struct PreparedLayerData
    {
      std::unique_ptr< QgsAbstractFeatureSource > source;
      QString layerId;
      QgsCoordinateReferenceSystem crs;
      QgsFields fields;
      std::unique_ptr< QgsFeatureRenderer > renderer;
      QgsRectangle extent;
      QgsCoordinateTransform transform;
      std::unique_ptr< QgsExpressionContextScope > layerScope;
    };
 
    std::vector< PreparedLayerData > mPreparedData;
 
    QgsMapSettings mSettings;
    QgsMapHitTest::LayerFilterExpression mLayerFilterExpression;
    QgsGeometry mPolygon;
    bool mOnlyExpressions = false;
    QMap<QString, QSet<QString>> mResults;
 
    std::unique_ptr< QgsFeedback > mFeedback;
};
 
#endif // QGSMAPHITTEST_H