QGIS API Documentation  3.0.2-Girona (307d082)
Classes | Public Types | Signals | Public Member Functions | List of all members
QgsAdvancedDigitizingDockWidget Class Reference

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>

Inheritance diagram for QgsAdvancedDigitizingDockWidget:
Inheritance graph
[legend]

Classes

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

Public Types

enum  AdditionalConstraint { NoConstraint, Perpendicular, Parallel }
 Additional constraints which can be enabled. More...
 
enum  CadCapacity { AbsoluteAngle = 1, RelativeAngle = 2, RelativeCoordinates = 4 }
 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...
 

Signals

void pointChanged (const QgsPointXY &point)
 Sometimes a constraint may change the current point out of a mouse event. More...
 
void popWarning ()
 Remove any previously emitted warnings (if any) More...
 
void pushWarning (const QString &message)
 Push a warning. More...
 
- Signals inherited from QgsDockWidget
void closed ()
 Emitted when dock widget is closed. More...
 
void closedStateChanged (bool wasClosed)
 Emitted when dock widget is closed (or opened). More...
 
void opened ()
 Emitted when dock widget is opened. More...
 
void openedStateChanged (bool wasOpened)
 Emitted when dock widget is opened (or closed). More...
 

Public Member Functions

 QgsAdvancedDigitizingDockWidget (QgsMapCanvas *canvas, QWidget *parent=nullptr)
 Create an advanced digitizing dock widget. More...
 
AdditionalConstraint additionalConstraint () const
 Additional constraints are used to place perpendicular/parallel segments to snapped segments on the canvas. More...
 
void addPoint (const QgsPointXY &point)
 Adds point to the CAD point list. More...
 
bool alignToSegment (QgsMapMouseEvent *e, QgsAdvancedDigitizingDockWidget::CadConstraint::LockMode lockMode=QgsAdvancedDigitizingDockWidget::CadConstraint::HardLock)
 align to segment for additional constraint. More...
 
bool applyConstraints (QgsMapMouseEvent *e)
 apply the CAD constraints. More...
 
bool cadEnabled () const
 determines if CAD tools are enabled or if map tools behaves "nomally" More...
 
bool canvasKeyPressEventFilter (QKeyEvent *e)
 Filter key events to e.g. More...
 
void clear ()
 Clear any cached previous clicks and helper lines. More...
 
void clearPoints ()
 Removes all points from the CAD point list. More...
 
bool commonAngleConstraint () const
 Constraint on a common angle. More...
 
const CadConstraintconstraintAngle () const
 Constraint on the angle. More...
 
const CadConstraintconstraintDistance () const
 Constraint on the distance. More...
 
const CadConstraintconstraintX () const
 Constraint on the X coordinate. More...
 
const CadConstraintconstraintY () const
 Constraint on the Y coordinate. More...
 
bool constructionMode () const
 construction mode is used to draw intermediate points. These points won't be given any further (i.e. to the map tools) More...
 
QgsPointXY currentPoint (bool *exists=nullptr) const
 The last point. More...
 
void disable ()
 Disable the widget. More...
 
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. More...
 
QAction * enableAction ()
 return the action used to enable/disable the tools More...
 
void hideEvent (QHideEvent *) override
 Disables the CAD tools when hiding the dock. More...
 
void keyPressEvent (QKeyEvent *e) override
 
QgsPointXY penultimatePoint (bool *exists=nullptr) const
 The penultimate point. More...
 
int pointsCount () const
 The number of points in the CAD point helper list. More...
 
QgsPointXY previousPoint (bool *exists=nullptr) const
 The previous point. More...
 
void releaseLocks (bool releaseRepeatingLocks=true)
 unlock all constraints More...
 
void setPoints (const QList< QgsPointXY > &points)
 Configures list of current CAD points. More...
 
QList< QgsPointXYsnappedSegment () const
 Snapped to a segment. More...
 
bool snappedToVertex () const
 Is it snapped to a vertex. More...
 
void updateCadPaintItem ()
 Updates canvas item that displays constraints on the ma. More...
 
- Public Member Functions inherited from QgsDockWidget
 QgsDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=nullptr)
 Constructor for QgsDockWidget. More...
 
 QgsDockWidget (const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags=nullptr)
 Constructor for QgsDockWidget. More...
 
bool isUserVisible () const
 Returns true if the dock is both opened and raised to the front (ie not hidden by any other tabs. More...
 

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. More...
 
- Protected Member Functions inherited from QgsDockWidget
void closeEvent (QCloseEvent *) override
 
void showEvent (QShowEvent *event) override
 

Detailed Description

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 42 of file qgsadvanceddigitizingdockwidget.h.

Member Enumeration Documentation

◆ AdditionalConstraint

Additional constraints which can be enabled.

Enumerator
NoConstraint 

No additional constraint.

Perpendicular 

Perpendicular.

Parallel 

Parallel.

Definition at line 65 of file qgsadvanceddigitizingdockwidget.h.

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

Definition at line 53 of file qgsadvanceddigitizingdockwidget.h.

Constructor & Destructor Documentation

◆ QgsAdvancedDigitizingDockWidget()

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

Create an advanced digitizing dock widget.

Parameters
canvasThe map canvas on which the widget operates
parentThe parent

Definition at line 38 of file qgsadvanceddigitizingdockwidget.cpp.

Member Function Documentation

◆ additionalConstraint()

AdditionalConstraint QgsAdvancedDigitizingDockWidget::additionalConstraint ( ) const
inline

Additional constraints are used to place perpendicular/parallel segments to snapped segments on the canvas.

Definition at line 245 of file qgsadvanceddigitizingdockwidget.h.

◆ addPoint()

void QgsAdvancedDigitizingDockWidget::addPoint ( const QgsPointXY point)

Adds point to the CAD point list.

Since
QGIS 3.0

Definition at line 967 of file qgsadvanceddigitizingdockwidget.cpp.

◆ alignToSegment()

align to segment for additional constraint.

If additional constraints are used, this will determine the angle to be locked depending on the snapped segment.

Since
QGIS 3.0

Definition at line 666 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 518 of file qgsadvanceddigitizingdockwidget.cpp.

◆ cadEnabled()

bool QgsAdvancedDigitizingDockWidget::cadEnabled ( ) const
inline

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

Definition at line 239 of file qgsadvanceddigitizingdockwidget.h.

◆ canvasKeyPressEventFilter()

bool QgsAdvancedDigitizingDockWidget::canvasKeyPressEventFilter ( QKeyEvent *  e)

Filter key events to e.g.

toggle construction mode or adapt constraints

Parameters
eA mouse event (may be modified)
Returns
If the event is hidden (construction mode hides events from the maptool)

Definition at line 707 of file qgsadvanceddigitizingdockwidget.cpp.

◆ clear()

void QgsAdvancedDigitizingDockWidget::clear ( )

Clear any cached previous clicks and helper lines.

Definition at line 738 of file qgsadvanceddigitizingdockwidget.cpp.

◆ clearPoints()

void QgsAdvancedDigitizingDockWidget::clearPoints ( )

Removes all points from the CAD point list.

Since
QGIS 3.0

Definition at line 991 of file qgsadvanceddigitizingdockwidget.cpp.

◆ commonAngleConstraint()

bool QgsAdvancedDigitizingDockWidget::commonAngleConstraint ( ) const
inline

Constraint on a common angle.

Definition at line 255 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintAngle()

const CadConstraint* QgsAdvancedDigitizingDockWidget::constraintAngle ( ) const
inline

Constraint on the angle.

Definition at line 247 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintDistance()

const CadConstraint* QgsAdvancedDigitizingDockWidget::constraintDistance ( ) const
inline

Constraint on the distance.

Definition at line 249 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintX()

const CadConstraint* QgsAdvancedDigitizingDockWidget::constraintX ( ) const
inline

Constraint on the X coordinate.

Definition at line 251 of file qgsadvanceddigitizingdockwidget.h.

◆ constraintY()

const CadConstraint* QgsAdvancedDigitizingDockWidget::constraintY ( ) const
inline

Constraint on the Y coordinate.

Definition at line 253 of file qgsadvanceddigitizingdockwidget.h.

◆ constructionMode()

bool QgsAdvancedDigitizingDockWidget::constructionMode ( ) const
inline

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

Definition at line 242 of file qgsadvanceddigitizingdockwidget.h.

◆ currentPoint()

QgsPointXY QgsAdvancedDigitizingDockWidget::currentPoint ( 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 1070 of file qgsadvanceddigitizingdockwidget.cpp.

◆ disable()

void QgsAdvancedDigitizingDockWidget::disable ( )

Disable the widget.

Normally done automatically from QgsMapToolAdvancedDigitizing::deactivate().

Definition at line 947 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 920 of file qgsadvanceddigitizingdockwidget.cpp.

◆ enableAction()

QAction* QgsAdvancedDigitizingDockWidget::enableAction ( )
inline

return the action used to enable/disable the tools

Definition at line 315 of file qgsadvanceddigitizingdockwidget.h.

◆ hideEvent()

void QgsAdvancedDigitizingDockWidget::hideEvent ( QHideEvent *  )
override

Disables the CAD tools when hiding the dock.

Definition at line 158 of file qgsadvanceddigitizingdockwidget.cpp.

◆ keyPressEvent()

void QgsAdvancedDigitizingDockWidget::keyPressEvent ( QKeyEvent *  e)
override

Definition at line 744 of file qgsadvanceddigitizingdockwidget.cpp.

◆ penultimatePoint()

QgsPointXY QgsAdvancedDigitizingDockWidget::penultimatePoint ( 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 1090 of file qgsadvanceddigitizingdockwidget.cpp.

◆ pointChanged

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
pointThe last known digitizing point. Can be used to emulate a mouse event.

◆ pointsCount()

int QgsAdvancedDigitizingDockWidget::pointsCount ( ) const
inline

The number of points in the CAD point helper list.

Definition at line 302 of file qgsadvanceddigitizingdockwidget.h.

◆ popWarning

void QgsAdvancedDigitizingDockWidget::popWarning ( )
signal

Remove any previously emitted warnings (if any)

◆ previousPoint()

QgsPointXY QgsAdvancedDigitizingDockWidget::previousPoint ( 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 1080 of file qgsadvanceddigitizingdockwidget.cpp.

◆ pushWarning

void QgsAdvancedDigitizingDockWidget::pushWarning ( const QString &  message)
signal

Push a warning.

Parameters
messageAn informative message

◆ releaseLocks()

void QgsAdvancedDigitizingDockWidget::releaseLocks ( bool  releaseRepeatingLocks = true)

unlock all constraints

Parameters
releaseRepeatingLocksset to false to preserve the lock for any constraints set to repeating lock mode
Since
QGIS 3.0

Definition at line 261 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.

Since
QGIS 3.0

Definition at line 773 of file qgsadvanceddigitizingdockwidget.cpp.

◆ snappedSegment()

QList<QgsPointXY> QgsAdvancedDigitizingDockWidget::snappedSegment ( ) const
inline

Snapped to a segment.

Definition at line 312 of file qgsadvanceddigitizingdockwidget.h.

◆ snappedToVertex()

bool QgsAdvancedDigitizingDockWidget::snappedToVertex ( ) const
inline

Is it snapped to a vertex.

Definition at line 307 of file qgsadvanceddigitizingdockwidget.h.

◆ updateCadPaintItem()

void QgsAdvancedDigitizingDockWidget::updateCadPaintItem ( )

Updates canvas item that displays constraints on the ma.

Since
QGIS 3.0

Definition at line 962 of file qgsadvanceddigitizingdockwidget.cpp.


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