QGIS API Documentation  3.13.0-Master (740be229cb)
qgsmaptoolidentify.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmaptoolidentify.h - map tool for identifying features
3  ---------------------
4  begin : January 2006
5  copyright : (C) 2006 by Martin Dobias
6  email : wonder.sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSMAPTOOLIDENTIFY_H
17 #define QGSMAPTOOLIDENTIFY_H
18 
19 #include "qgsfeature.h"
20 #include "qgsfields.h"
21 #include "qgsmaptool.h"
22 #include "qgspointxy.h"
23 #include "qgsunittypes.h"
24 
25 #include <QObject>
26 #include <QPointer>
27 #include "qgis_gui.h"
28 
29 class QgsRasterLayer;
30 class QgsVectorLayer;
31 class QgsMapLayer;
32 class QgsMapCanvas;
33 class QgsMeshLayer;
34 class QgsHighlight;
35 class QgsIdentifyMenu;
36 
46 class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
47 {
48  Q_OBJECT
49 
50  public:
51 
53  {
54  DefaultQgsSetting = -1,
58  LayerSelection
59  };
60  Q_ENUM( IdentifyMode )
61 
62  enum Type
63  {
66  MeshLayer = 4,
68  };
69  Q_DECLARE_FLAGS( LayerType, Type )
70  Q_FLAG( LayerType )
71 
73  {
75  IdentifyResult() = default;
76 
77  IdentifyResult( QgsMapLayer *layer, const QgsFeature &feature, const QMap< QString, QString > &derivedAttributes )
78  : mLayer( layer ), mFeature( feature ), mDerivedAttributes( derivedAttributes ) {}
79 
80  IdentifyResult( QgsMapLayer *layer, const QString &label, const QMap< QString, QString > &attributes, const QMap< QString, QString > &derivedAttributes )
81  : mLayer( layer ), mLabel( label ), mAttributes( attributes ), mDerivedAttributes( derivedAttributes ) {}
82 
83  IdentifyResult( QgsMapLayer *layer, const QString &label, const QgsFields &fields, const QgsFeature &feature, const QMap< QString, QString > &derivedAttributes )
84  : mLayer( layer ), mLabel( label ), mFields( fields ), mFeature( feature ), mDerivedAttributes( derivedAttributes ) {}
85 
86  QgsMapLayer *mLayer = nullptr;
87  QString mLabel;
90  QMap< QString, QString > mAttributes;
91  QMap< QString, QString > mDerivedAttributes;
92  QMap< QString, QVariant > mParams;
93  };
94 
97 
98  ~QgsMapToolIdentify() override;
99 
100  Flags flags() const override { return QgsMapTool::AllowZoomRect; }
101  void canvasMoveEvent( QgsMapMouseEvent *e ) override;
102  void canvasPressEvent( QgsMapMouseEvent *e ) override;
103  void canvasReleaseEvent( QgsMapMouseEvent *e ) override;
104  void activate() override;
105  void deactivate() override;
106 
114  QList<QgsMapToolIdentify::IdentifyResult> identify( int x, int y, const QList<QgsMapLayer *> &layerList = QList<QgsMapLayer *>(), IdentifyMode mode = DefaultQgsSetting );
115 
126  QList<QgsMapToolIdentify::IdentifyResult> identify( int x, int y, IdentifyMode mode, LayerType layerType = AllLayers );
127 
129  QList<QgsMapToolIdentify::IdentifyResult> identify( const QgsGeometry &geometry, IdentifyMode mode, LayerType layerType );
131  QList<QgsMapToolIdentify::IdentifyResult> identify( const QgsGeometry &geometry, IdentifyMode mode, const QList<QgsMapLayer *> &layerList, LayerType layerType );
132 
133 
138  QgsIdentifyMenu *identifyMenu() {return mIdentifyMenu;}
139 
140  public slots:
141  void formatChanged( QgsRasterLayer *layer );
142 
143  signals:
144  void identifyProgress( int, int );
145  void identifyMessage( const QString & );
146  void changedRasterResults( QList<QgsMapToolIdentify::IdentifyResult> & );
147 
148  protected:
149 
161  QList<QgsMapToolIdentify::IdentifyResult> identify( int x, int y, IdentifyMode mode, const QList<QgsMapLayer *> &layerList, LayerType layerType = AllLayers );
162 
163  QgsIdentifyMenu *mIdentifyMenu = nullptr;
164 
166  bool identifyLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsMapLayer *layer, const QgsPointXY &point, const QgsRectangle &viewExtent, double mapUnitsPerPixel, QgsMapToolIdentify::LayerType layerType = AllLayers );
167 
168  bool identifyRasterLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsRasterLayer *layer, QgsPointXY point, const QgsRectangle &viewExtent, double mapUnitsPerPixel );
169  bool identifyVectorLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsVectorLayer *layer, const QgsPointXY &point );
170 
177  bool identifyMeshLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsMeshLayer *layer, const QgsPointXY &point );
178 
180  QMap< QString, QString > derivedAttributesForPoint( const QgsPoint &point );
181 
194  void setCanvasPropertiesOverrides( double searchRadiusMapUnits );
195 
201  void restoreCanvasPropertiesOverrides();
202 
203  private:
204 
205  bool identifyLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsMapLayer *layer, const QgsGeometry &geometry, const QgsRectangle &viewExtent, double mapUnitsPerPixel, QgsMapToolIdentify::LayerType layerType = AllLayers );
206  bool identifyRasterLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsRasterLayer *layer, const QgsGeometry &geometry, const QgsRectangle &viewExtent, double mapUnitsPerPixel );
207  bool identifyVectorLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsVectorLayer *layer, const QgsGeometry &geometry );
208  bool identifyMeshLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsMeshLayer *layer, const QgsGeometry &geometry );
209 
215  virtual QgsUnitTypes::DistanceUnit displayDistanceUnits() const;
216 
222  virtual QgsUnitTypes::AreaUnit displayAreaUnits() const;
223 
229  QString formatDistance( double distance ) const;
230 
236  QString formatArea( double area ) const;
237 
242  QString formatDistance( double distance, QgsUnitTypes::DistanceUnit unit ) const;
243 
248  QString formatArea( double area, QgsUnitTypes::AreaUnit unit ) const;
249 
250  QMap< QString, QString > featureDerivedAttributes( const QgsFeature &feature, QgsMapLayer *layer, const QgsPointXY &layerPoint = QgsPointXY() );
251 
255  void closestVertexAttributes( const QgsAbstractGeometry &geometry, QgsVertexId vId, QgsMapLayer *layer, QMap< QString, QString > &derivedAttributes );
256 
260  void closestPointAttributes( const QgsAbstractGeometry &geometry, const QgsPointXY &layerPoint, QMap< QString, QString > &derivedAttributes );
261 
262  QString formatCoordinate( const QgsPointXY &canvasPoint ) const;
263  QString formatXCoordinate( const QgsPointXY &canvasPoint ) const;
264  QString formatYCoordinate( const QgsPointXY &canvasPoint ) const;
265 
266  // Last geometry (point or polygon) in map CRS
267  QgsGeometry mLastGeometry;
268 
269  double mLastMapUnitsPerPixel;
270 
271  QgsRectangle mLastExtent;
272 
273  int mCoordinatePrecision;
274 
275  double mOverrideCanvasSearchRadius = -1;
276 };
277 
278 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapToolIdentify::LayerType )
279 
280 #endif
IdentifyResult(QgsMapLayer *layer, const QString &label, const QgsFields &fields, const QgsFeature &feature, const QMap< QString, QString > &derivedAttributes)
IdentifyResult(QgsMapLayer *layer, const QgsFeature &feature, const QMap< QString, QString > &derivedAttributes)
A rectangle specified with double values.
Definition: qgsrectangle.h:41
Base class for all map layer types.
Definition: qgsmaplayer.h:80
virtual void canvasMoveEvent(QgsMapMouseEvent *e)
Mouse move event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:157
QMap< QString, QString > mAttributes
Represents a raster layer.
A class to represent a 2D point.
Definition: qgspointxy.h:43
Allow zooming by rectangle (by holding shift and dragging) while the tool is active.
Definition: qgsmaptool.h:94
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
Container of fields for a vector layer.
Definition: qgsfields.h:42
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:122
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:78
IdentifyResult(QgsMapLayer *layer, const QString &label, const QMap< QString, QString > &attributes, const QMap< QString, QString > &derivedAttributes)
virtual void canvasPressEvent(QgsMapMouseEvent *e)
Mouse press event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:167
virtual void activate()
called when set as currently active map tool
Definition: qgsmaptool.cpp:83
Map tool for identifying features in layers.
Utility class for identifying a unique vertex within a geometry.
A class for highlight features on the map.
Definition: qgshighlight.h:56
The QgsIdentifyMenu class builds a menu to be used with identify results (.
virtual void deactivate()
called when map tool is being deactivated
Definition: qgsmaptool.cpp:99
Abstract base class for all geometries.
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
DistanceUnit
Units of distance.
Definition: qgsunittypes.h:67
Abstract base class for all map tools.
Definition: qgsmaptool.h:62
QMap< QString, QVariant > mParams
Flags flags() const override
Returns the flags for the map tool.
QgsIdentifyMenu * identifyMenu()
Returns a pointer to the identify menu which will be used in layer selection mode this menu can also ...
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Definition: qgsmeshlayer.h:92
Represents a vector layer which manages a vector based data sets.
AreaUnit
Units of area.
Definition: qgsunittypes.h:93
QMap< QString, QString > mDerivedAttributes
virtual void canvasReleaseEvent(QgsMapMouseEvent *e)
Mouse release event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:172