Hook snapping utils into QGIS interface

Now the new snapping engine is ues for add feature map tool
qgis · Jan 20, 2015 · 83770df · 83770df
1 parent 1dae560
commit 83770df
Show file tree

Hide file tree

Showing 14 changed files with 278 additions and 55 deletions.
diff --git a/python/core/core.sip b/python/core/core.sip
@@ -78,6 +78,7 @@
 %Include qgspluginlayer.sip
 %Include qgspluginlayerregistry.sip
 %Include qgspoint.sip
+%Include qgspointlocator.sip
 %Include qgsproject.sip
 %Include qgsprojectproperty.sip
 %Include qgsprojectversion.sip
@@ -96,6 +97,7 @@
 %Include qgsscaleutils.sip
 %Include qgssimplifymethod.sip
 %Include qgssnapper.sip
+%Include qgssnappingutils.sip
 %Include qgsspatialindex.sip
 %Include qgstolerance.sip
 %Include qgsvectordataprovider.sip

diff --git a/python/gui/qgisinterface.sip b/python/gui/qgisinterface.sip
@@ -32,6 +32,13 @@ class QgisInterface : QObject
 
     virtual QgsLayerTreeView* layerTreeView() = 0;
 
+    /**
+     * Get access to snapping utilities - for use in map tools
+     *
+     * @note added in 2.8
+     */
+    virtual QgsSnappingUtils* snappingUtils() = 0;
+
   public slots: // TODO: do these functions really need to be slots?
 
     /* Exposed functions */

diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp
@@ -192,6 +192,7 @@
 #include "qgsshortcutsmanager.h"
 #include "qgssinglebandgrayrenderer.h"
 #include "qgssnappingdialog.h"
+#include "qgssnappingutils.h"
 #include "qgssponsors.h"
 #include "qgssvgannotationitem.h"
 #include "qgstextannotationitem.h"
@@ -404,6 +405,8 @@ void QgisApp::activeLayerChanged( QgsMapLayer* layer )
 {
   if ( mMapCanvas )
     mMapCanvas->setCurrentLayer( layer );
+  if ( mSnappingUtils )
+    mSnappingUtils->setCurrentLayer( qobject_cast<QgsVectorLayer*>( layer ) );
 }
 
 /**
@@ -488,6 +491,7 @@ QgisApp::QgisApp( QSplashScreen *splash, bool restorePlugins, QWidget * parent,
 #endif
     , mComposerManager( 0 )
     , mpGpsWidget( 0 )
+    , mSnappingUtils( 0 )
 {
   if ( smInstance )
   {
@@ -567,6 +571,13 @@ QgisApp::QgisApp( QSplashScreen *splash, bool restorePlugins, QWidget * parent,
   mAdvancedDigitizingDockWidget = new QgsAdvancedDigitizingDockWidget( mMapCanvas, this );
   mAdvancedDigitizingDockWidget->setObjectName( "AdvancedDigitizingTools" );
 
+  mSnappingUtils = new QgsSnappingUtils( this );
+  connect( QgsProject::instance(), SIGNAL( snapSettingsChanged() ), mSnappingUtils, SLOT( readConfigFromProject() ) );
+  connect( this, SIGNAL( newProject() ), mSnappingUtils, SLOT( readConfigFromProject() ) );
+  connect( this, SIGNAL( projectRead() ), mSnappingUtils, SLOT( readConfigFromProject() ) );
+  connect( mMapCanvas, SIGNAL( extentsChanged() ), this, SLOT( updateSnappingUtilsMapSettings() ) );
+  connect( mMapCanvas, SIGNAL( destinationCrsChanged() ), this, SLOT( updateSnappingUtilsMapSettings() ) );
+
   createActions();
   createActionGroups();
   createMenus();
@@ -817,6 +828,7 @@ QgisApp::QgisApp()
     , mPythonUtils( 0 )
     , mComposerManager( 0 )
     , mpGpsWidget( 0 )
+    , mSnappingUtils( 0 )
 {
   smInstance = this;
   setupUi( this );
@@ -4357,6 +4369,11 @@ void QgisApp::updateFilterLegendByMap()
   layerTreeView()->layerTreeModel()->setLegendFilterByMap( &mMapCanvas->mapSettings() );
 }
 
+void QgisApp::updateSnappingUtilsMapSettings()
+{
+  mSnappingUtils->setMapSettings( mMapCanvas->mapSettings() );
+}
+
 void QgisApp::saveMapAsImage()
 {
   QPair< QString, QString> myFileNameAndFilter = QgisGui::getSaveAsImageName( this, tr( "Choose a file name to save the map image as" ) );

diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h
@@ -59,6 +59,7 @@ class QgsPoint;
 class QgsProviderRegistry;
 class QgsPythonUtils;
 class QgsRectangle;
+class QgsSnappingUtils;
 class QgsUndoWidget;
 class QgsVectorLayer;
 class QgsVectorLayerTools;
@@ -1213,6 +1214,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
     void updateFilterLegendByMap();
     void setFilterLegendByMapEnabled( bool enabled );
 
+  public:
+    QgsSnappingUtils* snappingUtils() { return mSnappingUtils; }
+  private slots:
+    void updateSnappingUtilsMapSettings();
+
     /** Make the user feel dizzy */
     void dizzy();
 
@@ -1605,6 +1611,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
 
     QToolButton* mBtnFilterLegend;
 
+    QgsSnappingUtils* mSnappingUtils;
+
 #ifdef HAVE_TOUCH
     bool gestureEvent( QGestureEvent *event );
     void tapAndHoldTriggered( QTapAndHoldGesture *gesture );

diff --git a/src/app/qgisappinterface.cpp b/src/app/qgisappinterface.cpp
@@ -88,6 +88,11 @@ QgsLayerTreeView*QgisAppInterface::layerTreeView()
   return qgis->layerTreeView();
 }
 
+QgsSnappingUtils* QgisAppInterface::snappingUtils()
+{
+  return qgis->snappingUtils();
+}
+
 void QgisAppInterface::zoomFull()
 {
   qgis->zoomFull();

diff --git a/src/app/qgisappinterface.h b/src/app/qgisappinterface.h
@@ -51,6 +51,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
 
     QgsLayerTreeView* layerTreeView() override;
 
+    QgsSnappingUtils* snappingUtils();
+
     /* Exposed functions */
 
     //! Zoom map to full extent

diff --git a/src/app/qgsmapmouseevent.cpp b/src/app/qgsmapmouseevent.cpp
@@ -18,13 +18,13 @@
 #include "qgsmaptooladvanceddigitizing.h"
 #include "qgsmapcanvas.h"
 
+#include "qgisapp.h"
+#include "qgssnappingutils.h"
 
 QgsMapMouseEvent::QgsMapMouseEvent( QgsMapToolAdvancedDigitizing* mapTool, QMouseEvent* event , bool doSnap )
     :  QMouseEvent( event->type(), event->pos(), event->globalPos(), event->button(), event->buttons(), event->modifiers() )
     , mMapPoint( mapTool->canvas()->mapSettings().mapToPixel().toMapCoordinates( event->pos() ) )
-    , mSnapped( false )
     , mMapTool( mapTool )
-    , mSnapResults()
 {
   mOriginalPoint = mMapPoint;
 
@@ -41,9 +41,7 @@ QgsMapMouseEvent::QgsMapMouseEvent( QgsMapToolAdvancedDigitizing* mapTool, QgsPo
                    button, button, modifiers )
     , mMapPoint( point )
     , mOriginalPoint( point )
-    , mSnapped( false )
     , mMapTool( mapTool )
-    , mSnapResults()
 {
   if ( doSnap )
     snapPoint();
@@ -56,22 +54,9 @@ void QgsMapMouseEvent::setPoint( const QgsPoint& point )
 
 bool QgsMapMouseEvent::snapPoint()
 {
-  QgsMapCanvasSnapper snapper;
-  snapper.setMapCanvas( mMapTool->canvas() );
-  mSnapped = false;
-  if ( snapper.snapToBackgroundLayers( mMapPoint, mSnapResults ) == 0 )
-  {
-    mSnapped = !mSnapResults.isEmpty();
-  }
-  if ( mSnapped )
-  {
-    mMapPoint = mSnapResults.constBegin()->snappedVertex;
-  }
-  else
-  {
-    mMapPoint = mOriginalPoint;
-  }
-  return mSnapped;
+  mSnapMatch = QgisApp::instance()->snappingUtils()->snapToMap( mMapPoint );
+  mMapPoint = mSnapMatch.isValid() ? mSnapMatch.point() : mOriginalPoint;
+  return mSnapMatch.isValid();
 }
 
 QPoint QgsMapMouseEvent::mapToPixelCoordinates( QgsMapCanvas* canvas, const QgsPoint& point )
@@ -88,24 +73,23 @@ QgsPoint QgsMapMouseEvent::mapPoint( bool* snappedPoint ) const
 {
   if ( snappedPoint )
   {
-    *snappedPoint = mSnapped && mSnapResults.constBegin()->snappedVertexNr != -1;
+    *snappedPoint = mSnapMatch.hasVertex();
   }
   return mMapPoint;
 }
 
 QList<QgsPoint> QgsMapMouseEvent::snappedSegment( bool* snapped ) const
 {
   QList<QgsPoint> segment =  QList<QgsPoint>();
-  if ( mSnapped )
+  if ( mSnapMatch.hasEdge() )
+  {
+    QgsPoint pt1, pt2;
+    mSnapMatch.edgePoints( pt1, pt2 );
+    segment << pt1 << pt2;
+  }
+  else
   {
-    foreach ( const QgsSnappingResult result, mSnapResults )
-    {
-      if ( result.beforeVertexNr != -1 && result.afterVertexNr != -1 )
-      {
-        segment << result.beforeVertex << result.afterVertex;
-        break;
-      }
-    }
+    // TODO: run snapToMap with only segments (resp. all hits)
   }
 
   if ( snapped )

diff --git a/src/app/qgsmapmouseevent.h b/src/app/qgsmapmouseevent.h
@@ -20,6 +20,7 @@
 
 #include "qgsmapcanvassnapper.h"
 #include "qgspoint.h"
+#include "qgspointlocator.h"
 
 class QgsMapToolAdvancedDigitizing;
 
@@ -61,10 +62,9 @@ class APP_EXPORT QgsMapMouseEvent : public QMouseEvent
     QgsPoint mMapPoint;
 
     QgsPoint mOriginalPoint;
-    bool mSnapped;
 
     QgsMapToolAdvancedDigitizing* mMapTool;
-    QList<QgsSnappingResult> mSnapResults;
+    QgsPointLocator::Match mSnapMatch;
 };
 
 #endif // QGSMAPMOUSEEVENT_H