QGIS API Documentation 3.41.0-Master (af5edcb665c)
|
The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of a selection of map tools. More...
#include <qgsadvanceddigitizingdockwidget.h>
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... | |
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 | 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 | 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 | 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 | 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 () | |
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. | |
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 | 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. | |
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 | |
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. | |
Protected Member Functions inherited from QgsDockWidget | |
void | closeEvent (QCloseEvent *) override |
void | showEvent (QShowEvent *event) override |
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.
Definition at line 51 of file qgsadvanceddigitizingdockwidget.h.
typedef QFlags< CadCapacity > QgsAdvancedDigitizingDockWidget::CadCapacities |
Definition at line 68 of file qgsadvanceddigitizingdockwidget.h.
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 61 of file qgsadvanceddigitizingdockwidget.h.
Type of interaction to simulate when editing values from external widget.
Enumerator | |
---|---|
ReturnPressed | |
FocusOut | |
TextEdited |
Definition at line 76 of file qgsadvanceddigitizingdockwidget.h.
|
explicit |
Create an advanced digitizing dock widget.
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 55 of file qgsadvanceddigitizingdockwidget.cpp.
QgsAdvancedDigitizingDockWidget::~QgsAdvancedDigitizingDockWidget | ( | ) |
Definition at line 431 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::addPoint | ( | const QgsPointXY & | point | ) |
Adds point to the CAD point list.
Definition at line 2169 of file qgsadvanceddigitizingdockwidget.cpp.
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 1641 of file qgsadvanceddigitizingdockwidget.cpp.
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.
false
if no solution was found (invalid constraints) Definition at line 1292 of file qgsadvanceddigitizingdockwidget.cpp.
|
inline |
Returns the between line constraints which are used to place perpendicular/parallel segments to snapped segments on the canvas.
Definition at line 374 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
determines if CAD tools are enabled or if map tools behaves "nomally"
Definition at line 320 of file qgsadvanceddigitizingdockwidget.h.
|
signal |
Signals for external widgets that need to update according to current values.
Emitted whenever CAD is enabled or disabled
enabled | Whether CAD is enabled or not |
bool QgsAdvancedDigitizingDockWidget::canvasKeyPressEventFilter | ( | QKeyEvent * | e | ) |
Filter key events to e.g.
toggle construction mode or adapt constraints
e | A mouse event (may be modified) |
Definition at line 1682 of file qgsadvanceddigitizingdockwidget.cpp.
|
inline |
Returns the capacities.
Definition at line 634 of file qgsadvanceddigitizingdockwidget.h.
void QgsAdvancedDigitizingDockWidget::clear | ( | ) |
Clear any cached previous clicks and helper lines.
Definition at line 1713 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::clearLockedSnapVertices | ( | bool | force = true | ) |
Removes all points from the locked snap vertex list.
force | Clears the list even if the constraints that use it are still locked. |
Definition at line 2159 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::clearPoints | ( | ) |
Removes all points from the CAD point list.
Definition at line 2229 of file qgsadvanceddigitizingdockwidget.cpp.
|
inline |
Returns true
if a constraint on a common angle is active.
Definition at line 396 of file qgsadvanceddigitizingdockwidget.h.
|
signal |
Emitted whenever the option to show common angle snapping in the floater changes.
|
inline |
Returns the CadConstraint on the angle.
Definition at line 376 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the CadConstraint on the distance.
Definition at line 378 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the CadConstraint.
Definition at line 399 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the CadConstraint on the M coordinate.
Definition at line 394 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the CadConstraint on the X coordinate.
Definition at line 380 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the CadConstraint.
Definition at line 405 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the CadConstraint on the Y coordinate.
Definition at line 382 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the CadConstraint on the Z coordinate.
Definition at line 388 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Returns the vector layer within which construction guides are stored.
Definition at line 350 of file qgsadvanceddigitizingdockwidget.h.
|
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 344 of file qgsadvanceddigitizingdockwidget.h.
|
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).
Definition at line 490 of file qgsadvanceddigitizingdockwidget.h.
QgsPoint QgsAdvancedDigitizingDockWidget::currentPointLayerCoordinates | ( | QgsMapLayer * | layer | ) | const |
Returns the last CAD point, in a map layer's coordinates.
Definition at line 2412 of file qgsadvanceddigitizingdockwidget.cpp.
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).
Definition at line 2402 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::disable | ( | ) |
Disable the widget.
Normally done automatically from QgsMapToolAdvancedDigitizing::deactivate().
Definition at line 2138 of file qgsadvanceddigitizingdockwidget.cpp.
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 2081 of file qgsadvanceddigitizingdockwidget.cpp.
|
inline |
Returns the action used to enable/disable the tools.
Definition at line 538 of file qgsadvanceddigitizingdockwidget.h.
|
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.
enabled | Whether the angle parameter is enabled or not. |
|
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.
enabled | Whether the distance parameter is enabled or not. |
|
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.
enabled | Whether the M parameter is enabled or not. |
|
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.
enabled | Whether the X parameter is enabled or not. |
|
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.
enabled | Whether the Y parameter is enabled or not. |
|
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.
enabled | Whether the Z parameter is enabled or not. |
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
QString QgsAdvancedDigitizingDockWidget::formatCommonAngleSnapping | ( | double | angle | ) |
Returns the formatted label for common angle snapping option.
Definition at line 439 of file qgsadvanceddigitizingdockwidget.cpp.
double QgsAdvancedDigitizingDockWidget::getLineM | ( | ) | const |
Convenient method to get the M value from the line edit wiget.
Definition at line 2455 of file qgsadvanceddigitizingdockwidget.cpp.
double QgsAdvancedDigitizingDockWidget::getLineZ | ( | ) | const |
Convenient method to get the Z value from the line edit wiget.
Definition at line 2450 of file qgsadvanceddigitizingdockwidget.cpp.
|
override |
Definition at line 1729 of file qgsadvanceddigitizingdockwidget.cpp.
|
inline |
Returns on which side of the constraint line extension point, the line was created.
Definition at line 402 of file qgsadvanceddigitizingdockwidget.h.
|
signal |
Emitted whenever the angle parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
signal |
Emitted whenever the distance parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
inline |
Returns the snap matches whose vertices have been locked.
Definition at line 429 of file qgsadvanceddigitizingdockwidget.h.
|
signal |
Emitted whenever the M parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
signal |
Emitted whenever the X parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
signal |
Emitted whenever the Y parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
signal |
Emitted whenever the Z parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
inline |
Returns the point locator match.
Definition at line 423 of file qgsadvanceddigitizingdockwidget.h.
|
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).
Definition at line 520 of file qgsadvanceddigitizingdockwidget.h.
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 2435 of file qgsadvanceddigitizingdockwidget.cpp.
|
signal |
Sometimes a constraint may change the current point out of a mouse event.
This happens normally when a constraint is toggled.
point | The last known digitizing point. Can be used to emulate a mouse event. |
|
signal |
Sometimes a constraint may change the current point out of a mouse event.
This happens normally when a constraint is toggled.
point | The last known digitizing point. Can be used to emulate a mouse event. |
|
inline |
The number of points in the CAD point helper list.
Definition at line 525 of file qgsadvanceddigitizingdockwidget.h.
|
signal |
Remove any previously emitted warnings (if any)
|
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).
Definition at line 505 of file qgsadvanceddigitizingdockwidget.h.
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 2425 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::processCanvasMoveEvent | ( | QgsMapMouseEvent * | event | ) |
Processes the canvas move event.
Definition at line 1568 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::processCanvasPressEvent | ( | QgsMapMouseEvent * | event | ) |
Processes the canvas press event.
Definition at line 1555 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::processCanvasReleaseEvent | ( | QgsMapMouseEvent * | event | ) |
Processes the canvas release event.
Definition at line 1582 of file qgsadvanceddigitizingdockwidget.cpp.
|
signal |
Push a warning.
message | An informative message |
bool QgsAdvancedDigitizingDockWidget::recordConstructionGuides | ( | ) | const |
Returns whether construction guides are being recorded.
Definition at line 2470 of file qgsadvanceddigitizingdockwidget.cpp.
|
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.
relative | Whether the angle parameter is relative or not. |
|
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.
relative | Whether the M parameter is relative or not. |
|
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.
relative | Whether the X parameter is relative or not. |
|
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.
relative | Whether the Y parameter is relative or not. |
|
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.
relative | Whether the Z parameter is relative or not. |
void QgsAdvancedDigitizingDockWidget::releaseLocks | ( | bool | releaseRepeatingLocks = true | ) |
unlock all constraints
releaseRepeatingLocks | set to false to preserve the lock for any constraints set to repeating lock mode |
Definition at line 810 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::removePreviousPoint | ( | ) |
Removes previous point in the CAD point list.
Definition at line 2218 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setAngle | ( | const QString & | value, |
WidgetSetMode | mode | ||
) |
Set the angle value on the widget.
Can be used to set constraints by external widgets.
mode | What type of interaction to emulate |
value | The value (as a QString, as it could be an expression) |
Definition at line 515 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setDistance | ( | const QString & | value, |
WidgetSetMode | mode | ||
) |
Set the distance value on the widget.
Can be used to set constraints by external widgets.
mode | What type of interaction to emulate |
value | The value (as a QString, as it could be an expression) |
Definition at line 527 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setEnabledM | ( | bool | enable | ) |
Sets whether M is enabled.
Definition at line 641 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setEnabledZ | ( | bool | enable | ) |
Sets whether Z is enabled.
Definition at line 628 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setM | ( | const QString & | value, |
WidgetSetMode | mode | ||
) |
Set the M value on the widget.
Can be used to set constraints by external widgets.
mode | What type of interaction to emulate |
value | The value (as a QString, as it could be an expression) |
Definition at line 498 of file qgsadvanceddigitizingdockwidget.cpp.
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 1770 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setTool | ( | QgsAdvancedDigitizingTool * | tool | ) |
Sets an advanced digitizing tool which will take over digitizing until the tool is close.
Definition at line 668 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setX | ( | const QString & | value, |
WidgetSetMode | mode | ||
) |
Set the X value on the widget.
Can be used to set constraints by external widgets.
mode | What type of interaction to emulate |
value | The value (as a QString, as it could be an expression) |
Definition at line 447 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setY | ( | const QString & | value, |
WidgetSetMode | mode | ||
) |
Set the Y value on the widget.
Can be used to set constraints by external widgets.
mode | What type of interaction to emulate |
value | The value (as a QString, as it could be an expression) |
Definition at line 464 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::setZ | ( | const QString & | value, |
WidgetSetMode | mode | ||
) |
Set the Z value on the widget.
Can be used to set constraints by external widgets.
mode | What type of interaction to emulate |
value | The value (as a QString, as it could be an expression) |
Definition at line 481 of file qgsadvanceddigitizingdockwidget.cpp.
bool QgsAdvancedDigitizingDockWidget::showConstructionGuides | ( | ) | const |
Returns whether the construction guides are visible.
Definition at line 2460 of file qgsadvanceddigitizingdockwidget.cpp.
|
inline |
Snapped to a segment.
Definition at line 535 of file qgsadvanceddigitizingdockwidget.h.
|
inline |
Is it snapped to a vertex.
Definition at line 530 of file qgsadvanceddigitizingdockwidget.h.
bool QgsAdvancedDigitizingDockWidget::snapToConstructionGuides | ( | ) | const |
Returns whether points should snap to construction guides.
Definition at line 2465 of file qgsadvanceddigitizingdockwidget.cpp.
|
signal |
Emitted whenever the soft line extension parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
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 408 of file qgsadvanceddigitizingdockwidget.h.
|
signal |
Emitted whenever the soft x/y extension parameter is locked.
Could be used by widgets that must reflect the current advanced digitizing state.
|
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 411 of file qgsadvanceddigitizingdockwidget.h.
void QgsAdvancedDigitizingDockWidget::switchZM | ( | ) |
Determines if Z or M will be enabled.
Definition at line 588 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::toggleConstraintDistance | ( | ) |
Toggles the distance constraint.
Definition at line 1780 of file qgsadvanceddigitizingdockwidget.cpp.
QgsAdvancedDigitizingTool * QgsAdvancedDigitizingDockWidget::tool | ( | ) | const |
Returns the current advanced digitizing tool.
Returns nullptr
if not set.
Definition at line 689 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::updateCadPaintItem | ( | ) |
Updates canvas item that displays constraints on the ma.
Definition at line 2154 of file qgsadvanceddigitizingdockwidget.cpp.
void QgsAdvancedDigitizingDockWidget::updateCurrentPoint | ( | const QgsPoint & | point | ) |
Updates the current point in the CAD point list.
Definition at line 2238 of file qgsadvanceddigitizingdockwidget.cpp.
|
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.
|
signal |
Emitted whenever the bearing value changes.
Could be used by widgets that must reflect the current advanced digitizing state.
|
signal |
Emitted whenever the snapping to common angle option changes, angle = 0 means that the functionality is disabled.
|
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.
|
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.
|
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.
|
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.
|
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.
|
friend |
Definition at line 1184 of file qgsadvanceddigitizingdockwidget.h.
|
friend |
Definition at line 1185 of file qgsadvanceddigitizingdockwidget.h.