Subgroup: Map

Class: QgsMapToolAdvancedDigitizing

class qgis.gui.QgsMapToolAdvancedDigitizing(canvas: QgsMapCanvas, cadDockWidget: QgsAdvancedDigitizingDockWidget)

Bases: qgis._gui.QgsMapToolEdit

Creates an advanced digitizing maptool

Parameters:
  • canvas – The map canvas on which the tool works
  • cadDockWidget – The cad dock widget which will be used to adjust mouse events

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 (QgsMapToolMapEventFilter).

Note

at the moment, the event filter is used by the CAD tools (QgsCadDocWidget).

Note

the event filter definition is not exposed in Python API to avoid any unexpected behavior.

Methods

activate Registers this maptool with the cad dock widget
addTopologicalPoints
cadCanvasMoveEvent Override this method when subclassing this class.
cadCanvasPressEvent Override this method when subclassing this class.
cadCanvasReleaseEvent Override this method when subclassing this class.
cadDockWidget
canvasMoveEvent Catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method
canvasPressEvent Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method
canvasReleaseEvent Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method
childEvent
connectNotify
createGeometryRubberBand
createRubberBand
currentVectorLayer
customEvent
deactivate Unregisters this maptool from the cad dock widget
digitizingFillColor
digitizingStrokeColor
digitizingStrokeWidth
disconnectNotify
isAdvancedDigitizingAllowed Returns whether functionality of advanced digitizing dock widget is currently allowed.
isAutoSnapEnabled Returns whether mouse events (press/move/release) should automatically try to snap mouse position (according to the snapping configuration of map canvas) before passing the mouse coordinates to the tool.
isSignalConnected
notifyNotEditableLayer
notifyNotVectorLayer
receivers
sender
senderSignalIndex
setAdvancedDigitizingAllowed Sets whether functionality of advanced digitizing dock widget is currently allowed.
setAutoSnapEnabled Sets whether mouse events (press/move/release) should automatically try to snap mouse position This method is protected because it should be a decision of the map tool and not from elsewhere.
setSnapToLayerGridEnabled Enables or disables snap to grid of mouse events.
snapToLayerGridEnabled Enables or disables snap to grid of mouse events.
timerEvent
toCanvasCoordinates
toLayerCoordinates
toMapCoordinates
toMapCoordinatesV2

Signals

Attributes

activate(self)

Registers this maptool with the cad dock widget

addTopologicalPoints()
cadCanvasMoveEvent(self, e: QgsMapMouseEvent)

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:e – Mouse events prepared by the cad system
cadCanvasPressEvent(self, e: QgsMapMouseEvent)

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:e – Mouse events prepared by the cad system
cadCanvasReleaseEvent(self, e: QgsMapMouseEvent)

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:e – Mouse events prepared by the cad system
cadDockWidget(self) → QgsAdvancedDigitizingDockWidget
canvasMoveEvent(self, e: QgsMapMouseEvent)

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

canvasPressEvent(self, e: QgsMapMouseEvent)

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

canvasReleaseEvent(self, e: QgsMapMouseEvent)

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

childEvent()
connectNotify()
createGeometryRubberBand()
createRubberBand()
currentVectorLayer()
customEvent()
deactivate(self)

Unregisters this maptool from the cad dock widget

digitizingFillColor()
digitizingStrokeColor()
digitizingStrokeWidth()
disconnectNotify()
isAdvancedDigitizingAllowed(self) → bool

Returns whether functionality of advanced digitizing dock widget is currently allowed.

Tools may decide to switch this support on/off based on the current state of the map tool. For example, in vertex tool before user picks a vertex to move, advanced digitizing dock widget should be disabled and only enabled once a vertex is being moved. Other map tools may keep advanced digitizing allowed all the time.

If true is returned, that does not mean that advanced digitizing is actually active, because it is up to the user to enable/disable it when it is allowed. sa setAdvancedDigitizingAllowed()

New in version 3.0.

isAutoSnapEnabled(self) → bool

Returns whether mouse events (press/move/release) should automatically try to snap mouse position (according to the snapping configuration of map canvas) before passing the mouse coordinates to the tool. This may be desirable default behavior for some map tools, but not for other map tools. It is therefore possible to configure the behavior by the map tool. sa isAutoSnapEnabled()

New in version 3.0.

isSignalConnected()
notifyNotEditableLayer()
notifyNotVectorLayer()
receivers()
sender()
senderSignalIndex()
setAdvancedDigitizingAllowed(self, allowed: bool)

Sets whether functionality of advanced digitizing dock widget is currently allowed. This method is protected because it should be a decision of the map tool and not from elsewhere. sa isAdvancedDigitizingAllowed()

New in version 3.0.

setAutoSnapEnabled(self, enabled: bool)

Sets whether mouse events (press/move/release) should automatically try to snap mouse position This method is protected because it should be a decision of the map tool and not from elsewhere. sa isAutoSnapEnabled()

New in version 3.0.

setSnapToLayerGridEnabled(self, snapToLayerGridEnabled: bool)

Enables or disables snap to grid of mouse events. The snapping will occur in the layer’s CRS.

New in version 3.4.

snapToLayerGridEnabled(self) → bool

Enables or disables snap to grid of mouse events. The snapping will occur in the layer’s CRS.

New in version 3.4.

timerEvent()
toCanvasCoordinates()
toLayerCoordinates()
toMapCoordinates()
toMapCoordinatesV2()