Merge pull request #4078 from nyalldawson/geom_api

API changes to QgsGeometry::isEmpty()/isNull()
qgis · Jan 30, 2017 · 8709e1f · 8709e1f
2 parents c4165e4 + afcb75a
commit 8709e1f
Show file tree

Hide file tree

Showing 107 changed files with 368 additions and 290 deletions.
diff --git a/doc/api_break.dox b/doc/api_break.dox
@@ -1044,8 +1044,10 @@ QgsGeometry        {#qgis_api_break_3_0_QgsGeometry}
 
 - All QgsGeometry methods now accept geometry references instead of pointers, and return a QgsGeometry
 value instead of a pointer. The biggest impact with this change is that PyQGIS code should not compare a geometry
-result to None, but instead either use a boolean test (`if g.buffer(10):`) or explicitly use the isEmpty()
+result to None, but instead either use a boolean test (`if g.buffer(10):`) or explicitly use the isNull()
 method to determine if a geometry is valid.
+- isEmpty() was renamed to isNull() to differentiate a missing geometry from a geometry which is empty (eg an
+empty geometry collection)
 - wkbSize() and asWkb() has been replaced by exportToWkb(). WKB representation is no longer cached within QgsGeometry
 - asGeos() has been replaced by exportToGeos(). GEOS representation is no longer cached within QgsGeometry
 - int addPart( const QList<QgsPoint> &points, QgsWkbTypes::GeometryType geomType ) has been renamed to addPoints
@@ -1055,6 +1057,7 @@ method to determine if a geometry is valid.
 - static bool compare( const QgsMultiPolygon& p1, const QgsMultiPolygon& p2, double epsilon ) has been renamed to compareMultiPolygons
 - smoothLine and smoothPolygon are no longer public API (use smooth() instead)
 - avoidIntersections() got an extra argument: list of layers to include in the operation (previously read from active QgsProject)
+- isGeosEmpty() was removed. Use isEmpty() instead.
 
 
 QgsGeometryAnalyzer        {#qgis_api_break_3_0_QgsGeometryAnalyzer}

diff --git a/python/core/geometry/qgsabstractgeometry.sip b/python/core/geometry/qgsabstractgeometry.sip
@@ -311,7 +311,7 @@ class QgsAbstractGeometry
 
     /** Returns true if the geometry is empty
      */
-    bool isEmpty() const;
+    virtual bool isEmpty() const;
 
     /** Returns true if the geometry contains curved segments
      */

diff --git a/python/core/geometry/qgscircularstring.sip b/python/core/geometry/qgscircularstring.sip
@@ -25,6 +25,7 @@ class QgsCircularString: public QgsCurve
     QDomElement asGML3( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const;
     QString asJSON( int precision = 17 ) const;
 
+    bool isEmpty() const;
     int numPoints() const;
 
     /** Returns the point at index i within the circular string.

diff --git a/python/core/geometry/qgscompoundcurve.sip b/python/core/geometry/qgscompoundcurve.sip
@@ -33,6 +33,8 @@ class QgsCompoundCurve: public QgsCurve
     virtual QgsPointV2 endPoint() const;
     virtual void points( QList<QgsPointV2>& pts ) const;
     virtual int numPoints() const;
+    bool isEmpty() const;
+
     /** Returns a new line string geometry corresponding to a segmentized approximation
      * of the curve.
      * @param tolerance segmentation tolerance

diff --git a/python/core/geometry/qgscurvepolygon.sip b/python/core/geometry/qgscurvepolygon.sip
@@ -83,6 +83,7 @@ class QgsCurvePolygon: public QgsSurface
 
     virtual QList< QList< QList< QgsPointV2 > > > coordinateSequence() const;
     virtual int nCoordinates() const;
+    bool isEmpty() const;
     double closestSegment( const QgsPointV2& pt, QgsPointV2& segmentPt,  QgsVertexId& vertexAfter, bool* leftOf, double epsilon ) const;
     bool nextVertex( QgsVertexId& id, QgsPointV2& vertex ) const;
 

diff --git a/python/core/geometry/qgsgeometry.sip b/python/core/geometry/qgsgeometry.sip
@@ -57,12 +57,7 @@ class QgsGeometry
      */
     void setGeometry( QgsAbstractGeometry* geometry /Transfer/ );
 
-    /** Returns true if the geometry is empty (ie, contains no underlying geometry
-     * accessible via @link geometry @endlink).
-     * @see geometry
-     * @note added in QGIS 2.10
-     */
-    bool isEmpty() const;
+    bool isNull() const;
 
     /** Creates a new geometry from a WKT string */
     static QgsGeometry fromWkt( const QString& wkt );
@@ -120,6 +115,8 @@ class QgsGeometry
      */
     QgsWkbTypes::GeometryType type() const;
 
+    bool isEmpty() const;
+
     /** Returns true if WKB of the geometry is of WKBMulti* type */
     bool isMultipart() const;
 
@@ -133,11 +130,6 @@ class QgsGeometry
      */
     bool isGeosValid() const;
 
-    /** Check if the geometry is empty using GEOS
-      @note added in 1.5
-     */
-    bool isGeosEmpty() const;
-
     /** Returns the area of the geometry using GEOS
       @note added in 1.5
      */

diff --git a/python/core/geometry/qgsgeometrycollection.sip b/python/core/geometry/qgsgeometrycollection.sip
@@ -27,6 +27,7 @@ class QgsGeometryCollection: public QgsAbstractGeometry
     QgsAbstractGeometry* geometryN( int n );
 
     //methods inherited from QgsAbstractGeometry
+    bool isEmpty() const;
     virtual int dimension() const;
     virtual QString geometryType() const;
     virtual void clear();

diff --git a/python/core/geometry/qgslinestring.sip b/python/core/geometry/qgslinestring.sip
@@ -106,7 +106,7 @@ class QgsLineString: public QgsCurve
     virtual int dimension() const;
     virtual QgsLineString* clone() const /Factory/;
     virtual void clear();
-
+    bool isEmpty() const;
     virtual bool fromWkb( QgsConstWkbPtr& wkb );
     virtual bool fromWkt( const QString& wkt );
 

diff --git a/python/core/geometry/qgspointv2.sip b/python/core/geometry/qgspointv2.sip
@@ -245,6 +245,7 @@ class QgsPointV2: public QgsAbstractGeometry
     virtual int dimension() const;
     virtual QgsPointV2* clone() const /Factory/;
     void clear();
+    bool isEmpty() const;
     virtual bool fromWkb( QgsConstWkbPtr& wkb );
     virtual bool fromWkt( const QString& wkt );
     QByteArray asWkb() const;

diff --git a/python/plugins/processing/algs/qgis/CheckValidity.py b/python/plugins/processing/algs/qgis/CheckValidity.py
@@ -137,7 +137,7 @@ def doCheck(self, feedback):
             attrs = inFeat.attributes()
 
             valid = True
-            if not geom.isEmpty() and not geom.isGeosEmpty():
+            if not geom.isNull() and not geom.isEmpty():
                 errors = list(geom.validateGeometry())
                 if errors:
                     # QGIS method return a summary at the end

diff --git a/python/plugins/processing/algs/qgis/Delaunay.py b/python/plugins/processing/algs/qgis/Delaunay.py
@@ -82,7 +82,7 @@ def processAlgorithm(self, feedback):
         total = 100.0 / len(features)
         for current, inFeat in enumerate(features):
             geom = QgsGeometry(inFeat.geometry())
-            if geom.isEmpty():
+            if geom.isNull():
                 continue
             if geom.isMultipart():
                 points = geom.asMultiPoint()

diff --git a/python/plugins/processing/algs/qgis/Dissolve.py b/python/plugins/processing/algs/qgis/Dissolve.py
@@ -93,7 +93,7 @@ def processAlgorithm(self, feedback):
                     first = False
 
                 tmpInGeom = inFeat.geometry()
-                if tmpInGeom.isEmpty() or tmpInGeom.isGeosEmpty():
+                if tmpInGeom.isNull() or tmpInGeom.isEmpty():
                     continue
 
                 errors = tmpInGeom.validateGeometry()
@@ -137,7 +137,7 @@ def processAlgorithm(self, feedback):
                 index_attrs = tuple([attrs[i] for i in field_indexes])
 
                 tmpInGeom = QgsGeometry(inFeat.geometry())
-                if tmpInGeom.isGeosEmpty():
+                if tmpInGeom and tmpInGeom.isEmpty():
                     continue
                 errors = tmpInGeom.validateGeometry()
                 if len(errors) != 0:

diff --git a/python/plugins/processing/algs/qgis/HypsometricCurves.py b/python/plugins/processing/algs/qgis/HypsometricCurves.py
@@ -105,7 +105,7 @@ def processAlgorithm(self, feedback):
             geom = f.geometry()
             intersectedGeom = rasterGeom.intersection(geom)
 
-            if intersectedGeom.isGeosEmpty():
+            if intersectedGeom.isEmpty():
                 feedback.pushInfo(
                     self.tr('Feature %d does not intersect raster or '
                             'entirely located in NODATA area' % f.id()))

diff --git a/python/plugins/processing/algs/qgis/Intersection.py b/python/plugins/processing/algs/qgis/Intersection.py
@@ -107,7 +107,7 @@ def processAlgorithm(self, feedback):
                         if int_com:
                             int_sym = geom.symDifference(tmpGeom)
                             int_geom = QgsGeometry(int_com.difference(int_sym))
-                    if int_geom.isGeosEmpty() or not int_geom.isGeosValid():
+                    if int_geom.isEmpty() or not int_geom.isGeosValid():
                         ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
                                                self.tr('GEOS geoprocessing error: One or '
                                                        'more input features have invalid '

diff --git a/python/plugins/processing/algs/qgis/PolygonCentroids.py b/python/plugins/processing/algs/qgis/PolygonCentroids.py
@@ -80,7 +80,7 @@ def processAlgorithm(self, feedback):
             inGeom = feat.geometry()
             attrs = feat.attributes()
 
-            if inGeom.isEmpty():
+            if inGeom.isNull():
                 outGeom = QgsGeometry(None)
             else:
                 outGeom = QgsGeometry(inGeom.centroid())

diff --git a/python/plugins/processing/algs/qgis/ReverseLineDirection.py b/python/plugins/processing/algs/qgis/ReverseLineDirection.py
@@ -65,7 +65,7 @@ def processAlgorithm(self, feedback):
             attrs = inFeat.attributes()
 
             outGeom = None
-            if not inGeom.isEmpty():
+            if not inGeom.isNull():
                 reversedLine = inGeom.geometry().reversed()
                 if not reversedLine:
                     raise GeoAlgorithmExecutionException(

diff --git a/python/plugins/processing/algs/qgis/SplitWithLines.py b/python/plugins/processing/algs/qgis/SplitWithLines.py
@@ -127,7 +127,7 @@ def processAlgorithm(self, feedback):
                         while len(inGeoms) > 0:
                             inGeom = inGeoms.pop()
 
-                            if inGeom.isEmpty(): # this has been encountered and created a run-time error
+                            if inGeom.isNull(): # this has been encountered and created a run-time error
                                 continue
 
                             if split_geom_engine.intersects(inGeom.geometry()):

diff --git a/python/plugins/processing/tests/AlgorithmsTestBase.py b/python/plugins/processing/tests/AlgorithmsTestBase.py
@@ -255,7 +255,7 @@ def check_results(self, results, params, expected):
                     data = file.read()
 
                 for rule in expected_result.get('rules', []):
-                    self.assertRegexpMatches(data, rule)
+                    self.assertRegex(data, rule)
 
 
 if __name__ == '__main__':

diff --git a/src/analysis/interpolation/qgsinterpolator.cpp b/src/analysis/interpolation/qgsinterpolator.cpp
@@ -105,7 +105,7 @@ int QgsInterpolator::cacheBaseData()
 
 int QgsInterpolator::addVerticesToCache( const QgsGeometry& geom, bool zCoord, double attributeValue )
 {
-  if ( geom.isEmpty() )
+  if ( geom.isNull() )
     return 1;
 
   bool hasZValue = false;

diff --git a/src/analysis/interpolation/qgstininterpolator.cpp b/src/analysis/interpolation/qgstininterpolator.cpp
@@ -175,7 +175,7 @@ int QgsTINInterpolator::insertData( QgsFeature* f, bool zCoord, int attr, InputT
 
   QgsGeometry g = f->geometry();
   {
-    if ( g.isEmpty() )
+    if ( g.isNull() )
     {
       return 2;
     }

diff --git a/src/analysis/openstreetmap/qgsosmdatabase.cpp b/src/analysis/openstreetmap/qgsosmdatabase.cpp
@@ -504,7 +504,7 @@ void QgsOSMDatabase::exportSpatiaLiteWays( bool closed, const QString& tableName
         sqlite3_bind_null( stmtInsert, ++col );
     }
 
-    if ( !geom.isEmpty() )
+    if ( !geom.isNull() )
     {
       QByteArray wkb( geom.exportToWkb() );
       sqlite3_bind_blob( stmtInsert, ++col, wkb.constData(), wkb.length(), SQLITE_STATIC );

diff --git a/src/analysis/raster/qgskde.cpp b/src/analysis/raster/qgskde.cpp
@@ -110,7 +110,7 @@ QgsKernelDensityEstimation::Result QgsKernelDensityEstimation::prepare()
 QgsKernelDensityEstimation::Result QgsKernelDensityEstimation::addFeature( const QgsFeature& feature )
 {
   QgsGeometry featureGeometry = feature.geometry();
-  if ( featureGeometry.isEmpty() )
+  if ( featureGeometry.isNull() )
   {
     return Success;
   }

diff --git a/src/analysis/vector/qgsgeometryanalyzer.cpp b/src/analysis/vector/qgsgeometryanalyzer.cpp
@@ -475,7 +475,7 @@ bool QgsGeometryAnalyzer::convexHull( QgsVectorLayer* layer, const QString& shap
         ++jt;
       }
       QList<double> values;
-      if ( dissolveGeometry.isEmpty() )
+      if ( dissolveGeometry.isNull() )
       {
         QgsDebugMsg( "no dissolved geometry - should not happen" );
         return false;
@@ -520,7 +520,7 @@ bool QgsGeometryAnalyzer::convexHull( QgsVectorLayer* layer, const QString& shap
         ++jt;
       }
       QList<double> values;
-      if ( dissolveGeometry.isEmpty() )
+      if ( dissolveGeometry.isNull() )
       {
         QgsDebugMsg( "no dissolved geometry - should not happen" );
         return false;
@@ -705,7 +705,7 @@ QgsGeometry QgsGeometryAnalyzer::dissolveFeature( const QgsFeature& f, const Qgs
 
   QgsGeometry featureGeometry = f.geometry();
 
-  if ( dissolveInto.isEmpty() )
+  if ( dissolveInto.isNull() )
   {
     return featureGeometry;
   }
@@ -810,7 +810,7 @@ bool QgsGeometryAnalyzer::buffer( QgsVectorLayer* layer, const QString& shapefil
   if ( dissolve )
   {
     QgsFeature dissolveFeature;
-    if ( dissolveGeometry.isEmpty() )
+    if ( dissolveGeometry.isNull() )
     {
       QgsDebugMsg( "no dissolved geometry - should not happen" );
       return false;
@@ -967,7 +967,7 @@ bool QgsGeometryAnalyzer::eventLayer( QgsVectorLayer* lineLayer, QgsVectorLayer*
         lrsGeom = locateBetweenMeasures( measure1, measure2, featureIdIt->geometry() );
       }
 
-      if ( !lrsGeom.isEmpty() )
+      if ( !lrsGeom.isNull() )
       {
         ++nOutputFeatures;
         addEventLayerFeature( fet, lrsGeom, featureIdIt->geometry(), fileWriter, memoryProviderFeatures, offsetField, offsetScale, forceSingleGeometry );
@@ -995,7 +995,7 @@ bool QgsGeometryAnalyzer::eventLayer( QgsVectorLayer* lineLayer, QgsVectorLayer*
 void QgsGeometryAnalyzer::addEventLayerFeature( QgsFeature& feature, const QgsGeometry& geom, const QgsGeometry& lineGeom, QgsVectorFileWriter* fileWriter, QgsFeatureList& memoryFeatures,
     int offsetField, double offsetScale, bool forceSingleType )
 {
-  if ( geom.isEmpty() )
+  if ( geom.isNull() )
   {
     return;
   }
@@ -1020,7 +1020,7 @@ void QgsGeometryAnalyzer::addEventLayerFeature( QgsFeature& feature, const QgsGe
       double offsetVal = feature.attribute( offsetField ).toDouble();
       offsetVal *= offsetScale;
       newGeom = createOffsetGeometry( *geomIt, lineGeom, offsetVal );
-      if ( newGeom.isEmpty() )
+      if ( newGeom.isNull() )
       {
         continue;
       }
@@ -1040,7 +1040,7 @@ void QgsGeometryAnalyzer::addEventLayerFeature( QgsFeature& feature, const QgsGe
 
 QgsGeometry QgsGeometryAnalyzer::createOffsetGeometry( const QgsGeometry& geom, const QgsGeometry& lineGeom, double offset )
 {
-  if ( !geom || lineGeom.isEmpty() )
+  if ( !geom || lineGeom.isNull() )
   {
     return QgsGeometry();
   }
@@ -1147,7 +1147,7 @@ QgsPoint QgsGeometryAnalyzer::createPointOffset( double x, double y, double dist
 
 QgsGeometry QgsGeometryAnalyzer::locateBetweenMeasures( double fromMeasure, double toMeasure, const QgsGeometry& lineGeom )
 {
-  if ( lineGeom.isEmpty() )
+  if ( lineGeom.isNull() )
   {
     return QgsGeometry();
   }
@@ -1189,7 +1189,7 @@ QgsGeometry QgsGeometryAnalyzer::locateBetweenMeasures( double fromMeasure, doub
 
 QgsGeometry QgsGeometryAnalyzer::locateAlongMeasure( double measure, const QgsGeometry& lineGeom )
 {
-  if ( lineGeom.isEmpty() )
+  if ( lineGeom.isNull() )
   {
     return QgsGeometry();
   }

diff --git a/src/analysis/vector/qgsgeometrysnapper.cpp b/src/analysis/vector/qgsgeometrysnapper.cpp
@@ -475,7 +475,7 @@ QgsFeatureList QgsGeometrySnapper::snapFeatures( const QgsFeatureList& features,
 
 void QgsGeometrySnapper::processFeature( QgsFeature& feature, double snapTolerance, SnapMode mode )
 {
-  if ( !feature.geometry().isEmpty() )
+  if ( !feature.geometry().isNull() )
     feature.setGeometry( snapGeometry( feature.geometry(), snapTolerance, mode ) );
 }