QGIS API Documentation  2.99.0-Master (19b062c)
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 QgsHighlight;
34 class QgsIdentifyMenu;
35 class QgsDistanceArea;
36 
46 class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
47 {
48  Q_OBJECT
49  Q_FLAGS( LayerType )
50 
51  public:
52 
54  {
55  DefaultQgsSetting = -1,
59  LayerSelection
60  };
61 
62  enum Type
63  {
64  VectorLayer = 1,
65  RasterLayer = 2,
66  AllLayers = VectorLayer | RasterLayer
67  };
68  Q_DECLARE_FLAGS( LayerType, Type )
69 
71  {
73  IdentifyResult() = default;
74 
75  IdentifyResult( QgsMapLayer *layer, const QgsFeature &feature, const QMap< QString, QString > &derivedAttributes )
76  : mLayer( layer ), mFeature( feature ), mDerivedAttributes( derivedAttributes ) {}
77 
78  IdentifyResult( QgsMapLayer *layer, const QString &label, const QMap< QString, QString > &attributes, const QMap< QString, QString > &derivedAttributes )
79  : mLayer( layer ), mLabel( label ), mAttributes( attributes ), mDerivedAttributes( derivedAttributes ) {}
80 
81  IdentifyResult( QgsMapLayer *layer, const QString &label, const QgsFields &fields, const QgsFeature &feature, const QMap< QString, QString > &derivedAttributes )
82  : mLayer( layer ), mLabel( label ), mFields( fields ), mFeature( feature ), mDerivedAttributes( derivedAttributes ) {}
83 
84  QgsMapLayer *mLayer = nullptr;
85  QString mLabel;
88  QMap< QString, QString > mAttributes;
89  QMap< QString, QString > mDerivedAttributes;
90  QMap< QString, QVariant > mParams;
91  };
92 
95 
96  virtual ~QgsMapToolIdentify();
97 
98  virtual Flags flags() const override { return QgsMapTool::AllowZoomRect; }
99  virtual void canvasMoveEvent( QgsMapMouseEvent *e ) override;
100  virtual void canvasPressEvent( QgsMapMouseEvent *e ) override;
101  virtual void canvasReleaseEvent( QgsMapMouseEvent *e ) override;
102  virtual void activate() override;
103  virtual void deactivate() override;
104 
112  QList<QgsMapToolIdentify::IdentifyResult> identify( int x, int y, const QList<QgsMapLayer *> &layerList = QList<QgsMapLayer *>(), IdentifyMode mode = DefaultQgsSetting );
113 
123  QList<QgsMapToolIdentify::IdentifyResult> identify( int x, int y, IdentifyMode mode, LayerType layerType = AllLayers );
124 
129  QgsIdentifyMenu *identifyMenu() {return mIdentifyMenu;}
130 
131  public slots:
132  void formatChanged( QgsRasterLayer *layer );
133 
134  signals:
135  void identifyProgress( int, int );
136  void identifyMessage( const QString & );
137  void changedRasterResults( QList<QgsMapToolIdentify::IdentifyResult> & );
138 
139  protected:
140 
151  QList<QgsMapToolIdentify::IdentifyResult> identify( int x, int y, IdentifyMode mode, const QList<QgsMapLayer *> &layerList, LayerType layerType = AllLayers );
152 
153  QgsIdentifyMenu *mIdentifyMenu = nullptr;
154 
156  bool identifyLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsMapLayer *layer, const QgsPointXY &point, const QgsRectangle &viewExtent, double mapUnitsPerPixel, QgsMapToolIdentify::LayerType layerType = AllLayers );
157 
158  bool identifyRasterLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsRasterLayer *layer, QgsPointXY point, const QgsRectangle &viewExtent, double mapUnitsPerPixel );
159  bool identifyVectorLayer( QList<QgsMapToolIdentify::IdentifyResult> *results, QgsVectorLayer *layer, const QgsPointXY &point );
160 
161  private:
162 
168  virtual QgsUnitTypes::DistanceUnit displayDistanceUnits() const;
169 
175  virtual QgsUnitTypes::AreaUnit displayAreaUnits() const;
176 
182  QString formatDistance( double distance ) const;
183 
189  QString formatArea( double area ) const;
190 
191  QMap< QString, QString > featureDerivedAttributes( QgsFeature *feature, QgsMapLayer *layer, const QgsPointXY &layerPoint = QgsPointXY() );
192 
196  void closestVertexAttributes( const QgsAbstractGeometry &geometry, QgsVertexId vId, QgsMapLayer *layer, QMap< QString, QString > &derivedAttributes );
197 
198  QString formatCoordinate( const QgsPointXY &canvasPoint ) const;
199  QString formatXCoordinate( const QgsPointXY &canvasPoint ) const;
200  QString formatYCoordinate( const QgsPointXY &canvasPoint ) const;
201 
202  // Last point in canvas CRS
203  QgsPointXY mLastPoint;
204 
205  double mLastMapUnitsPerPixel;
206 
207  QgsRectangle mLastExtent;
208 
209  int mCoordinatePrecision;
210 };
211 
212 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapToolIdentify::LayerType )
213 
214 #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:39
Base class for all map layer types.
Definition: qgsmaplayer.h:56
virtual void canvasMoveEvent(QgsMapMouseEvent *e)
Mouse move event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:148
QMap< QString, QString > mAttributes
This class provides qgis with the ability to render raster datasets onto the mapcanvas.
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:95
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
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:62
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:74
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:158
virtual void activate()
called when set as currently active map tool
Definition: qgsmaptool.cpp:81
Map tool for identifying features in layers.
Utility class for identifying a unique vertex within a geometry.
virtual Flags flags() const override
Returns the flags for the map tool.
A class for highlight features on the map.
Definition: qgshighlight.h:49
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:97
Abstract base class for all geometries.
DistanceUnit
Units of distance.
Definition: qgsunittypes.h:43
Abstract base class for all map tools.
Definition: qgsmaptool.h:63
A general purpose distance and area calculator, capable of performing ellipsoid based calculations...
QMap< QString, QVariant > mParams
QgsIdentifyMenu * identifyMenu()
return a pointer to the identify menu which will be used in layer selection mode this menu can also b...
Represents a vector layer which manages a vector based data sets.
AreaUnit
Units of area.
Definition: qgsunittypes.h:69
QMap< QString, QString > mDerivedAttributes
virtual void canvasReleaseEvent(QgsMapMouseEvent *e)
Mouse release event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:163