Merge pull request #36200 from olivierdalang/self_snap

[feature] Snapping also snaps to the currently digitised feature
qgis · May 26, 2020 · 38673f5 · 38673f5
2 parents 2a2fe1e + 47fdd4b
commit 38673f5
Show file tree

Hide file tree

Showing 18 changed files with 532 additions and 27 deletions.
diff --git a/images/images.qrc b/images/images.qrc
@@ -700,6 +700,7 @@
         <file>themes/default/mIconSnappingMiddle.svg</file>
         <file>themes/default/mIconSnappingOnScale.svg</file>
         <file>themes/default/mIconSnappingVertex.svg</file>
+        <file>themes/default/mIconSnappingSelf.svg</file>
         <file>themes/default/mIconSnappingSegment.svg</file>
         <file>themes/default/mIconTopologicalEditing.svg</file>
         <file>themes/default/mIconSnappingIntersection.svg</file>

diff --git a/images/themes/default/mIconSnappingSelf.svg b/images/themes/default/mIconSnappingSelf.svg
diff --git a/python/core/auto_generated/qgscadutils.sip.in b/python/core/auto_generated/qgscadutils.sip.in
@@ -53,6 +53,8 @@ The QgsCadUtils class provides routines for CAD editing.
 
       QgsPointXY finalMapPoint;
 
+      QgsPointLocator::Match snapMatch;
+
       QgsPointLocator::Match edgeMatch;
 
       double softLockCommonAngle;

diff --git a/python/core/auto_generated/qgssnappingconfig.sip.in b/python/core/auto_generated/qgssnappingconfig.sip.in
@@ -343,6 +343,20 @@ Returns if the snapping on intersection is enabled
     void setIntersectionSnapping( bool enabled );
 %Docstring
 Sets if the snapping on intersection is enabled
+%End
+
+    bool selfSnapping() const;
+%Docstring
+Returns if self snapping (snapping to the currently digitised feature) is enabled
+
+.. versionadded:: 3.14
+%End
+
+    void setSelfSnapping( bool enabled );
+%Docstring
+Sets if self snapping (snapping to the currently digitised feature) is enabled
+
+.. versionadded:: 3.14
 %End
 
     SIP_PYDICT individualLayerSettings() const;

diff --git a/python/core/auto_generated/qgssnappingutils.sip.in b/python/core/auto_generated/qgssnappingutils.sip.in
@@ -166,6 +166,42 @@ Set if invisible features must be snapped or not.
 .. versionadded:: 3.2
 %End
 
+    void addExtraSnapLayer( QgsVectorLayer *vl );
+%Docstring
+Supply an extra snapping layer (typically a memory layer).
+This can be used by map tools to provide additionnal
+snappings points.
+
+.. seealso:: :py:func:`removeExtraSnapLayer`
+
+.. seealso:: :py:func:`getExtraSnapLayers`
+
+.. versionadded:: 3.14
+%End
+
+    void removeExtraSnapLayer( QgsVectorLayer *vl );
+%Docstring
+Removes an extra snapping layer
+
+.. seealso:: :py:func:`addExtraSnapLayer`
+
+.. seealso:: :py:func:`getExtraSnapLayers`
+
+.. versionadded:: 3.14
+%End
+
+    QSet<QgsVectorLayer *> getExtraSnapLayers();
+%Docstring
+Returns the list of extra snapping layers
+
+.. seealso:: :py:func:`addExtraSnapLayer`
+
+.. seealso:: :py:func:`removeExtraSnapLayer`
+
+.. versionadded:: 3.14
+%End
+
+
   public slots:
 
     void setConfig( const QgsSnappingConfig &snappingConfig );

diff --git a/src/app/qgssnappingwidget.cpp b/src/app/qgssnappingwidget.cpp
@@ -303,6 +303,14 @@ QgsSnappingWidget::QgsSnappingWidget( QgsProject *project, QgsMapCanvas *canvas,
   tracingMenu->addAction( widgetAction );
   mEnableTracingAction->setMenu( tracingMenu );
 
+  // self-snapping button
+  mSelfSnappingAction = new QAction( tr( "Self-snapping" ), this );
+  mSelfSnappingAction->setCheckable( true );
+  mSelfSnappingAction->setIcon( QIcon( QgsApplication::getThemeIcon( "/mIconSnappingSelf.svg" ) ) );
+  mSelfSnappingAction->setToolTip( tr( "If self snapping is enabled, snapping will also take the current state of the digitized feature into consideration." ) );
+  mSelfSnappingAction->setObjectName( QStringLiteral( "SelfSnappingAction" ) );
+  connect( mSelfSnappingAction, &QAction::toggled, this, &QgsSnappingWidget::enableSelfSnapping );
+
   // layout
   if ( mDisplayMode == ToolBar )
   {
@@ -332,6 +340,7 @@ QgsSnappingWidget::QgsSnappingWidget( QgsProject *project, QgsMapCanvas *canvas,
     mAvoidIntersectionsModeAction = tb->addWidget( mAvoidIntersectionsModeButton );
     tb->addAction( mIntersectionSnappingAction );
     tb->addAction( mEnableTracingAction );
+    tb->addAction( mSelfSnappingAction );
   }
   else
   {
@@ -366,6 +375,12 @@ QgsSnappingWidget::QgsSnappingWidget( QgsProject *project, QgsMapCanvas *canvas,
     interButton->setToolButtonStyle( Qt::ToolButtonTextBesideIcon );
     layout->addWidget( interButton );
 
+    QToolButton *selfsnapButton = new QToolButton();
+    selfsnapButton->addAction( mSelfSnappingAction );
+    selfsnapButton->setDefaultAction( mSelfSnappingAction );
+    selfsnapButton->setToolButtonStyle( Qt::ToolButtonTextBesideIcon );
+    layout->addWidget( selfsnapButton );
+
     layout->setContentsMargins( 0, 0, 0, 0 );
     layout->setAlignment( Qt::AlignRight );
     layout->setSpacing( mDisplayMode == Widget ? 3 : 0 );
@@ -504,6 +519,11 @@ void QgsSnappingWidget::projectSnapSettingsChanged()
     mIntersectionSnappingAction->setChecked( config.intersectionSnapping() );
   }
 
+  if ( config.selfSnapping() != mSelfSnappingAction->isChecked() )
+  {
+    mSelfSnappingAction->setChecked( config.selfSnapping() );
+  }
+
   toggleSnappingWidgets( config.enabled() );
 
 }
@@ -568,6 +588,7 @@ void QgsSnappingWidget::toggleSnappingWidgets( bool enabled )
     mAdvancedConfigWidget->setEnabled( enabled );
   }
   mIntersectionSnappingAction->setEnabled( enabled );
+  mSelfSnappingAction->setEnabled( enabled );
   mEnableTracingAction->setEnabled( enabled );
 }
 
@@ -609,6 +630,12 @@ void QgsSnappingWidget::enableIntersectionSnapping( bool enabled )
   mProject->setSnappingConfig( mConfig );
 }
 
+void QgsSnappingWidget::enableSelfSnapping( bool enabled )
+{
+  mConfig.setSelfSnapping( enabled );
+  mProject->setSnappingConfig( mConfig );
+}
+
 void QgsSnappingWidget::onSnappingTreeLayersChanged()
 {
   mLayerTreeView->expandAll();

diff --git a/src/app/qgssnappingwidget.h b/src/app/qgssnappingwidget.h
@@ -114,6 +114,8 @@ class APP_EXPORT QgsSnappingWidget : public QWidget
 
     void enableIntersectionSnapping( bool enabled );
 
+    void enableSelfSnapping( bool enabled );
+
     void modeButtonTriggered( QAction *action );
     void avoidIntersectionsModeButtonTriggered( QAction *action );
     void typeButtonTriggered( QAction *action );
@@ -172,6 +174,7 @@ class APP_EXPORT QgsSnappingWidget : public QWidget
     QAction *mIntersectionSnappingAction = nullptr;
     QAction *mEnableTracingAction = nullptr;
     QgsDoubleSpinBox *mTracingOffsetSpinBox = nullptr;
+    QAction *mSelfSnappingAction = nullptr;
     QTreeView *mLayerTreeView = nullptr;
     QWidget *mAdvancedConfigWidget = nullptr;
     QgsFloatingWidget *mAdvancedConfigContainer = nullptr;

diff --git a/src/core/qgscadutils.cpp b/src/core/qgscadutils.cpp
@@ -42,16 +42,19 @@ QgsCadUtils::AlignMapPointOutput QgsCadUtils::alignMapPoint( const QgsPointXY &o
 
   // try to snap to anything
   QgsPointLocator::Match snapMatch = ctx.snappingUtils->snapToMap( originalMapPoint, nullptr, true );
+  res.snapMatch = snapMatch;
   QgsPointXY point = snapMatch.isValid() ? snapMatch.point() : originalMapPoint;
-
-  // try to snap explicitly to a segment - useful for some constraints
   QgsPointXY edgePt0, edgePt1;
-  EdgesOnlyFilter edgesOnlyFilter;
-  QgsPointLocator::Match edgeMatch = ctx.snappingUtils->snapToMap( originalMapPoint, &edgesOnlyFilter, true );
-  if ( edgeMatch.hasEdge() )
-    edgeMatch.edgePoints( edgePt0, edgePt1 );
-
-  res.edgeMatch = edgeMatch;
+  if ( snapMatch.hasEdge() )
+  {
+    snapMatch.edgePoints( edgePt0, edgePt1 );
+    // note : res.edgeMatch should be removed, as we can just check snapMatch.hasEdge()
+    res.edgeMatch = snapMatch;
+  }
+  else
+  {
+    res.edgeMatch = QgsPointLocator::Match();
+  }
 
   QgsPointXY previousPt, penultimatePt;
   if ( ctx.cadPointList.count() >= 2 )
@@ -71,7 +74,7 @@ QgsCadUtils::AlignMapPointOutput QgsCadUtils::alignMapPoint( const QgsPointXY &o
     {
       point.setX( previousPt.x() + ctx.xConstraint.value );
     }
-    if ( edgeMatch.hasEdge() && !ctx.yConstraint.locked )
+    if ( snapMatch.hasEdge() && !ctx.yConstraint.locked )
     {
       // intersect with snapped segment line at X coordinate
       const double dx = edgePt1.x() - edgePt0.x();
@@ -99,7 +102,7 @@ QgsCadUtils::AlignMapPointOutput QgsCadUtils::alignMapPoint( const QgsPointXY &o
     {
       point.setY( previousPt.y() + ctx.yConstraint.value );
     }
-    if ( edgeMatch.hasEdge() && !ctx.xConstraint.locked )
+    if ( snapMatch.hasEdge() && !ctx.xConstraint.locked )
     {
       // intersect with snapped segment line at Y coordinate
       const double dy = edgePt1.y() - edgePt0.y();
@@ -224,7 +227,7 @@ QgsCadUtils::AlignMapPointOutput QgsCadUtils::alignMapPoint( const QgsPointXY &o
       point.setY( previousPt.y() + sina * v );
     }
 
-    if ( edgeMatch.hasEdge() && !ctx.distanceConstraint.locked )
+    if ( snapMatch.hasEdge() && !ctx.distanceConstraint.locked )
     {
       // magnetize to the intersection of the snapped segment and the lockedAngle
 
@@ -287,7 +290,7 @@ QgsCadUtils::AlignMapPointOutput QgsCadUtils::alignMapPoint( const QgsPointXY &o
                    previousPt.y() + ( point.y() - previousPt.y() ) * vP );
       }
 
-      if ( edgeMatch.hasEdge() && !ctx.angleConstraint.locked )
+      if ( snapMatch.hasEdge() && !ctx.angleConstraint.locked )
       {
         // we will magnietize to the intersection of that segment and the lockedDistance !
         res.valid &= QgsGeometryUtils::lineCircleIntersection( previousPt, ctx.distanceConstraint.value, edgePt0, edgePt1, point );

diff --git a/src/core/qgscadutils.h b/src/core/qgscadutils.h
@@ -92,7 +92,16 @@ class CORE_EXPORT QgsCadUtils
       //! map point aligned according to the constraints
       QgsPointXY finalMapPoint;
 
-      //! Snapped segment - only valid if actually used for something
+      /**
+       * Snapped point - only valid if actually used for something
+       * \since QGIS 3.14
+       */
+      QgsPointLocator::Match snapMatch;
+
+      /**
+       * Snapped segment - only valid if actually used for something
+       * \deprecated will be removed in QGIS 4.0 - use snapMatch instead
+       */
       QgsPointLocator::Match edgeMatch;
 
       //! Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)