Class: QgsMapToolCapture¶
-
class
qgis.gui.
QgsMapToolCapture
(canvas: QgsMapCanvas, cadDockWidget: QgsAdvancedDigitizingDockWidget, mode: QgsMapToolCapture.CaptureMode)¶ Bases:
QgsMapToolAdvancedDigitizing
constructor
- Parameters
canvas (QgsMapCanvas) –
cadDockWidget (QgsAdvancedDigitizingDockWidget) –
mode –
-
CaptureLine
= 2¶
-
class
CaptureMode
¶ Bases:
int
-
CaptureNone
= 0¶
-
CapturePoint
= 1¶
-
CapturePolygon
= 3¶
-
activate
(self)¶
-
addCurve
(self, c: QgsCurve) → int¶ Adds a whole curve (e.g. circularstring) to the captured geometry. Curve must be in map CRS
- Parameters
c (QgsCurve) –
- Return type
int
-
addTopologicalPoints
()¶
-
addVertex
(self, point: QgsPointXY) → int¶ addVertex(self, mapPoint:
QgsPointXY
, match: QgsPointLocator.Match) -> int Variant to supply more information in the case of snapping- Parameters
mapPoint – The vertex to add in map coordinates
match – Data about the snapping match. Can be an invalid match, if point not snapped.
New in version 2.14.
- Parameters
point (QgsPointXY) –
- Return type
int
-
cadCanvasMoveEvent
(self, e: QgsMapMouseEvent)¶ - Parameters
e (QgsMapMouseEvent) –
-
captureCurve
(self) → QgsCompoundCurve¶ Gets the capture curve
- Return type
- Returns
Capture curve
-
childEvent
()¶
-
clean
(self)¶ convenient method to clean members
-
clearCurve
(self)¶ Clear capture curve.
New in version 3.0.
-
closePolygon
(self)¶ Close an open polygon
-
connectNotify
()¶
-
createGeometryRubberBand
()¶
-
createRubberBand
()¶
-
currentVectorLayer
()¶
-
customEvent
()¶
-
deactivate
(self)¶
-
deleteTempRubberBand
(self)¶ Clean a temporary rubberband
-
digitizingFillColor
()¶
-
digitizingStrokeColor
()¶
-
digitizingStrokeWidth
()¶
-
disconnectNotify
()¶
-
fetchLayerPoint
(self, match: QgsPointLocator.Match, layerPoint: QgsPoint) → int¶ - Parameters
match (QgsPointLocator.Match) –
layerPoint (QgsPoint) –
- Return type
int
-
isCapturing
(self) → bool¶ Are we currently capturing?
- Return type
bool
- Returns
Is the tool in capture mode?
-
isSignalConnected
()¶
-
keyPressEvent
(self, e: QKeyEvent)¶ Intercept key events like Esc or Del to delete the last point
- Parameters
e (QKeyEvent) – key event
-
mapPoint
(self, e: QgsMapMouseEvent) → QgsPoint¶ Creates a
QgsPoint
with ZM support if necessary (according to the WkbType of the current layer). If the point is snapped, then the Z value is took from the snapped point.- Parameters
e (QgsMapMouseEvent) – A mouse event
- Returns
a point with ZM support if necessary
New in version 3.0.
mapPoint(self, point:
QgsPointXY
) -> QgsPoint Creates aQgsPoint
with ZM support if necessary (according to the WkbType of the current layer).- Parameters
point – A point in 2D
- Return type
- Returns
a point with ZM support if necessary
New in version 3.0.
-
mode
(self) → QgsMapToolCapture.CaptureMode¶ The capture mode
- Return type
- Returns
Capture mode
-
nextPoint
(self, mapPoint: QgsPoint, layerPoint: QgsPoint) → int¶ nextPoint(self, p: QPoint, layerPoint:
QgsPoint
, mapPoint:QgsPoint
) -> int
-
notifyNotEditableLayer
()¶
-
notifyNotVectorLayer
()¶
-
points
(self) → List[QgsPointXY]¶ List of digitized points
- Return type
List[QgsPointXY]
- Returns
List of points
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setAdvancedDigitizingAllowed
()¶
-
setAutoSnapEnabled
()¶
-
setPoints
(self, pointList: Iterable[QgsPointXY])¶ Set the points on which to work
- Parameters
pointList (Iterable[QgsPointXY]) – A list of points
-
size
(self) → int¶ Number of points digitized
- Return type
int
- Returns
Number of points
-
snappingMatches
(self) → List[QgsPointLocator.Match]¶ Returns a list of matches for each point on the captureCurve.
New in version 3.0.
- Return type
List[QgsPointLocator.Match]
-
startCapturing
(self)¶ Start capturing
-
stopCapturing
(self)¶ Stop capturing
-
timerEvent
()¶
-
toCanvasCoordinates
()¶
-
toLayerCoordinates
()¶
-
toMapCoordinates
()¶
-
toMapCoordinatesV2
()¶
-
undo
(self)¶ Removes the last vertex from mRubberBand and mCaptureList