Add an annotation item edit operation for adding nodes

qgis · Sep 10, 2021 · 4cb06c0 · 4cb06c0
1 parent a7d299d
commit 4cb06c0
Show file tree

Hide file tree

Showing 13 changed files with 153 additions and 5 deletions.
diff --git a/python/core/auto_additions/qgsannotationitemeditoperation.py b/python/core/auto_additions/qgsannotationitemeditoperation.py
@@ -2,6 +2,7 @@
 # monkey patching scoped based enum
 QgsAbstractAnnotationItemEditOperation.Type.MoveNode.__doc__ = "Move a node"
 QgsAbstractAnnotationItemEditOperation.Type.DeleteNode.__doc__ = "Delete a node"
+QgsAbstractAnnotationItemEditOperation.Type.AddNode.__doc__ = "Add a node"
 QgsAbstractAnnotationItemEditOperation.Type.TranslateItem.__doc__ = "Translate (move) an item"
-QgsAbstractAnnotationItemEditOperation.Type.__doc__ = 'Operation type\n\n' + '* ``MoveNode``: ' + QgsAbstractAnnotationItemEditOperation.Type.MoveNode.__doc__ + '\n' + '* ``DeleteNode``: ' + QgsAbstractAnnotationItemEditOperation.Type.DeleteNode.__doc__ + '\n' + '* ``TranslateItem``: ' + QgsAbstractAnnotationItemEditOperation.Type.TranslateItem.__doc__
+QgsAbstractAnnotationItemEditOperation.Type.__doc__ = 'Operation type\n\n' + '* ``MoveNode``: ' + QgsAbstractAnnotationItemEditOperation.Type.MoveNode.__doc__ + '\n' + '* ``DeleteNode``: ' + QgsAbstractAnnotationItemEditOperation.Type.DeleteNode.__doc__ + '\n' + '* ``AddNode``: ' + QgsAbstractAnnotationItemEditOperation.Type.AddNode.__doc__ + '\n' + '* ``TranslateItem``: ' + QgsAbstractAnnotationItemEditOperation.Type.TranslateItem.__doc__
 # --
diff --git a/python/core/auto_generated/annotations/qgsannotationitemeditoperation.sip.in b/python/core/auto_generated/annotations/qgsannotationitemeditoperation.sip.in
@@ -26,6 +26,7 @@ Abstract base class for annotation item edit operations
     {
       MoveNode,
       DeleteNode,
+      AddNode,
       TranslateItem,
     };
 
@@ -129,6 +130,34 @@ Returns the node position before the delete occurred (in layer coordinates).
 
 };
 
+class QgsAnnotationItemEditOperationAddNode : QgsAbstractAnnotationItemEditOperation
+{
+%Docstring(signature="appended")
+Annotation item edit operation consisting of adding a node
+
+.. versionadded:: 3.22
+%End
+
+%TypeHeaderCode
+#include "qgsannotationitemeditoperation.h"
+%End
+  public:
+
+    QgsAnnotationItemEditOperationAddNode( const QString &itemId, const QgsPoint &point );
+%Docstring
+Constructor for QgsAnnotationItemEditOperationAddNode at the specified ``point``.
+%End
+
+    virtual Type type() const;
+
+
+    QgsPoint point() const;
+%Docstring
+Returns the node position (in layer coordinates).
+%End
+
+};
+
 
 class QgsAnnotationItemEditOperationTranslateItem : QgsAbstractAnnotationItemEditOperation
 {

diff --git a/src/core/annotations/qgsannotationitemeditoperation.cpp b/src/core/annotations/qgsannotationitemeditoperation.cpp
@@ -79,3 +79,20 @@ QgsAbstractAnnotationItemEditOperation::Type QgsAnnotationItemEditOperationTrans
 {
   return Type::TranslateItem;
 }
+
+
+//
+// QgsAnnotationItemEditOperationAddNode
+//
+
+QgsAnnotationItemEditOperationAddNode::QgsAnnotationItemEditOperationAddNode( const QString &itemId, const QgsPoint &point )
+  : QgsAbstractAnnotationItemEditOperation( itemId )
+  , mPoint( point )
+{
+
+}
+
+QgsAbstractAnnotationItemEditOperation::Type QgsAnnotationItemEditOperationAddNode::type() const
+{
+  return Type::AddNode;
+}
diff --git a/src/core/annotations/qgsannotationitemeditoperation.h b/src/core/annotations/qgsannotationitemeditoperation.h
@@ -40,6 +40,7 @@ class CORE_EXPORT QgsAbstractAnnotationItemEditOperation
     {
       MoveNode, //!< Move a node
       DeleteNode, //!< Delete a node
+      AddNode, //!< Add a node
       TranslateItem, //!< Translate (move) an item
     };
 
@@ -145,6 +146,33 @@ class CORE_EXPORT QgsAnnotationItemEditOperationDeleteNode : public QgsAbstractA
 
 };
 
+/**
+ * \ingroup core
+ * \brief Annotation item edit operation consisting of adding a node
+ * \since QGIS 3.22
+ */
+class CORE_EXPORT QgsAnnotationItemEditOperationAddNode : public QgsAbstractAnnotationItemEditOperation
+{
+  public:
+
+    /**
+     * Constructor for QgsAnnotationItemEditOperationAddNode at the specified \a point.
+     */
+    QgsAnnotationItemEditOperationAddNode( const QString &itemId, const QgsPoint &point );
+
+    Type type() const override;
+
+    /**
+     * Returns the node position (in layer coordinates).
+     */
+    QgsPoint point() const { return mPoint; }
+
+  private:
+
+    QgsPoint mPoint;
+
+};
+
 
 /**
  * \ingroup core
@@ -188,7 +216,6 @@ class CORE_EXPORT QgsAnnotationItemEditOperationTranslateItem : public QgsAbstra
     double mTranslateX = 0;
     double mTranslateY = 0;
 
-
 };
 
 /**

diff --git a/src/core/annotations/qgsannotationlineitem.cpp b/src/core/annotations/qgsannotationlineitem.cpp
@@ -112,6 +112,18 @@ Qgis::AnnotationItemEditOperationResult QgsAnnotationLineItem::applyEdit( QgsAbs
       break;
     }
 
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
+    {
+      QgsAnnotationItemEditOperationAddNode *addOperation = qgis::down_cast< QgsAnnotationItemEditOperationAddNode * >( operation );
+
+      QgsPoint segmentPoint;
+      QgsVertexId endOfSegmentVertex;
+      mCurve->closestSegment( addOperation->point(), segmentPoint, endOfSegmentVertex );
+      if ( mCurve->insertVertex( endOfSegmentVertex, addOperation->point() ) )
+        return Qgis::AnnotationItemEditOperationResult::Success;
+      break;
+    }
+
     case QgsAbstractAnnotationItemEditOperation::Type::TranslateItem:
     {
       QgsAnnotationItemEditOperationTranslateItem *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationTranslateItem * >( operation );
@@ -149,6 +161,7 @@ QgsAnnotationItemEditOperationTransientResults *QgsAnnotationLineItem::transient
     }
 
     case QgsAbstractAnnotationItemEditOperation::Type::DeleteNode:
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
       break;
   }
   return nullptr;

diff --git a/src/core/annotations/qgsannotationmarkeritem.cpp b/src/core/annotations/qgsannotationmarkeritem.cpp
@@ -103,6 +103,9 @@ Qgis::AnnotationItemEditOperationResult QgsAnnotationMarkerItem::applyEdit( QgsA
       mPoint.setY( mPoint.y() + moveOperation->translationY() );
       return Qgis::AnnotationItemEditOperationResult::Success;
     }
+
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
+      break;
   }
 
   return Qgis::AnnotationItemEditOperationResult::Invalid;
@@ -125,6 +128,7 @@ QgsAnnotationItemEditOperationTransientResults *QgsAnnotationMarkerItem::transie
     }
 
     case QgsAbstractAnnotationItemEditOperation::Type::DeleteNode:
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
       break;
   }
   return nullptr;

diff --git a/src/core/annotations/qgsannotationpointtextitem.cpp b/src/core/annotations/qgsannotationpointtextitem.cpp
@@ -161,6 +161,9 @@ Qgis::AnnotationItemEditOperationResult QgsAnnotationPointTextItem::applyEdit( Q
       mPoint.setY( mPoint.y() + moveOperation->translationY() );
       return Qgis::AnnotationItemEditOperationResult::Success;
     }
+
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
+      break;
   }
 
   return Qgis::AnnotationItemEditOperationResult::Invalid;
@@ -183,6 +186,7 @@ QgsAnnotationItemEditOperationTransientResults *QgsAnnotationPointTextItem::tran
     }
 
     case QgsAbstractAnnotationItemEditOperation::Type::DeleteNode:
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
       break;
   }
   return nullptr;

diff --git a/src/core/annotations/qgsannotationpolygonitem.cpp b/src/core/annotations/qgsannotationpolygonitem.cpp
@@ -142,6 +142,18 @@ Qgis::AnnotationItemEditOperationResult QgsAnnotationPolygonItem::applyEdit( Qgs
       break;
     }
 
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
+    {
+      QgsAnnotationItemEditOperationAddNode *addOperation = qgis::down_cast< QgsAnnotationItemEditOperationAddNode * >( operation );
+
+      QgsPoint segmentPoint;
+      QgsVertexId endOfSegmentVertex;
+      mPolygon->closestSegment( addOperation->point(), segmentPoint, endOfSegmentVertex );
+      if ( mPolygon->insertVertex( endOfSegmentVertex, addOperation->point() ) )
+        return Qgis::AnnotationItemEditOperationResult::Success;
+      break;
+    }
+
     case QgsAbstractAnnotationItemEditOperation::Type::TranslateItem:
     {
       QgsAnnotationItemEditOperationTranslateItem *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationTranslateItem * >( operation );
@@ -179,6 +191,7 @@ QgsAnnotationItemEditOperationTransientResults *QgsAnnotationPolygonItem::transi
     }
 
     case QgsAbstractAnnotationItemEditOperation::Type::DeleteNode:
+    case QgsAbstractAnnotationItemEditOperation::Type::AddNode:
       break;
   }
   return nullptr;

diff --git a/tests/src/python/test_qgsannotationitemeditoperation.py b/tests/src/python/test_qgsannotationitemeditoperation.py
@@ -16,6 +16,8 @@
 from qgis.core import (
     QgsAnnotationItemEditOperationMoveNode,
     QgsAnnotationItemEditOperationDeleteNode,
+    QgsAnnotationItemEditOperationTranslateItem,
+    QgsAnnotationItemEditOperationAddNode,
     QgsVertexId,
     QgsPoint,
     QgsPointXY
@@ -43,6 +45,17 @@ def test_delete_node_operation(self):
         self.assertEqual(operation.nodeId(), QgsVertexId(1, 2, 3))
         self.assertEqual(operation.before(), QgsPoint(6, 7))
 
+    def test_add_node_operation(self):
+        operation = QgsAnnotationItemEditOperationAddNode('item id', QgsPoint(6, 7))
+        self.assertEqual(operation.itemId(), 'item id')
+        self.assertEqual(operation.point(), QgsPoint(6, 7))
+
+    def test_translate_operation(self):
+        operation = QgsAnnotationItemEditOperationTranslateItem('item id', 6, 7)
+        self.assertEqual(operation.itemId(), 'item id')
+        self.assertEqual(operation.translationX(), 6)
+        self.assertEqual(operation.translationY(), 7)
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/tests/src/python/test_qgsannotationlineitem.py b/tests/src/python/test_qgsannotationlineitem.py
@@ -39,7 +39,8 @@
                        QgsVertexId,
                        QgsAnnotationItemEditOperationMoveNode,
                        QgsAnnotationItemEditOperationDeleteNode,
-                       QgsAnnotationItemEditOperationTranslateItem
+                       QgsAnnotationItemEditOperationTranslateItem,
+                       QgsAnnotationItemEditOperationAddNode
                        )
 from qgis.PyQt.QtXml import QDomDocument
 
@@ -115,6 +116,13 @@ def test_apply_delete_node_edit(self):
         self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationDeleteNode('', QgsVertexId(0, 0, 1), QgsPoint(16, 17))), Qgis.AnnotationItemEditOperationResult.ItemCleared)
         self.assertEqual(item.geometry().asWkt(), 'LineString EMPTY')
 
+    def test_apply_add_node_edit(self):
+        item = QgsAnnotationLineItem(QgsLineString([QgsPoint(12, 13), QgsPoint(14, 13), QgsPoint(14, 15), QgsPoint(16, 17)]))
+        self.assertEqual(item.geometry().asWkt(), 'LineString (12 13, 14 13, 14 15, 16 17)')
+
+        self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationAddNode('', QgsPoint(15, 16))), Qgis.AnnotationItemEditOperationResult.Success)
+        self.assertEqual(item.geometry().asWkt(), 'LineString (12 13, 14 13, 14 15, 15 16, 16 17)')
+
     def test_transient_move_operation(self):
         item = QgsAnnotationLineItem(QgsLineString([QgsPoint(12, 13), QgsPoint(14, 13), QgsPoint(14, 15)]))
         self.assertEqual(item.geometry().asWkt(), 'LineString (12 13, 14 13, 14 15)')

diff --git a/tests/src/python/test_qgsannotationmarkeritem.py b/tests/src/python/test_qgsannotationmarkeritem.py
@@ -37,7 +37,8 @@
                        QgsVertexId,
                        QgsAnnotationItemEditOperationMoveNode,
                        QgsAnnotationItemEditOperationDeleteNode,
-                       QgsAnnotationItemEditOperationTranslateItem
+                       QgsAnnotationItemEditOperationTranslateItem,
+                       QgsAnnotationItemEditOperationAddNode
                        )
 from qgis.PyQt.QtXml import QDomDocument
 
@@ -102,6 +103,10 @@ def test_apply_delete_node_edit(self):
 
         self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationDeleteNode('', QgsVertexId(0, 0, 0), QgsPoint(12, 13))), Qgis.AnnotationItemEditOperationResult.ItemCleared)
 
+    def test_apply_add_node_edit(self):
+        item = QgsAnnotationMarkerItem(QgsPoint(12, 13))
+        self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationAddNode('', QgsPoint(13, 14))), Qgis.AnnotationItemEditOperationResult.Invalid)
+
     def test_transient_move_operation(self):
         item = QgsAnnotationMarkerItem(QgsPoint(12, 13))
         self.assertEqual(item.geometry().asWkt(), 'POINT(12 13)')

diff --git a/tests/src/python/test_qgsannotationpointtextitem.py b/tests/src/python/test_qgsannotationpointtextitem.py
@@ -38,6 +38,7 @@
                        QgsVertexId,
                        QgsAnnotationItemEditOperationMoveNode,
                        QgsAnnotationItemEditOperationDeleteNode,
+                       QgsAnnotationItemEditOperationAddNode,
                        QgsAnnotationItemEditOperationTranslateItem,
                        QgsPoint
                        )
@@ -128,6 +129,10 @@ def test_apply_delete_node_edit(self):
 
         self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationDeleteNode('', QgsVertexId(0, 0, 0), QgsPoint(12, 13))), Qgis.AnnotationItemEditOperationResult.ItemCleared)
 
+    def test_apply_add_node_edit(self):
+        item = QgsAnnotationPointTextItem('my text', QgsPointXY(12, 13))
+        self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationAddNode('', QgsPoint(13, 14))), Qgis.AnnotationItemEditOperationResult.Invalid)
+
     def testReadWriteXml(self):
         doc = QDomDocument("testdoc")
         elem = doc.createElement('test')

diff --git a/tests/src/python/test_qgsannotationpolygonitem.py b/tests/src/python/test_qgsannotationpolygonitem.py
@@ -41,7 +41,8 @@
                        QgsVertexId,
                        QgsAnnotationItemEditOperationMoveNode,
                        QgsAnnotationItemEditOperationDeleteNode,
-                       QgsAnnotationItemEditOperationTranslateItem
+                       QgsAnnotationItemEditOperationTranslateItem,
+                       QgsAnnotationItemEditOperationAddNode
                        )
 from qgis.PyQt.QtXml import QDomDocument
 
@@ -121,6 +122,14 @@ def test_apply_delete_node_edit(self):
         self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationDeleteNode('', QgsVertexId(0, 0, 0), QgsPoint(12, 13))), Qgis.AnnotationItemEditOperationResult.ItemCleared)
         self.assertEqual(item.geometry().asWkt(), 'Polygon EMPTY')
 
+    def test_apply_add_node_edit(self):
+        item = QgsAnnotationPolygonItem(
+            QgsPolygon(QgsLineString([QgsPoint(12, 13), QgsPoint(14, 13), QgsPoint(14, 15), QgsPoint(14.5, 15.5), QgsPoint(14.5, 16.5), QgsPoint(14.5, 17.5), QgsPoint(12, 13)])))
+        self.assertEqual(item.geometry().asWkt(), 'Polygon ((12 13, 14 13, 14 15, 14.5 15.5, 14.5 16.5, 14.5 17.5, 12 13))')
+
+        self.assertEqual(item.applyEdit(QgsAnnotationItemEditOperationAddNode('', QgsPoint(15, 16))), Qgis.AnnotationItemEditOperationResult.Success)
+        self.assertEqual(item.geometry().asWkt(), 'Polygon ((12 13, 14 13, 14 15, 14.5 15.5, 15 16, 14.5 16.5, 14.5 17.5, 12 13))')
+
     def test_transient_move_operation(self):
         item = QgsAnnotationPolygonItem(
             QgsPolygon(QgsLineString([QgsPoint(12, 13), QgsPoint(14, 13), QgsPoint(14, 15), QgsPoint(12, 13)])))