qgsmapmouseevent.h

Go to the documentation of this file.

/***************************************************************************
    qgsmapmouseevent.h  -  mouse event in map coordinates and ability to snap
    ----------------------
    begin                : October 2014
    copyright            : (C) Denis Rouzaud
    email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSMAPMOUSEEVENT_H
#define QGSMAPMOUSEEVENT_H

#include <QMouseEvent>

#include "qgspointxy.h"
#include "qgspointlocator.h"
#include "qgis_gui.h"

class QgsMapCanvas;
class QgsMapToolAdvancedDigitizing;

class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsMapMouseEvent *>( sipCpp ) )
      sipType = sipType_QgsMapMouseEvent;
    else
      sipType = 0;
    SIP_END
#endif

  public:

    QgsMapMouseEvent( QgsMapCanvas *mapCanvas, QMouseEvent *event );

    QgsMapMouseEvent( QgsMapCanvas *mapCanvas, QEvent::Type type, QPoint pos, Qt::MouseButton button = Qt::NoButton,
                      Qt::MouseButtons buttons = Qt::NoButton, Qt::KeyboardModifiers modifiers = Qt::NoModifier );

    QgsPointXY snapPoint();

    bool isSnapped() const { return mSnapMatch.isValid(); }

    inline QgsPointXY mapPoint() const { return mMapPoint; }

    QgsPointLocator::Match mapPointMatch() const { return mSnapMatch; }

    void setMapPoint( const QgsPointXY &point );

    QgsPointXY originalMapPoint() const { return mMapPoint; }

    QPoint pixelPoint() const { return mPixelPoint; }

    QPoint originalPixelPoint() const { return pos(); }

  private:

    QPoint mapToPixelCoordinates( const QgsPointXY &point );

    bool mHasCachedSnapResult;

    QgsPointXY mOriginalMapPoint;

    QgsPointXY mMapPoint;

    QPoint mPixelPoint;

    QgsMapCanvas *mMapCanvas = nullptr;

    QgsPointLocator::Match mSnapMatch;
};

#endif // QGSMAPMOUSEEVENT_H