QGIS API Documentation  2.99.0-Master (009e47e)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsMapToolAdvancedDigitizing Class Reference

The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates and allows filtering its events. More...

#include <qgsmaptooladvanceddigitizing.h>

Inheritance diagram for QgsMapToolAdvancedDigitizing:
Inheritance graph
[legend]

Public Types

enum  CaptureMode {
  CaptureNone, CapturePoint, CaptureSegment, CaptureLine,
  CapturePolygon
}
 Different capture modes. More...
 
- Public Types inherited from QgsMapTool
enum  Flag { Transient = 1 << 1, EditTool = 1 << 2, AllowZoomRect = 1 << 3 }
 Enumeration of flags that adjust the way the map tool operates. More...
 

Public Member Functions

 QgsMapToolAdvancedDigitizing (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
 Creates an advanced digitizing maptool. More...
 
virtual void activate () override
 Registers this maptool with the cad dock widget. More...
 
QgsAdvancedDigitizingDockWidgetcadDockWidget () const
 
virtual void canvasMoveEvent (QgsMapMouseEvent *e) override
 Catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
virtual void canvasPressEvent (QgsMapMouseEvent *e) override
 Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
virtual void canvasReleaseEvent (QgsMapMouseEvent *e) override
 Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
virtual void deactivate () override
 Unregisters this maptool from the cad dock widget. More...
 
CaptureMode mode () const
 The capture mode. More...
 
void setMode (CaptureMode mode)
 Set capture mode. More...
 
- Public Member Functions inherited from QgsMapToolEdit
 QgsMapToolEdit (QgsMapCanvas *canvas)
 
double defaultZValue () const
 Return default Z value Use for set Z coordinate to new vertex for 2.5d geometries. More...
 
virtual Flags flags () const override
 Returns the flags for the map tool. More...
 
- Public Member Functions inherited from QgsMapTool
virtual ~QgsMapTool ()
 
QAction * action ()
 Return associated action with map tool or NULL if no action is associated. More...
 
QAbstractButton * button ()
 Return associated button with map tool or NULL if no button is associated. More...
 
QgsMapCanvascanvas ()
 returns pointer to the tool's map canvas More...
 
virtual void canvasDoubleClickEvent (QgsMapMouseEvent *e)
 Mouse double click event for overriding. Default implementation does nothing. More...
 
virtual bool gestureEvent (QGestureEvent *e)
 gesture event for overriding. Default implementation does nothing. More...
 
virtual void keyPressEvent (QKeyEvent *e)
 Key event for overriding. Default implementation does nothing. More...
 
virtual void keyReleaseEvent (QKeyEvent *e)
 Key event for overriding. Default implementation does nothing. More...
 
void setAction (QAction *action)
 Use this to associate a QAction to this maptool. More...
 
void setButton (QAbstractButton *button)
 Use this to associate a button to this maptool. More...
 
virtual void setCursor (const QCursor &cursor)
 Set a user defined cursor. More...
 
QString toolName ()
 Emit map tool changed with the old tool. More...
 
virtual void wheelEvent (QWheelEvent *e)
 Mouse wheel event for overriding. Default implementation does nothing. More...
 

Protected Member Functions

virtual void cadCanvasMoveEvent (QgsMapMouseEvent *e)
 Override this method when subclassing this class. More...
 
virtual void cadCanvasPressEvent (QgsMapMouseEvent *e)
 Override this method when subclassing this class. More...
 
virtual void cadCanvasReleaseEvent (QgsMapMouseEvent *e)
 Override this method when subclassing this class. More...
 
- Protected Member Functions inherited from QgsMapToolEdit
int addTopologicalPoints (const QList< QgsPointXY > &geom)
 Adds vertices to other features to keep topology up to date, e.g. More...
 
QgsGeometryRubberBandcreateGeometryRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false) const
 
QgsRubberBandcreateRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false)
 Creates a rubber band with the color/line width from the QGIS settings. More...
 
QgsVectorLayercurrentVectorLayer ()
 Returns the current vector layer of the map canvas or 0. More...
 
void notifyNotEditableLayer ()
 Display a timed message bar noting the active vector layer is not editable. More...
 
void notifyNotVectorLayer ()
 Display a timed message bar noting the active layer is not vector. More...
 
- Protected Member Functions inherited from QgsMapTool
 QgsMapTool (QgsMapCanvas *canvas)
 constructor takes map canvas as a parameter More...
 
QPoint toCanvasCoordinates (const QgsPointXY &point)
 transformation from map coordinates to screen coordinates More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
 transformation from screen coordinates to layer's coordinates More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 transformation from map coordinates to layer's coordinates More...
 
QgsRectangle toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
 trnasformation of the rect from map coordinates to layer's coordinates More...
 
QgsPointXY toMapCoordinates (QPoint point)
 transformation from screen coordinates to map coordinates More...
 
QgsPointXY toMapCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...
 
QgsPoint toMapCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
 transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...
 

Protected Attributes

CaptureMode mCaptureMode
 The capture mode in which this tool operates. More...
 
bool mSnapOnDoubleClick
 Snap on double click. More...
 
bool mSnapOnMove
 Snap on move. More...
 
bool mSnapOnPress
 Snap on press. More...
 
bool mSnapOnRelease
 Snap on release. More...
 
- Protected Attributes inherited from QgsMapTool
QAction * mAction = nullptr
 optionally map tool can have pointer to action which will be used to set that action as active More...
 
QAbstractButton * mButton = nullptr
 optionally map tool can have pointer to a button which will be used to set that action as active More...
 
QgsMapCanvasmCanvas = nullptr
 pointer to map canvas More...
 
QCursor mCursor
 cursor used in map tool More...
 
QString mToolName
 translated name of the map tool More...
 

Additional Inherited Members

- Signals inherited from QgsMapTool
void activated ()
 signal emitted once the map tool is activated More...
 
void deactivated ()
 signal emitted once the map tool is deactivated More...
 
void messageDiscarded ()
 emit signal to clear previous message More...
 
void messageEmitted (const QString &message, QgsMessageBar::MessageLevel=QgsMessageBar::INFO)
 emit a message More...
 
- Static Public Member Functions inherited from QgsMapTool
static double searchRadiusMM ()
 Get search radius in mm. More...
 
static double searchRadiusMU (const QgsRenderContext &context)
 Get search radius in map units for given context. More...
 
static double searchRadiusMU (QgsMapCanvas *canvas)
 Get search radius in map units for given canvas. More...
 
- Static Protected Member Functions inherited from QgsMapToolEdit
static QColor digitizingFillColor ()
 Returns fill color for rubber bands (from global settings) More...
 
static QColor digitizingStrokeColor ()
 Returns stroke color for rubber bands (from global settings) More...
 
static int digitizingStrokeWidth ()
 Returns stroke width for rubber bands (from global settings) More...
 

Detailed Description

The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates and allows filtering its events.

Events from QgsMapTool are caught and their QMouseEvent are transformed into QgsMapMouseEvent (with map coordinates). Events are then forwarded to corresponding virtual methods which can be reimplemented in subclasses. An event filter can be set on the map tool to filter and modify the events in map coordinates (

See also
QgsMapToolMapEventFilter).
Note
at the moment, the event filter is used by the CAD tools (
See also
QgsCadDocWidget).
Note
the event filter definition is not exposed in Python API to avoid any unexpected behavior.

Definition at line 34 of file qgsmaptooladvanceddigitizing.h.

Member Enumeration Documentation

◆ CaptureMode

Different capture modes.

Enumerator
CaptureNone 

Do not capture.

CapturePoint 

Capture points.

CaptureSegment 

Capture a segment (i.e. 2 points)

CaptureLine 

Capture lines.

CapturePolygon 

Capture polygons.

Definition at line 39 of file qgsmaptooladvanceddigitizing.h.

Constructor & Destructor Documentation

◆ QgsMapToolAdvancedDigitizing()

QgsMapToolAdvancedDigitizing::QgsMapToolAdvancedDigitizing ( QgsMapCanvas canvas,
QgsAdvancedDigitizingDockWidget cadDockWidget 
)
explicit

Creates an advanced digitizing maptool.

Parameters
canvasThe map canvas on which the tool works
cadDockWidgetThe cad dock widget which will be used to adjust mouse events

Definition at line 21 of file qgsmaptooladvanceddigitizing.cpp.

Member Function Documentation

◆ activate()

void QgsMapToolAdvancedDigitizing::activate ( )
overridevirtual

Registers this maptool with the cad dock widget.

Reimplemented from QgsMapTool.

Reimplemented in QgsMapToolCapture.

Definition at line 69 of file qgsmaptooladvanceddigitizing.cpp.

◆ cadCanvasMoveEvent()

virtual void QgsMapToolAdvancedDigitizing::cadCanvasMoveEvent ( QgsMapMouseEvent e)
inlineprotectedvirtual

Override this method when subclassing this class.

This will receive adapted events from the cad system whenever a canvasMoveEvent is triggered and it's not hidden by the cad's construction mode.

Parameters
eMouse events prepared by the cad system

Reimplemented in QgsMapToolCapture.

Definition at line 122 of file qgsmaptooladvanceddigitizing.h.

◆ cadCanvasPressEvent()

virtual void QgsMapToolAdvancedDigitizing::cadCanvasPressEvent ( QgsMapMouseEvent e)
inlineprotectedvirtual

Override this method when subclassing this class.

This will receive adapted events from the cad system whenever a canvasPressEvent is triggered and it's not hidden by the cad's construction mode.

Parameters
eMouse events prepared by the cad system

Definition at line 100 of file qgsmaptooladvanceddigitizing.h.

◆ cadCanvasReleaseEvent()

virtual void QgsMapToolAdvancedDigitizing::cadCanvasReleaseEvent ( QgsMapMouseEvent e)
inlineprotectedvirtual

Override this method when subclassing this class.

This will receive adapted events from the cad system whenever a canvasReleaseEvent is triggered and it's not hidden by the cad's construction mode.

Parameters
eMouse events prepared by the cad system

Definition at line 111 of file qgsmaptooladvanceddigitizing.h.

◆ cadDockWidget()

QgsAdvancedDigitizingDockWidget* QgsMapToolAdvancedDigitizing::cadDockWidget ( ) const
inline

Definition at line 87 of file qgsmaptooladvanceddigitizing.h.

◆ canvasMoveEvent()

void QgsMapToolAdvancedDigitizing::canvasMoveEvent ( QgsMapMouseEvent e)
overridevirtual

Catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method.

Reimplemented from QgsMapTool.

Definition at line 62 of file qgsmaptooladvanceddigitizing.cpp.

◆ canvasPressEvent()

void QgsMapToolAdvancedDigitizing::canvasPressEvent ( QgsMapMouseEvent e)
overridevirtual

Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method.

Reimplemented from QgsMapTool.

Definition at line 32 of file qgsmaptooladvanceddigitizing.cpp.

◆ canvasReleaseEvent()

void QgsMapToolAdvancedDigitizing::canvasReleaseEvent ( QgsMapMouseEvent e)
overridevirtual

Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method.

Reimplemented from QgsMapTool.

Definition at line 39 of file qgsmaptooladvanceddigitizing.cpp.

◆ deactivate()

void QgsMapToolAdvancedDigitizing::deactivate ( )
overridevirtual

Unregisters this maptool from the cad dock widget.

Reimplemented from QgsMapTool.

Reimplemented in QgsMapToolCapture.

Definition at line 76 of file qgsmaptooladvanceddigitizing.cpp.

◆ mode()

CaptureMode QgsMapToolAdvancedDigitizing::mode ( ) const
inline

The capture mode.

Returns
Capture mode

Definition at line 67 of file qgsmaptooladvanceddigitizing.h.

◆ setMode()

void QgsMapToolAdvancedDigitizing::setMode ( CaptureMode  mode)
inline

Set capture mode.

This should correspond to the layer on which the digitizing happens.

Parameters
modeCapture Mode

Definition at line 75 of file qgsmaptooladvanceddigitizing.h.

Member Data Documentation

◆ mCaptureMode

CaptureMode QgsMapToolAdvancedDigitizing::mCaptureMode
protected

The capture mode in which this tool operates.

Definition at line 125 of file qgsmaptooladvanceddigitizing.h.

◆ mSnapOnDoubleClick

bool QgsMapToolAdvancedDigitizing::mSnapOnDoubleClick
protected

Snap on double click.

Definition at line 130 of file qgsmaptooladvanceddigitizing.h.

◆ mSnapOnMove

bool QgsMapToolAdvancedDigitizing::mSnapOnMove
protected

Snap on move.

Definition at line 129 of file qgsmaptooladvanceddigitizing.h.

◆ mSnapOnPress

bool QgsMapToolAdvancedDigitizing::mSnapOnPress
protected

Snap on press.

Definition at line 127 of file qgsmaptooladvanceddigitizing.h.

◆ mSnapOnRelease

bool QgsMapToolAdvancedDigitizing::mSnapOnRelease
protected

Snap on release.

Definition at line 128 of file qgsmaptooladvanceddigitizing.h.


The documentation for this class was generated from the following files: