Avoid duplicate code for evaluating label obstacle data defined values

qgis · Dec 7, 2019 · 7f38c41 · 7f38c41
1 parent 0443299
commit 7f38c41
Show file tree

Hide file tree

Showing 11 changed files with 138 additions and 85 deletions.
diff --git a/python/core/auto_generated/qgslabelobstaclesettings.sip.in b/python/core/auto_generated/qgslabelobstaclesettings.sip.in
@@ -8,6 +8,7 @@
 
 
 
+
 class QgsLabelObstacleSettings
 {
 %Docstring
@@ -95,6 +96,12 @@ Controls how features act as obstacles for labels.
 .. seealso:: :py:func:`isObstacle`
 
 .. seealso:: :py:func:`factor`
+%End
+
+    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
+%Docstring
+Updates the obstacle settings to respect any data defined properties
+set within the specified ``properties`` collection.
 %End
 
 };

diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -266,6 +266,7 @@ SET(QGIS_CORE_SRCS
   qgslabelfeature.cpp
   qgslabelingengine.cpp
   qgslabelingenginesettings.cpp
+  qgslabelobstaclesettings.cpp
   qgslabelsearchtree.cpp
   qgslayerdefinition.cpp
   qgslegendrenderer.cpp

diff --git a/src/core/qgslabelfeature.cpp b/src/core/qgslabelfeature.cpp
@@ -31,8 +31,6 @@ QgsLabelFeature::QgsLabelFeature( QgsFeatureId id, geos::unique_ptr geometry, QS
   , mOffsetType( QgsPalLayerSettings::FromPoint )
   , mRepeatDistance( 0 )
   , mAlwaysShow( false )
-  , mIsObstacle( false )
-  , mObstacleFactor( 1 )
 {
 }
 

diff --git a/src/core/qgslabelfeature.h b/src/core/qgslabelfeature.h
@@ -305,15 +305,6 @@ class CORE_EXPORT QgsLabelFeature
     //! Sets whether label should be always shown (sets very high label priority)
     void setAlwaysShow( bool enabled ) { mAlwaysShow = enabled; }
 
-
-
-    /**
-     * Returns whether the feature will act as an obstacle for labels.
-     * \returns TRUE if feature is an obstacle
-     * \see setIsObstacle
-     */
-    bool isObstacle() const { return mIsObstacle; }
-
     /**
      * Returns the feature's arrangement flags.
      * \see setArrangementFlags

diff --git a/src/core/qgslabelobstaclesettings.cpp b/src/core/qgslabelobstaclesettings.cpp
@@ -0,0 +1,40 @@
+/***************************************************************************
+  qgslabelobstaclesettings.cpp
+  ----------------------------
+  Date                 : December 2019
+  Copyright            : (C) 2019 by Nyall Dawson
+  Email                : nyall dot dawson at gmail dot com
+ ***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#include "qgslabelobstaclesettings.h"
+#include "qgspropertycollection.h"
+#include "qgsexpressioncontext.h"
+#include "qgspallabeling.h"
+
+void QgsLabelObstacleSettings::updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context )
+{
+  if ( properties.isActive( QgsPalLayerSettings::ObstacleFactor ) )
+  {
+    context.setOriginalValueVariable( mObstacleFactor );
+    QVariant exprVal = properties.value( QgsPalLayerSettings::ObstacleFactor, context );
+    if ( exprVal.isValid() )
+    {
+      bool ok;
+      double factorD = exprVal.toDouble( &ok );
+      if ( ok )
+      {
+        factorD = qBound( 0.0, factorD, 10.0 );
+        factorD = factorD / 5.0 + 0.0001; // convert 0 -> 10 to 0.0001 -> 2.0
+        mObstacleFactor = factorD;
+      }
+    }
+  }
+
+}
diff --git a/src/core/qgslabelobstaclesettings.h b/src/core/qgslabelobstaclesettings.h
@@ -19,6 +19,9 @@
 #include "qgis_core.h"
 #include "qgis_sip.h"
 
+class QgsPropertyCollection;
+class QgsExpressionContext;
+
 /**
  * \ingroup core
  * \class QgsLabelObstacleSettings
@@ -117,6 +120,12 @@ class CORE_EXPORT QgsLabelObstacleSettings
       mObstacleType = type;
     }
 
+    /**
+     * Updates the obstacle settings to respect any data defined properties
+     * set within the specified \a properties collection.
+     */
+    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
+
   private:
 
     bool mIsObstacle = true;

diff --git a/src/core/qgspallabeling.cpp b/src/core/qgspallabeling.cpp
@@ -2480,25 +2480,7 @@ void QgsPalLayerSettings::registerFeature( const QgsFeature &f, QgsRenderContext
 
   QgsLabelObstacleSettings os = mObstacleSettings;
   os.setIsObstacle( isObstacle );
-
-  double featObstacleFactor = mObstacleSettings.factor();
-  if ( isObstacle && mDataDefinedProperties.isActive( QgsPalLayerSettings::ObstacleFactor ) )
-  {
-    context.expressionContext().setOriginalValueVariable( featObstacleFactor );
-    exprVal = mDataDefinedProperties.value( QgsPalLayerSettings::ObstacleFactor, context.expressionContext() );
-    if ( exprVal.isValid() )
-    {
-      bool ok;
-      double factorD = exprVal.toDouble( &ok );
-      if ( ok )
-      {
-        factorD = qBound( 0.0, factorD, 10.0 );
-        factorD = factorD / 5.0 + 0.0001; // convert 0 -> 10 to 0.0001 -> 2.0
-        featObstacleFactor = factorD;
-      }
-    }
-  }
-  os.setFactor( featObstacleFactor );
+  os.updateDataDefinedProperties( mDataDefinedProperties, context.expressionContext() );
   lf->setObstacleSettings( os );
 
   QVector< QgsPalLayerSettings::PredefinedPointPosition > positionOrder = predefinedPositionOrder;
@@ -2568,26 +2550,7 @@ void QgsPalLayerSettings::registerObstacleFeature( const QgsFeature &f, QgsRende
 
   QgsLabelObstacleSettings os = mObstacleSettings;
   os.setIsObstacle( true );
-
-  double featObstacleFactor = mObstacleSettings.factor();
-  if ( mDataDefinedProperties.isActive( QgsPalLayerSettings::ObstacleFactor ) )
-  {
-    context.expressionContext().setOriginalValueVariable( featObstacleFactor );
-    QVariant exprVal = mDataDefinedProperties.value( QgsPalLayerSettings::ObstacleFactor, context.expressionContext() );
-    if ( exprVal.isValid() )
-    {
-      bool ok;
-      double factorD = exprVal.toDouble( &ok );
-      if ( ok )
-      {
-        factorD = qBound( 0.0, factorD, 10.0 );
-        factorD = factorD / 5.0 + 0.0001; // convert 0 -> 10 to 0.0001 -> 2.0
-        featObstacleFactor = factorD;
-      }
-    }
-  }
-  os.setFactor( featObstacleFactor );
-
+  os.updateDataDefinedProperties( mDataDefinedProperties, context.expressionContext() );
   ( *obstacleFeature )->setObstacleSettings( os );
 
   mFeatsRegPal++;

diff --git a/src/core/qgsvectorlayerdiagramprovider.cpp b/src/core/qgsvectorlayerdiagramprovider.cpp
@@ -295,7 +295,9 @@ QgsLabelFeature *QgsVectorLayerDiagramProvider::registerDiagram( QgsFeature &fea
   lf->setHasFixedAngle( true );
   lf->setFixedAngle( 0 );
   lf->setAlwaysShow( alwaysShow );
-  lf->setIsObstacle( isObstacle );
+  QgsLabelObstacleSettings os;
+  os.setIsObstacle( isObstacle );
+  lf->setObstacleSettings( os );
   if ( geosObstacleGeomClone )
   {
     lf->setObstacleGeometry( std::move( geosObstacleGeomClone ) );

diff --git a/tests/src/python/CMakeLists.txt b/tests/src/python/CMakeLists.txt
@@ -91,6 +91,7 @@ ADD_PYTHON_TEST(PyQgsImageCache test_qgsimagecache.py)
 ADD_PYTHON_TEST(PyQgsImageSourceLineEdit test_qgsimagesourcelineedit.py)
 ADD_PYTHON_TEST(PyQgsInterval test_qgsinterval.py)
 ADD_PYTHON_TEST(PyQgsJsonUtils test_qgsjsonutils.py)
+ADD_PYTHON_TEST(PyQgsLabelObstacleSettings test_qgslabelobstaclesettings.py)
 ADD_PYTHON_TEST(PyQgsLabelSettingsWidget test_qgslabelsettingswidget.py)
 ADD_PYTHON_TEST(PyQgsLayerMetadata test_qgslayermetadata.py)
 ADD_PYTHON_TEST(PyQgsLayerTreeMapCanvasBridge test_qgslayertreemapcanvasbridge.py)

diff --git a/tests/src/python/test_qgslabelobstaclesettings.py b/tests/src/python/test_qgslabelobstaclesettings.py
@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+"""QGIS Unit tests for QgsLabelObstacleSettings
+
+.. note:: This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+"""
+__author__ = 'Nyall Dawson'
+__date__ = '2019-12-07'
+__copyright__ = 'Copyright 2019, The QGIS Project'
+
+import qgis  # NOQA
+
+from qgis.core import (QgsProperty,
+                       QgsPropertyCollection,
+                       QgsPalLayerSettings,
+                       QgsLabelObstacleSettings,
+                       QgsExpressionContext,
+                       QgsExpressionContextScope)
+
+from qgis.testing import unittest
+
+
+class TestQgsLabelObstacleSettings(unittest.TestCase):
+
+    def test_obstacle_settings(self):
+        """
+        Test obstacle settings
+        """
+        settings = QgsLabelObstacleSettings()
+        settings.setIsObstacle(True)
+        self.assertTrue(settings.isObstacle())
+        settings.setIsObstacle(False)
+        self.assertFalse(settings.isObstacle())
+
+        settings.setFactor(0.1)
+        self.assertEqual(settings.factor(), 0.1)
+
+        settings.setType(QgsLabelObstacleSettings.PolygonWhole)
+        self.assertEqual(settings.type(), QgsLabelObstacleSettings.PolygonWhole)
+
+        # check that compatibility code works
+        pal_settings = QgsPalLayerSettings()
+        pal_settings.obstacle = True
+        self.assertTrue(pal_settings.obstacle)
+        self.assertTrue(pal_settings.obstacleSettings().isObstacle())
+        pal_settings.obstacle = False
+        self.assertFalse(pal_settings.obstacle)
+        self.assertFalse(pal_settings.obstacleSettings().isObstacle())
+
+        pal_settings.obstacleFactor = 0.2
+        self.assertEqual(pal_settings.obstacleFactor, 0.2)
+        self.assertEqual(pal_settings.obstacleSettings().factor(), 0.2)
+
+        pal_settings.obstacleType = QgsPalLayerSettings.PolygonWhole
+        self.assertEqual(pal_settings.obstacleType, QgsPalLayerSettings.PolygonWhole)
+        self.assertEqual(pal_settings.obstacleSettings().type(), QgsLabelObstacleSettings.PolygonWhole)
+
+    def testUpdateDataDefinedProps(self):
+        settings = QgsLabelObstacleSettings()
+        settings.setFactor(0.1)
+        self.assertEqual(settings.factor(), 0.1)
+
+        props = QgsPropertyCollection()
+        props.setProperty(QgsPalLayerSettings.ObstacleFactor, QgsProperty.fromExpression('@factor'))
+        context = QgsExpressionContext()
+        scope = QgsExpressionContextScope()
+        scope.setVariable('factor', 9)
+        props.updateDataDefinedProperties(props, context)
+        self.assertEqual(settings.factor(), 0.1)
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/tests/src/python/test_qgspallabeling_placement.py b/tests/src/python/test_qgspallabeling_placement.py
@@ -109,40 +109,6 @@ def setUpClass(cls):
         TestPlacementBase.setUpClass()
         cls.layer = None
 
-    def test_obstacle_settings(self):
-        """
-        Test obstacle settings
-        """
-
-        settings = QgsLabelObstacleSettings()
-        settings.setIsObstacle(True)
-        self.assertTrue(settings.isObstacle())
-        settings.setIsObstacle(False)
-        self.assertFalse(settings.isObstacle())
-
-        settings.setFactor(0.1)
-        self.assertEqual(settings.factor(), 0.1)
-
-        settings.setType(QgsLabelObstacleSettings.PolygonWhole)
-        self.assertEqual(settings.type(), QgsLabelObstacleSettings.PolygonWhole)
-
-        # check that compatibility code works
-        pal_settings = QgsPalLayerSettings()
-        pal_settings.obstacle = True
-        self.assertTrue(pal_settings.obstacle)
-        self.assertTrue(pal_settings.obstacleSettings().isObstacle())
-        pal_settings.obstacle = False
-        self.assertFalse(pal_settings.obstacle)
-        self.assertFalse(pal_settings.obstacleSettings().isObstacle())
-
-        pal_settings.obstacleFactor = 0.2
-        self.assertEqual(pal_settings.obstacleFactor, 0.2)
-        self.assertEqual(pal_settings.obstacleSettings().factor(), 0.2)
-
-        pal_settings.obstacleType = QgsPalLayerSettings.PolygonWhole
-        self.assertEqual(pal_settings.obstacleType, QgsPalLayerSettings.PolygonWhole)
-        self.assertEqual(pal_settings.obstacleSettings().type(), QgsLabelObstacleSettings.PolygonWhole)
-
     def test_point_placement_around(self):
         # Default point label placement
         self.layer = TestQgsPalLabeling.loadFeatureLayer('point')