[advanced digitizing] Add circles intersection digitizing tool

images/images.qrc

@@ -693,6 +693,7 @@
         <file>themes/default/mActionPanHighlightFeature.svg</file>
         <file>themes/default/mActionPrevious.svg</file>
         <file>themes/default/mActionPlay.svg</file>
+        <file>themes/default/cadtools/circlesintersection.svg</file>
         <file>themes/default/cadtools/construction.svg</file>
         <file>themes/default/cadtools/delta.svg</file>
         <file>themes/default/cadtools/floater.svg</file>

python/PyQt6/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in

@@ -204,13 +204,15 @@ Removes unit suffix from the constraint text.
 
     };
 
-    explicit QgsAdvancedDigitizingDockWidget( QgsMapCanvas *canvas, QWidget *parent = 0 );
+    explicit QgsAdvancedDigitizingDockWidget( QgsMapCanvas *canvas, QWidget *parent = 0, QgsUserInputWidget *userInputWidget = 0 );
 %Docstring
 Create an advanced digitizing dock widget
 
 :param canvas: The map canvas on which the widget operates
 :param parent: The parent
+:param userInputWidget: The user input widget on which tools can add widget overlays on top of the map canvas (since QGIS 3.40)
 %End
+    ~QgsAdvancedDigitizingDockWidget();
 
     bool canvasKeyPressEventFilter( QKeyEvent *e );
 %Docstring
@@ -232,6 +234,41 @@ apply the CAD constraints. The will modify the position of the map event in map
 %Docstring
 align to segment for between line constraint.
 If between line constraints are used, this will determine the angle to be locked depending on the snapped segment.
+%End
+
+    bool processCanvasPressEvent( QgsMapMouseEvent *event );
+%Docstring
+Processes the canvas press ``event``.
+
+:return: Returns ``True`` if the event has been 'eaten' and should not propagate further.
+%End
+
+    bool processCanvasMoveEvent( QgsMapMouseEvent *event );
+%Docstring
+Processes the canvas move ``event``.
+
+:return: Returns ``True`` if the event has been 'eaten' and should not propagate further.
+%End
+
+    bool processCanvasReleaseEvent( QgsMapMouseEvent *event );
+%Docstring
+Processes the canvas release ``event``.
+
+:return: Returns ``True`` if the event has been 'eaten' and should not propagate further.
+%End
+
+    void setTool( QgsAdvancedDigitizingTool *tool );
+%Docstring
+Sets an advanced digitizing tool which will take over digitizing until the tool is close.
+
+.. versionadded:: 3.40
+%End
+
+    QgsAdvancedDigitizingTool *tool() const;
+%Docstring
+Returns the current advanced digitizing tool. Returns ``None`` if not set.
+
+.. versionadded:: 3.40
 %End
 
     void releaseLocks( bool releaseRepeatingLocks = true );

python/PyQt6/gui/auto_generated/qgsadvanceddigitizingtools.sip.in

@@ -0,0 +1,84 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsadvanceddigitizingtools.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
+class QgsAdvancedDigitizingTool : QWidget
+{
+%Docstring(signature="appended")
+An abstract class for advanced digitizing tools.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsadvanceddigitizingtools.h"
+%End
+  public:
+
+    explicit QgsAdvancedDigitizingTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget );
+%Docstring
+The advanced digitizing tool constructor.
+
+:param canvas: The map canvas on which the widget operates
+:param cadDockWidget: The cadDockWidget to which the floater belongs
+%End
+
+    QgsMapCanvas *mapCanvas() const;
+%Docstring
+Returns the map canvas associated with the tool.
+%End
+
+    QgsAdvancedDigitizingDockWidget *cadDockWidget() const;
+%Docstring
+Returns the advanced digitizing widget associated with the tool.
+%End
+
+    virtual void paint( QPainter *painter );
+%Docstring
+Paints tool content onto the advanced digitizing canvas item.
+%End
+
+    virtual bool canvasPressEvent( QgsMapMouseEvent *event );
+%Docstring
+Handles canvas press event. If ``True`` is returned, the tool will have
+blocked the event for propagating.
+%End
+
+    virtual bool canvasMoveEvent( QgsMapMouseEvent *event );
+%Docstring
+Handles canvas press move. If ``True`` is returned, the tool will have
+blocked the event for propagating.
+%End
+
+    virtual bool canvasReleaseEvent( QgsMapMouseEvent *event );
+%Docstring
+Handles canvas release event. If ``True`` is returned, the tool will have
+blocked the event for propagating.
+%End
+
+  signals:
+
+    void paintRequested();
+%Docstring
+Requests a new painting event to the advanced digitizing canvas item.
+%End
+
+};
+
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsadvanceddigitizingtools.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/PyQt6/gui/auto_generated/qgsadvanceddigitizingtoolsregistry.sip.in

@@ -0,0 +1,113 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsadvanceddigitizingtoolsregistry.h                         *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+class QgsAdvancedDigitizingToolAbstractMetadata
+{
+%Docstring(signature="appended")
+Stores metadata about one advanced digitizing tool class.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsadvanceddigitizingtoolsregistry.h"
+%End
+  public:
+
+    QgsAdvancedDigitizingToolAbstractMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon() );
+%Docstring
+Constructor for QgsAdvancedDigitizingToolAbstractMetadata with the specified tool ``name``.
+
+``visibleName`` should be set to a translated, user visible name identifying the corresponding annotation item.
+
+An optional ``icon`` can be set, which will be used by the advanced digitizing dock widget.
+%End
+
+    virtual ~QgsAdvancedDigitizingToolAbstractMetadata();
+
+    QString name() const;
+%Docstring
+Returns the tool's unique name
+%End
+
+    QString visibleName() const;
+%Docstring
+Returns the tool's translatable user-friendly name
+%End
+
+    QIcon icon() const;
+%Docstring
+Returns the tool's icon
+%End
+
+    virtual QgsAdvancedDigitizingTool *createTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) /Factory/;
+%Docstring
+Returns new tool of this type. Return ``None`` on error
+%End
+
+  protected:
+};
+
+
+class QgsAdvancedDigitizingToolsRegistry
+{
+%Docstring(signature="appended")
+Registry of available advanced digitizing tools.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsadvanceddigitizingtoolsregistry.h"
+%End
+  public:
+
+    QgsAdvancedDigitizingToolsRegistry();
+    ~QgsAdvancedDigitizingToolsRegistry();
+
+
+    void addDefaultTools();
+%Docstring
+Adds the default tools shipped in QGIS
+%End
+
+    bool addTool( QgsAdvancedDigitizingToolAbstractMetadata *toolMetaData /Transfer/ );
+%Docstring
+Adds an advanced digitizing tool (take ownership) and return ``True`` on success
+%End
+
+    bool removeTool( const QString &name );
+%Docstring
+Removes the advanced digitizing tool matching the provided ``name`` and return ``True`` on success
+%End
+
+    QgsAdvancedDigitizingToolAbstractMetadata *toolMetadata( const QString &name );
+%Docstring
+Returns the advanced digitizing tool matching the provided ``name`` or ``None`` when no match available
+%End
+
+    const QStringList toolMetadataNames() const;
+%Docstring
+Returns the list of registered tool names
+%End
+
+  private:
+    QgsAdvancedDigitizingToolsRegistry( const QgsAdvancedDigitizingToolsRegistry &rh );
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsadvanceddigitizingtoolsregistry.h                         *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/PyQt6/gui/auto_generated/qgsgui.sip.in

@@ -77,6 +77,13 @@ Returns the global layout item GUI registry, used for registering the GUI behavi
 Returns the global annotation item GUI registry, used for registering the GUI behavior of annotation items.
 
 .. versionadded:: 3.22
+%End
+
+    static QgsAdvancedDigitizingToolsRegistry *advancedDigitizingToolsRegistry() /KeepReference/;
+%Docstring
+Returns the global advanced digitizing tools registry, used for registering advanced digitizing tools.
+
+.. versionadded:: 3.40
 %End
 
     static QgsProcessingGuiRegistry *processingGuiRegistry() /KeepReference/;

python/PyQt6/gui/gui_auto.sip

@@ -6,6 +6,8 @@
 %Include auto_generated/qgsadvanceddigitizingcanvasitem.sip
 %Include auto_generated/qgsadvanceddigitizingdockwidget.sip
 %Include auto_generated/qgsadvanceddigitizingfloater.sip
+%Include auto_generated/qgsadvanceddigitizingtools.sip
+%Include auto_generated/qgsadvanceddigitizingtoolsregistry.sip
 %Include auto_generated/qgsaggregatetoolbutton.sip
 %Include auto_generated/qgsalignmentcombobox.sip
 %Include auto_generated/qgsapplicationexitblockerinterface.sip

python/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in

@@ -204,13 +204,15 @@ Removes unit suffix from the constraint text.
 
     };
 
-    explicit QgsAdvancedDigitizingDockWidget( QgsMapCanvas *canvas, QWidget *parent = 0 );
+    explicit QgsAdvancedDigitizingDockWidget( QgsMapCanvas *canvas, QWidget *parent = 0, QgsUserInputWidget *userInputWidget = 0 );
 %Docstring
 Create an advanced digitizing dock widget
 
 :param canvas: The map canvas on which the widget operates
 :param parent: The parent
+:param userInputWidget: The user input widget on which tools can add widget overlays on top of the map canvas (since QGIS 3.40)
 %End
+    ~QgsAdvancedDigitizingDockWidget();
 
     bool canvasKeyPressEventFilter( QKeyEvent *e );
 %Docstring
@@ -232,6 +234,41 @@ apply the CAD constraints. The will modify the position of the map event in map
 %Docstring
 align to segment for between line constraint.
 If between line constraints are used, this will determine the angle to be locked depending on the snapped segment.
+%End
+
+    bool processCanvasPressEvent( QgsMapMouseEvent *event );
+%Docstring
+Processes the canvas press ``event``.
+
+:return: Returns ``True`` if the event has been 'eaten' and should not propagate further.
+%End
+
+    bool processCanvasMoveEvent( QgsMapMouseEvent *event );
+%Docstring
+Processes the canvas move ``event``.
+
+:return: Returns ``True`` if the event has been 'eaten' and should not propagate further.
+%End
+
+    bool processCanvasReleaseEvent( QgsMapMouseEvent *event );
+%Docstring
+Processes the canvas release ``event``.
+
+:return: Returns ``True`` if the event has been 'eaten' and should not propagate further.
+%End
+
+    void setTool( QgsAdvancedDigitizingTool *tool );
+%Docstring
+Sets an advanced digitizing tool which will take over digitizing until the tool is close.
+
+.. versionadded:: 3.40
+%End
+
+    QgsAdvancedDigitizingTool *tool() const;
+%Docstring
+Returns the current advanced digitizing tool. Returns ``None`` if not set.
+
+.. versionadded:: 3.40
 %End
 
     void releaseLocks( bool releaseRepeatingLocks = true );