qgsmaptooladvanceddigitizing.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptooladvanceddigitizing.h  - map tool with event in map coordinates
    ----------------------
    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 QGSMAPTOOLADVANCEDDIGITIZE_H
#define QGSMAPTOOLADVANCEDDIGITIZE_H
 
#include <memory>
 
#include "qgis_gui.h"
#include "qgsmapmouseevent.h"
#include "qgsmaptooledit.h"
#include "qgsreferencedgeometry.h"
 
class QgsAdvancedDigitizingDockWidget;
class QgsSnapToGridCanvasItem;
class QgsSnapIndicator;

class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit
{
    Q_OBJECT
  public:
    explicit QgsMapToolAdvancedDigitizing( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget );
    ~QgsMapToolAdvancedDigitizing() override;

    void canvasPressEvent( QgsMapMouseEvent *e ) override;
    void canvasReleaseEvent( QgsMapMouseEvent *e ) override;
    void canvasMoveEvent( QgsMapMouseEvent *e ) override;

    void activate() override;

    void deactivate() override;
 
    QgsAdvancedDigitizingDockWidget *cadDockWidget() const { return mCadDockWidget; }

    virtual QgsMapLayer *layer() const;

    bool isAdvancedDigitizingAllowed() const { return mAdvancedDigitizingAllowed; }

    bool isAutoSnapEnabled() const { return mAutoSnapEnabled; }

    bool useSnappingIndicator() const;
 
  protected:
    void setAdvancedDigitizingAllowed( bool allowed ) { mAdvancedDigitizingAllowed = allowed; }

    void setAutoSnapEnabled( bool enabled ) { mAutoSnapEnabled = enabled; }

    void setUseSnappingIndicator( bool enabled );
 
 
    QgsAdvancedDigitizingDockWidget *mCadDockWidget = nullptr;
 
  public:
    virtual void cadCanvasPressEvent( QgsMapMouseEvent *e ) { Q_UNUSED( e ) }
 

    virtual void cadCanvasReleaseEvent( QgsMapMouseEvent *e ) { Q_UNUSED( e ) }
 

    virtual void cadCanvasMoveEvent( QgsMapMouseEvent *e ) { Q_UNUSED( e ) }

    bool snapToLayerGridEnabled() const;

    void setSnapToLayerGridEnabled( bool snapToLayerGridEnabled );
 
  signals:
 
    //NOTE -- we use QgsReferencedGeometry here, as we'd like to defer the transformation of geometry to a particular
    //desired destination CRS (eg layer CRS or map canvas CRS) as the caller's responsibility. That's because we don't want
    //to waste cycles doing that transformation with every mouse move, when potentially NOTHING is even connected to this signal!
    //By using QgsReferencedGeometry we allows the emitters to just use the geometries they've already calculated for the rubber
    //bands, regardless of what CRS they are in
    void transientGeometryChanged( const QgsReferencedGeometry &geometry );
 
  private slots:

    void cadPointChanged( const QgsPointXY &point );
 
    void onCurrentLayerChanged();
 
  private:
    bool mAdvancedDigitizingAllowed = true;
    bool mAutoSnapEnabled = true;
    bool mSnapToLayerGridEnabled = true;
    QgsSnapToGridCanvasItem *mSnapToGridCanvasItem = nullptr;
 
    std::unique_ptr<QgsSnapIndicator> mSnapIndicator;
};
 
#endif // QGSMAPTOOLADVANCEDDIGITIZE_H