[pal] Add api to allow setting the outer bounds for a label feature

The outer bounds can represent the extreme margins of a label, including non-text parts like borders or padded backgrounds. During the label solving the outer bounds will be used when detecting whether labels are in conflict.
qgis · Nov 8, 2022 · 5093ae9 · 5093ae9
1 parent 8a121e3
commit 5093ae9
Show file tree

Hide file tree

Showing 6 changed files with 343 additions and 121 deletions.
diff --git a/src/core/labeling/qgslabelfeature.h b/src/core/labeling/qgslabelfeature.h
@@ -111,6 +111,24 @@ class CORE_EXPORT QgsLabelFeature
     //! Size of the label (in map units)
     QSizeF size( double angle = 0.0 ) const;
 
+    /**
+     * Returns the extreme outer bounds of the label feature, including any surrounding content like
+     * borders or background shapes.
+     *
+     * \see setOuterBounds()
+     * \since QGIS 3.30
+     */
+    QRectF outerBounds() const { return mOuterBounds; }
+
+    /**
+     * Sets the extreme outer \a bounds of the label feature, including any surrounding content like
+     * borders or background shapes.
+     *
+     * \see outerBounds()
+     * \since QGIS 3.30
+     */
+    void setOuterBounds( const QRectF &bounds ) { mOuterBounds = bounds; }
+
     /**
      * Sets the visual margin for the label feature. The visual margin represents a margin
      * within the label which should not be considered when calculating the positions of candidates
@@ -627,6 +645,8 @@ class CORE_EXPORT QgsLabelFeature
     QSizeF mSize;
     //! Width and height of the label when rotated between 45 to 135 and 235 to 315 degrees;
     QSizeF mRotatedSize;
+    //! Extreme outer bounds of the label feature, including any surrounding content like borders or background shapes.
+    QRectF mOuterBounds;
     //! Visual margin of label contents
     QgsMargins mVisualMargin;
     //! Size of associated rendered symbol, if applicable

diff --git a/src/core/labeling/qgsvectorlayerlabelprovider.cpp b/src/core/labeling/qgsvectorlayerlabelprovider.cpp
@@ -569,6 +569,25 @@ void QgsVectorLayerLabelProvider::drawLabelPrivate( pal::LabelPosition *label, Q
       painter->drawLine( QPointF( rect.left(), rect.bottom() + bottomMargin ), QPointF( rect.right(), rect.bottom() + bottomMargin ) );
     }
 
+    const QRectF outerBounds = label->getFeaturePart()->feature()->outerBounds();
+    if ( !outerBounds.isNull() )
+    {
+      const QRectF mapOuterBounds = QRectF( label->getX() + outerBounds.left(),
+                                            label->getY() + outerBounds.top(),
+                                            outerBounds.width(), outerBounds.height() );
+
+      QgsPointXY outerBoundsPt1 = xform.transform( mapOuterBounds.left(), mapOuterBounds.top() );
+      QgsPointXY outerBoundsPt2 = xform.transform( mapOuterBounds.right(), mapOuterBounds.bottom() );
+
+      const QRectF outerBoundsPixel( outerBoundsPt1.x() - outPt.x(),
+                                     outerBoundsPt1.y() - outPt.y(),
+                                     outerBoundsPt2.x() - outerBoundsPt1.x(),
+                                     outerBoundsPt2.y() - outerBoundsPt1.y() );
+
+      painter->setPen( QColor( 255, 0, 255, 140 ) );
+      painter->drawRect( outerBoundsPixel );
+    }
+
     if ( QgsTextLabelFeature *textFeature = dynamic_cast< QgsTextLabelFeature * >( label->getFeaturePart()->feature() ) )
     {
       const QgsTextDocumentMetrics &metrics = textFeature->documentMetrics();
@@ -583,6 +602,8 @@ void QgsVectorLayerLabelProvider::drawLabelPrivate( pal::LabelPosition *label, Q
         painter->drawLine( QPointF( rect.left(), rect.top()  + blockBaseLine ), QPointF( rect.right(), rect.top() + blockBaseLine ) );
       }
     }
+
+
     painter->restore();
   }
 

diff --git a/src/core/pal/costcalculator.cpp b/src/core/pal/costcalculator.cpp
@@ -16,7 +16,6 @@
 #include "layer.h"
 #include "pal.h"
 #include "feature.h"
-#include "geomfunction.h"
 #include "labelposition.h"
 #include "util.h"
 #include "costcalculator.h"
@@ -40,7 +39,7 @@ void CostCalculator::addObstacleCostPenalty( LabelPosition *lp, FeaturePart *obs
   {
     case GEOS_POINT:
 
-      dist = lp->getDistanceToPoint( obstacle->x[0], obstacle->y[0] );
+      dist = lp->getDistanceToPoint( obstacle->x[0], obstacle->y[0], true );
       if ( dist < 0 )
         n = 2;
       else if ( dist < distlabel )

diff --git a/src/core/pal/feature.cpp b/src/core/pal/feature.cpp
@@ -2040,7 +2040,7 @@ std::size_t FeaturePart::createCandidatesOutsidePolygon( std::vector<std::unique
     // here we deviate a little from R&R, and instead of just calculating the centroid distance
     // to centroid of label, we calculate the distance from the centroid to the nearest point on the label
 
-    const double centroidDistance = candidate->getDistanceToPoint( cx, cy );
+    const double centroidDistance = candidate->getDistanceToPoint( cx, cy, false );
     const double centroidCost = centroidDistance / estimateOfMaxPossibleDistanceCentroidToLabel;
     candidate->setCost( centroidCost );