qgsmaptoolshapeabstract.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptoolshapeabstract.h  -  base class for map tools digitizing shapes
    ---------------------
    begin                : January 2022
    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 QGSMAPTOOLSHAPEABSTRACT_H
#define QGSMAPTOOLSHAPEABSTRACT_H
 
// no bindings for now, not stable yet
#define SIP_NO_FILE
 
#include "qgis_gui.h"
#include "qgsabstractgeometry.h"
#include "qgsmaptoolcapture.h"
#include "qgsreferencedgeometry.h"
 
#include <QIcon>
#include <QString>
 
class QgsMapMouseEvent;
class QgsVectorLayer;
class QgsGeometryRubberBand;
class QKeyEvent;
 

class GUI_EXPORT QgsMapToolShapeAbstract
  : public QObject
{
    Q_OBJECT
  public:
    enum class ShapeCategory
    {
      Curve,          
      Circle,         
      Ellipse,        
      Rectangle,      
      RegularPolygon, 
    };
    Q_ENUM( ShapeCategory )
 
    
    QgsMapToolShapeAbstract( const QString &id, QgsMapToolCapture *parentTool )
      : mId( id ), mParentTool( parentTool )
    {
      Q_ASSERT( !mId.isEmpty() );
      Q_ASSERT( parentTool );
    }
 
    ~QgsMapToolShapeAbstract() override;

    QString id() const { return mId; }

    virtual bool cadCanvasReleaseEvent( QgsMapMouseEvent *e, QgsMapToolCapture::CaptureMode mode ) = 0;

    virtual void cadCanvasMoveEvent( QgsMapMouseEvent *e, QgsMapToolCapture::CaptureMode mode ) = 0;

    virtual void keyPressEvent( QKeyEvent *e );

    virtual void keyReleaseEvent( QKeyEvent *e );

    virtual void activate( QgsMapToolCapture::CaptureMode mode, const QgsPoint &lastCapturedMapPoint )
    {
      Q_UNUSED( mode );
      Q_UNUSED( lastCapturedMapPoint )
    }

    virtual void deactivate() { clean(); }

    virtual void clean();

    virtual void undo();
 
  signals:

    void transientGeometryChanged( const QgsReferencedGeometry &geometry );
 
  private:
    QString mId;
 
  protected:
    void setTransientGeometry( const QgsGeometry &geometry );
 
    QgsMapToolCapture *mParentTool = nullptr;

    QgsPointSequence mPoints;
 
    QgsGeometryRubberBand *mTempRubberBand = nullptr;
};
 
 
#endif // QGSMAPTOOLSHAPEABSTRACT_H