qgsmaptoolidentify.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptoolidentify.h  -  map tool for identifying features
    ---------------------
    begin                : January 2006
    copyright            : (C) 2006 by Martin Dobias
    email                : wonder.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 QGSMAPTOOLIDENTIFY_H
#define QGSMAPTOOLIDENTIFY_H
 
#include "qgis_gui.h"
#include "qgsfeature.h"
#include "qgsfields.h"
#include "qgsidentifycontext.h"
#include "qgsmaptool.h"
#include "qgspointxy.h"
 
#include <QObject>
#include <QPointer>
 
class QgsRasterLayer;
class QgsVectorLayer;
class QgsVectorTileLayer;
class QgsMapLayer;
class QgsMapCanvas;
class QgsMeshLayer;
class QgsHighlight;
class QgsIdentifyMenu;
class QgsPointCloudLayer;
class QgsPointCloudLayerElevationProperties;
class QgsFeatureRenderer;
class QgsExpressionContext;
class QgsCoordinateReferenceSystem;

class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
{
    Q_OBJECT
 
  public:
    enum IdentifyMode
    {
      DefaultQgsSetting = -1,
      ActiveLayer,
      TopDownStopAtFirst,
      TopDownAll,
      LayerSelection
    };
    Q_ENUM( IdentifyMode )
 
    enum Type SIP_ENUM_BASETYPE( IntFlag )
    {
      VectorLayer = 1,
      RasterLayer = 2,
      MeshLayer = 4,        
      VectorTileLayer = 8,  
      PointCloudLayer = 16, 
      AllLayers = VectorLayer | RasterLayer | MeshLayer | VectorTileLayer | PointCloudLayer
    };
    Q_DECLARE_FLAGS( LayerType, Type )
    Q_FLAG( LayerType )
 
    struct IdentifyResult
    {
        IdentifyResult() = default;
 
        IdentifyResult( QgsMapLayer *layer, const QgsFeature &feature, const QMap<QString, QString> &derivedAttributes )
          : mLayer( layer )
          , mFeature( feature )
          , mDerivedAttributes( derivedAttributes )
        {}
 
        IdentifyResult( QgsMapLayer *layer, const QString &label, const QMap<QString, QString> &attributes, const QMap<QString, QString> &derivedAttributes )
          : mLayer( layer )
          , mLabel( label )
          , mAttributes( attributes )
          , mDerivedAttributes( derivedAttributes )
        {}
 
        IdentifyResult( QgsMapLayer *layer, const QString &label, const QgsFields &fields, const QgsFeature &feature, const QMap<QString, QString> &derivedAttributes )
          : mLayer( layer )
          , mLabel( label )
          , mFields( fields )
          , mFeature( feature )
          , mDerivedAttributes( derivedAttributes )
        {}
 
        QgsMapLayer *mLayer = nullptr;
        QString mLabel;
        QgsFields mFields;
        QgsFeature mFeature;
        QMap<QString, QString> mAttributes;
        QMap<QString, QString> mDerivedAttributes;
        QMap<QString, QVariant> mParams;
    };
 
    struct IdentifyProperties
    {
        double searchRadiusMapUnits = -1;
        bool skip3DLayers = false;
    };

    QgsMapToolIdentify( QgsMapCanvas *canvas );
 
    ~QgsMapToolIdentify() override;
 
    Flags flags() const override { return QgsMapTool::AllowZoomRect; }
    void canvasMoveEvent( QgsMapMouseEvent *e ) override;
    void canvasPressEvent( QgsMapMouseEvent *e ) override;
    void canvasReleaseEvent( QgsMapMouseEvent *e ) override;
    void activate() override;
    void deactivate() override;

    QList<QgsMapToolIdentify::IdentifyResult> identify(
      int x, int y, const QList<QgsMapLayer *> &layerList = QList<QgsMapLayer *>(), IdentifyMode mode = DefaultQgsSetting, const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );

    QList<QgsMapToolIdentify::IdentifyResult> identify( int x, int y, IdentifyMode mode, LayerType layerType = AllLayers, const QgsIdentifyContext &identifyContext = QgsIdentifyContext() );

    QList<QgsMapToolIdentify::IdentifyResult> identify( const QgsGeometry &geometry, IdentifyMode mode, LayerType layerType, const QgsIdentifyContext &identifyContext = QgsIdentifyContext() );
    QList<QgsMapToolIdentify::IdentifyResult> identify(
      const QgsGeometry &geometry, IdentifyMode mode, const QList<QgsMapLayer *> &layerList, LayerType layerType, const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );
 

    QgsIdentifyMenu *identifyMenu() { return mIdentifyMenu; }

    static void fromPointCloudIdentificationToIdentifyResults( QgsPointCloudLayer *layer, const QVector<QVariantMap> &identified, QList<QgsMapToolIdentify::IdentifyResult> &results ) SIP_SKIP;

    void fromElevationProfileLayerIdentificationToIdentifyResults( QgsMapLayer *layer, const QVector<QVariantMap> &identified, QList<QgsMapToolIdentify::IdentifyResult> &results ) SIP_SKIP;
 
  public slots:
    void formatChanged( QgsRasterLayer *layer );
 
  signals:

    void identifyProgress( int processed, int total );

    void identifyMessage( const QString &message );

    void changedRasterResults( QList<QgsMapToolIdentify::IdentifyResult> &results );
 
  protected:
    QList<QgsMapToolIdentify::IdentifyResult> identify(
      int x, int y, IdentifyMode mode, const QList<QgsMapLayer *> &layerList, LayerType layerType = AllLayers, const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );
 
    QgsIdentifyMenu *mIdentifyMenu = nullptr;

    bool identifyLayer(
      QList<QgsMapToolIdentify::IdentifyResult> *results,
      QgsMapLayer *layer,
      const QgsPointXY &point,
      const QgsRectangle &viewExtent,
      double mapUnitsPerPixel,
      QgsMapToolIdentify::LayerType layerType = AllLayers,
      const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );

    bool identifyRasterLayer(
      QList<QgsMapToolIdentify::IdentifyResult> *results,
      QgsRasterLayer *layer,
      QgsPointXY point,
      const QgsRectangle &viewExtent,
      double mapUnitsPerPixel,
      const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );

    bool identifyVectorLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsVectorLayer *layer, const QgsPointXY &point, const QgsIdentifyContext &identifyContext = QgsIdentifyContext() );

    bool identifyMeshLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsMeshLayer *layer, const QgsPointXY &point, const QgsIdentifyContext &identifyContext = QgsIdentifyContext() );

    QMap<QString, QString> derivedAttributesForPoint( const QgsPoint &point );

    Q_DECL_DEPRECATED void setCanvasPropertiesOverrides( double searchRadiusMapUnits ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void restoreCanvasPropertiesOverrides() SIP_DEPRECATED;

    void setPropertiesOverrides( IdentifyProperties overrides );

    void restorePropertiesOverrides();
 
  private:
    bool identifyLayer(
      QList<QgsMapToolIdentify::IdentifyResult> *results,
      QgsMapLayer *layer,
      const QgsGeometry &geometry,
      const QgsRectangle &viewExtent,
      double mapUnitsPerPixel,
      QgsMapToolIdentify::LayerType layerType = AllLayers,
      const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );
    bool identifyRasterLayer(
      QList<QgsMapToolIdentify::IdentifyResult> *results,
      QgsRasterLayer *layer,
      const QgsGeometry &geometry,
      const QgsRectangle &viewExtent,
      double mapUnitsPerPixel,
      const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );
    bool identifyVectorLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsVectorLayer *layer, const QgsGeometry &geometry, const QgsIdentifyContext &identifyContext = QgsIdentifyContext() );
    int identifyVectorLayer(
      QList<QgsMapToolIdentify::IdentifyResult> *results,
      QgsVectorLayer *layer,
      const QgsFeatureList &features,
      QgsFeatureRenderer *renderer,
      const QMap<QString, QString> &commonDerivedAttributes,
      const std::function<QMap<QString, QString>( const QgsFeature & )> &derivedAttributes,
      QgsRenderContext &context
    );
    bool identifyMeshLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsMeshLayer *layer, const QgsGeometry &geometry, const QgsIdentifyContext &identifyContext = QgsIdentifyContext() );
    bool identifyVectorTileLayer(
      QList<QgsMapToolIdentify::IdentifyResult> *results, QgsVectorTileLayer *layer, const QgsGeometry &geometry, const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );
    bool identifyPointCloudLayer(
      QList<QgsMapToolIdentify::IdentifyResult> *results, QgsPointCloudLayer *layer, const QgsGeometry &geometry, const QgsIdentifyContext &identifyContext = QgsIdentifyContext()
    );

    virtual Qgis::DistanceUnit displayDistanceUnits() const;

    virtual Qgis::AreaUnit displayAreaUnits() const;

    QString formatDistance( double distance ) const;

    QString formatArea( double area ) const;

    QString formatDistance( double distance, Qgis::DistanceUnit unit ) const;

    QString formatArea( double area, Qgis::AreaUnit unit ) const;
 
    QMap<QString, QString> featureDerivedAttributes( const QgsFeature &feature, QgsMapLayer *layer, const QgsPointXY &layerPoint = QgsPointXY() );

    void closestVertexAttributes(
      const QgsCoordinateTransform layerToMapTransform,
      const QgsCoordinateReferenceSystem &layerVertCrs,
      const QgsCoordinateReferenceSystem &mapVertCrs,
      const QgsAbstractGeometry &geometry,
      QgsVertexId vId,
      bool showTransformedZ,
      QMap<QString, QString> &derivedAttributes
    );

    void closestPointAttributes(
      const QgsCoordinateTransform layerToMapTransform,
      const QgsCoordinateReferenceSystem &layerVertCrs,
      const QgsCoordinateReferenceSystem &mapVertCrs,
      const QgsAbstractGeometry &geometry,
      const QgsPointXY &layerPoint,
      bool showTransformedZ,
      QMap<QString, QString> &derivedAttributes
    );
 
    static void formatCoordinate( const QgsPointXY &canvasPoint, QString &x, QString &y, const QgsCoordinateReferenceSystem &mapCrs, int coordinatePrecision );
    void formatCoordinate( const QgsPointXY &canvasPoint, QString &x, QString &y ) const;
 
    // Last geometry (point or polygon) in map CRS
    QgsGeometry mLastGeometry;
 
    double mLastMapUnitsPerPixel = -1.0;
 
    QgsRectangle mLastExtent;
 
    int mCoordinatePrecision = 6;
 
    IdentifyProperties mPropertiesOverrides;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapToolIdentify::LayerType )
 
#endif