Respect scale lock when panning/zooming the map

Fixes #38953 and #38417
qgis · Sep 23, 2020 · 83525ab · 83525ab
1 parent b7ea040
commit 83525ab
Show file tree

Hide file tree

Showing 5 changed files with 122 additions and 10 deletions.
diff --git a/python/gui/auto_generated/qgsmapcanvas.sip.in b/python/gui/auto_generated/qgsmapcanvas.sip.in
@@ -1201,6 +1201,7 @@ called when panning is in action, reset indicates end of panning
 called on resize or changed extent to notify canvas items to change their rectangle
 %End
 
+      public:
 }; // class QgsMapCanvas
 
 

diff --git a/src/core/qgsmapsettings.cpp b/src/core/qgsmapsettings.cpp
@@ -226,6 +226,7 @@ void QgsMapSettings::updateDerived()
   QgsDebugMsgLevel( QStringLiteral( "Rotation: %1 degrees" ).arg( mRotation ), 5 );
   QgsDebugMsgLevel( QStringLiteral( "Extent: %1" ).arg( mExtent.asWktCoordinates() ), 5 );
   QgsDebugMsgLevel( QStringLiteral( "Visible Extent: %1" ).arg( mVisibleExtent.asWktCoordinates() ), 5 );
+  QgsDebugMsgLevel( QStringLiteral( "Magnification factor: %1" ).arg( mMagnificationFactor ), 5 );
 
   mValid = true;
 }

diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp
@@ -1086,7 +1086,23 @@ void QgsMapCanvas::setExtent( const QgsRectangle &r, bool magnified )
   }
   else
   {
-    mSettings.setExtent( r, magnified );
+    // If scale is locked we need to maintain the current scale, so we
+    // - magnify and recenter the map
+    // - restore locked scale
+    if ( mScaleLocked && magnified )
+    {
+      ScaleRestorer restorer( this );
+      const double ratio { extent().width() / extent().height() };
+      const double factor { r.width() / r.height() > ratio ? extent().width() / r.width() :  extent().height() / r.height() };
+      const double scaleFactor { qBound( QgsGuiUtils::CANVAS_MAGNIFICATION_MIN,  mSettings.magnificationFactor() * factor, QgsGuiUtils::CANVAS_MAGNIFICATION_MAX ) };
+      const QgsPointXY newCenter { r.center() };
+      mSettings.setMagnificationFactor( scaleFactor, &newCenter );
+      emit magnificationChanged( scaleFactor );
+    }
+    else
+    {
+      mSettings.setExtent( r, magnified );
+    }
   }
   emit extentsChanged();
   updateScale();
@@ -1134,18 +1150,15 @@ bool QgsMapCanvas::setReferencedExtent( const QgsReferencedRectangle &extent )
 void QgsMapCanvas::setCenter( const QgsPointXY &center )
 {
   const QgsRectangle r = mapSettings().extent();
-  const double x = center.x();
-  const double y = center.y();
+  const double xMin = center.x() - r.width() / 2.0;
+  const double yMin = center.y() - r.height() / 2.0;
   const QgsRectangle rect(
-    x - r.width() / 2.0, y - r.height() / 2.0,
-    x + r.width() / 2.0, y + r.height() / 2.0
+    xMin, yMin,
+    xMin + r.width(), yMin + r.height()
   );
   if ( ! rect.isEmpty() )
   {
-    setExtent(
-      rect,
-      true
-    );
+    setExtent( rect, true );
   }
 } // setCenter
 
@@ -1941,6 +1954,7 @@ void QgsMapCanvas::zoomWithCenter( int x, int y, bool zoomIn )
 
   if ( mScaleLocked )
   {
+    ScaleRestorer restorer( this );
     setMagnificationFactor( mapSettings().magnificationFactor() / scaleFactor, &center );
   }
   else
@@ -2523,7 +2537,7 @@ void QgsMapCanvas::zoomByFactor( double scaleFactor, const QgsPointXY *center, b
 {
   if ( mScaleLocked && !ignoreScaleLock )
   {
-    // zoom map to mouse cursor by magnifying
+    ScaleRestorer restorer( this );
     setMagnificationFactor( mapSettings().magnificationFactor() / scaleFactor, center );
   }
   else

diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h
@@ -1110,6 +1110,28 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView
 
   private:
 
+    // Restore scale RAII
+    class ScaleRestorer
+    {
+      public:
+        ScaleRestorer( QgsMapCanvas *canvas ):
+          mCanvas( canvas )
+        {
+          mLockedScale = mCanvas->mapSettings().scale();
+        };
+
+        ~ScaleRestorer()
+        {
+          QgsRectangle newExtent = mCanvas->mapSettings().extent();
+          newExtent.scale( mLockedScale / mCanvas->mapSettings().scale() );
+          mCanvas->mSettings.setExtent( newExtent );
+        };
+
+      private:
+        QgsMapCanvas *mCanvas;
+        double mLockedScale;
+    };
+
     //! encompases all map settings necessary for map rendering
     QgsMapSettings mSettings;
 

diff --git a/tests/src/python/test_qgsmapcanvas.py b/tests/src/python/test_qgsmapcanvas.py
@@ -26,6 +26,7 @@
                        QgsPolygon,
                        QgsLineString,
                        QgsPoint,
+                       QgsPointXY,
                        QgsApplication)
 from qgis.gui import (QgsMapCanvas)
 
@@ -485,6 +486,79 @@ def testSaveMultipleCanvasesToProject(self):
         self.assertEqual(c4.expressionContextScope().variable('vara'), 2222)
         self.assertEqual(c4.expressionContextScope().variable('varc'), 'cc')
 
+    def testLockedScale(self):
+        """Test zoom/pan/center operations when scale lock is on"""
+
+        c = QgsMapCanvas()
+        c.setExtent(QgsRectangle(5, 45, 9, 47))
+        c.zoomScale(2500000)
+        c.setScaleLocked(True)
+
+        # Test setExtent
+        c.setExtent(QgsRectangle(6, 45.5, 8, 46), True)
+        self.assertEqual(round(c.scale()), 2500000)
+        self.assertEqual(c.center().x(), 7.0)
+        self.assertEqual(c.center().y(), 45.75)
+        self.assertEqual(round(c.magnificationFactor(), 1), 1.9)
+
+        # Test setCenter
+        c.setCenter(QgsPointXY(6, 46))
+        self.assertEqual(c.center().x(), 6)
+        self.assertEqual(c.center().y(), 46)
+        self.assertEqual(round(c.scale()), 2500000)
+
+        # Test zoom
+        c.zoomByFactor(0.5, QgsPointXY(6.5, 46.5), False)
+        self.assertEqual(c.center().x(), 6.5)
+        self.assertEqual(c.center().y(), 46.5)
+        self.assertEqual(round(c.magnificationFactor(), 1), 3.9)
+        self.assertEqual(round(c.scale()), 2500000)
+
+        # Test zoom with center
+        # default zoom factor is 2, x and y are pixel coordinates, default size is 640x480
+        c.zoomWithCenter(300, 200, True)
+        self.assertEqual(round(c.center().x(), 1), 6.5)
+        self.assertEqual(round(c.center().y(), 1), 46.6)
+        self.assertEqual(round(c.scale()), 2500000)
+        self.assertEqual(round(c.magnificationFactor(), 1), 7.8)
+        # out ...
+        c.zoomWithCenter(300, 200, False)
+        self.assertEqual(round(c.center().x(), 1), 6.5)
+        self.assertEqual(round(c.center().y(), 1), 46.6)
+        self.assertEqual(round(c.scale()), 2500000)
+        self.assertEqual(round(c.magnificationFactor(), 1), 3.9)
+
+        # Test setExtent with different ratio
+        c2 = QgsMapCanvas()
+        c2.setExtent(QgsRectangle(5, 45, 9, 47))
+        c2.zoomScale(2500000)
+        c2.setScaleLocked(True)
+
+        c2.setExtent(QgsRectangle(3, 45, 11, 45.5), True)
+        self.assertEqual(round(c2.scale()), 2500000)
+        self.assertEqual(c2.center().x(), 7.0)
+        self.assertEqual(c2.center().y(), 45.25)
+        self.assertEqual(round(c2.magnificationFactor(), 1), 0.5)
+
+        # Restore original
+        c2.setExtent(QgsRectangle(5, 45, 9, 47), True)
+        self.assertEqual(round(c2.scale()), 2500000)
+        self.assertEqual(c2.center().x(), 7.0)
+        self.assertEqual(c2.center().y(), 46.0)
+        self.assertEqual(round(c2.magnificationFactor(), 1), 1)
+
+        c2.setExtent(QgsRectangle(7, 46, 11, 46.5), True)
+        self.assertEqual(round(c2.scale()), 2500000)
+        self.assertEqual(c2.center().x(), 9.0)
+        self.assertEqual(c2.center().y(), 46.25)
+        self.assertEqual(round(c2.magnificationFactor(), 1), 1)
+
+        c2.setExtent(QgsRectangle(7, 46, 9, 46.5), True)
+        self.assertEqual(round(c2.scale()), 2500000)
+        self.assertEqual(c2.center().x(), 8.0)
+        self.assertEqual(c2.center().y(), 46.25)
+        self.assertEqual(round(c2.magnificationFactor(), 1), 2)
+
 
 if __name__ == '__main__':
     unittest.main()