Class: QgsAdvancedDigitizingDockWidget¶

class qgis.gui.QgsAdvancedDigitizingDockWidget¶

Bases: QgsDockWidget

The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of a selection of map tools. It handles both the UI and the constraints. Constraints are applied by implementing filters called from QgsMapToolAdvancedDigitizing.

QgsAdvancedDigitizingDockWidget(canvas: QgsMapCanvas, parent: QWidget = None) Create an advanced digitizing dock widget

Parameters

canvas – The map canvas on which the widget operates

parent –

The parent

Methods

`actionEvent`
`addPoint`	Adds point to the CAD point list
`alignToSegment`	align to segment for between line constraint.
`applyConstraints`	apply the CAD constraints.
`betweenLineConstraint`	Returns the between line constraints which are used to place perpendicular/parallel segments to snapped segments on the canvas
`cadEnabled`	determines if CAD tools are enabled or if map tools behaves "nomally"
`canvasKeyPressEventFilter`	Filter key events to e.g.
`capacities`	Returns the capacities
`changeEvent`
`childEvent`
`clear`	Clear any cached previous clicks and helper lines
`clearLockedSnapVertices`	Removes all points from the locked snap vertex list
`clearPoints`	Removes all points from the CAD point list
`closeEvent`
`commonAngleConstraint`	Returns `True` if a constraint on a common angle is active
`connectNotify`
`constraintAngle`	Returns the `CadConstraint` on the angle
`constraintDistance`	Returns the `CadConstraint` on the distance
`constraintLineExtension`	Returns the `CadConstraint`
`constraintM`	Returns the `CadConstraint` on the M coordinate
`constraintX`	Returns the `CadConstraint` on the X coordinate
`constraintXyVertex`	Returns the `CadConstraint`
`constraintY`	Returns the `CadConstraint` on the Y coordinate
`constraintZ`	Returns the `CadConstraint` on the Z coordinate
`constructionMode`	construction mode is used to draw intermediate points.
`contextMenuEvent`
`create`
`currentPoint`	The last point.
`currentPointLayerCoordinates`	Returns the last CAD point, in a map `layer`'s coordinates.
`currentPointV2`	The last point.
`customEvent`
`destroy`
`disable`	Disable the widget.
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`enable`	Enables the tool (call this when an appropriate map tool is set and in the condition to make use of cad digitizing) Normally done automatically from `QgsMapToolAdvancedDigitizing.activate()` but may need to be fine tuned if the map tool depends on preconditions like a feature selection.
`enableAction`	Returns the action used to enable/disable the tools
`enterEvent`
`event`
`eventFilter`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`getLineM`	Convenient method to get the M value from the line edit wiget
`getLineZ`	Convenient method to get the Z value from the line edit wiget
`hideEvent`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`	param e
`keyReleaseEvent`
`leaveEvent`
`lineExtensionSide`	Returns on which side of the constraint line extension point, the line was created
`lockedSnapVertices`	Returns the snap matches whose vertices have been locked
`mapPointMatch`	Returns the point locator match
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`penultimatePoint`	The penultimate point.
`penultimatePointV2`	The penultimate point.
`pointsCount`	The number of points in the CAD point helper list
`previousPoint`	The previous point.
`previousPointV2`	The previous point.
`receivers`
`releaseLocks`	unlock all constraints
`removePreviousPoint`	Remove previous point in the CAD point list
`resizeEvent`
`sender`
`senderSignalIndex`
`setAngle`	Set the angle value on the widget.
`setDistance`	Set the distance value on the widget.
`setEnabledM`	Sets whether M is enabled
`setEnabledZ`	Sets whether Z is enabled
`setM`	Set the M value on the widget.
`setPoints`	Configures list of current CAD points
`setX`	Set the X value on the widget.
`setY`	Set the Y value on the widget.
`setZ`	Set the Z value on the widget.
`sharedPainter`
`showEvent`
`snappedSegment`	Snapped to a segment
`snappedToVertex`	Is it snapped to a vertex
`softLockX`	Returns the X value of the X soft lock.
`softLockY`	Returns the Y value of the Y soft lock.
`switchZM`	Determines if Z or M will be enabled.
`tabletEvent`
`timerEvent`
`updateCadPaintItem`	Updates canvas item that displays constraints on the ma
`updateMicroFocus`
`wheelEvent`

Signals

`cadEnabledChanged`	Emitted whenever CAD is enabled or disabled
`enabledChangedAngle`	Emitted whenever the angle field is enabled or disabled.
`enabledChangedDistance`	Emitted whenever the distance field is enabled or disabled.
`enabledChangedM`	Emitted whenever the M field is enabled or disabled.
`enabledChangedX`	Emitted whenever the X field is enabled or disabled.
`enabledChangedY`	Emitted whenever the Y field is enabled or disabled.
`enabledChangedZ`	Emitted whenever the Z field is enabled or disabled.
`focusOnAngleRequested`	Emitted whenever the angle field should get the focus using the shortcuts (A).
`focusOnDistanceRequested`	Emitted whenever the distance field should get the focus using the shortcuts (D).
`focusOnMRequested`	Emitted whenever the M field should get the focus using the shortcuts (M).
`focusOnXRequested`	Emitted whenever the X field should get the focus using the shortcuts (X).
`focusOnYRequested`	Emitted whenever the Y field should get the focus using the shortcuts (Y).
`focusOnZRequested`	Emitted whenever the Z field should get the focus using the shortcuts (Z).
`lockAngleChanged`	Emitted whenever the angle parameter is `locked`.
`lockDistanceChanged`	Emitted whenever the distance parameter is `locked`.
`lockMChanged`	Emitted whenever the M parameter is `locked`.
`lockXChanged`	Emitted whenever the X parameter is `locked`.
`lockYChanged`	Emitted whenever the Y parameter is `locked`.
`lockZChanged`	Emitted whenever the Z parameter is `locked`.
`pointChanged`	Sometimes a constraint may change the current point out of a mouse event.
`pointChangedV2`	Sometimes a constraint may change the current point out of a mouse event.
`popWarning`	Remove any previously emitted warnings (if any) [signal]
`pushWarning`	Push a warning
`relativeAngleChanged`	Emitted whenever the angleX parameter is toggled between absolute and relative.
`relativeMChanged`	Emitted whenever the M parameter is toggled between absolute and relative.
`relativeXChanged`	Emitted whenever the X parameter is toggled between absolute and relative.
`relativeYChanged`	Emitted whenever the Y parameter is toggled between absolute and relative.
`relativeZChanged`	Emitted whenever the Z parameter is toggled between absolute and relative.
`softLockLineExtensionChanged`	Emitted whenever the soft line extension parameter is `locked`.
`softLockXyChanged`	Emitted whenever the soft x/y extension parameter is `locked`.
`valueAngleChanged`	Emitted whenever the angle `value` changes (either the mouse moved, or the user changed the input).
`valueDistanceChanged`	Emitted whenever the distance `value` changes (either the mouse moved, or the user changed the input).
`valueMChanged`	Emitted whenever the M `value` changes (either the mouse moved, or the user changed the input).
`valueXChanged`	Emitted whenever the X `value` changes (either the mouse moved, or the user changed the input).
`valueYChanged`	Emitted whenever the Y `value` changes (either the mouse moved, or the user changed the input).
`valueZChanged`	Emitted whenever the Z `value` changes (either the mouse moved, or the user changed the input).

Attributes

`AbsoluteAngle`
`Distance`
`RelativeAngle`
`RelativeCoordinates`
`ReturnPressed`

AbsoluteAngle = 1¶

class CadCapacities¶

class CadCapacities(Union[QgsAdvancedDigitizingDockWidget.CadCapacities, QgsAdvancedDigitizingDockWidget.CadCapacity])

class CadCapacities(QgsAdvancedDigitizingDockWidget.CadCapacities)

Bases: sip.wrapper

baseClass¶: alias of QgsAdvancedDigitizingDockWidget

class CadCapacity¶: Bases: int

class CadConstraint¶

Bases: sip.wrapper

The CadConstraint is an abstract class for all basic constraints (angle/distance/x/y). It contains all values (locked, value, relative) and pointers to corresponding widgets.

Note

Relative is not mandatory since it is not used for distance.

QgsAdvancedDigitizingDockWidget.CadConstraint(lineEdit: QLineEdit, lockerButton: QToolButton, relativeButton: QToolButton = None, repeatingLockButton: QToolButton = None) Constructor for CadConstraint.

Parameters

lineEdit – associated line edit for constraint value
lockerButton – associated button for locking constraint
relativeButton – optional button for toggling relative constraint mode
repeatingLockButton – optional button for toggling repeating lock mode

QgsAdvancedDigitizingDockWidget.CadConstraint(QgsAdvancedDigitizingDockWidget.CadConstraint)

HardLock = 2¶

class LockMode¶: Bases: int

NoLock = 0¶

SoftLock = 1¶

isLocked(self) → bool¶

Is any kind of lock mode enabled

Return type: bool

isRepeatingLock(self) → bool¶

Returns True if a repeating lock is set for the constraint. Repeating locks are not automatically cleared after a new point is added.

See also

setRepeatingLock()

New in version 2.16.

Return type: bool

lineEdit(self) → QLineEdit¶

The line edit that manages the value of the constraint

Return type: QLineEdit

lockMode(self) → QgsAdvancedDigitizingDockWidget.CadConstraint.LockMode¶

The current lock mode of this constraint

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint.LockMode
Returns: Lock mode

precision(self) → int¶

Returns the numeric precision (decimal places) to show in the associated widget.

See also

setPrecision()

New in version 3.22.

Return type: int

relative(self) → bool¶

Is the constraint in relative mode

Return type: bool

setLockMode(self, mode: QgsAdvancedDigitizingDockWidget.CadConstraint.LockMode)¶

Set the lock mode

Parameters: mode (QgsAdvancedDigitizingDockWidget.CadConstraint.LockMode) –

setPrecision(self, precision: int)¶

Sets the numeric precision (decimal places) to show in the associated widget.

See also

precision()

New in version 3.22.

Parameters: precision (int) –

setRelative(self, relative: bool)¶

Set if the constraint should be treated relative

Parameters: relative (bool) –

setRepeatingLock(self, repeating: bool)¶

Sets whether a repeating lock is set for the constraint. Repeating locks are not automatically cleared after a new point is added.

Parameters: repeating (bool) – set to True to set the lock to repeat automatically

See also

isRepeatingLock()

New in version 2.16.

setValue(self, value: float, updateWidget: bool = True)¶

Set the value of the constraint

Parameters

value (float) – new value for constraint
updateWidget (bool = True) – set to False to prevent automatically updating the associated widget’s value

toggleLocked(self)¶: Toggle lock mode

toggleRelative(self)¶: Toggle relative mode

value(self) → float¶

The value of the constraint

Return type: float

Distance = 8¶

RelativeAngle = 2¶

RelativeCoordinates = 4¶

ReturnPressed = 0¶

class WidgetSetMode¶: Bases: int

actionEvent(self, QActionEvent)¶

addPoint(self, point: QgsPointXY)¶

Adds point to the CAD point list

New in version 3.0.

Parameters: point (QgsPointXY) –

alignToSegment(self, e: QgsMapMouseEvent, lockMode: QgsAdvancedDigitizingDockWidget.CadConstraint.LockMode = QgsAdvancedDigitizingDockWidget.CadConstraint.HardLock) → bool¶

align to segment for between line constraint. If between line constraints are used, this will determine the angle to be locked depending on the snapped segment.

New in version 3.0.

Parameters

e (QgsMapMouseEvent) –
lockMode (QgsAdvancedDigitizingDockWidget.CadConstraint.LockMode = QgsAdvancedDigitizingDockWidget.CadConstraint.HardLock) –

Return type

bool

applyConstraints(self, e: QgsMapMouseEvent) → bool¶

apply the CAD constraints. The will modify the position of the map event in map coordinates by applying the CAD constraints.

Return type: bool
Returns: False if no solution was found (invalid constraints)
Parameters: e (QgsMapMouseEvent) –

betweenLineConstraint(self) → Qgis.BetweenLineConstraint¶

Returns the between line constraints which are used to place perpendicular/parallel segments to snapped segments on the canvas

Return type: Qgis.BetweenLineConstraint

cadEnabled(self) → bool¶

determines if CAD tools are enabled or if map tools behaves “nomally”

Return type: bool

cadEnabledChanged¶

Emitted whenever CAD is enabled or disabled

Parameters: enabled (bool) – Whether CAD is enabled or not

Note

unstable API (will likely change).

New in version 3.8: [signal]

canvasKeyPressEventFilter(self, e: QKeyEvent) → bool¶

Filter key events to e.g. toggle construction mode or adapt constraints

Parameters: e (QKeyEvent) – A mouse event (may be modified)
Return type: bool
Returns: If the event is hidden (construction mode hides events from the maptool)

capacities(self) → QgsAdvancedDigitizingDockWidget.CadCapacities¶

Returns the capacities

New in version 3.26.

Return type: QgsAdvancedDigitizingDockWidget.CadCapacities

changeEvent(self, QEvent)¶

childEvent(self, QChildEvent)¶

clear(self)¶: Clear any cached previous clicks and helper lines

clearLockedSnapVertices(self, force: bool = True)¶

Removes all points from the locked snap vertex list

Parameters: force (bool = True) – Clears the list even if the constraints that use it are still locked.

New in version 3.26.

clearPoints(self)¶: Removes all points from the CAD point list

New in version 3.0.

closeEvent(self, QCloseEvent)¶

commonAngleConstraint(self) → bool¶

Returns True if a constraint on a common angle is active

Return type: bool

connectNotify(self, QMetaMethod)¶

constraintAngle(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint on the angle

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constraintDistance(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint on the distance

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constraintLineExtension(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constraintM(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint on the M coordinate

New in version 3.22.

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constraintX(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint on the X coordinate

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constraintXyVertex(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constraintY(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint on the Y coordinate

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constraintZ(self) → QgsAdvancedDigitizingDockWidget.CadConstraint¶

Returns the CadConstraint on the Z coordinate

New in version 3.22.

Return type: QgsAdvancedDigitizingDockWidget.CadConstraint

constructionMode(self) → bool¶

construction mode is used to draw intermediate points. These points won’t be given any further (i.e. to the map tools)

Return type: bool

contextMenuEvent(self, QContextMenuEvent)¶

create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

currentPoint(self) → Tuple[QgsPointXY, bool]¶

The last point. Helper for the CAD point list. The CAD point list is the list of points currently digitized. It contains both “normal” points and intermediate points (construction mode).

Deprecated since version QGIS: 3.22. Use currentPointV2() instead.

Return type: Tuple[QgsPointXY, bool]

currentPointLayerCoordinates(self, layer: QgsMapLayer) → QgsPoint¶

Returns the last CAD point, in a map layer’s coordinates.

New in version 3.22.

Parameters: layer (QgsMapLayer) –
Return type: QgsPoint

currentPointV2(self) → Tuple[QgsPoint, bool]¶

The last point. Helper for the CAD point list. The CAD point list is the list of points currently digitized. It contains both “normal” points and intermediate points (construction mode).

New in version 3.22.

Return type: Tuple[QgsPoint, bool]

customEvent(self, QEvent)¶

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶

disable(self)¶: Disable the widget. Normally done automatically from QgsMapToolAdvancedDigitizing.deactivate().

disconnectNotify(self, QMetaMethod)¶

dragEnterEvent(self, QDragEnterEvent)¶

dragLeaveEvent(self, QDragLeaveEvent)¶

dragMoveEvent(self, QDragMoveEvent)¶

dropEvent(self, QDropEvent)¶

enable(self)¶: Enables the tool (call this when an appropriate map tool is set and in the condition to make use of cad digitizing) Normally done automatically from QgsMapToolAdvancedDigitizing.activate() but may need to be fine tuned if the map tool depends on preconditions like a feature selection.

enableAction(self) → QAction¶

Returns the action used to enable/disable the tools

Return type: QAction

enabledChangedAngle¶

Emitted whenever the angle field is enabled or disabled. Depending on the context, some parameters do not make sense (e.g. you need a previous point to define a distance). Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: enabled (bool) – Whether the angle parameter is enabled or not.

Note

unstable API (will likely change)

New in version 3.8: [signal]

enabledChangedDistance¶

Emitted whenever the distance field is enabled or disabled. Depending on the context, some parameters do not make sense (e.g. you need a previous point to define a distance). Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: enabled (bool) – Whether the distance parameter is enabled or not.

Note

unstable API (will likely change)

New in version 3.8: [signal]

enabledChangedM¶

Emitted whenever the M field is enabled or disabled. Depending on the context, some parameters do not make sense (e.g. you need a previous point to define a distance). Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: enabled (bool) – Whether the M parameter is enabled or not.

Note

unstable API (will likely change)

New in version 3.22: [signal]

enabledChangedX¶

Emitted whenever the X field is enabled or disabled. Depending on the context, some parameters do not make sense (e.g. you need a previous point to define a distance). Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: enabled (bool) – Whether the X parameter is enabled or not.

Note

unstable API (will likely change)

New in version 3.8: [signal]

enabledChangedY¶

Emitted whenever the Y field is enabled or disabled. Depending on the context, some parameters do not make sense (e.g. you need a previous point to define a distance). Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: enabled (bool) – Whether the Y parameter is enabled or not.

Note

unstable API (will likely change)

New in version 3.8: [signal]

enabledChangedZ¶

Emitted whenever the Z field is enabled or disabled. Depending on the context, some parameters do not make sense (e.g. you need a previous point to define a distance). Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: enabled (bool) – Whether the Z parameter is enabled or not.

Note

unstable API (will likely change)

New in version 3.22: [signal]

enterEvent(self, QEvent)¶

event(self, QEvent) → bool¶

eventFilter(self, QObject, QEvent) → bool¶

focusInEvent(self, QFocusEvent)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, bool) → bool¶

focusOnAngleRequested¶: Emitted whenever the angle field should get the focus using the shortcuts (A). Could be used by widgets to capture the focus when a field is being edited.

Note

unstable API (will likely change)

New in version 3.8: [signal]

focusOnDistanceRequested¶: Emitted whenever the distance field should get the focus using the shortcuts (D). Could be used by widgets to capture the focus when a field is being edited.

Note

unstable API (will likely change)

New in version 3.8: [signal]

focusOnMRequested¶: Emitted whenever the M field should get the focus using the shortcuts (M). Could be used by widgets to capture the focus when a field is being edited.

Note

unstable API (will likely change)

New in version 3.22: [signal]

focusOnXRequested¶: Emitted whenever the X field should get the focus using the shortcuts (X). Could be used by widgets to capture the focus when a field is being edited.

Note

unstable API (will likely change)

New in version 3.8: [signal]

focusOnYRequested¶: Emitted whenever the Y field should get the focus using the shortcuts (Y). Could be used by widgets to capture the focus when a field is being edited.

Note

unstable API (will likely change)

New in version 3.8: [signal]

focusOnZRequested¶: Emitted whenever the Z field should get the focus using the shortcuts (Z). Could be used by widgets to capture the focus when a field is being edited.

Note

unstable API (will likely change)

New in version 3.22: [signal]

focusOutEvent(self, QFocusEvent)¶

focusPreviousChild(self) → bool¶

getLineM(self) → float¶

Convenient method to get the M value from the line edit wiget

New in version 3.22.

Return type: float

getLineZ(self) → float¶

Convenient method to get the Z value from the line edit wiget

New in version 3.22.

Return type: float

hideEvent(self, QHideEvent)¶

initPainter(self, QPainter)¶

initStyleOption(self, QStyleOptionDockWidget)¶

inputMethodEvent(self, QInputMethodEvent)¶

isSignalConnected(self, QMetaMethod) → bool¶

keyPressEvent(self, e: QKeyEvent)¶

Parameters: e (QKeyEvent) –

keyReleaseEvent(self, QKeyEvent)¶

leaveEvent(self, QEvent)¶

lineExtensionSide(self) → Qgis.LineExtensionSide¶

Returns on which side of the constraint line extension point, the line was created

Return type: Qgis.LineExtensionSide

lockAngleChanged¶

Emitted whenever the angle parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: locked (bool) –

lockDistanceChanged¶

Emitted whenever the distance parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: locked (bool) –

lockMChanged¶

Emitted whenever the M parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.22: [signal]

Parameters: locked (bool) –

lockXChanged¶

Emitted whenever the X parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: locked (bool) –

lockYChanged¶

Emitted whenever the Y parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: locked (bool) –

lockZChanged¶

Emitted whenever the Z parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.22: [signal]

Parameters: locked (bool) –

lockedSnapVertices(self) → List[QgsPointLocator.Match]¶

Returns the snap matches whose vertices have been locked

New in version 3.26.

Return type: List[QgsPointLocator.Match]

mapPointMatch(self) → QgsPointLocator.Match¶

Returns the point locator match

New in version 3.4.

Return type: QgsPointLocator.Match

metric(self, QPaintDevice.PaintDeviceMetric) → int¶

mouseDoubleClickEvent(self, QMouseEvent)¶

mouseMoveEvent(self, QMouseEvent)¶

mousePressEvent(self, QMouseEvent)¶

mouseReleaseEvent(self, QMouseEvent)¶

moveEvent(self, QMoveEvent)¶

nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]¶

paintEvent(self, QPaintEvent)¶

penultimatePoint(self) → Tuple[QgsPointXY, bool]¶

The penultimate point. Helper for the CAD point list. The CAD point list is the list of points currently digitized. It contains both “normal” points and intermediate points (construction mode).

Deprecated since version QGIS: 3.22. Use penultimatePointV2() instead.

Return type: Tuple[QgsPointXY, bool]

penultimatePointV2(self) → Tuple[QgsPoint, bool]¶

The penultimate point. Helper for the CAD point list. The CAD point list is the list of points currently digitized. It contains both “normal” points and intermediate points (construction mode).

Return type: Tuple[QgsPoint, bool]

pointChanged¶

Sometimes a constraint may change the current point out of a mouse event. This happens normally when a constraint is toggled.

Parameters: point (QgsPointXY) – The last known digitizing point. Can be used to emulate a mouse event.

Deprecated since version QGIS: 3.22. No longer used, will be removed in QGIS 4.0. Use pointChangedV2 instead. [signal]

pointChangedV2¶

Sometimes a constraint may change the current point out of a mouse event. This happens normally when a constraint is toggled.

Parameters: point (QgsPoint) – The last known digitizing point. Can be used to emulate a mouse event.

New in version 3.22: [signal]

pointsCount(self) → int¶

The number of points in the CAD point helper list

Return type: int

popWarning¶: Remove any previously emitted warnings (if any) [signal]

previousPoint(self) → Tuple[QgsPointXY, bool]¶

The previous point. Helper for the CAD point list. The CAD point list is the list of points currently digitized. It contains both “normal” points and intermediate points (construction mode).

Deprecated since version QGIS: 3.22. Use previousPointV2() instead.

Return type: Tuple[QgsPointXY, bool]

previousPointV2(self) → Tuple[QgsPoint, bool]¶

The previous point. Helper for the CAD point list. The CAD point list is the list of points currently digitized. It contains both “normal” points and intermediate points (construction mode).

Return type: Tuple[QgsPoint, bool]

pushWarning¶

Push a warning

Parameters: message (str) – An informative message [signal]

receivers(self, PYQT_SIGNAL) → int¶

relativeAngleChanged¶

Emitted whenever the angleX parameter is toggled between absolute and relative. Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: relative (bool) – Whether the angle parameter is relative or not.

Note

unstable API (will likely change)

New in version 3.8: [signal]

relativeMChanged¶

Emitted whenever the M parameter is toggled between absolute and relative. Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: relative (bool) – Whether the M parameter is relative or not.

Note

unstable API (will likely change)

New in version 3.22: [signal]

relativeXChanged¶

Emitted whenever the X parameter is toggled between absolute and relative. Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: relative (bool) – Whether the X parameter is relative or not.

Note

unstable API (will likely change)

New in version 3.8: [signal]

relativeYChanged¶

Emitted whenever the Y parameter is toggled between absolute and relative. Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: relative (bool) – Whether the Y parameter is relative or not.

Note

unstable API (will likely change)

New in version 3.8: [signal]

relativeZChanged¶

Emitted whenever the Z parameter is toggled between absolute and relative. Could be used by widgets that must reflect the current advanced digitizing state.

Parameters: relative (bool) – Whether the Z parameter is relative or not.

Note

unstable API (will likely change)

New in version 3.22: [signal]

releaseLocks(self, releaseRepeatingLocks: bool = True)¶

unlock all constraints

Parameters: releaseRepeatingLocks (bool = True) – set to False to preserve the lock for any constraints set to repeating lock mode

New in version 3.0.

removePreviousPoint(self)¶: Remove previous point in the CAD point list

New in version 3.8.

resizeEvent(self, QResizeEvent)¶

sender(self) → QObject¶

senderSignalIndex(self) → int¶

setAngle(self, value: str, mode: QgsAdvancedDigitizingDockWidget.WidgetSetMode)¶

Set the angle value on the widget. Can be used to set constraints by external widgets.

Parameters

mode (QgsAdvancedDigitizingDockWidget.WidgetSetMode) – What type of interaction to emulate
value (str) – The value (as a QString, as it could be an expression)

Note

unstable API (will likely change)

New in version 3.8.

setDistance(self, value: str, mode: QgsAdvancedDigitizingDockWidget.WidgetSetMode)¶

Set the distance value on the widget. Can be used to set constraints by external widgets.

Parameters

mode (QgsAdvancedDigitizingDockWidget.WidgetSetMode) – What type of interaction to emulate
value (str) – The value (as a QString, as it could be an expression)

Note

unstable API (will likely change)

New in version 3.8.

setEnabledM(self, enable: bool)¶

Sets whether M is enabled

New in version 3.22.

Parameters: enable (bool) –

setEnabledZ(self, enable: bool)¶

Sets whether Z is enabled

New in version 3.22.

Parameters: enable (bool) –

setM(self, value: str, mode: QgsAdvancedDigitizingDockWidget.WidgetSetMode)¶

Set the M value on the widget. Can be used to set constraints by external widgets.

Parameters

mode (QgsAdvancedDigitizingDockWidget.WidgetSetMode) – What type of interaction to emulate
value (str) – The value (as a QString, as it could be an expression)

Note

unstable API (will likely change)

New in version 3.22.

setPoints(self, points: Iterable[QgsPointXY])¶

Configures list of current CAD points

Some map tools may find it useful to override list of CAD points that is otherwise automatically populated when user clicks with left mouse button on map canvas.

New in version 3.0.

Parameters: points (Iterable[QgsPointXY]) –

setX(self, value: str, mode: QgsAdvancedDigitizingDockWidget.WidgetSetMode)¶

Set the X value on the widget. Can be used to set constraints by external widgets.

Parameters

mode (QgsAdvancedDigitizingDockWidget.WidgetSetMode) – What type of interaction to emulate
value (str) – The value (as a QString, as it could be an expression)

Note

unstable API (will likely change)

New in version 3.8.

setY(self, value: str, mode: QgsAdvancedDigitizingDockWidget.WidgetSetMode)¶

Set the Y value on the widget. Can be used to set constraints by external widgets.

Parameters

mode (QgsAdvancedDigitizingDockWidget.WidgetSetMode) – What type of interaction to emulate
value (str) – The value (as a QString, as it could be an expression)

Note

unstable API (will likely change)

New in version 3.8.

setZ(self, value: str, mode: QgsAdvancedDigitizingDockWidget.WidgetSetMode)¶

Set the Z value on the widget. Can be used to set constraints by external widgets.

Parameters

mode (QgsAdvancedDigitizingDockWidget.WidgetSetMode) – What type of interaction to emulate
value (str) – The value (as a QString, as it could be an expression)

Note

unstable API (will likely change)

New in version 3.22.

sharedPainter(self) → QPainter¶

showEvent(self, event: QShowEvent)¶

snappedSegment(self) → List[QgsPointXY]¶

Snapped to a segment

Return type: List[QgsPointXY]

snappedToVertex(self) → bool¶

Is it snapped to a vertex

Return type: bool

softLockLineExtensionChanged¶

Emitted whenever the soft line extension parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.26: [signal]

Parameters: locked (bool) –

softLockX(self) → float¶

Returns the X value of the X soft lock. The value is NaN is the constraint isn’t magnetized to a line

Return type: float

softLockXyChanged¶

Emitted whenever the soft x/y extension parameter is locked. Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.26: [signal]

Parameters: locked (bool) –

softLockY(self) → float¶

Returns the Y value of the Y soft lock. The value is NaN is the constraint isn’t magnetized to a line

Return type: float

switchZM(self)¶: Determines if Z or M will be enabled.

New in version 3.22.

tabletEvent(self, QTabletEvent)¶

timerEvent(self, QTimerEvent)¶

updateCadPaintItem(self)¶: Updates canvas item that displays constraints on the ma

New in version 3.0.

updateMicroFocus(self)¶

valueAngleChanged¶

Emitted whenever the angle value changes (either the mouse moved, or the user changed the input). Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: value (str) –

valueDistanceChanged¶

Emitted whenever the distance value changes (either the mouse moved, or the user changed the input). Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: value (str) –

valueMChanged¶

Emitted whenever the M value changes (either the mouse moved, or the user changed the input). Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.22: [signal]

Parameters: value (str) –

valueXChanged¶

Emitted whenever the X value changes (either the mouse moved, or the user changed the input). Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: value (str) –

valueYChanged¶

Emitted whenever the Y value changes (either the mouse moved, or the user changed the input). Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.8: [signal]

Parameters: value (str) –

valueZChanged¶

Emitted whenever the Z value changes (either the mouse moved, or the user changed the input). Could be used by widgets that must reflect the current advanced digitizing state.

Note

unstable API (will likely change)

New in version 3.22: [signal]

Parameters: value (str) –

wheelEvent(self, QWheelEvent)¶