Class: QgsMapToolEdit¶
- class qgis.gui.QgsMapToolEdit¶
Bases:
QgsMapTool
Base class for map tools that edit vector geometry
Methods
Adds a list of
vertices
to other features to keep topology up to date, e.g.- param geometryType
Creates a rubber band with the color/line width from the QGIS settings.
Returns the current vector layer of the map canvas or 0
Returns default Z value Use for set Z coordinate to new vertex for 2.5d geometries
Returns fill color for rubber bands (from global settings)
Returns stroke color for rubber bands (from global settings)
Returns stroke width for rubber bands (from global settings)
- rtype
QgsMapTool.Flags
Display a timed message bar noting the active vector layer is not editable.
Display a timed message bar noting the active layer is not vector.
Transforms a
point
from map coordinates to screen coordinates.Transforms a
point
from screen coordinates tolayer
coordinates.Transforms a
point
from screen coordinates to map coordinates.Transforms a
point
fromlayer
coordinates to map coordinates (which is different in case reprojection is used).Attributes
- InvalidCanvas = 1¶
- InvalidLayer = 2¶
- Success = 0¶
- class TopologicalResult¶
Bases:
int
- addTopologicalPoints(self, vertices: Iterable[QgsPointXY]) → QgsMapToolEdit.TopologicalResult¶
Adds a list of
vertices
to other features to keep topology up to date, e.g. to neighbouring polygons. Thevertices
list specifies a set of topological points to add, in the layer’s coordinate reference system.Deprecated since version QGIS: 3.12 - will be removed in QGIS 4.0. Use the variant which accepts
QgsPoint
objects instead ofQgsPointXY
.addTopologicalPoints(self, vertices: Iterable[QgsPoint]) -> QgsMapToolEdit.TopologicalResult Adds a list of
vertices
to other features to keep topology up to date, e.g. to neighbouring polygons. Thevertices
list specifies a set of topological points to add, in the layer’s coordinate reference system.New in version 3.10.
- Parameters
vertices (Iterable[QgsPointXY]) –
- Return type
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- createGeometryRubberBand(self, geometryType: QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry, alternativeBand: bool = False) → QgsGeometryRubberBand¶
- Parameters
geometryType (QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry) –
alternativeBand (bool = False) –
- Return type
- createRubberBand(self, geometryType: QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry, alternativeBand: bool = False) → QgsRubberBand¶
Creates a rubber band with the color/line width from the QGIS settings. The caller takes ownership of the returned object
- Parameters
geometryType (QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry) –
alternativeBand (bool = False) – if
True
, rubber band will be set with more transparency and a dash pattern. default isFalse
.
- Return type
- currentVectorLayer(self) → QgsVectorLayer¶
Returns the current vector layer of the map canvas or 0
- Return type
- customEvent(self, QEvent)¶
- defaultZValue(self) → float¶
Returns default Z value Use for set Z coordinate to new vertex for 2.5d geometries
- Return type
float
- digitizingFillColor() → QColor¶
Returns fill color for rubber bands (from global settings)
- Return type
QColor
- digitizingStrokeColor() → QColor¶
Returns stroke color for rubber bands (from global settings)
- Return type
QColor
- digitizingStrokeWidth() → int¶
Returns stroke width for rubber bands (from global settings)
- Return type
int
- disconnectNotify(self, QMetaMethod)¶
- flags(self) → QgsMapTool.Flags¶
- Return type
- isSignalConnected(self, QMetaMethod) → bool¶
- notifyNotEditableLayer(self)¶
Display a timed message bar noting the active vector layer is not editable.
- notifyNotVectorLayer(self)¶
Display a timed message bar noting the active layer is not vector.
- receivers(self, PYQT_SIGNAL) → int¶
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- timerEvent(self, QTimerEvent)¶
- toCanvasCoordinates(self, point: QgsPointXY) → QPoint¶
Transforms a
point
from map coordinates to screen coordinates.
- toLayerCoordinates(self, layer: QgsMapLayer, point: QPoint) → QgsPointXY¶
Transforms a
point
from screen coordinates tolayer
coordinates.toLayerCoordinates(self, layer:
QgsMapLayer
, point:QgsPointXY
) -> QgsPointXY Transforms apoint
from map coordinates tolayer
coordinates.toLayerCoordinates(self, layer:
QgsMapLayer
, rect:QgsRectangle
) -> QgsRectangle Transforms arect
from map coordinates tolayer
coordinates.
- toMapCoordinates(self, point: QPoint) → QgsPointXY¶
Transforms a
point
from screen coordinates to map coordinates.toMapCoordinates(self, layer:
QgsMapLayer
, point:QgsPointXY
) -> QgsPointXY Transforms apoint
fromlayer
coordinates to map coordinates (which is different in case reprojection is used).
- toMapCoordinatesV2(self, layer: QgsMapLayer, point: QgsPoint) → QgsPoint¶
Transforms a
point
fromlayer
coordinates to map coordinates (which is different in case reprojection is used).Note
This method is available in the Python bindings as toMapCoordinatesV2.