A dockable widget used to handle the CAD tools on top of a selection of map tools. More...

#include <qgsadvanceddigitizingdockwidget.h>

Inheritance diagram for QgsAdvancedDigitizingDockWidget:

[legend]

Classes
class	CadConstraint
	The CadConstraint is a class for all basic constraints (angle/distance/x/y). More...

Public Types
typedef QFlags< CadCapacity >	CadCapacities
enum	CadCapacity { AbsoluteAngle = 1 , RelativeAngle = 2 , RelativeCoordinates = 4 , Distance = 8 }
	The CadCapacity enum defines the possible constraints to be set depending on the number of points in the CAD point list (the list of points currently digitized). More...
enum	WidgetSetMode { ReturnPressed , FocusOut , TextEdited }
	Type of interaction to simulate when editing values from external widget. More...

Public Slots
void	updateTransientGeometryProperties (const QgsReferencedGeometry &geometry)
	Updates properties associated with the transient geometry from the active map tool.
Public Slots inherited from QgsDockWidget
void	setUserVisible (bool visible)
	Sets the dock widget as visible to a user, ie both shown and raised to the front.
void	toggleUserVisible ()
	Toggles whether the dock is user visible.

Signals
void	cadEnabledChanged (bool enabled)
	Signals for external widgets that need to update according to current values.
void	commonAngleSnappingShowInFloaterChanged (bool enabled)
	Emitted whenever the option to show common angle snapping in the floater changes.
void	enabledChangedAngle (bool enabled)
	Emitted whenever the angle field is enabled or disabled.
void	enabledChangedDistance (bool enabled)
	Emitted whenever the distance field is enabled or disabled.
void	enabledChangedM (bool enabled)
	Emitted whenever the M field is enabled or disabled.
void	enabledChangedWeight (bool enabled)
	Emitted whenever the weight field is enabled or disabled for NURBS curves.
void	enabledChangedX (bool enabled)
	Emitted whenever the X field is enabled or disabled.
void	enabledChangedY (bool enabled)
	Emitted whenever the Y field is enabled or disabled.
void	enabledChangedZ (bool enabled)
	Emitted whenever the Z field is enabled or disabled.
void	focusOnAngleRequested ()
	Emitted whenever the angle field should get the focus using the shortcuts (A).
void	focusOnDistanceRequested ()
	Emitted whenever the distance field should get the focus using the shortcuts (D).
void	focusOnMRequested ()
	Emitted whenever the M field should get the focus using the shortcuts (M).
void	focusOnWeightRequested ()
	Emitted whenever the weight field should get the focus using the shortcuts (W).
void	focusOnXRequested ()
	Emitted whenever the X field should get the focus using the shortcuts (X).
void	focusOnYRequested ()
	Emitted whenever the Y field should get the focus using the shortcuts (Y).
void	focusOnZRequested ()
	Emitted whenever the Z field should get the focus using the shortcuts (Z).
void	lockAngleChanged (bool locked)
	Emitted whenever the angle parameter is locked.
void	lockDistanceChanged (bool locked)
	Emitted whenever the distance parameter is locked.
void	lockMChanged (bool locked)
	Emitted whenever the M parameter is locked.
void	lockXChanged (bool locked)
	Emitted whenever the X parameter is locked.
void	lockYChanged (bool locked)
	Emitted whenever the Y parameter is locked.
void	lockZChanged (bool locked)
	Emitted whenever the Z parameter is locked.
Q_DECL_DEPRECATED void	pointChanged (const QgsPointXY &point)
	Sometimes a constraint may change the current point out of a mouse event.
void	pointChangedV2 (const QgsPoint &point)
	Sometimes a constraint may change the current point out of a mouse event.
void	popWarning ()
	Remove any previously emitted warnings (if any).
void	pushWarning (const QString &message)
	Push a warning.
void	relativeAngleChanged (bool relative)
	Emitted whenever the angleX parameter is toggled between absolute and relative.
void	relativeMChanged (bool relative)
	Emitted whenever the M parameter is toggled between absolute and relative.
void	relativeXChanged (bool relative)
	Emitted whenever the X parameter is toggled between absolute and relative.
void	relativeYChanged (bool relative)
	Emitted whenever the Y parameter is toggled between absolute and relative.
void	relativeZChanged (bool relative)
	Emitted whenever the Z parameter is toggled between absolute and relative.
void	softLockLineExtensionChanged (bool locked)
	Emitted whenever the soft line extension parameter is locked.
void	softLockXyChanged (bool locked)
	Emitted whenever the soft x/y extension parameter is locked.
void	valueAngleChanged (const QString &value)
	Emitted whenever the angle value changes (either the mouse moved, or the user changed the input).
void	valueAreaChanged (const QString &value)
	Emitted whenever the total summed area value changes.
void	valueBearingChanged (const QString &value)
	Emitted whenever the bearing value changes.
void	valueCommonAngleSnappingChanged (double angle)
	Emitted whenever the snapping to common angle option changes, angle = 0 means that the functionality is disabled.
void	valueDistanceChanged (const QString &value)
	Emitted whenever the distance value changes (either the mouse moved, or the user changed the input).
void	valueMChanged (const QString &value)
	Emitted whenever the M value changes (either the mouse moved, or the user changed the input).
void	valueTotalLengthChanged (const QString &value)
	Emitted whenever the total length (or perimeter) value changes.
void	valueWeightChanged (const QString &value)
	Emitted whenever the weight value changes for NURBS curves.
void	valueXChanged (const QString &value)
	Emitted whenever the X value changes (either the mouse moved, or the user changed the input).
void	valueYChanged (const QString &value)
	Emitted whenever the Y value changes (either the mouse moved, or the user changed the input).
void	valueZChanged (const QString &value)
	Emitted whenever the Z value changes (either the mouse moved, or the user changed the input).
Signals inherited from QgsDockWidget
void	closed ()
	Emitted when dock widget is closed.
void	closedStateChanged (bool wasClosed)
	Emitted when dock widget is closed (or opened).
void	opened ()
	Emitted when dock widget is opened.
void	openedStateChanged (bool wasOpened)
	Emitted when dock widget is opened (or closed).

Public Member Functions
	QgsAdvancedDigitizingDockWidget (QgsMapCanvas canvas, QWidget parent=nullptr, QgsUserInputWidget *userInputWidget=nullptr)
	Create an advanced digitizing dock widget.
	~QgsAdvancedDigitizingDockWidget () override
void	addPoint (const QgsPointXY &point)
	Adds point to the CAD point list.
bool	alignToSegment (QgsMapMouseEvent *e, QgsAdvancedDigitizingDockWidget::CadConstraint::LockMode lockMode=QgsAdvancedDigitizingDockWidget::CadConstraint::HardLock)
	align to segment for between line constraint.
bool	applyConstraints (QgsMapMouseEvent *e)
	apply the CAD constraints.
Qgis::BetweenLineConstraint	betweenLineConstraint () const
	Returns the between line constraints which are used to place perpendicular/parallel segments to snapped segments on the canvas.
bool	cadEnabled () const
	determines if CAD tools are enabled or if map tools behaves "nomally"
bool	canvasKeyPressEventFilter (QKeyEvent *e)
	Filter key events to e.g.
CadCapacities	capacities () const
	Returns the capacities.
void	clear ()
	Clear any cached previous clicks and helper lines.
void	clearLockedSnapVertices (bool force=true)
	Removes all points from the locked snap vertex list.
void	clearPoints ()
	Removes all points from the CAD point list.
bool	commonAngleConstraint () const
	Returns `true` if a constraint on a common angle is active.
const CadConstraint *	constraintAngle () const
	Returns the CadConstraint on the angle.
const CadConstraint *	constraintDistance () const
	Returns the CadConstraint on the distance.
const CadConstraint *	constraintLineExtension () const
	Returns the CadConstraint.
const CadConstraint *	constraintM () const
	Returns the CadConstraint on the M coordinate.
const CadConstraint *	constraintX () const
	Returns the CadConstraint on the X coordinate.
const CadConstraint *	constraintXyVertex () const
	Returns the CadConstraint.
const CadConstraint *	constraintY () const
	Returns the CadConstraint on the Y coordinate.
const CadConstraint *	constraintZ () const
	Returns the CadConstraint on the Z coordinate.
QgsVectorLayer *	constructionGuidesLayer () const
	Returns the vector layer within which construction guides are stored.
bool	constructionMode () const
	Returns whether the construction mode is activated.
Q_DECL_DEPRECATED QgsPointXY	currentPoint (bool *exists=nullptr) const
	The last point.
QgsPoint	currentPointLayerCoordinates (QgsMapLayer *layer) const
	Returns the last CAD point, in a map layer's coordinates.
QgsPoint	currentPointV2 (bool *exists=nullptr) const
	The last point.
void	disable ()
	Disable the widget.
void	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.
QAction *	enableAction ()
	Returns the action used to enable/disable the tools.
QgsAdvancedDigitizingFloater *	floater () const
	Returns the advanced digitizing floater.
QString	formatCommonAngleSnapping (double angle)
	Returns the formatted label for common angle snapping option.
double	getLineM () const
	Convenient method to get the M value from the line edit wiget.
double	getLineZ () const
	Convenient method to get the Z value from the line edit wiget.
void	keyPressEvent (QKeyEvent *e) override
Qgis::LineExtensionSide	lineExtensionSide () const
	Returns on which side of the constraint line extension point, the line was created.
QList< QgsPointLocator::Match >	lockedSnapVertices () const
	Returns the snap matches whose vertices have been locked.
QgsPointLocator::Match	mapPointMatch () const
	Returns the point locator match.
Q_DECL_DEPRECATED QgsPointXY	penultimatePoint (bool *exists=nullptr) const
	The penultimate point.
QgsPoint	penultimatePointV2 (bool *exists=nullptr) const
	The penultimate point.
int	pointsCount () const
	The number of points in the CAD point helper list.
Q_DECL_DEPRECATED QgsPointXY	previousPoint (bool *exists=nullptr) const
	The previous point.
QgsPoint	previousPointV2 (bool *exists=nullptr) const
	The previous point.
void	processCanvasMoveEvent (QgsMapMouseEvent *event)
	Processes the canvas move event.
void	processCanvasPressEvent (QgsMapMouseEvent *event)
	Processes the canvas press event.
void	processCanvasReleaseEvent (QgsMapMouseEvent *event)
	Processes the canvas release event.
bool	recordConstructionGuides () const
	Returns whether construction guides are being recorded.
void	releaseLocks (bool releaseRepeatingLocks=true)
	unlock all constraints
void	removePreviousPoint ()
	Removes previous point in the CAD point list.
void	setAngle (const QString &value, WidgetSetMode mode)
	Set the angle value on the widget.
void	setDistance (const QString &value, WidgetSetMode mode)
	Set the distance value on the widget.
void	setEnabledM (bool enable)
	Sets whether M is enabled.
void	setEnabledZ (bool enable)
	Sets whether Z is enabled.
void	setM (const QString &value, WidgetSetMode mode)
	Set the M value on the widget.
void	setPoints (const QList< QgsPointXY > &points)
	Configures list of current CAD points.
void	setTool (QgsAdvancedDigitizingTool *tool)
	Sets an advanced digitizing tool which will take over digitizing until the tool is close.
void	setWeight (const QString &value, bool enabled)
	Set the weight value for NURBS curves.
void	setX (const QString &value, WidgetSetMode mode)
	Set the X value on the widget.
void	setY (const QString &value, WidgetSetMode mode)
	Set the Y value on the widget.
void	setZ (const QString &value, WidgetSetMode mode)
	Set the Z value on the widget.
bool	showConstructionGuides () const
	Returns whether the construction guides are visible.
QList< QgsPointXY >	snappedSegment () const
	Snapped to a segment.
bool	snappedToVertex () const
	Is it snapped to a vertex.
bool	snapToConstructionGuides () const
	Returns whether points should snap to construction guides.
double	softLockX () const
	Returns the X value of the X soft lock. The value is NaN is the constraint isn't magnetized to a line.
double	softLockY () const
	Returns the Y value of the Y soft lock. The value is NaN is the constraint isn't magnetized to a line.
void	switchZM ()
	Determines if Z or M will be enabled.
void	toggleConstraintDistance ()
	Toggles the distance constraint.
QgsAdvancedDigitizingTool *	tool () const
	Returns the current advanced digitizing tool.
void	updateCadPaintItem ()
	Updates canvas item that displays constraints on the ma.
void	updateCurrentPoint (const QgsPoint &point)
	Updates the current point in the CAD point list.
QString	weight () const
	Returns the current weight value for NURBS curves.
Public Member Functions inherited from QgsDockWidget
	QgsDockWidget (const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Constructor for QgsDockWidget.
	QgsDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Constructor for QgsDockWidget.
bool	isUserVisible () const
	Returns `true` if the dock is both opened and raised to the front (ie not hidden by any other tabs.
void	setToggleVisibilityAction (QAction *action)
	Links an action to the dock, so that toggling the action will automatically set the dock's visibility to suit (and changing the dock visibility will update the action's state).
QAction *	toggleVisibilityAction ()
	Returns the action linked to the dock.

Friends
class	TestQgsAdvancedDigitizing
class	TestQgsAdvancedDigitizingDockWidget

Additional Inherited Members
Protected Member Functions inherited from QgsDockWidget
void	closeEvent (QCloseEvent *) override
void	showEvent (QShowEvent *event) override

Detailed Description

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.

Definition at line 52 of file qgsadvanceddigitizingdockwidget.h.

Member Typedef Documentation

◆ CadCapacities

typedef QFlags< CadCapacity > QgsAdvancedDigitizingDockWidget::CadCapacities

Definition at line 69 of file qgsadvanceddigitizingdockwidget.h.

Member Enumeration Documentation

◆ CadCapacity

enum QgsAdvancedDigitizingDockWidget::CadCapacity

The CadCapacity enum defines the possible constraints to be set depending on the number of points in the CAD point list (the list of points currently digitized).

Enumerator
AbsoluteAngle	Azimuth.
RelativeAngle	Also for parallel and perpendicular.
RelativeCoordinates	This corresponds to distance and relative coordinates.
Distance	Distance.

Definition at line 62 of file qgsadvanceddigitizingdockwidget.h.

◆ WidgetSetMode

enum QgsAdvancedDigitizingDockWidget::WidgetSetMode

Type of interaction to simulate when editing values from external widget.

Note: unstable API (will likely change)

Since: QGIS 3.8

Enumerator
ReturnPressed
FocusOut
TextEdited

Definition at line 77 of file qgsadvanceddigitizingdockwidget.h.

Constructor & Destructor Documentation

◆ QgsAdvancedDigitizingDockWidget()

QgsAdvancedDigitizingDockWidget::QgsAdvancedDigitizingDockWidget	(	QgsMapCanvas *	canvas,
		QWidget *	parent = nullptr,
		QgsUserInputWidget *	userInputWidget = nullptr )

explicit

Create an advanced digitizing dock widget.

Parameters

canvas	The map canvas on which the widget operates
parent	The parent
userInputWidget	The user input widget on which tools can add widget overlays on top of the map canvas (since QGIS 3.40)

Definition at line 60 of file qgsadvanceddigitizingdockwidget.cpp.

◆ ~QgsAdvancedDigitizingDockWidget()

QgsAdvancedDigitizingDockWidget::~QgsAdvancedDigitizingDockWidget ( )

override

Definition at line 555 of file qgsadvanceddigitizingdockwidget.cpp.

Member Function Documentation

◆ addPoint()

void QgsAdvancedDigitizingDockWidget::addPoint ( const QgsPointXY & point )

Adds point to the CAD point list.

Definition at line 2331 of file qgsadvanceddigitizingdockwidget.cpp.

◆ alignToSegment()

bool QgsAdvancedDigitizingDockWidget::alignToSegment	(	QgsMapMouseEvent *	e,
		QgsAdvancedDigitizingDockWidget::CadConstraint::LockMode	lockMode = QgsAdvancedDigitizingDockWidget::CadConstraint::HardLock )

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.

Definition at line 1803 of file qgsadvanceddigitizingdockwidget.cpp.

◆ applyConstraints()

bool QgsAdvancedDigitizingDockWidget::applyConstraints ( QgsMapMouseEvent * e )

apply the CAD constraints.

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

Returns: false if no solution was found (invalid constraints)

Definition at line 1451 of file qgsadvanceddigitizingdockwidget.cpp.

◆ betweenLineConstraint()

Qgis::BetweenLineConstraint QgsAdvancedDigitizingDockWidget::betweenLineConstraint ( ) const

inline

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

Definition at line 377 of file qgsadvanceddigitizingdockwidget.h.

◆ cadEnabled()

bool QgsAdvancedDigitizingDockWidget::cadEnabled ( ) const

inline

determines if CAD tools are enabled or if map tools behaves "nomally"

Definition at line 323 of file qgsadvanceddigitizingdockwidget.h.

◆ cadEnabledChanged

void QgsAdvancedDigitizingDockWidget::cadEnabledChanged ( bool enabled )

signal

Signals for external widgets that need to update according to current values.

Emitted whenever CAD is enabled or disabled

Parameters

enabled Whether CAD is enabled or not

Note: unstable API (will likely change).

Since: QGIS 3.8

◆ canvasKeyPressEventFilter()

bool QgsAdvancedDigitizingDockWidget::canvasKeyPressEventFilter ( QKeyEvent * e )

Filter key events to e.g.

toggle construction mode or adapt constraints

Parameters

e	A mouse event (may be modified)

Returns: If the event is hidden (construction mode hides events from the maptool)

Definition at line 1844 of file qgsadvanceddigitizingdockwidget.cpp.

◆ capacities()

CadCapacities QgsAdvancedDigitizingDockWidget::capacities ( ) const

inline

Returns the capacities.

Since: QGIS 3.26

Definition at line 653 of file qgsadvanceddigitizingdockwidget.h.

◆ clear()

void QgsAdvancedDigitizingDockWidget::clear ( )

Clear any cached previous clicks and helper lines.

Definition at line 1875 of file qgsadvanceddigitizingdockwidget.cpp.

◆ clearLockedSnapVertices()

void QgsAdvancedDigitizingDockWidget::clearLockedSnapVertices ( bool force = true )

Removes all points from the locked snap vertex list.

Parameters

force Clears the list even if the constraints that use it are still locked.

Since: QGIS 3.26

Definition at line 2321 of file qgsadvanceddigitizingdockwidget.cpp.

◆ clearPoints()

void QgsAdvancedDigitizingDockWidget::clearPoints ( )

Removes all points from the CAD point list.

Definition at line 2391 of file qgsadvanceddigitizingdockwidget.cpp.

◆ commonAngleConstraint()

bool QgsAdvancedDigitizingDockWidget::commonAngleConstraint ( ) const

inline

Returns true if a constraint on a common angle is active.

Definition at line 399 of file qgsadvanceddigitizingdockwidget.h.

◆ commonAngleSnappingShowInFloaterChanged

void QgsAdvancedDigitizingDockWidget::commonAngleSnappingShowInFloaterChanged ( bool enabled )

signal

Emitted whenever the option to show common angle snapping in the floater changes.

Note: Not available in Python bindings

◆ constraintAngle()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintAngle ( ) const

inline

Returns the CadConstraint on the angle.

Definition at line 379 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintDistance()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintDistance ( ) const

inline

Returns the CadConstraint on the distance.

Definition at line 381 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintLineExtension()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintLineExtension ( ) const

inline

Returns the CadConstraint.

Definition at line 402 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintM()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintM ( ) const

inline

Returns the CadConstraint on the M coordinate.

Since: QGIS 3.22

Definition at line 397 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintX()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintX ( ) const

inline

Returns the CadConstraint on the X coordinate.

Definition at line 383 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintXyVertex()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintXyVertex ( ) const

inline

Returns the CadConstraint.

Definition at line 408 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintY()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintY ( ) const

inline

Returns the CadConstraint on the Y coordinate.

Definition at line 385 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintZ()

const CadConstraint * QgsAdvancedDigitizingDockWidget::constraintZ ( ) const

inline

Returns the CadConstraint on the Z coordinate.

Since: QGIS 3.22

Definition at line 391 of file qgsadvanceddigitizingdockwidget.h.

◆ constructionGuidesLayer()

QgsVectorLayer * QgsAdvancedDigitizingDockWidget::constructionGuidesLayer ( ) const

inline

Returns the vector layer within which construction guides are stored.

Since: QGIS 3.40

Definition at line 353 of file qgsadvanceddigitizingdockwidget.h.

◆ constructionMode()

bool QgsAdvancedDigitizingDockWidget::constructionMode ( ) const

inline

Returns whether the construction mode is activated.

The construction mode is used to draw intermediate points that will not be part of a geometry being digitized.

Definition at line 347 of file qgsadvanceddigitizingdockwidget.h.

◆ currentPoint()

Q_DECL_DEPRECATED QgsPointXY QgsAdvancedDigitizingDockWidget::currentPoint ( bool * exists = nullptr ) const

inline

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: QGIS 3.22. Use currentPointV2() instead.

Definition at line 493 of file qgsadvanceddigitizingdockwidget.h.

◆ currentPointLayerCoordinates()

QgsPoint QgsAdvancedDigitizingDockWidget::currentPointLayerCoordinates ( QgsMapLayer * layer ) const

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

Since: QGIS 3.22

Definition at line 2574 of file qgsadvanceddigitizingdockwidget.cpp.

◆ currentPointV2()

QgsPoint QgsAdvancedDigitizingDockWidget::currentPointV2 ( bool * exists = nullptr ) const

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).

Since: QGIS 3.22

Definition at line 2564 of file qgsadvanceddigitizingdockwidget.cpp.

◆ disable()

void QgsAdvancedDigitizingDockWidget::disable ( )

Disable the widget.

Normally done automatically from QgsMapToolAdvancedDigitizing::deactivate().

Definition at line 2300 of file qgsadvanceddigitizingdockwidget.cpp.

◆ enable()

void QgsAdvancedDigitizingDockWidget::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.

Definition at line 2243 of file qgsadvanceddigitizingdockwidget.cpp.

◆ enableAction()

QAction * QgsAdvancedDigitizingDockWidget::enableAction ( )

inline

Returns the action used to enable/disable the tools.

Definition at line 541 of file qgsadvanceddigitizingdockwidget.h.

◆ enabledChangedAngle

void QgsAdvancedDigitizingDockWidget::enabledChangedAngle ( bool enabled )

signal

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 Whether the angle parameter is enabled or not.

Note: unstable API (will likely change)

Since: QGIS 3.8

◆ enabledChangedDistance

void QgsAdvancedDigitizingDockWidget::enabledChangedDistance ( bool enabled )

signal

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 Whether the distance parameter is enabled or not.

Note: unstable API (will likely change)

Since: QGIS 3.8

◆ enabledChangedM

void QgsAdvancedDigitizingDockWidget::enabledChangedM ( bool enabled )

signal

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 Whether the M parameter is enabled or not.

Note: unstable API (will likely change)

Since: QGIS 3.22

◆ enabledChangedWeight

void QgsAdvancedDigitizingDockWidget::enabledChangedWeight ( bool enabled )

signal

Emitted whenever the weight field is enabled or disabled for NURBS curves.

Could be used by widgets that must reflect the current weight editing state.

Parameters

enabled Whether the weight parameter is enabled or not.

Note: unstable API (will likely change)

Since: QGIS 4.0

◆ enabledChangedX

void QgsAdvancedDigitizingDockWidget::enabledChangedX ( bool enabled )

signal

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 Whether the X parameter is enabled or not.

Note: unstable API (will likely change)

Since: QGIS 3.8

◆ enabledChangedY

void QgsAdvancedDigitizingDockWidget::enabledChangedY ( bool enabled )

signal

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 Whether the Y parameter is enabled or not.

Note: unstable API (will likely change)

Since: QGIS 3.8

◆ enabledChangedZ

void QgsAdvancedDigitizingDockWidget::enabledChangedZ ( bool enabled )

signal

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 Whether the Z parameter is enabled or not.

Note: unstable API (will likely change)

Since: QGIS 3.22

◆ floater()

QgsAdvancedDigitizingFloater * QgsAdvancedDigitizingDockWidget::floater ( ) const

Returns the advanced digitizing floater.

Since: QGIS 4.0

Definition at line 2692 of file qgsadvanceddigitizingdockwidget.cpp.

◆ focusOnAngleRequested

void QgsAdvancedDigitizingDockWidget::focusOnAngleRequested ( )

signal

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)

Since: QGIS 3.8

◆ focusOnDistanceRequested

void QgsAdvancedDigitizingDockWidget::focusOnDistanceRequested ( )

signal

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)

Since: QGIS 3.8

◆ focusOnMRequested

void QgsAdvancedDigitizingDockWidget::focusOnMRequested ( )

signal

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)

Since: QGIS 3.22

◆ focusOnWeightRequested

void QgsAdvancedDigitizingDockWidget::focusOnWeightRequested ( )

signal

Emitted whenever the weight field should get the focus using the shortcuts (W).

Could be used by widgets to capture the focus when a field is being edited.

Note: unstable API (will likely change)

Since: QGIS 4.0

◆ focusOnXRequested

void QgsAdvancedDigitizingDockWidget::focusOnXRequested ( )

signal

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)

Since: QGIS 3.8

◆ focusOnYRequested

void QgsAdvancedDigitizingDockWidget::focusOnYRequested ( )

signal

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)

Since: QGIS 3.8

◆ focusOnZRequested

void QgsAdvancedDigitizingDockWidget::focusOnZRequested ( )

signal

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)

Since: QGIS 3.22

◆ formatCommonAngleSnapping()

QString QgsAdvancedDigitizingDockWidget::formatCommonAngleSnapping ( double angle )

Returns the formatted label for common angle snapping option.

Since: QGIS 3.32

Definition at line 563 of file qgsadvanceddigitizingdockwidget.cpp.

◆ getLineM()

double QgsAdvancedDigitizingDockWidget::getLineM ( ) const

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

Since: QGIS 3.22

Definition at line 2617 of file qgsadvanceddigitizingdockwidget.cpp.

◆ getLineZ()

double QgsAdvancedDigitizingDockWidget::getLineZ ( ) const

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

Since: QGIS 3.22

Definition at line 2612 of file qgsadvanceddigitizingdockwidget.cpp.

◆ keyPressEvent()

void QgsAdvancedDigitizingDockWidget::keyPressEvent ( QKeyEvent * e )

override

Definition at line 1891 of file qgsadvanceddigitizingdockwidget.cpp.

◆ lineExtensionSide()

Qgis::LineExtensionSide QgsAdvancedDigitizingDockWidget::lineExtensionSide ( ) const

inline

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

Definition at line 405 of file qgsadvanceddigitizingdockwidget.h.

◆ lockAngleChanged

void QgsAdvancedDigitizingDockWidget::lockAngleChanged ( bool locked )

signal

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)

Since: QGIS 3.8

◆ lockDistanceChanged

void QgsAdvancedDigitizingDockWidget::lockDistanceChanged ( bool locked )

signal

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)

Since: QGIS 3.8

◆ lockedSnapVertices()

QList< QgsPointLocator::Match > QgsAdvancedDigitizingDockWidget::lockedSnapVertices ( ) const

inline

Returns the snap matches whose vertices have been locked.

Since: QGIS 3.26

Definition at line 432 of file qgsadvanceddigitizingdockwidget.h.

◆ lockMChanged

void QgsAdvancedDigitizingDockWidget::lockMChanged ( bool locked )

signal

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)

Since: QGIS 3.22

◆ lockXChanged

void QgsAdvancedDigitizingDockWidget::lockXChanged ( bool locked )

signal

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)

Since: QGIS 3.8

◆ lockYChanged

void QgsAdvancedDigitizingDockWidget::lockYChanged ( bool locked )

signal

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)

Since: QGIS 3.8

◆ lockZChanged

void QgsAdvancedDigitizingDockWidget::lockZChanged ( bool locked )

signal

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)

Since: QGIS 3.22

◆ mapPointMatch()

QgsPointLocator::Match QgsAdvancedDigitizingDockWidget::mapPointMatch ( ) const

inline

Returns the point locator match.

Since: QGIS 3.4

Definition at line 426 of file qgsadvanceddigitizingdockwidget.h.

◆ penultimatePoint()

Q_DECL_DEPRECATED QgsPointXY QgsAdvancedDigitizingDockWidget::penultimatePoint ( bool * exists = nullptr ) const

inline

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: QGIS 3.22. Use penultimatePointV2() instead.

Definition at line 523 of file qgsadvanceddigitizingdockwidget.h.

◆ penultimatePointV2()

QgsPoint QgsAdvancedDigitizingDockWidget::penultimatePointV2 ( bool * exists = nullptr ) const

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).

Definition at line 2597 of file qgsadvanceddigitizingdockwidget.cpp.

◆ pointChanged

Q_DECL_DEPRECATED void QgsAdvancedDigitizingDockWidget::pointChanged ( const QgsPointXY & point )

signal

Sometimes a constraint may change the current point out of a mouse event.

This happens normally when a constraint is toggled.

Parameters

point The last known digitizing point. Can be used to emulate a mouse event.

Deprecated: QGIS 3.22. No longer used, will be removed in QGIS 5.0. Use pointChangedV2() instead.

◆ pointChangedV2

void QgsAdvancedDigitizingDockWidget::pointChangedV2 ( const QgsPoint & point )

signal

Sometimes a constraint may change the current point out of a mouse event.

This happens normally when a constraint is toggled.

Parameters

point The last known digitizing point. Can be used to emulate a mouse event.

Since: QGIS 3.22

◆ pointsCount()

int QgsAdvancedDigitizingDockWidget::pointsCount ( ) const

inline

The number of points in the CAD point helper list.

Definition at line 528 of file qgsadvanceddigitizingdockwidget.h.

◆ popWarning

void QgsAdvancedDigitizingDockWidget::popWarning ( )

signal

Remove any previously emitted warnings (if any).

◆ previousPoint()

Q_DECL_DEPRECATED QgsPointXY QgsAdvancedDigitizingDockWidget::previousPoint ( bool * exists = nullptr ) const

inline

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: QGIS 3.22. Use previousPointV2() instead.

Definition at line 508 of file qgsadvanceddigitizingdockwidget.h.

◆ previousPointV2()

QgsPoint QgsAdvancedDigitizingDockWidget::previousPointV2 ( bool * exists = nullptr ) const

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).

Definition at line 2587 of file qgsadvanceddigitizingdockwidget.cpp.

◆ processCanvasMoveEvent()

void QgsAdvancedDigitizingDockWidget::processCanvasMoveEvent ( QgsMapMouseEvent * event )

Processes the canvas move event.

Definition at line 1730 of file qgsadvanceddigitizingdockwidget.cpp.

◆ processCanvasPressEvent()

void QgsAdvancedDigitizingDockWidget::processCanvasPressEvent ( QgsMapMouseEvent * event )

Processes the canvas press event.

Definition at line 1717 of file qgsadvanceddigitizingdockwidget.cpp.

◆ processCanvasReleaseEvent()

void QgsAdvancedDigitizingDockWidget::processCanvasReleaseEvent ( QgsMapMouseEvent * event )

Processes the canvas release event.

Definition at line 1744 of file qgsadvanceddigitizingdockwidget.cpp.

◆ pushWarning

void QgsAdvancedDigitizingDockWidget::pushWarning ( const QString & message )

signal

Push a warning.

Parameters

message An informative message

◆ recordConstructionGuides()

bool QgsAdvancedDigitizingDockWidget::recordConstructionGuides ( ) const

Returns whether construction guides are being recorded.

Since: QGIS 3.40

Definition at line 2650 of file qgsadvanceddigitizingdockwidget.cpp.

◆ relativeAngleChanged

void QgsAdvancedDigitizingDockWidget::relativeAngleChanged ( bool relative )

signal

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 Whether the angle parameter is relative or not.

Note: unstable API (will likely change)

Since: QGIS 3.8

◆ relativeMChanged

void QgsAdvancedDigitizingDockWidget::relativeMChanged ( bool relative )

signal

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 Whether the M parameter is relative or not.

Note: unstable API (will likely change)

Since: QGIS 3.22

◆ relativeXChanged

void QgsAdvancedDigitizingDockWidget::relativeXChanged ( bool relative )

signal

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 Whether the X parameter is relative or not.

Note: unstable API (will likely change)

Since: QGIS 3.8

◆ relativeYChanged

void QgsAdvancedDigitizingDockWidget::relativeYChanged ( bool relative )

signal

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 Whether the Y parameter is relative or not.

Note: unstable API (will likely change)

Since: QGIS 3.8

◆ relativeZChanged

void QgsAdvancedDigitizingDockWidget::relativeZChanged ( bool relative )

signal

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 Whether the Z parameter is relative or not.

Note: unstable API (will likely change)

Since: QGIS 3.22

◆ releaseLocks()

void QgsAdvancedDigitizingDockWidget::releaseLocks ( bool releaseRepeatingLocks = true )

unlock all constraints

Parameters

releaseRepeatingLocks set to false to preserve the lock for any constraints set to repeating lock mode

Definition at line 969 of file qgsadvanceddigitizingdockwidget.cpp.

◆ removePreviousPoint()

void QgsAdvancedDigitizingDockWidget::removePreviousPoint ( )

Removes previous point in the CAD point list.

Since: QGIS 3.8

Definition at line 2380 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setAngle()

void QgsAdvancedDigitizingDockWidget::setAngle	(	const QString &	value,
		WidgetSetMode	mode )

Set the angle value on the widget.

Can be used to set constraints by external widgets.

Parameters

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

Note: unstable API (will likely change)

Since: QGIS 3.8

Definition at line 663 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setDistance()

void QgsAdvancedDigitizingDockWidget::setDistance	(	const QString &	value,
		WidgetSetMode	mode )

Set the distance value on the widget.

Can be used to set constraints by external widgets.

Parameters

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

Note: unstable API (will likely change)

Since: QGIS 3.8

Definition at line 675 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setEnabledM()

void QgsAdvancedDigitizingDockWidget::setEnabledM ( bool enable )

Sets whether M is enabled.

Since: QGIS 3.22

Definition at line 796 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setEnabledZ()

void QgsAdvancedDigitizingDockWidget::setEnabledZ ( bool enable )

Sets whether Z is enabled.

Since: QGIS 3.22

Definition at line 779 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setM()

void QgsAdvancedDigitizingDockWidget::setM	(	const QString &	value,
		WidgetSetMode	mode )

Set the M value on the widget.

Can be used to set constraints by external widgets.

Parameters

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

Note: unstable API (will likely change)

Since: QGIS 3.22

Definition at line 646 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setPoints()

void QgsAdvancedDigitizingDockWidget::setPoints ( const QList< QgsPointXY > & points )

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.

Definition at line 1932 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setTool()

void QgsAdvancedDigitizingDockWidget::setTool ( QgsAdvancedDigitizingTool * tool )

Sets an advanced digitizing tool which will take over digitizing until the tool is close.

Since: QGIS 3.40

Definition at line 827 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setWeight()

void QgsAdvancedDigitizingDockWidget::setWeight	(	const QString &	value,
		bool	enabled )

Set the weight value for NURBS curves.

Parameters

value	The weight value as a QString
enabled	Whether weight editing is enabled

Note: unstable API (will likely change)

Since: QGIS 4.0

Definition at line 2622 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setX()

void QgsAdvancedDigitizingDockWidget::setX	(	const QString &	value,
		WidgetSetMode	mode )

Set the X value on the widget.

Can be used to set constraints by external widgets.

Parameters

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

Note: unstable API (will likely change)

Since: QGIS 3.8

Definition at line 595 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setY()

void QgsAdvancedDigitizingDockWidget::setY	(	const QString &	value,
		WidgetSetMode	mode )

Set the Y value on the widget.

Can be used to set constraints by external widgets.

Parameters

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

Note: unstable API (will likely change)

Since: QGIS 3.8

Definition at line 612 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setZ()

void QgsAdvancedDigitizingDockWidget::setZ	(	const QString &	value,
		WidgetSetMode	mode )

Set the Z value on the widget.

Can be used to set constraints by external widgets.

Parameters

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

Note: unstable API (will likely change)

Since: QGIS 3.22

Definition at line 629 of file qgsadvanceddigitizingdockwidget.cpp.

◆ showConstructionGuides()

bool QgsAdvancedDigitizingDockWidget::showConstructionGuides ( ) const

Returns whether the construction guides are visible.

Since: QGIS 3.40

Definition at line 2640 of file qgsadvanceddigitizingdockwidget.cpp.

◆ snappedSegment()

QList< QgsPointXY > QgsAdvancedDigitizingDockWidget::snappedSegment ( ) const

inline

Snapped to a segment.

Definition at line 538 of file qgsadvanceddigitizingdockwidget.h.

◆ snappedToVertex()

bool QgsAdvancedDigitizingDockWidget::snappedToVertex ( ) const

inline

Is it snapped to a vertex.

Definition at line 533 of file qgsadvanceddigitizingdockwidget.h.

◆ snapToConstructionGuides()

bool QgsAdvancedDigitizingDockWidget::snapToConstructionGuides ( ) const

Returns whether points should snap to construction guides.

Since: QGIS 3.40

Definition at line 2645 of file qgsadvanceddigitizingdockwidget.cpp.

◆ softLockLineExtensionChanged

void QgsAdvancedDigitizingDockWidget::softLockLineExtensionChanged ( bool locked )

signal

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)

Since: QGIS 3.26

◆ softLockX()

double QgsAdvancedDigitizingDockWidget::softLockX ( ) const

inline

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

Definition at line 411 of file qgsadvanceddigitizingdockwidget.h.

◆ softLockXyChanged

void QgsAdvancedDigitizingDockWidget::softLockXyChanged ( bool locked )

signal

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)

Since: QGIS 3.26

◆ softLockY()

double QgsAdvancedDigitizingDockWidget::softLockY ( ) const

inline

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

Definition at line 414 of file qgsadvanceddigitizingdockwidget.h.

◆ switchZM()

void QgsAdvancedDigitizingDockWidget::switchZM ( )

Determines if Z or M will be enabled.

Since: QGIS 3.22

Definition at line 736 of file qgsadvanceddigitizingdockwidget.cpp.

◆ toggleConstraintDistance()

void QgsAdvancedDigitizingDockWidget::toggleConstraintDistance ( )

Toggles the distance constraint.

Since: QGIS 3.40

Definition at line 1942 of file qgsadvanceddigitizingdockwidget.cpp.

◆ tool()

QgsAdvancedDigitizingTool * QgsAdvancedDigitizingDockWidget::tool ( ) const

Returns the current advanced digitizing tool.

Returns nullptr if not set.

Since: QGIS 3.40

Definition at line 848 of file qgsadvanceddigitizingdockwidget.cpp.

◆ updateCadPaintItem()

void QgsAdvancedDigitizingDockWidget::updateCadPaintItem ( )

Updates canvas item that displays constraints on the ma.

Definition at line 2316 of file qgsadvanceddigitizingdockwidget.cpp.

◆ updateCurrentPoint()

void QgsAdvancedDigitizingDockWidget::updateCurrentPoint ( const QgsPoint & point )

Updates the current point in the CAD point list.

Since: QGIS 3.30.2

Definition at line 2400 of file qgsadvanceddigitizingdockwidget.cpp.

◆ updateTransientGeometryProperties

void QgsAdvancedDigitizingDockWidget::updateTransientGeometryProperties ( const QgsReferencedGeometry & geometry )

slot

Updates properties associated with the transient geometry from the active map tool.

Transient geometry includes non-finalized changes, e.g. the current mouse hover state.

Note: Not available in Python bindings

Since: QGIS 4.0

Definition at line 571 of file qgsadvanceddigitizingdockwidget.cpp.

◆ valueAngleChanged

void QgsAdvancedDigitizingDockWidget::valueAngleChanged ( const QString & value )

signal

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)

Since: QGIS 3.8

◆ valueAreaChanged

void QgsAdvancedDigitizingDockWidget::valueAreaChanged ( const QString & value )

signal

Emitted whenever the total summed area value changes.

Could be used by widgets that must reflect the current advanced digitizing state.

Note: unstable API (will likely change)

Since: QGIS 4.0

◆ valueBearingChanged

void QgsAdvancedDigitizingDockWidget::valueBearingChanged ( const QString & value )

signal

Emitted whenever the bearing value changes.

Could be used by widgets that must reflect the current advanced digitizing state.

Note: unstable API (will likely change)

Since: QGIS 3.32

◆ valueCommonAngleSnappingChanged

void QgsAdvancedDigitizingDockWidget::valueCommonAngleSnappingChanged ( double angle )

signal

Emitted whenever the snapping to common angle option changes, angle = 0 means that the functionality is disabled.

Since: QGIS 3.32

◆ valueDistanceChanged

void QgsAdvancedDigitizingDockWidget::valueDistanceChanged ( const QString & value )

signal

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)

Since: QGIS 3.8

◆ valueMChanged

void QgsAdvancedDigitizingDockWidget::valueMChanged ( const QString & value )

signal

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)

Since: QGIS 3.22

◆ valueTotalLengthChanged

void QgsAdvancedDigitizingDockWidget::valueTotalLengthChanged ( const QString & value )

signal

Emitted whenever the total length (or perimeter) value changes.

Could be used by widgets that must reflect the current advanced digitizing state.

Note: unstable API (will likely change)

Since: QGIS 4.0

◆ valueWeightChanged

void QgsAdvancedDigitizingDockWidget::valueWeightChanged ( const QString & value )

signal

Emitted whenever the weight value changes for NURBS curves.

Could be used by widgets that must reflect the current weight value.

Note: unstable API (will likely change)

Since: QGIS 4.0

◆ valueXChanged

void QgsAdvancedDigitizingDockWidget::valueXChanged ( const QString & value )

signal

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)

Since: QGIS 3.8

◆ valueYChanged

void QgsAdvancedDigitizingDockWidget::valueYChanged ( const QString & value )

signal

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)

Since: QGIS 3.8

◆ valueZChanged

void QgsAdvancedDigitizingDockWidget::valueZChanged ( const QString & value )

signal

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)

Since: QGIS 3.22

◆ weight()

QString QgsAdvancedDigitizingDockWidget::weight ( ) const

Returns the current weight value for NURBS curves.

Note: unstable API (will likely change)

Since: QGIS 4.0

Definition at line 2635 of file qgsadvanceddigitizingdockwidget.cpp.

◆ TestQgsAdvancedDigitizing

friend class TestQgsAdvancedDigitizing

friend

Definition at line 1267 of file qgsadvanceddigitizingdockwidget.h.

◆ TestQgsAdvancedDigitizingDockWidget

friend class TestQgsAdvancedDigitizingDockWidget

friend

Definition at line 1268 of file qgsadvanceddigitizingdockwidget.h.

The documentation for this class was generated from the following files:

/build/qgis-3.99.0+git20260209+8e76e220402+99sid/src/gui/qgsadvanceddigitizingdockwidget.h
/build/qgis-3.99.0+git20260209+8e76e220402+99sid/src/gui/qgsadvanceddigitizingdockwidget.cpp

Classes

Public Types

Public Slots

Signals

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CadCapacities

Member Enumeration Documentation

◆ CadCapacity

◆ WidgetSetMode

Constructor & Destructor Documentation

◆ QgsAdvancedDigitizingDockWidget()

◆ ~QgsAdvancedDigitizingDockWidget()

Member Function Documentation

◆ addPoint()

◆ alignToSegment()

◆ applyConstraints()

◆ betweenLineConstraint()

◆ cadEnabled()

◆ cadEnabledChanged

◆ canvasKeyPressEventFilter()

◆ capacities()

◆ clear()

◆ clearLockedSnapVertices()

◆ clearPoints()

◆ commonAngleConstraint()

◆ commonAngleSnappingShowInFloaterChanged

◆ constraintAngle()

◆ constraintDistance()

◆ constraintLineExtension()

◆ constraintM()

◆ constraintX()

◆ constraintXyVertex()

◆ constraintY()

◆ constraintZ()

◆ constructionGuidesLayer()

◆ constructionMode()

◆ currentPoint()

◆ currentPointLayerCoordinates()

◆ currentPointV2()

◆ disable()

◆ enable()

◆ enableAction()

◆ enabledChangedAngle

◆ enabledChangedDistance

◆ enabledChangedM

◆ enabledChangedWeight

◆ enabledChangedX

◆ enabledChangedY

◆ enabledChangedZ

◆ floater()

◆ focusOnAngleRequested

◆ focusOnDistanceRequested

◆ focusOnMRequested

◆ focusOnWeightRequested

◆ focusOnXRequested

◆ focusOnYRequested

◆ focusOnZRequested

◆ formatCommonAngleSnapping()

◆ getLineM()

◆ getLineZ()

◆ keyPressEvent()

◆ lineExtensionSide()

◆ lockAngleChanged

◆ lockDistanceChanged

◆ lockedSnapVertices()

◆ lockMChanged

◆ lockXChanged

◆ lockYChanged

◆ lockZChanged

◆ mapPointMatch()

◆ penultimatePoint()

◆ penultimatePointV2()

◆ pointChanged

◆ pointChangedV2

◆ pointsCount()

◆ popWarning