QGIS API Documentation  2.99.0-Master (dc72e14)
qgsmaptool.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmaptool.cpp - base class for map canvas tools
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 #include "qgslogger.h"
17 #include "qgsmaptool.h"
18 #include "qgsmapcanvas.h"
19 #include "qgsmaptopixel.h"
20 #include "qgsrendercontext.h"
21 #include "qgssettings.h"
22 
23 #include <QAction>
24 #include <QAbstractButton>
25 
27  : QObject( canvas )
28  , mCanvas( canvas )
29  , mCursor( Qt::CrossCursor )
30 {
31 }
32 
33 
35 {
36  mCanvas->unsetMapTool( this );
37 }
38 
39 
41 {
43 }
44 
46 {
47  QgsPointXY result = mCanvas->mapSettings().layerToMapCoordinates( layer, QgsPointXY( point.x(), point.y() ) );
48  return QgsPoint( result.x(), result.y() );
49 }
50 
51 
53 {
54  QgsPointXY pt = toMapCoordinates( point );
55  return toLayerCoordinates( layer, pt );
56 }
57 
59 {
60  return mCanvas->mapSettings().mapToLayerCoordinates( layer, point );
61 }
62 
64 {
65  return mCanvas->mapSettings().layerToMapCoordinates( layer, point );
66 }
67 
69 {
70  return mCanvas->mapSettings().mapToLayerCoordinates( layer, rect );
71 }
72 
74 {
75  qreal x = point.x(), y = point.y();
77  return QPoint( std::round( x ), std::round( y ) );
78 }
79 
80 
82 {
83  // make action and/or button active
84  if ( mAction )
85  mAction->setChecked( true );
86  if ( mButton )
87  mButton->setChecked( true );
88 
89  // set cursor (map tools usually set it in constructor)
90  mCanvas->setCursor( mCursor );
91  QgsDebugMsg( "Cursor has been set" );
92 
93  emit activated();
94 }
95 
96 
98 {
99  if ( mAction )
100  mAction->setChecked( false );
101  if ( mButton )
102  mButton->setChecked( false );
103 
104  emit deactivated();
105 }
106 
108 {
109  if ( mAction )
110  disconnect( mAction, &QObject::destroyed, this, &QgsMapTool::actionDestroyed );
111  mAction = action;
112  if ( mAction )
113  connect( mAction, &QObject::destroyed, this, &QgsMapTool::actionDestroyed );
114 }
115 
116 void QgsMapTool::actionDestroyed()
117 {
118  if ( mAction == sender() )
119  mAction = nullptr;
120 }
121 
123 {
124  return mAction;
125 }
126 
127 void QgsMapTool::setButton( QAbstractButton *button )
128 {
129  mButton = button;
130 }
131 
132 QAbstractButton *QgsMapTool::button()
133 {
134  return mButton;
135 }
136 
137 void QgsMapTool::setCursor( const QCursor &cursor )
138 {
139  mCursor = cursor;
140 }
141 
142 
144 {
145  Q_UNUSED( e );
146 }
147 
149 {
150  Q_UNUSED( e );
151 }
152 
154 {
155  Q_UNUSED( e );
156 }
157 
159 {
160  Q_UNUSED( e );
161 }
162 
163 void QgsMapTool::wheelEvent( QWheelEvent *e )
164 {
165  e->ignore();
166 }
167 
168 void QgsMapTool::keyPressEvent( QKeyEvent *e )
169 {
170  Q_UNUSED( e );
171 }
172 
173 void QgsMapTool::keyReleaseEvent( QKeyEvent *e )
174 {
175  Q_UNUSED( e );
176 }
177 
178 bool QgsMapTool::gestureEvent( QGestureEvent *e )
179 {
180  Q_UNUSED( e );
181  return true;
182 }
183 
185 {
186  return mCanvas;
187 }
188 
190 {
191  QgsSettings settings;
192  double radius = settings.value( QStringLiteral( "Map/searchRadiusMM" ), Qgis::DEFAULT_SEARCH_RADIUS_MM ).toDouble();
193 
194  if ( radius > 0 )
195  {
196  return radius;
197  }
199 }
200 
202 {
203  return searchRadiusMM() * context.scaleFactor() * context.mapToPixel().mapUnitsPerPixel();
204 }
205 
207 {
208  if ( !canvas )
209  {
210  return 0;
211  }
212  QgsMapSettings mapSettings = canvas->mapSettings();
213  QgsRenderContext context = QgsRenderContext::fromMapSettings( mapSettings );
214  return searchRadiusMU( context );
215 }
void unsetMapTool(QgsMapTool *mapTool)
Unset the current map tool or last non zoom tool.
A rectangle specified with double values.
Definition: qgsrectangle.h:38
Base class for all map layer types.
Definition: qgsmaplayer.h:54
double y
Definition: qgspoint.h:41
virtual void canvasMoveEvent(QgsMapMouseEvent *e)
Mouse move event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:143
static double searchRadiusMU(const QgsRenderContext &context)
Get search radius in map units for given context.
Definition: qgsmaptool.cpp:201
QAbstractButton * button()
Return associated button with map tool or NULL if no button is associated.
Definition: qgsmaptool.cpp:132
This class is a composition of two QSettings instances:
Definition: qgssettings.h:54
#define QgsDebugMsg(str)
Definition: qgslogger.h:37
double y
Definition: qgspointxy.h:47
A class to represent a 2D point.
Definition: qgspointxy.h:42
QAbstractButton * mButton
optionally map tool can have pointer to a button which will be used to set that action as active ...
Definition: qgsmaptool.h:231
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
QgsPointXY toMapCoordinates(QPoint point)
transformation from screen coordinates to map coordinates
Definition: qgsmaptool.cpp:40
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:73
virtual void canvasPressEvent(QgsMapMouseEvent *e)
Mouse press event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:153
void setButton(QAbstractButton *button)
Use this to associate a button to this maptool.
Definition: qgsmaptool.cpp:127
The QgsMapSettings class contains configuration for rendering of the map.
void transformInPlace(double &x, double &y) const
Transform device coordinates to map coordinates.
virtual void activate()
called when set as currently active map tool
Definition: qgsmaptool.cpp:81
QgsMapCanvas * mCanvas
pointer to map canvas
Definition: qgsmaptool.h:220
virtual void keyReleaseEvent(QKeyEvent *e)
Key event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:173
QCursor mCursor
cursor used in map tool
Definition: qgsmaptool.h:223
QgsMapCanvas * canvas()
returns pointer to the tool&#39;s map canvas
Definition: qgsmaptool.cpp:184
void setAction(QAction *action)
Use this to associate a QAction to this maptool.
Definition: qgsmaptool.cpp:107
static const double DEFAULT_SEARCH_RADIUS_MM
Identify search radius in mm.
Definition: qgis.h:94
virtual void deactivate()
called when map tool is being deactivated
Definition: qgsmaptool.cpp:97
double mapUnitsPerPixel() const
Return current map units per pixel.
virtual void wheelEvent(QWheelEvent *e)
Mouse wheel event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:163
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:36
void activated()
signal emitted once the map tool is activated
double x
Definition: qgspointxy.h:46
QAction * action()
Return associated action with map tool or NULL if no action is associated.
Definition: qgsmaptool.cpp:122
virtual void keyPressEvent(QKeyEvent *e)
Key event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:168
const QgsMapSettings & mapSettings() const
Get access to properties used for map rendering.
Contains information about the context of a rendering operation.
QgsPointXY toLayerCoordinates(const QgsMapLayer *layer, QPoint point)
transformation from screen coordinates to layer&#39;s coordinates
Definition: qgsmaptool.cpp:52
void deactivated()
signal emitted once the map tool is deactivated
const QgsMapToPixel & mapToPixel() const
virtual bool gestureEvent(QGestureEvent *e)
gesture event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:178
virtual void canvasDoubleClickEvent(QgsMapMouseEvent *e)
Mouse double-click event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:148
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), const Section section=NoSection) const
Returns the value for setting key.
QgsPointXY layerToMapCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from layer&#39;s CRS to output CRS
static QgsRenderContext fromMapSettings(const QgsMapSettings &mapSettings)
create initialized QgsRenderContext instance from given QgsMapSettings
virtual ~QgsMapTool()
Definition: qgsmaptool.cpp:34
QAction * mAction
optionally map tool can have pointer to action which will be used to set that action as active ...
Definition: qgsmaptool.h:227
const QgsMapToPixel * getCoordinateTransform()
Get the current coordinate transform.
virtual void setCursor(const QCursor &cursor)
Set a user defined cursor.
Definition: qgsmaptool.cpp:137
QgsMapTool(QgsMapCanvas *canvas)
constructor takes map canvas as a parameter
Definition: qgsmaptool.cpp:26
QgsPointXY mapToLayerCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from output CRS to layer&#39;s CRS
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
QPoint toCanvasCoordinates(const QgsPointXY &point)
transformation from map coordinates to screen coordinates
Definition: qgsmaptool.cpp:73
QgsPointXY toMapCoordinates(int x, int y) const
static double searchRadiusMM()
Get search radius in mm.
Definition: qgsmaptool.cpp:189
double x
Definition: qgspoint.h:40
virtual void canvasReleaseEvent(QgsMapMouseEvent *e)
Mouse release event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:158