Add framework for retrieving the temporary results of a in-progress

edit operation on an annotation item This is used for the item to return a representative geometry of what the item would look like if the operation were to be applied. It's used to generate a rubber band showing a preview of the modification during interactive editing operations on an annotation item.
qgis · Sep 10, 2021 · 1537d39 · 1537d39
1 parent 1fe8743
commit 1537d39
Show file tree

Hide file tree

Showing 22 changed files with 171 additions and 1 deletion.
diff --git a/python/core/auto_generated/annotations/qgsannotationitem.sip.in b/python/core/auto_generated/annotations/qgsannotationitem.sip.in
@@ -129,6 +129,13 @@ Applies an edit ``operation`` to the item.
 
 Returns ``True`` if the operation was successfully applied.
 
+.. versionadded:: 3.22
+%End
+
+    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) /Factory/;
+%Docstring
+Retrieves the results of a transient (in progress) edit ``operation`` on the item.
+
 .. versionadded:: 3.22
 %End
 

diff --git a/python/core/auto_generated/annotations/qgsannotationitemeditoperation.sip.in b/python/core/auto_generated/annotations/qgsannotationitemeditoperation.sip.in
@@ -79,6 +79,37 @@ Returns the node position after the move occurred (in layer coordinates).
 
 };
 
+class QgsAnnotationItemEditOperationTransientResults
+{
+%Docstring(signature="appended")
+Encapsulates the transient results of an in-progress annotation edit operation.
+
+.. versionadded:: 3.22
+%End
+
+%TypeHeaderCode
+#include "qgsannotationitemeditoperation.h"
+%End
+  public:
+
+    QgsAnnotationItemEditOperationTransientResults( const QgsGeometry &representativeGeometry );
+%Docstring
+Constructor for QgsAnnotationItemEditOperationTransientResults.
+
+The ``representativeGeometry`` parameter specifies a geometry (in layer CRS) which represents
+the shape of the item if the operation were to be applied. It is used for creating a graphical
+representation of the operation during interactive edits.
+%End
+
+    QgsGeometry representativeGeometry() const;
+%Docstring
+Returns the geometry (in layer CRS) which represents the shape of the item if the operation were to be applied.
+
+This is used for creating a graphical representation of the operation during interactive edits.
+%End
+
+};
+
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

diff --git a/python/core/auto_generated/annotations/qgsannotationlineitem.sip.in b/python/core/auto_generated/annotations/qgsannotationlineitem.sip.in
@@ -43,6 +43,8 @@ Constructor for QgsAnnotationLineItem, with the specified ``linestring``.
 
     virtual bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation );
 
+    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) /Factory/;
+
 
     static QgsAnnotationLineItem *create() /Factory/;
 %Docstring

diff --git a/python/core/auto_generated/annotations/qgsannotationmarkeritem.sip.in b/python/core/auto_generated/annotations/qgsannotationmarkeritem.sip.in
@@ -41,6 +41,8 @@ Constructor for QgsAnnotationMarkerItem, at the specified ``point``.
 
     virtual bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation );
 
+    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) /Factory/;
+
 
     static QgsAnnotationMarkerItem *create() /Factory/;
 %Docstring

diff --git a/python/core/auto_generated/annotations/qgsannotationpointtextitem.sip.in b/python/core/auto_generated/annotations/qgsannotationpointtextitem.sip.in
@@ -57,6 +57,8 @@ Creates a new text at point annotation item.
 
     virtual bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation );
 
+    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) /Factory/;
+
 
     QgsPointXY point() const;
 %Docstring

diff --git a/python/core/auto_generated/annotations/qgsannotationpolygonitem.sip.in b/python/core/auto_generated/annotations/qgsannotationpolygonitem.sip.in
@@ -43,6 +43,8 @@ Constructor for QgsAnnotationPolygonItem, with the specified ``polygon`` geometr
 
     virtual bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation );
 
+    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) /Factory/;
+
 
     static QgsAnnotationPolygonItem *create() /Factory/;
 %Docstring

diff --git a/src/core/annotations/qgsannotationitem.cpp b/src/core/annotations/qgsannotationitem.cpp
@@ -28,6 +28,11 @@ bool QgsAnnotationItem::applyEdit( QgsAbstractAnnotationItemEditOperation * )
   return false;
 }
 
+QgsAnnotationItemEditOperationTransientResults *QgsAnnotationItem::transientEditResults( QgsAbstractAnnotationItemEditOperation * )
+{
+  return nullptr;
+}
+
 QList<QgsAnnotationItemNode> QgsAnnotationItem::nodes() const
 {
   return {};

diff --git a/src/core/annotations/qgsannotationitem.h b/src/core/annotations/qgsannotationitem.h
@@ -30,6 +30,7 @@ class QgsLineSymbol;
 class QgsFillSymbol;
 class QgsAnnotationItemNode;
 class QgsAbstractAnnotationItemEditOperation;
+class QgsAnnotationItemEditOperationTransientResults;
 
 /**
  * \ingroup core
@@ -158,6 +159,13 @@ class CORE_EXPORT QgsAnnotationItem
      */
     virtual bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation );
 
+    /**
+     * Retrieves the results of a transient (in progress) edit \a operation on the item.
+     *
+     * \since QGIS 3.22
+     */
+    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) SIP_FACTORY;
+
     /**
      * Returns the item's z index, which controls the order in which annotation items
      * are rendered in the layer.

diff --git a/src/core/annotations/qgsannotationitemeditoperation.h b/src/core/annotations/qgsannotationitemeditoperation.h
@@ -93,4 +93,37 @@ class CORE_EXPORT QgsAnnotationItemEditOperationMoveNode : public QgsAbstractAnn
 
 };
 
+/**
+ * \ingroup core
+ * \brief Encapsulates the transient results of an in-progress annotation edit operation.
+ * \since QGIS 3.22
+ */
+class CORE_EXPORT QgsAnnotationItemEditOperationTransientResults
+{
+  public:
+
+    /**
+     * Constructor for QgsAnnotationItemEditOperationTransientResults.
+     *
+     * The \a representativeGeometry parameter specifies a geometry (in layer CRS) which represents
+     * the shape of the item if the operation were to be applied. It is used for creating a graphical
+     * representation of the operation during interactive edits.
+     */
+    QgsAnnotationItemEditOperationTransientResults( const QgsGeometry &representativeGeometry )
+      : mRepresentativeGeometry( representativeGeometry )
+    {}
+
+    /**
+     * Returns the geometry (in layer CRS) which represents the shape of the item if the operation were to be applied.
+     *
+     * This is used for creating a graphical representation of the operation during interactive edits.
+     */
+    QgsGeometry representativeGeometry() const { return mRepresentativeGeometry; }
+
+  private:
+
+    QgsGeometry mRepresentativeGeometry;
+
+};
+
 #endif // QGSANNOTATIONITEMEDITOPERATION_H
diff --git a/src/core/annotations/qgsannotationlineitem.cpp b/src/core/annotations/qgsannotationlineitem.cpp
@@ -115,6 +115,19 @@ bool QgsAnnotationLineItem::applyEdit( QgsAbstractAnnotationItemEditOperation *o
   }
 }
 
+QgsAnnotationItemEditOperationTransientResults *QgsAnnotationLineItem::transientEditResults( QgsAbstractAnnotationItemEditOperation *operation )
+{
+  if ( QgsAnnotationItemEditOperationMoveNode *moveOperation = dynamic_cast< QgsAnnotationItemEditOperationMoveNode * >( operation ) )
+  {
+    std::unique_ptr< QgsCurve > modifiedCurve( mCurve->clone() );
+    if ( modifiedCurve->moveVertex( moveOperation->nodeId(), QgsPoint( moveOperation->after() ) ) )
+    {
+      return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry( std::move( modifiedCurve ) ) );
+    }
+  }
+  return nullptr;
+}
+
 QgsAnnotationLineItem *QgsAnnotationLineItem::create()
 {
   return new QgsAnnotationLineItem( new QgsLineString() );

diff --git a/src/core/annotations/qgsannotationlineitem.h b/src/core/annotations/qgsannotationlineitem.h
@@ -47,6 +47,7 @@ class CORE_EXPORT QgsAnnotationLineItem : public QgsAnnotationItem
     QgsGeometry rubberBandGeometry() const override;
     bool transform( const QTransform &transform ) override;
     bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) override;
+    QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) override SIP_FACTORY;
 
     /**
      * Creates a new linestring annotation item.

diff --git a/src/core/annotations/qgsannotationmarkeritem.cpp b/src/core/annotations/qgsannotationmarkeritem.cpp
@@ -93,6 +93,15 @@ bool QgsAnnotationMarkerItem::applyEdit( QgsAbstractAnnotationItemEditOperation
   }
 }
 
+QgsAnnotationItemEditOperationTransientResults *QgsAnnotationMarkerItem::transientEditResults( QgsAbstractAnnotationItemEditOperation *operation )
+{
+  if ( QgsAnnotationItemEditOperationMoveNode *moveOperation = dynamic_cast< QgsAnnotationItemEditOperationMoveNode * >( operation ) )
+  {
+    return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry::fromPointXY( moveOperation->after() ) );
+  }
+  return nullptr;
+}
+
 QgsAnnotationMarkerItem *QgsAnnotationMarkerItem::create()
 {
   return new QgsAnnotationMarkerItem( QgsPoint() );

diff --git a/src/core/annotations/qgsannotationmarkeritem.h b/src/core/annotations/qgsannotationmarkeritem.h
@@ -45,6 +45,7 @@ class CORE_EXPORT QgsAnnotationMarkerItem : public QgsAnnotationItem
     Qgis::AnnotationItemFlags flags() const override;
     QList< QgsAnnotationItemNode > nodes() const override;
     bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) override;
+    QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) override SIP_FACTORY;
 
     /**
      * Creates a new marker annotation item.

diff --git a/src/core/annotations/qgsannotationpointtextitem.cpp b/src/core/annotations/qgsannotationpointtextitem.cpp
@@ -160,6 +160,15 @@ bool QgsAnnotationPointTextItem::applyEdit( QgsAbstractAnnotationItemEditOperati
   }
 }
 
+QgsAnnotationItemEditOperationTransientResults *QgsAnnotationPointTextItem::transientEditResults( QgsAbstractAnnotationItemEditOperation *operation )
+{
+  if ( QgsAnnotationItemEditOperationMoveNode *moveOperation = dynamic_cast< QgsAnnotationItemEditOperationMoveNode * >( operation ) )
+  {
+    return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry::fromPointXY( moveOperation->after() ) );
+  }
+  return nullptr;
+}
+
 QgsTextFormat QgsAnnotationPointTextItem::format() const
 {
   return mTextFormat;

diff --git a/src/core/annotations/qgsannotationpointtextitem.h b/src/core/annotations/qgsannotationpointtextitem.h
@@ -57,6 +57,7 @@ class CORE_EXPORT QgsAnnotationPointTextItem : public QgsAnnotationItem
     QList< QgsAnnotationItemNode > nodes() const override;
     bool transform( const QTransform &transform ) override;
     bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) override;
+    QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) override SIP_FACTORY;
 
     /**
      * Returns the point location of the text.

diff --git a/src/core/annotations/qgsannotationpolygonitem.cpp b/src/core/annotations/qgsannotationpolygonitem.cpp
@@ -145,6 +145,19 @@ bool QgsAnnotationPolygonItem::applyEdit( QgsAbstractAnnotationItemEditOperation
   }
 }
 
+QgsAnnotationItemEditOperationTransientResults *QgsAnnotationPolygonItem::transientEditResults( QgsAbstractAnnotationItemEditOperation *operation )
+{
+  if ( QgsAnnotationItemEditOperationMoveNode *moveOperation = dynamic_cast< QgsAnnotationItemEditOperationMoveNode * >( operation ) )
+  {
+    std::unique_ptr< QgsCurvePolygon > modifiedPolygon( mPolygon->clone() );
+    if ( modifiedPolygon->moveVertex( moveOperation->nodeId(), QgsPoint( moveOperation->after() ) ) )
+    {
+      return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry( std::move( modifiedPolygon ) ) );
+    }
+  }
+  return nullptr;
+}
+
 QgsAnnotationPolygonItem *QgsAnnotationPolygonItem::create()
 {
   return new QgsAnnotationPolygonItem( new QgsPolygon() );

diff --git a/src/core/annotations/qgsannotationpolygonitem.h b/src/core/annotations/qgsannotationpolygonitem.h
@@ -46,6 +46,7 @@ class CORE_EXPORT QgsAnnotationPolygonItem : public QgsAnnotationItem
     QgsGeometry rubberBandGeometry() const override;
     bool transform( const QTransform &transform ) override;
     bool applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) override;
+    QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) override SIP_FACTORY;
 
     /**
      * Creates a new polygon annotation item.

diff --git a/src/gui/annotations/qgsmaptoolmodifyannotation.cpp b/src/gui/annotations/qgsmaptoolmodifyannotation.cpp
@@ -25,6 +25,7 @@
 #include "qgsrenderedannotationitemdetails.h"
 #include "qgsannotationitem.h"
 #include "qgsannotationitemnode.h"
+#include "qgsannotationitemeditoperation.h"
 #include "RTree.h"
 #include <QTransform>
 #include <QWindow>

diff --git a/tests/src/python/test_qgsannotationlineitem.py b/tests/src/python/test_qgsannotationlineitem.py
@@ -101,6 +101,13 @@ def test_apply_move_node_edit(self):
         self.assertFalse(item.applyEdit(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 3), QgsPointXY(14, 15), QgsPointXY(19, 20))))
         self.assertEqual(item.geometry().asWkt(), 'LineString (12 13, 17 18, 19 20)')
 
+    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)')
+
+        res = item.transientEditResults(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 1), QgsPointXY(14, 13), QgsPointXY(17, 18)))
+        self.assertEqual(res.representativeGeometry().asWkt(), 'LineString (12 13, 17 18, 14 15)')
+
     def test_rubberbandgeometry(self):
         """
         Test creating rubber band geometry

diff --git a/tests/src/python/test_qgsannotationmarkeritem.py b/tests/src/python/test_qgsannotationmarkeritem.py
@@ -95,6 +95,13 @@ def test_apply_move_node_edit(self):
         self.assertTrue(item.applyEdit(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 1), QgsPointXY(14, 13), QgsPointXY(17, 18))))
         self.assertEqual(item.geometry().asWkt(), 'POINT(17 18)')
 
+    def test_transient_move_operation(self):
+        item = QgsAnnotationMarkerItem(QgsPoint(12, 13))
+        self.assertEqual(item.geometry().asWkt(), 'POINT(12 13)')
+
+        res = item.transientEditResults(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 0), QgsPointXY(12, 13), QgsPointXY(17, 18)))
+        self.assertEqual(res.representativeGeometry().asWkt(), 'Point (17 18)')
+
     def testReadWriteXml(self):
         doc = QDomDocument("testdoc")
         elem = doc.createElement('test')

diff --git a/tests/src/python/test_qgsannotationpointtextitem.py b/tests/src/python/test_qgsannotationpointtextitem.py
@@ -103,9 +103,16 @@ def test_apply_move_node_edit(self):
         item = QgsAnnotationPointTextItem('my text', QgsPointXY(12, 13))
         self.assertEqual(item.point().asWkt(), 'POINT(12 13)')
 
-        self.assertTrue(item.applyEdit(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 1), QgsPointXY(14, 13), QgsPointXY(17, 18))))
+        self.assertTrue(item.applyEdit(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 0), QgsPointXY(14, 13), QgsPointXY(17, 18))))
         self.assertEqual(item.point().asWkt(), 'POINT(17 18)')
 
+    def test_transient_move_operation(self):
+        item = QgsAnnotationPointTextItem('my text', QgsPointXY(12, 13))
+        self.assertEqual(item.point().asWkt(), 'POINT(12 13)')
+
+        res = item.transientEditResults(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 0), QgsPointXY(12, 13), QgsPointXY(17, 18)))
+        self.assertEqual(res.representativeGeometry().asWkt(), 'Point (17 18)')
+
     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
@@ -113,6 +113,14 @@ def test_apply_move_node_edit(self):
         self.assertFalse(item.applyEdit(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 4), QgsPointXY(14, 15), QgsPointXY(19, 20))))
         self.assertEqual(item.geometry().asWkt(), 'Polygon ((19 20, 17 18, 14 15, 19 20))')
 
+    def test_transient_move_operation(self):
+        item = QgsAnnotationPolygonItem(
+            QgsPolygon(QgsLineString([QgsPoint(12, 13), QgsPoint(14, 13), QgsPoint(14, 15), QgsPoint(12, 13)])))
+        self.assertEqual(item.geometry().asWkt(), 'Polygon ((12 13, 14 13, 14 15, 12 13))')
+
+        res = item.transientEditResults(QgsAnnotationItemEditOperationMoveNode('', QgsVertexId(0, 0, 1), QgsPointXY(14, 13), QgsPointXY(17, 18)))
+        self.assertEqual(res.representativeGeometry().asWkt(), 'Polygon ((12 13, 17 18, 14 15, 12 13))')
+
     def testReadWriteXml(self):
         doc = QDomDocument("testdoc")
         elem = doc.createElement('test')