QGIS API Documentation  3.0.2-Girona (307d082)
qgsmapmouseevent.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmapmouseevent.h - mouse event in map coordinates and ability to snap
3  ----------------------
4  begin : October 2014
5  copyright : (C) Denis Rouzaud
6  email : [email protected]
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 QGSMAPMOUSEEVENT_H
17 #define QGSMAPMOUSEEVENT_H
18 
19 #include <QMouseEvent>
20 
21 #include "qgspointxy.h"
22 #include "qgspointlocator.h"
23 #include "qgis_gui.h"
24 
25 class QgsMapCanvas;
27 
35 class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent
36 {
37 
38 #ifdef SIP_RUN
40  if ( dynamic_cast<QgsMapMouseEvent *>( sipCpp ) )
41  sipType = sipType_QgsMapMouseEvent;
42  else
43  sipType = 0;
44  SIP_END
45 #endif
46 
47  public:
48 
55  QgsMapMouseEvent( QgsMapCanvas *mapCanvas, QMouseEvent *event );
56 
67  QgsMapMouseEvent( QgsMapCanvas *mapCanvas, QEvent::Type type, QPoint pos, Qt::MouseButton button = Qt::NoButton,
68  Qt::MouseButtons buttons = Qt::NoButton, Qt::KeyboardModifiers modifiers = Qt::NoModifier );
69 
74  QgsPointXY snapPoint();
75 
82  bool isSnapped() const { return mSnapMatch.isValid(); }
83 
88  inline QgsPointXY mapPoint() const { return mMapPoint; }
89 
97  QgsPointLocator::Match mapPointMatch() const { return mSnapMatch; }
98 
105  void setMapPoint( const QgsPointXY &point );
106 
112  QgsPointXY originalMapPoint() const { return mMapPoint; }
113 
119  QPoint pixelPoint() const { return mPixelPoint; }
120 
127  QPoint originalPixelPoint() const { return pos(); }
128 
129  private:
130 
131  QPoint mapToPixelCoordinates( const QgsPointXY &point );
132 
134  bool mHasCachedSnapResult;
135 
137  QgsPointXY mOriginalMapPoint;
138 
140  QgsPointXY mMapPoint;
141 
146  QPoint mPixelPoint;
147 
149  QgsMapCanvas *mMapCanvas = nullptr;
150 
151  QgsPointLocator::Match mSnapMatch;
152 };
153 
154 #endif // QGSMAPMOUSEEVENT_H
A class to represent a 2D point.
Definition: qgspointxy.h:43
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
bool isSnapped() const
Returns true if there is a snapped point cached.
The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates ...
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:74
#define SIP_END
Definition: qgis_sip.h:175
QgsPointLocator::Match mapPointMatch() const
Returns the matching data from the most recently snapped point.
QgsPointXY originalMapPoint() const
Returns the original, unmodified map point of the mouse cursor.
QPoint originalPixelPoint() const
The unsnapped, real mouse cursor position in pixel coordinates.
QgsPointXY mapPoint() const
mapPoint returns the point in coordinates
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:165
QPoint pixelPoint() const
The snapped mouse cursor in pixel coordinates.