qgsmaptoolcapture.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptoolcapture.h  -  map tool for capturing points, lines, polygons
    ---------------------
    begin                : January 2006
    copyright            : (C) 2006 by Martin Dobias
    email                : wonder.sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSMAPTOOLCAPTURE_H
#define QGSMAPTOOLCAPTURE_H


#include "qgsmaptooladvanceddigitizing.h"
#include "qgscompoundcurvev2.h"
#include "qgspoint.h"
#include "qgsgeometry.h"
#include "qgslayertreeview.h"
#include "qgspointlocator.h"

#include <QPoint>
#include <QList>

class QgsRubberBand;
class QgsVertexMarker;
class QgsMapLayer;
class QgsGeometryValidator;

class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing
{
    Q_OBJECT

  public:
    QgsMapToolCapture( QgsMapCanvas* canvas, QgsAdvancedDigitizingDockWidget* cadDockWidget, CaptureMode mode = CaptureNone );

    virtual ~QgsMapToolCapture();

    virtual void activate() override;

    virtual void deactivate() override;

    int addCurve( QgsCurveV2* c );

    const QgsCompoundCurveV2* captureCurve() const { return &mCaptureCurve; }


    virtual void cadCanvasMoveEvent( QgsMapMouseEvent * e ) override;

    virtual void keyPressEvent( QKeyEvent* e ) override;

#ifdef Q_OS_WIN
    virtual bool eventFilter( QObject *obj, QEvent *e ) override;
#endif

    void deleteTempRubberBand();

  private slots:
    void validationFinished();
    void currentLayerChanged( QgsMapLayer *layer );
    void addError( QgsGeometry::Error );


  protected:
    // TODO QGIS 3.0 returns an enum instead of a magic constant
    Q_DECL_DEPRECATED int nextPoint( const QgsPoint& mapPoint, QgsPoint& layerPoint );

    // TODO QGIS 3.0 returns an enum instead of a magic constant
    int nextPoint( const QgsPointV2& mapPoint, QgsPointV2& layerPoint );

    // TODO QGIS 3.0 returns an enum instead of a magic constant
    Q_DECL_DEPRECATED int nextPoint( QPoint p, QgsPoint &layerPoint, QgsPoint &mapPoint );

    // TODO QGIS 3.0 returns an enum instead of a magic constant
    int nextPoint( QPoint p, QgsPointV2 &layerPoint, QgsPointV2 &mapPoint );

    // TODO QGIS 3.0 returns an enum instead of a magic constant
    int fetchLayerPoint( QgsPointLocator::Match match, QgsPointV2& layerPoint );

    // TODO QGIS 3.0 returns an enum instead of a magic constant
    int addVertex( const QgsPoint& point );

    int addVertex( const QgsPoint& mapPoint, QgsPointLocator::Match match );

    void undo();

    void startCapturing();

    bool isCapturing() const;

    void stopCapturing();

    int size();

    QList<QgsPoint> points() const;

    QgsPointSequenceV2 pointsV2();

    void setPoints( const QList<QgsPoint>& pointList );

    void closePolygon();

  private:
    bool tracingEnabled();
    QgsPoint tracingStartPoint();
    bool tracingMouseMove( QgsMapMouseEvent* e );
    bool tracingAddVertex( const QgsPoint& point );

  private:
    bool mCapturing;

    QgsRubberBand* mRubberBand;

    QgsRubberBand* mTempRubberBand;

    QgsCompoundCurveV2 mCaptureCurve;

    void validateGeometry();
    QStringList mValidationWarnings;
    QgsGeometryValidator *mValidator;
    QList< QgsGeometry::Error > mGeomErrors;
    QList< QgsVertexMarker * > mGeomErrorMarkers;

    bool mCaptureModeFromLayer;

    QgsVertexMarker* mSnappingMarker;

    friend class TestQgsMapToolReshape;

#ifdef Q_OS_WIN
    int mSkipNextContextMenuEvent;
#endif
};

#endif