Add method to retrieve all labels from QgsLabelingResults, instead of just labels within a rect

nyalldawson · nyalldawson · commit 8e2fb49718a3 · 2021-06-09T20:45:20.000+10:00
diff --git a/python/core/auto_generated/labeling/qgslabelingresults.sip.in b/python/core/auto_generated/labeling/qgslabelingresults.sip.in
@@ -25,6 +25,13 @@ Class that stores computed placement from labeling engine.
     ~QgsLabelingResults();
 
 
+    QList< QgsLabelPosition > allLabels() const;
+%Docstring
+Returns a list of all labels generated by the labeling run.
+
+.. versionadded:: 3.20
+%End
+
     QList<QgsLabelPosition> labelsAtPosition( const QgsPointXY &p ) const;
 %Docstring
 Returns the details of any labels placed at the specified point (in map coordinates).
diff --git a/python/core/auto_generated/labeling/qgslabelsearchtree.sip.in b/python/core/auto_generated/labeling/qgslabelsearchtree.sip.in
@@ -41,6 +41,13 @@ Removes and deletes all the entries.
 
 
 
+    QList< QgsLabelPosition > allLabels() const;
+%Docstring
+Returns a list of all labels generated by the labeling run.
+
+.. versionadded:: 3.20
+%End
+
 
 
 
diff --git a/src/core/labeling/qgslabelingresults.cpp b/src/core/labeling/qgslabelingresults.cpp
@@ -23,6 +23,12 @@ QgsLabelingResults::QgsLabelingResults()
 
 QgsLabelingResults::~QgsLabelingResults() = default;
 
+
+QList<QgsLabelPosition> QgsLabelingResults::allLabels() const
+{
+  return mLabelSearchTree ? mLabelSearchTree->allLabels() : QList<QgsLabelPosition>();
+}
+
 QList<QgsLabelPosition> QgsLabelingResults::labelsAtPosition( const QgsPointXY &p ) const
 {
   QList<QgsLabelPosition> positions;
diff --git a/src/core/labeling/qgslabelingresults.h b/src/core/labeling/qgslabelingresults.h
@@ -40,6 +40,13 @@ class CORE_EXPORT QgsLabelingResults
     //! QgsLabelingResults cannot be copied.
     QgsLabelingResults &operator=( const QgsLabelingResults &rh ) = delete;
 
+    /**
+     * Returns a list of all labels generated by the labeling run.
+     *
+     * \since QGIS 3.20
+     */
+    QList< QgsLabelPosition > allLabels() const;
+
     /**
      * Returns the details of any labels placed at the specified point (in map coordinates).
      */
diff --git a/src/core/labeling/qgslabelsearchtree.cpp b/src/core/labeling/qgslabelsearchtree.cpp
@@ -42,6 +42,17 @@ void QgsLabelSearchTree::label( const QgsPointXY &point, QList<QgsLabelPosition
   }
 }
 
+QList<QgsLabelPosition> QgsLabelSearchTree::allLabels() const
+{
+  QList<QgsLabelPosition> res;
+  res.reserve( mOwnedPositions.size() );
+  for ( const std::unique_ptr< QgsLabelPosition > &pos : mOwnedPositions )
+  {
+    res.append( * pos );
+  }
+  return res;
+}
+
 void QgsLabelSearchTree::labelsInRect( const QgsRectangle &r, QList<QgsLabelPosition *> &posList ) const
 {
   QList<QgsLabelPosition *> searchResults;
diff --git a/src/core/labeling/qgslabelsearchtree.h b/src/core/labeling/qgslabelsearchtree.h
@@ -74,6 +74,13 @@ class CORE_EXPORT QgsLabelSearchTree
 
     //TODO: why does this break bindings with QList<QgsLabelPosition>?
 
+    /**
+     * Returns a list of all labels generated by the labeling run.
+     *
+     * \since QGIS 3.20
+     */
+    QList< QgsLabelPosition > allLabels() const;
+
     /**
      * Returns label position(s) in given rectangle. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions
      * \note not available in Python bindings
diff --git a/tests/src/core/testqgslabelingengine.cpp b/tests/src/core/testqgslabelingengine.cpp
@@ -1961,7 +1961,17 @@ void TestQgsLabelingEngine::labelingResults()
   QVERIFY( results );
 
   // retrieve some labels
-  QList<QgsLabelPosition> labels = results->labelsAtPosition( QgsPointXY( -654732, 7003282 ) );
+  QList<QgsLabelPosition> labels = results->allLabels();
+  QCOMPARE( labels.count(), 3 );
+  std::sort( labels.begin(), labels.end(), []( const QgsLabelPosition & a, const QgsLabelPosition & b )
+  {
+    return a.labelText.compare( b.labelText );
+  } );
+  QCOMPARE( labels.at( 0 ).labelText, QStringLiteral( "1" ) );
+  QCOMPARE( labels.at( 1 ).labelText, QStringLiteral( "8888" ) );
+  QCOMPARE( labels.at( 2 ).labelText, QStringLiteral( "33333" ) );
+
+  labels = results->labelsAtPosition( QgsPointXY( -654732, 7003282 ) );
   QCOMPARE( labels.count(), 1 );
   QCOMPARE( labels.at( 0 ).featureId, 1 );
   QCOMPARE( labels.at( 0 ).labelText, QStringLiteral( "1" ) );

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,17 @@ void QgsLabelSearchTree::label( const QgsPointXY &point, QList<QgsLabelPosition`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
	`45`	`+QList<QgsLabelPosition> QgsLabelSearchTree::allLabels() const`
	`46`	`+{`
	`47`	`+ QList<QgsLabelPosition> res;`
	`48`	`+ res.reserve( mOwnedPositions.size() );`
	`49`	`+ for ( const std::unique_ptr< QgsLabelPosition > &pos : mOwnedPositions )`
	`50`	`+ {`
	`51`	`+ res.append( * pos );`
	`52`	`+ }`
	`53`	`+ return res;`
	`54`	`+}`
	`55`	`+`
`45`	`56`	`void QgsLabelSearchTree::labelsInRect( const QgsRectangle &r, QList<QgsLabelPosition *> &posList ) const`
`46`	`57`	`{`
`47`	`58`	`QList<QgsLabelPosition *> searchResults;`