Subgroup: Map

Class: QgsMapCanvasSnappingUtils¶

class qgis.gui.QgsMapCanvasSnappingUtils¶

Bases: qgis._core.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.

New in version 2.8: Methods

`blockSignals`
`childEvent`
`children`
`clearAllLocators`
`config`	The snapping configuration controls the behavior of this object
`connectNotify`
`currentLayer`	The current layer used if mode is SnapCurrentLayer
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dump`	Get extra information about the instance
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`indexingStrategy`	Find out which strategy is used for indexing - by default hybrid indexing is used
`inherits`
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`layers`	Query layers used for snapping
`locatorForLayer`	Get a point locator for the given layer.
`mapSettings`
`metaObject`
`moveToThread`
`objectName`
`parent`
`prepareIndexProgress`
`prepareIndexStarting`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeEventFilter`
`sender`
`senderSignalIndex`
`setConfig`	The snapping configuration controls the behavior of this object
`setCurrentLayer`	Set current layer so that if mode is SnapCurrentLayer we know which layer to use
`setIndexingStrategy`	Set a strategy for indexing geometry data - determines how fast and memory consuming the data structures will be
`setMapSettings`	Assign current map settings to the utils - used for conversion between screen coords to map coords
`setObjectName`
`setParent`
`setProperty`
`signalsBlocked`
`snapToCurrentLayer`	Snap to current layer
`snapToMap`	Snap to map according to the current configuration.
`startTimer`
`thread`
`timerEvent`
`toggleEnabled`	Toggles the state of snapping
`tr`

Attributes

`IndexAlwaysFull`
`IndexExtent`
`IndexHybrid`
`IndexNeverFull`
`configChanged`	Emitted when the snapping settings object changes.
`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

childEvent()¶

clearAllLocators()¶

connectNotify()¶

customEvent()¶

disconnectNotify()¶

isSignalConnected()¶

prepareIndexProgress(self, index: int)¶

prepareIndexStarting(self, count: int)¶

receivers()¶

sender()¶

senderSignalIndex()¶

timerEvent()¶