Add QgsRectangle::setNull(), deprecating setMinimal()

qgis · Oct 19, 2023 · 0ec5f0d · 0ec5f0d
1 parent d927a59
commit 0ec5f0d
Show file tree

Hide file tree

Showing 24 changed files with 102 additions and 53 deletions.
diff --git a/python/core/auto_generated/geometry/qgsrectangle.sip.in b/python/core/auto_generated/geometry/qgsrectangle.sip.in
@@ -111,10 +111,26 @@ Set the minimum y value.
 Set the maximum y value.
 %End
 
-    void setMinimal() /HoldGIL/;
+    void setNull() /HoldGIL/;
+%Docstring
+Mark a rectangle as being null (holding no spatial information).
+
+A null rectangle is also empty by definition.
+
+.. seealso:: :py:func:`isNull`
+
+.. seealso:: :py:func:`isEmpty`
+
+.. versionadded:: 3.34
+%End
+
+ void setMinimal() /Deprecated/;
 %Docstring
 Set a rectangle so that min corner is at max
 and max corner is at min. It is NOT normalized.
+
+.. deprecated:: QGIS 3.34
+   - will be removed in QGIS 4.0. Use :py:func:`~QgsRectangle.setNull`.
 %End
 
     double xMaximum() const /HoldGIL/;
@@ -290,15 +306,23 @@ Returns the distance from ``point`` to the nearest point on the boundary of the
 
     bool isEmpty() const;
 %Docstring
-Returns ``True`` if the rectangle is empty.
-An empty rectangle may still be non-null if it contains valid information (e.g. bounding box of a point).
+Returns ``True`` if the rectangle has no area.
+
+An empty rectangle may still be non-null if it contains valid
+spatial information (e.g. bounding box of a point or of a vertical
+or horizontal segment).
+
+.. seealso:: :py:func:`isNull`
 %End
 
     bool isNull() const;
 %Docstring
-Test if the rectangle is null (all coordinates zero or after call to :py:func:`~QgsRectangle.setMinimal`).
+Test if the rectangle is null (holding no spatial information).
+
 A null rectangle is also an empty rectangle.
 
+.. seealso:: :py:func:`setNull`
+
 .. versionadded:: 2.4
 %End
 

diff --git a/src/app/3d/qgs3dmapcanvaswidget.cpp b/src/app/3d/qgs3dmapcanvaswidget.cpp
@@ -604,7 +604,7 @@ void Qgs3DMapCanvasWidget::onViewed2DExtentFrom3DChanged( QVector<QgsPointXY> ex
   if ( mCanvas->map()->viewSyncMode().testFlag( Qgis::ViewSyncModeFlag::Sync2DTo3D ) )
   {
     QgsRectangle extentRect;
-    extentRect.setMinimal();
+    extentRect.setNull();
     for ( QgsPointXY &pt : extent )
     {
       extentRect.include( pt );

diff --git a/src/core/geometry/qgsrectangle.h b/src/core/geometry/qgsrectangle.h
@@ -165,16 +165,31 @@ class CORE_EXPORT QgsRectangle
      */
     void setYMaximum( double y ) SIP_HOLDGIL { mYmax = y; }
 
+    /**
+     * Mark a rectangle as being null (holding no spatial information).
+     *
+     * A null rectangle is also empty by definition.
+     *
+     * \see isNull()
+     * \see isEmpty()
+     *
+     * \since QGIS 3.34
+     */
+    void setNull() SIP_HOLDGIL
+    {
+      mXmin = mYmin = std::numeric_limits<double>::max();
+      mXmax = mYmax = -std::numeric_limits<double>::max();
+    }
+
     /**
      * Set a rectangle so that min corner is at max
      * and max corner is at min. It is NOT normalized.
+     *
+     * \deprecated since QGIS 3.34 - will be removed in QGIS 4.0. Use setNull().
      */
-    void setMinimal() SIP_HOLDGIL
+    Q_DECL_DEPRECATED void setMinimal() SIP_DEPRECATED
     {
-      mXmin = std::numeric_limits<double>::max();
-      mYmin = std::numeric_limits<double>::max();
-      mXmax = -std::numeric_limits<double>::max();
-      mYmax = -std::numeric_limits<double>::max();
+      setNull();
     }
 
     /**
@@ -473,22 +488,32 @@ class CORE_EXPORT QgsRectangle
     QgsRectangle &operator+=( QgsVector v );
 
     /**
-     * Returns TRUE if the rectangle is empty.
-     * An empty rectangle may still be non-null if it contains valid information (e.g. bounding box of a point).
+     * Returns TRUE if the rectangle has no area.
+     *
+     * An empty rectangle may still be non-null if it contains valid
+     * spatial information (e.g. bounding box of a point or of a vertical
+     * or horizontal segment).
+     *
+     * \see isNull()
      */
     bool isEmpty() const
     {
       return mXmax < mXmin || mYmax < mYmin || qgsDoubleNear( mXmax, mXmin ) || qgsDoubleNear( mYmax, mYmin );
     }
 
     /**
-     * Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
+     * Test if the rectangle is null (holding no spatial information).
+     *
      * A null rectangle is also an empty rectangle.
+     *
+     * \see setNull()
+     *
      * \since QGIS 2.4
      */
     bool isNull() const
     {
-      // rectangle created QgsRectangle() or with rect.setMinimal() ?
+      // rectangle created QgsRectangle() or with rect.setNull() or
+      // otherwise having NaN ordinates
       return ( std::isnan( mXmin )  && std::isnan( mXmax ) && std::isnan( mYmin ) && std::isnan( mYmax ) ) ||
              ( qgsDoubleNear( mXmin, 0.0 ) && qgsDoubleNear( mXmax, 0.0 ) && qgsDoubleNear( mYmin, 0.0 ) && qgsDoubleNear( mYmax, 0.0 ) ) ||
              ( qgsDoubleNear( mXmin, std::numeric_limits<double>::max() ) && qgsDoubleNear( mYmin, std::numeric_limits<double>::max() ) &&

diff --git a/src/core/maprenderer/qgsmaprenderercache.cpp b/src/core/maprenderer/qgsmaprenderercache.cpp
@@ -35,7 +35,7 @@ void QgsMapRendererCache::clear()
 
 void QgsMapRendererCache::clearInternal()
 {
-  mExtent.setMinimal();
+  mExtent.setNull();
   mScale = 0;
 
   // make sure we are disconnected from all layers

diff --git a/src/core/mesh/qgsmeshlayer.cpp b/src/core/mesh/qgsmeshlayer.cpp
@@ -153,7 +153,7 @@ QgsRectangle QgsMeshLayer::extent() const
   else
   {
     QgsRectangle rec;
-    rec.setMinimal();
+    rec.setNull();
     return rec;
   }
 }

diff --git a/src/core/mesh/qgstriangularmesh.cpp b/src/core/mesh/qgstriangularmesh.cpp
@@ -187,7 +187,7 @@ bool QgsTriangularMesh::update( QgsMesh *nativeMesh, const QgsCoordinateTransfor
   // TRANSFORM VERTICES
   mCoordinateTransform = transform;
   mTriangularMesh.vertices.resize( nativeMesh->vertices.size() );
-  mExtent.setMinimal();
+  mExtent.setNull();
   for ( int i = 0; i < nativeMesh->vertices.size(); ++i )
   {
     mTriangularMesh.vertices[i] = nativeToTriangularCoordinates( nativeMesh->vertices.at( i ) );
@@ -316,7 +316,7 @@ QgsRectangle QgsTriangularMesh::extent() const
 {
   if ( !mIsExtentValid )
   {
-    mExtent.setMinimal();
+    mExtent.setNull();
     for ( int i = 0; i < mTriangularMesh.vertices.size(); ++i )
       if ( !mTriangularMesh.vertices.at( i ).isEmpty() )
         mExtent.include( mTriangularMesh.vertices.at( i ) );

diff --git a/src/core/proj/qgscoordinatetransform.cpp b/src/core/proj/qgscoordinatetransform.cpp
@@ -616,7 +616,7 @@ QgsRectangle QgsCoordinateTransform::transformBoundingBox( const QgsRectangle &r
   const int nYPoints = std::min( static_cast< int >( std::ceil( ( yMax - yMin ) / dst ) ) + 1, 1000 );
 
   QgsRectangle bb_rect;
-  bb_rect.setMinimal();
+  bb_rect.setNull();
 
   // We're interfacing with C-style vectors in the
   // end, so let's do C-style vectors here too.

diff --git a/src/core/providers/memory/qgsmemoryprovider.cpp b/src/core/providers/memory/qgsmemoryprovider.cpp
@@ -337,7 +337,7 @@ QgsRectangle QgsMemoryProvider::extent() const
 {
   if ( mExtent.isEmpty() && !mFeatures.isEmpty() )
   {
-    mExtent.setMinimal();
+    mExtent.setNull();
     if ( mSubsetString.isEmpty() )
     {
       // fast way - iterate through all features
@@ -361,7 +361,7 @@ QgsRectangle QgsMemoryProvider::extent() const
   }
   else if ( mFeatures.isEmpty() )
   {
-    mExtent.setMinimal();
+    mExtent.setNull();
   }
 
   return mExtent;
@@ -758,7 +758,7 @@ bool QgsMemoryProvider::setSubsetString( const QString &theSQL, bool updateFeatu
 
   mSubsetString = theSQL;
   clearMinMaxCache();
-  mExtent.setMinimal();
+  mExtent.setNull();
 
   emit dataChanged();
   return true;
@@ -795,13 +795,13 @@ bool QgsMemoryProvider::truncate()
 {
   mFeatures.clear();
   clearMinMaxCache();
-  mExtent.setMinimal();
+  mExtent.setNull();
   return true;
 }
 
 void QgsMemoryProvider::updateExtents()
 {
-  mExtent.setMinimal();
+  mExtent.setNull();
 }
 
 QString QgsMemoryProvider::name() const

diff --git a/src/core/providers/meshmemory/qgsmeshmemorydataprovider.cpp b/src/core/providers/meshmemory/qgsmeshmemorydataprovider.cpp
@@ -640,7 +640,7 @@ void QgsMeshMemoryDataProvider::close()
 QgsRectangle QgsMeshMemoryDataProvider::calculateExtent() const
 {
   QgsRectangle rec;
-  rec.setMinimal();
+  rec.setNull();
   for ( const QgsMeshVertex &v : mVertices )
   {
     rec.setXMinimum( std::min( rec.xMinimum(), v.x() ) );

diff --git a/src/core/qgsgeometrysimplifier.cpp b/src/core/qgsgeometrysimplifier.cpp
@@ -28,7 +28,7 @@ bool QgsAbstractGeometrySimplifier::isGeneralizableByDeviceBoundingBox( const Qg
 bool QgsAbstractGeometrySimplifier::isGeneralizableByDeviceBoundingBox( const QVector<QPointF> &points, float mapToPixelTol )
 {
   QgsRectangle r;
-  r.setMinimal();
+  r.setNull();
 
   for ( int i = 0, numPoints = points.size(); i < numPoints; ++i )
   {

diff --git a/src/core/qgsgml.cpp b/src/core/qgsgml.cpp
@@ -61,7 +61,7 @@ QgsGml::QgsGml(
 int QgsGml::getFeatures( const QString &uri, Qgis::WkbType *wkbType, QgsRectangle *extent, const QString &userName, const QString &password, const QString &authcfg )
 {
   //start with empty extent
-  mExtent.setMinimal();
+  mExtent.setNull();
 
   QNetworkRequest request( uri );
   QgsSetRequestInitiatorClass( request, QStringLiteral( "QgsGml" ) );
@@ -178,7 +178,7 @@ int QgsGml::getFeatures( const QString &uri, Qgis::WkbType *wkbType, QgsRectangl
 
 int QgsGml::getFeatures( const QByteArray &data, Qgis::WkbType *wkbType, QgsRectangle *extent )
 {
-  mExtent.setMinimal();
+  mExtent.setNull();
 
   QString errorMsg;
   if ( !mParser.processData( data, true /* atEnd */, errorMsg ) )

diff --git a/src/core/qgsmaplayerutils.cpp b/src/core/qgsmaplayerutils.cpp
@@ -31,7 +31,7 @@ QgsRectangle QgsMapLayerUtils::combinedExtent( const QList<QgsMapLayer *> &layer
 {
   // We can't use a constructor since QgsRectangle normalizes the rectangle upon construction
   QgsRectangle fullExtent;
-  fullExtent.setMinimal();
+  fullExtent.setNull();
 
   // iterate through the map layers and test each layers extent
   // against the current min and max values

diff --git a/src/core/qgsmapsettings.cpp b/src/core/qgsmapsettings.cpp
@@ -692,7 +692,7 @@ QgsRectangle QgsMapSettings::fullExtent() const
   // reset the map canvas extent since the extent may now be smaller
   // We can't use a constructor since QgsRectangle normalizes the rectangle upon construction
   QgsRectangle fullExtent;
-  fullExtent.setMinimal();
+  fullExtent.setNull();
 
   // iterate through the map layers and test each layers extent
   // against the current min and max values

diff --git a/src/core/raster/qgsrasterlayerrenderer.cpp b/src/core/raster/qgsrasterlayerrenderer.cpp
@@ -131,7 +131,7 @@ QgsRasterLayerRenderer::QgsRasterLayerRenderer( QgsRasterLayer *layer, QgsRender
       catch ( QgsCsException &cs )
       {
         QgsMessageLog::logMessage( QObject::tr( "Could not reproject view extent: %1" ).arg( cs.what() ), QObject::tr( "Raster" ) );
-        myProjectedViewExtent.setMinimal();
+        myProjectedViewExtent.setNull();
       }
     }
 
@@ -144,7 +144,7 @@ QgsRasterLayerRenderer::QgsRasterLayerRenderer( QgsRasterLayer *layer, QgsRender
     catch ( QgsCsException &cs )
     {
       QgsMessageLog::logMessage( QObject::tr( "Could not reproject layer extent: %1" ).arg( cs.what() ), QObject::tr( "Raster" ) );
-      myProjectedLayerExtent.setMinimal();
+      myProjectedLayerExtent.setNull();
     }
   }
   else

diff --git a/src/core/vector/qgsvectorlayer.cpp b/src/core/vector/qgsvectorlayer.cpp
@@ -830,7 +830,7 @@ QgsRectangle QgsVectorLayer::boundingBoxOfSelected() const
   }
 
   QgsRectangle r, retval;
-  retval.setMinimal();
+  retval.setNull();
 
   QgsFeature fet;
   if ( mDataProvider->capabilities() & QgsVectorDataProvider::SelectAtId )
@@ -1011,7 +1011,7 @@ QgsRectangle QgsVectorLayer::extent() const
   QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
   QgsRectangle rect;
-  rect.setMinimal();
+  rect.setNull();
 
   if ( !isSpatial() )
     return rect;

diff --git a/src/gui/layertree/qgslayertreeviewdefaultactions.cpp b/src/gui/layertree/qgslayertreeviewdefaultactions.cpp
@@ -372,7 +372,7 @@ void QgsLayerTreeViewDefaultActions::zoomToLayers( QgsMapCanvas *canvas, const Q
   QgsTemporaryCursorOverride cursorOverride( Qt::WaitCursor );
 
   QgsRectangle extent;
-  extent.setMinimal();
+  extent.setNull();
 
   if ( !layers.empty() )
   {

diff --git a/src/gui/qgsexpressionselectiondialog.cpp b/src/gui/qgsexpressionselectiondialog.cpp
@@ -164,7 +164,7 @@ void QgsExpressionSelectionDialog::mButtonZoomToFeatures_clicked()
   QgsFeatureIterator features = mLayer->getFeatures( request );
 
   QgsRectangle bbox;
-  bbox.setMinimal();
+  bbox.setNull();
   QgsFeature feat;
   int featureCount = 0;
   while ( features.nextFeature( feat ) )

diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp
@@ -1790,9 +1790,9 @@ void QgsMapCanvas::zoomToSelected( QgsMapLayer *layer )
 void QgsMapCanvas::zoomToSelected( const QList<QgsMapLayer *> &layers )
 {
   QgsRectangle rect;
-  rect.setMinimal();
+  rect.setNull();
   QgsRectangle selectionExtent;
-  selectionExtent.setMinimal();
+  selectionExtent.setNull();
 
   for ( QgsMapLayer *mapLayer : layers )
   {
@@ -2054,7 +2054,7 @@ void QgsMapCanvas::panToSelected( QgsMapLayer *layer )
 void QgsMapCanvas::panToSelected( const QList<QgsMapLayer *> &layers )
 {
   QgsRectangle selectionExtent;
-  selectionExtent.setMinimal();
+  selectionExtent.setNull();
 
   for ( QgsMapLayer *mapLayer : layers )
   {

diff --git a/src/gui/qgsmapcanvasutils.cpp b/src/gui/qgsmapcanvasutils.cpp
@@ -30,7 +30,7 @@ long QgsMapCanvasUtils::zoomToMatchingFeatures( QgsMapCanvas *canvas, QgsVectorL
   QgsFeatureIterator features = layer->getFeatures( request );
 
   QgsRectangle bbox;
-  bbox.setMinimal();
+  bbox.setNull();
   QgsFeature feat;
   int featureCount = 0;
   while ( features.nextFeature( feat ) )

diff --git a/src/providers/mssql/qgsmssqlprovider.cpp b/src/providers/mssql/qgsmssqlprovider.cpp
@@ -1826,7 +1826,7 @@ bool QgsMssqlProvider::deleteFeatures( const QgsFeatureIds &ids )
 
 void QgsMssqlProvider::updateExtents()
 {
-  mExtent.setMinimal();
+  mExtent.setNull();
 }
 
 QgsVectorDataProvider::Capabilities QgsMssqlProvider::capabilities() const
@@ -2011,7 +2011,7 @@ bool QgsMssqlProvider::setSubsetString( const QString &theSQL, bool )
 
   setDataSourceUri( anUri.uri() );
 
-  mExtent.setMinimal();
+  mExtent.setNull();
 
   emit dataChanged();