Class: QgsMapCanvasSnappingUtils¶

class qgis.gui.QgsMapCanvasSnappingUtils¶

Bases: QgsSnappingUtils

Snapping utils instance that is connected to a canvas and updates the configuration (map settings + current layer) whenever that is changed in the canvas.

QgsMapCanvasSnappingUtils(canvas: Optional[QgsMapCanvas], parent: Optional[QObject] = None) Construct map canvas snapping utils object

Parameters:

canvas – map canvas

parent –

parent object: if False it will block until indexing is done

Methods

`childEvent`
`clearAllLocators`	Deletes all existing locators (e.g. when destination CRS has changed and we need to reindex).
`connectNotify`
`customEvent`
`disconnectNotify`
`isSignalConnected`
`prepareIndexProgress`	param index:
`prepareIndexStarting`	param count:
`receivers`
`sender`
`senderSignalIndex`
`timerEvent`

childEvent(self, a0: QChildEvent | None)¶

clearAllLocators(self)¶: Deletes all existing locators (e.g. when destination CRS has changed and we need to reindex)

connectNotify(self, signal: QMetaMethod)¶

customEvent(self, a0: QEvent | None)¶

disconnectNotify(self, signal: QMetaMethod)¶

isSignalConnected(self, signal: QMetaMethod) → bool¶

prepareIndexProgress(self, index: int)¶

Parameters:: index (int)

prepareIndexStarting(self, count: int)¶

Parameters:: count (int)

receivers(self, signal: PYQT_SIGNAL) → int¶

sender(self) → QObject | None¶

senderSignalIndex(self) → int¶

timerEvent(self, a0: QTimerEvent | None)¶