refactoring of QgsMapToolCapture to integrate shape map tools

doc/CMakeLists.txt

@@ -109,6 +109,7 @@ if(WITH_APIDOC)
       ${CMAKE_SOURCE_DIR}/src/gui/layertree
       ${CMAKE_SOURCE_DIR}/src/gui/layout
       ${CMAKE_SOURCE_DIR}/src/gui/locator
+      ${CMAKE_SOURCE_DIR}/src/gui/maptools
       ${CMAKE_SOURCE_DIR}/src/gui/mesh
       ${CMAKE_SOURCE_DIR}/src/gui/numericformats
       ${CMAKE_SOURCE_DIR}/src/gui/ogr

images/images.qrc

@@ -290,7 +290,9 @@
         <file>themes/default/mActionDeleteTable.svg</file>
         <file>themes/default/mActionDeselectAll.svg</file>
         <file>themes/default/mActionDeselectActiveLayer.svg</file>
+        <file>themes/default/mActionDigitizeShape.svg</file>
         <file>themes/default/mActionDigitizeWithCurve.svg</file>
+        <file>themes/default/mActionDigitizeWithSegment.svg</file>
         <file>themes/default/mActionDuplicateLayer.svg</file>
         <file>themes/default/mActionDuplicateComposer.svg</file>
         <file>themes/default/mActionEditCopy.svg</file>

python/gui/auto_additions/qgsmaptoolcapture.py

@@ -0,0 +1,2 @@
+# The following has been generated automatically from src/gui/qgsmaptoolcapture.h
+QgsMapToolCapture.CaptureTechnique.baseClass = QgsMapToolCapture

python/gui/auto_generated/maptools/qgsmaptoolcapturelayergeometry.sip.in

@@ -0,0 +1,59 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/maptools/qgsmaptoolcapturelayergeometry.h                    *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+class QgsMapToolCaptureLayerGeometry : QgsMapToolCapture
+{
+%Docstring(signature="appended")
+:py:class:`QgsMapToolCaptureLayerGeometry` is a base class for map tools digitizing layer geometries
+This map tool subclass automatically handles intersection avoidance with other layers in the active project whenever a geometry is digitized by the user.
+
+.. versionadded:: 3.26
+%End
+
+%TypeHeaderCode
+#include "qgsmaptoolcapturelayergeometry.h"
+%End
+  public:
+    QgsMapToolCaptureLayerGeometry( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget, CaptureMode mode );
+%Docstring
+Constructor
+%End
+
+  private:
+    virtual void layerGeometryCaptured( const QgsGeometry &geometry );
+%Docstring
+Called when the geometry is captured
+A more specific handler is also called afterwards (layerPointCaptured, layerLineCaptured or layerPolygonCaptured)
+%End
+    virtual void layerPointCaptured( const QgsPoint &point );
+%Docstring
+Called when a point is captured
+The generic :py:func:`~QgsMapToolCaptureLayerGeometry.geometryCaptured` signal will be emitted immediately before this point-specific signal.
+%End
+    virtual void layerLineCaptured( const QgsCurve *line );
+%Docstring
+Called when a line is captured
+The generic :py:func:`~QgsMapToolCaptureLayerGeometry.geometryCaptured` signal will be emitted immediately before this line-specific signal.
+%End
+    virtual void layerPolygonCaptured( const QgsCurvePolygon *polygon );
+%Docstring
+Called when a polygon is captured
+The generic :py:func:`~QgsMapToolCaptureLayerGeometry.geometryCaptured` signal will be emitted immediately before this polygon-specific signal.
+%End
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/maptools/qgsmaptoolcapturelayergeometry.h                    *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/gui/auto_generated/qgisinterface.sip.in

@@ -672,69 +672,133 @@ Returns the Hide Deselected Layers action.
     virtual QAction *actionCheckQgisVersion() = 0;
     virtual QAction *actionAbout() = 0;
 
-    virtual QAction *actionCircle2Points()  = 0;
+
+ virtual QAction *actionCircle2Points() /Deprecated/;
 %Docstring
 Returns the native add circle from 2 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionCircle3Points()  = 0;
+
+ virtual QAction *actionCircle3Points() /Deprecated/;
 %Docstring
 Returns the native add circle from 3 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionCircle3Tangents()  = 0;
+
+ virtual QAction *actionCircle3Tangents() /Deprecated/;
 %Docstring
 Returns the native add circle from 3 tangents action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionCircle2TangentsPoint()  = 0;
+
+ virtual QAction *actionCircle2TangentsPoint() /Deprecated/;
 %Docstring
 Returns the native add circle from 2 tangents and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionCircleCenterPoint()  = 0;
+
+ virtual QAction *actionCircleCenterPoint() /Deprecated/;
 %Docstring
 Returns the native add circle from center action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionEllipseCenter2Points()  = 0;
+
+ virtual QAction *actionEllipseCenter2Points() /Deprecated/;
 %Docstring
 Returns the native add ellipse from center and 2 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionEllipseCenterPoint()  = 0;
+
+ virtual QAction *actionEllipseCenterPoint() /Deprecated/;
 %Docstring
 Returns the native add ellipse from center and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionEllipseExtent()  = 0;
+
+ virtual QAction *actionEllipseExtent() /Deprecated/;
 %Docstring
 Returns the native add ellipse from an extent action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionEllipseFoci()  = 0;
+
+ virtual QAction *actionEllipseFoci() /Deprecated/;
 %Docstring
 Returns the native add ellipse from foci action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionRectangleCenterPoint()  = 0;
+
+ virtual QAction *actionRectangleCenterPoint() /Deprecated/;
 %Docstring
 Returns the native add rectangle from center and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionRectangleExtent()  = 0;
+
+ virtual QAction *actionRectangleExtent() /Deprecated/;
 %Docstring
 Returns the native add rectangle from extent action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionRectangle3PointsDistance()  = 0;
+
+ virtual QAction *actionRectangle3PointsDistance() /Deprecated/;
 %Docstring
 Returns the native add rectangle from 3 points (distance from 2nd and 3rd points) action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionRectangle3PointsProjected()  = 0;
+
+ virtual QAction *actionRectangle3PointsProjected() /Deprecated/;
 %Docstring
 Returns the native add rectangle from 3 points (distance from projected 3rd point on segment p1 and p2) action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionRegularPolygon2Points()  = 0;
+
+ virtual QAction *actionRegularPolygon2Points() /Deprecated/;
 %Docstring
 Returns the native add regular polygon from 2 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionRegularPolygonCenterPoint()  = 0;
+
+ virtual QAction *actionRegularPolygonCenterPoint() /Deprecated/;
 %Docstring
 Returns the native add regular polygon from center and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
-    virtual QAction *actionRegularPolygonCenterCorner()  = 0;
+
+ virtual QAction *actionRegularPolygonCenterCorner() /Deprecated/;
 %Docstring
 Returns the native add regular polygon from center and a corner action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
+
+.. deprecated:: QGIS 3.24
+   shape digitizing is now part of the add feature tool. To enable the shape tool, use :py:func:`QgsMapToolCapture.setCurrentCaptureTechnique()` and then :py:func:`QgsMapToolCapture.setCurrentShapeMapTool()`.
 %End
 
     virtual QgsVectorLayerTools *vectorLayerTools() = 0;

python/gui/auto_generated/qgsmaptool.sip.in

@@ -261,6 +261,11 @@ The default implementation does nothing and returns false.
    is present in :py:func:`~QgsMapTool.flags`.
 
 .. versionadded:: 3.18
+%End
+
+    QgsPointXY toMapCoordinates( QPoint point );
+%Docstring
+Transforms a ``point`` from screen coordinates to map coordinates.
 %End
 
   signals:
@@ -289,11 +294,6 @@ signal emitted once the map tool is deactivated
     QgsMapTool( QgsMapCanvas *canvas /TransferThis/ );
 %Docstring
 Constructor takes a map canvas as a parameter.
-%End
-
-    QgsPointXY toMapCoordinates( QPoint point );
-%Docstring
-Transforms a ``point`` from screen coordinates to map coordinates.
 %End
 
     QgsPoint toLayerCoordinates( const QgsMapLayer *layer, const QgsPoint &point ) /PyName=toLayerCoordinatesV2/;