LCOV - code coverage report
Current view: top level - core/geometry - qgsrectangle.h (source / functions) Hit Total Coverage
Test: coverage.info.cleaned Lines: 126 188 67.0 %
Date: 2021-04-10 08:29:14 Functions: 0 0 -
Branches: 0 0 -

           Branch data     Line data    Source code
       1                 :            : /***************************************************************************
       2                 :            :                           qgsrectangle.h  -  description
       3                 :            :                              -------------------
       4                 :            :     begin                : Sat Jun 22 2002
       5                 :            :     copyright            : (C) 2002 by Gary E.Sherman
       6                 :            :     email                : sherman at mrcc.com
       7                 :            : ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSRECTANGLE_H
      19                 :            : #define QGSRECTANGLE_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis.h"
      23                 :            : #include <iosfwd>
      24                 :            : #include <QDomDocument>
      25                 :            : #include <QRectF>
      26                 :            : 
      27                 :            : class QString;
      28                 :            : class QRectF;
      29                 :            : class QgsBox3d;
      30                 :            : #include "qgspointxy.h"
      31                 :            : 
      32                 :            : 
      33                 :            : /**
      34                 :            :  * \ingroup core
      35                 :            :  * \brief A rectangle specified with double values.
      36                 :            :  *
      37                 :            :  * QgsRectangle is used to store a rectangle when double values are required.
      38                 :            :  * Examples are storing a layer extent or the current view extent of a map
      39                 :            :  * \see QgsBox3d
      40                 :            :  */
      41                 :            : class CORE_EXPORT QgsRectangle
      42                 :            : {
      43                 :            :   public:
      44                 :            : 
      45                 :            :     //! Constructor for a null rectangle
      46                 :      36003 :     QgsRectangle() = default; // optimised constructor for null rectangle - no need to call normalize here
      47                 :            : 
      48                 :            :     /**
      49                 :            :      * Constructs a QgsRectangle from a set of x and y minimum and maximum coordinates.
      50                 :            :      *
      51                 :            :      * The rectangle will be normalized after creation. Since QGIS 3.20, if \a normalize is FALSE then
      52                 :            :      * the normalization step will not be applied automatically.
      53                 :            :      */
      54                 :       1649 :     explicit QgsRectangle( double xMin, double yMin = 0, double xMax = 0, double yMax = 0, bool normalize = true ) SIP_HOLDGIL
      55                 :       1649 :   : mXmin( xMin )
      56                 :       1649 :     , mYmin( yMin )
      57                 :       1649 :     , mXmax( xMax )
      58                 :       1649 :     , mYmax( yMax )
      59                 :            :     {
      60                 :       1649 :       if ( normalize )
      61                 :        415 :         QgsRectangle::normalize();
      62                 :       1649 :     }
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * Construct a rectangle from two points.
      66                 :            :      *
      67                 :            :      * The rectangle is normalized after construction. Since QGIS 3.20, if \a normalize is FALSE then
      68                 :            :      * the normalization step will not be applied automatically.
      69                 :            :      */
      70                 :         20 :     QgsRectangle( const QgsPointXY &p1, const QgsPointXY &p2, bool normalize = true ) SIP_HOLDGIL
      71                 :            :     {
      72                 :         20 :       set( p1, p2, normalize );
      73                 :         20 :     }
      74                 :            : 
      75                 :            :     /**
      76                 :            :      * Construct a rectangle from a QRectF.
      77                 :            :      *
      78                 :            :      * The rectangle is NOT normalized after construction.
      79                 :            :      */
      80                 :          0 :     QgsRectangle( const QRectF &qRectF ) SIP_HOLDGIL
      81                 :            :     {
      82                 :          0 :       mXmin = qRectF.topLeft().x();
      83                 :          0 :       mYmin = qRectF.topLeft().y();
      84                 :          0 :       mXmax = qRectF.bottomRight().x();
      85                 :          0 :       mYmax = qRectF.bottomRight().y();
      86                 :          0 :     }
      87                 :            : 
      88                 :            :     //! Copy constructor
      89                 :       7034 :     QgsRectangle( const QgsRectangle &other ) SIP_HOLDGIL
      90                 :            :     {
      91                 :       7034 :       mXmin = other.xMinimum();
      92                 :       7034 :       mYmin = other.yMinimum();
      93                 :       7034 :       mXmax = other.xMaximum();
      94                 :       7034 :       mYmax = other.yMaximum();
      95                 :       7034 :     }
      96                 :            : 
      97                 :            :     // IMPORTANT - while QgsRectangle is inherited by QgsReferencedRectangle, we do NOT want a virtual destructor here
      98                 :            :     // because this class MUST be lightweight and we don't want the cost of the vtable here.
      99                 :            :     // see https://github.com/qgis/QGIS/pull/4720#issuecomment-308652392
     100                 :            :     ~QgsRectangle() = default;
     101                 :            : 
     102                 :            :     /**
     103                 :            :     * Creates a new rectangle from a \a wkt string.
     104                 :            :     * The WKT must contain only 5 vertices, representing a rectangle aligned with X and Y axes.
     105                 :            :     * \since QGIS 3.0
     106                 :            :     */
     107                 :            :     static QgsRectangle fromWkt( const QString &wkt );
     108                 :            : 
     109                 :            :     /**
     110                 :            :      * Creates a new rectangle, given the specified \a center point
     111                 :            :      * and \a width and \a height.
     112                 :            :      * \since QGIS 3.0
     113                 :            :      */
     114                 :            :     static QgsRectangle fromCenterAndSize( QgsPointXY center, double width, double height );
     115                 :            : 
     116                 :            :     /**
     117                 :            :      * Sets the rectangle from two QgsPoints.
     118                 :            :      *
     119                 :            :      * The rectangle is normalised after construction. Since QGIS 3.20, if \a normalize is FALSE then
     120                 :            :      * the normalization step will not be applied automatically.
     121                 :            :      */
     122                 :         20 :     void set( const QgsPointXY &p1, const QgsPointXY &p2, bool normalize = true )
     123                 :            :     {
     124                 :         20 :       mXmin = p1.x();
     125                 :         20 :       mXmax = p2.x();
     126                 :         20 :       mYmin = p1.y();
     127                 :         20 :       mYmax = p2.y();
     128                 :         20 :       if ( normalize )
     129                 :         20 :         QgsRectangle::normalize();
     130                 :         20 :     }
     131                 :            : 
     132                 :            :     /**
     133                 :            :      * Sets the rectangle from four points.
     134                 :            :      *
     135                 :            :      * The rectangle is normalised after construction. Since QGIS 3.20, if \a normalize is FALSE then
     136                 :            :      * the normalization step will not be applied automatically.
     137                 :            :      */
     138                 :          4 :     void set( double xMin, double yMin, double xMax, double yMax, bool normalize = true )
     139                 :            :     {
     140                 :          4 :       mXmin = xMin;
     141                 :          4 :       mYmin = yMin;
     142                 :          4 :       mXmax = xMax;
     143                 :          4 :       mYmax = yMax;
     144                 :          4 :       if ( normalize )
     145                 :          4 :         QgsRectangle::normalize();
     146                 :          4 :     }
     147                 :            : 
     148                 :            :     /**
     149                 :            :      * Set the minimum x value.
     150                 :            :      */
     151                 :          0 :     void setXMinimum( double x ) SIP_HOLDGIL { mXmin = x; }
     152                 :            : 
     153                 :            :     /**
     154                 :            :      * Set the maximum x value.
     155                 :            :      */
     156                 :          0 :     void setXMaximum( double x ) SIP_HOLDGIL { mXmax = x; }
     157                 :            : 
     158                 :            :     /**
     159                 :            :      * Set the minimum y value.
     160                 :            :      */
     161                 :          0 :     void setYMinimum( double y ) SIP_HOLDGIL { mYmin = y; }
     162                 :            : 
     163                 :            :     /**
     164                 :            :      * Set the maximum y value.
     165                 :            :      */
     166                 :          0 :     void setYMaximum( double y ) SIP_HOLDGIL { mYmax = y; }
     167                 :            : 
     168                 :            :     /**
     169                 :            :      * Set a rectangle so that min corner is at max
     170                 :            :      * and max corner is at min. It is NOT normalized.
     171                 :            :      */
     172                 :         88 :     void setMinimal() SIP_HOLDGIL
     173                 :            :     {
     174                 :         88 :       mXmin = std::numeric_limits<double>::max();
     175                 :         88 :       mYmin = std::numeric_limits<double>::max();
     176                 :         88 :       mXmax = -std::numeric_limits<double>::max();
     177                 :         88 :       mYmax = -std::numeric_limits<double>::max();
     178                 :         88 :     }
     179                 :            : 
     180                 :            :     /**
     181                 :            :      * Returns the x maximum value (right side of rectangle).
     182                 :            :      */
     183                 :      32581 :     double xMaximum() const SIP_HOLDGIL { return mXmax; }
     184                 :            : 
     185                 :            :     /**
     186                 :            :      * Returns the x minimum value (left side of rectangle).
     187                 :            :      */
     188                 :     152996 :     double xMinimum() const SIP_HOLDGIL { return mXmin; }
     189                 :            : 
     190                 :            :     /**
     191                 :            :      * Returns the y maximum value (top side of rectangle).
     192                 :            :      */
     193                 :      32529 :     double yMaximum() const SIP_HOLDGIL { return mYmax; }
     194                 :            : 
     195                 :            :     /**
     196                 :            :      * Returns the y minimum value (bottom side of rectangle).
     197                 :            :      */
     198                 :     152997 :     double yMinimum() const SIP_HOLDGIL { return mYmin; }
     199                 :            : 
     200                 :            :     /**
     201                 :            :      * Normalize the rectangle so it has non-negative width/height.
     202                 :            :      */
     203                 :        439 :     void normalize()
     204                 :            :     {
     205                 :        439 :       if ( isNull() )
     206                 :         17 :         return;
     207                 :            : 
     208                 :        422 :       if ( mXmin > mXmax )
     209                 :            :       {
     210                 :          3 :         std::swap( mXmin, mXmax );
     211                 :          3 :       }
     212                 :        422 :       if ( mYmin > mYmax )
     213                 :            :       {
     214                 :          1 :         std::swap( mYmin, mYmax );
     215                 :          1 :       }
     216                 :        439 :     }
     217                 :            : 
     218                 :            :     /**
     219                 :            :      * Returns the width of the rectangle.
     220                 :            :      * \see height()
     221                 :            :      * \see area()
     222                 :            :      */
     223                 :        100 :     double width() const SIP_HOLDGIL { return mXmax - mXmin; }
     224                 :            : 
     225                 :            :     /**
     226                 :            :      * Returns the height of the rectangle.
     227                 :            :      * \see width()
     228                 :            :      * \see area()
     229                 :            :      */
     230                 :        100 :     double height() const SIP_HOLDGIL { return mYmax - mYmin; }
     231                 :            : 
     232                 :            :     /**
     233                 :            :      * Returns the area of the rectangle.
     234                 :            :      * \see width()
     235                 :            :      * \see height()
     236                 :            :      * \see perimeter()
     237                 :            :      * \since QGIS 3.0
     238                 :            :      */
     239                 :          0 :     double area() const SIP_HOLDGIL { return ( mXmax - mXmin ) * ( mYmax - mYmin ); }
     240                 :            : 
     241                 :            :     /**
     242                 :            :      * Returns the perimeter of the rectangle.
     243                 :            :      * \see area()
     244                 :            :      * \since QGIS 3.0
     245                 :            :      */
     246                 :          0 :     double perimeter() const SIP_HOLDGIL { return 2 * ( mXmax - mXmin ) + 2 * ( mYmax - mYmin ); }
     247                 :            : 
     248                 :            :     /**
     249                 :            :      * Returns the center point of the rectangle.
     250                 :            :      */
     251                 :         54 :     QgsPointXY center() const SIP_HOLDGIL { return QgsPointXY( mXmax * 0.5 + mXmin * 0.5, mYmin * 0.5 + mYmax * 0.5 ); }
     252                 :            : 
     253                 :            :     /**
     254                 :            :      * Scale the rectangle around its center point.
     255                 :            :      */
     256                 :          0 :     void scale( double scaleFactor, const QgsPointXY *c = nullptr )
     257                 :            :     {
     258                 :            :       // scale from the center
     259                 :            :       double centerX, centerY;
     260                 :          0 :       if ( c )
     261                 :            :       {
     262                 :          0 :         centerX = c->x();
     263                 :          0 :         centerY = c->y();
     264                 :          0 :       }
     265                 :            :       else
     266                 :            :       {
     267                 :          0 :         centerX = mXmin + width() / 2;
     268                 :          0 :         centerY = mYmin + height() / 2;
     269                 :            :       }
     270                 :          0 :       scale( scaleFactor, centerX, centerY );
     271                 :          0 :     }
     272                 :            : 
     273                 :            :     /**
     274                 :            :      * Scale the rectangle around its center point.
     275                 :            :      */
     276                 :          0 :     void scale( double scaleFactor, double centerX, double centerY )
     277                 :            :     {
     278                 :          0 :       double newWidth = width() * scaleFactor;
     279                 :          0 :       double newHeight = height() * scaleFactor;
     280                 :          0 :       mXmin = centerX - newWidth / 2.0;
     281                 :          0 :       mXmax = centerX + newWidth / 2.0;
     282                 :          0 :       mYmin = centerY - newHeight / 2.0;
     283                 :          0 :       mYmax = centerY + newHeight / 2.0;
     284                 :          0 :     }
     285                 :            : 
     286                 :            :     /**
     287                 :            :      * Scale the rectangle around its \a center point.
     288                 :            :      * \since QGIS 3.4
     289                 :            :      */
     290                 :            :     QgsRectangle scaled( double scaleFactor, const QgsPointXY *center = nullptr ) const;
     291                 :            : 
     292                 :            :     /**
     293                 :            :      * Grows the rectangle in place by the specified amount.
     294                 :            :      * \see buffered()
     295                 :            :      */
     296                 :         67 :     void grow( double delta )
     297                 :            :     {
     298                 :         67 :       mXmin -= delta;
     299                 :         67 :       mXmax += delta;
     300                 :         67 :       mYmin -= delta;
     301                 :         67 :       mYmax += delta;
     302                 :         67 :     }
     303                 :            : 
     304                 :            :     /**
     305                 :            :      * Updates the rectangle to include the specified point.
     306                 :            :      */
     307                 :          0 :     void include( const QgsPointXY &p )
     308                 :            :     {
     309                 :          0 :       if ( p.x() < xMinimum() )
     310                 :          0 :         setXMinimum( p.x() );
     311                 :          0 :       else if ( p.x() > xMaximum() )
     312                 :          0 :         setXMaximum( p.x() );
     313                 :          0 :       if ( p.y() < yMinimum() )
     314                 :          0 :         setYMinimum( p.y() );
     315                 :          0 :       if ( p.y() > yMaximum() )
     316                 :          0 :         setYMaximum( p.y() );
     317                 :          0 :     }
     318                 :            : 
     319                 :            :     /**
     320                 :            :      * Gets rectangle enlarged by buffer.
     321                 :            :      * \note In earlier QGIS releases this method was named buffer().
     322                 :            :      * \see grow()
     323                 :            :      * \since QGIS 3.0
     324                 :            :     */
     325                 :          0 :     QgsRectangle buffered( double width ) const
     326                 :            :     {
     327                 :          0 :       return QgsRectangle( mXmin - width, mYmin - width, mXmax + width, mYmax + width );
     328                 :            :     }
     329                 :            : 
     330                 :            :     /**
     331                 :            :      * Returns the intersection with the given rectangle.
     332                 :            :      */
     333                 :          0 :     QgsRectangle intersect( const QgsRectangle &rect ) const
     334                 :            :     {
     335                 :          0 :       QgsRectangle intersection = QgsRectangle();
     336                 :          0 :       if ( intersects( rect ) )
     337                 :            :       {
     338                 :          0 :         intersection.setXMinimum( mXmin > rect.xMinimum() ? mXmin : rect.xMinimum() );
     339                 :          0 :         intersection.setXMaximum( mXmax < rect.xMaximum() ? mXmax : rect.xMaximum() );
     340                 :          0 :         intersection.setYMinimum( mYmin > rect.yMinimum() ? mYmin : rect.yMinimum() );
     341                 :          0 :         intersection.setYMaximum( mYmax < rect.yMaximum() ? mYmax : rect.yMaximum() );
     342                 :          0 :       }
     343                 :          0 :       return intersection;
     344                 :            :     }
     345                 :            : 
     346                 :            :     /**
     347                 :            :      * Returns TRUE when rectangle intersects with other rectangle.
     348                 :            :      */
     349                 :         22 :     bool intersects( const QgsRectangle &rect ) const SIP_HOLDGIL
     350                 :            :     {
     351                 :         22 :       double x1 = ( mXmin > rect.mXmin ? mXmin : rect.mXmin );
     352                 :         22 :       double x2 = ( mXmax < rect.mXmax ? mXmax : rect.mXmax );
     353                 :         22 :       if ( x1 > x2 )
     354                 :         15 :         return false;
     355                 :          7 :       double y1 = ( mYmin > rect.mYmin ? mYmin : rect.mYmin );
     356                 :          7 :       double y2 = ( mYmax < rect.mYmax ? mYmax : rect.mYmax );
     357                 :          7 :       return y1 <= y2;
     358                 :         22 :     }
     359                 :            : 
     360                 :            :     /**
     361                 :            :      * Returns TRUE when rectangle contains other rectangle.
     362                 :            :      */
     363                 :          0 :     bool contains( const QgsRectangle &rect ) const SIP_HOLDGIL
     364                 :            :     {
     365                 :          0 :       return ( rect.mXmin >= mXmin && rect.mXmax <= mXmax && rect.mYmin >= mYmin && rect.mYmax <= mYmax );
     366                 :            :     }
     367                 :            : 
     368                 :            :     /**
     369                 :            :      * Returns TRUE when rectangle contains a point.
     370                 :            :      */
     371                 :          0 :     bool contains( const QgsPointXY &p ) const SIP_HOLDGIL
     372                 :            :     {
     373                 :          0 :       return mXmin <= p.x() && p.x() <= mXmax &&
     374                 :          0 :              mYmin <= p.y() && p.y() <= mYmax;
     375                 :            :     }
     376                 :            : 
     377                 :            :     /**
     378                 :            :      * Returns TRUE when rectangle contains the point at (\a x, \a y).
     379                 :            :      *
     380                 :            :      * \since QGIS 3.20
     381                 :            :      */
     382                 :         19 :     bool contains( double x, double y ) const SIP_HOLDGIL
     383                 :            :     {
     384                 :         26 :       return mXmin <= x && x <= mXmax &&
     385                 :          7 :              mYmin <= y && y <= mYmax;
     386                 :            :     }
     387                 :            : 
     388                 :            :     /**
     389                 :            :      * Expands the rectangle so that it covers both the original rectangle and the given rectangle.
     390                 :            :      */
     391                 :        148 :     void combineExtentWith( const QgsRectangle &rect )
     392                 :            :     {
     393                 :        148 :       if ( isNull() )
     394                 :         16 :         *this = rect;
     395                 :        132 :       else if ( !rect.isNull() )
     396                 :            :       {
     397                 :        132 :         mXmin = std::min( mXmin, rect.xMinimum() );
     398                 :        132 :         mXmax = std::max( mXmax, rect.xMaximum() );
     399                 :        132 :         mYmin = std::min( mYmin, rect.yMinimum() );
     400                 :        132 :         mYmax = std::max( mYmax, rect.yMaximum() );
     401                 :        132 :       }
     402                 :        148 :     }
     403                 :            : 
     404                 :            :     /**
     405                 :            :      * Expands the rectangle so that it covers both the original rectangle and the given point.
     406                 :            :      */
     407                 :        113 :     void combineExtentWith( double x, double y )
     408                 :            :     {
     409                 :        113 :       if ( isNull() )
     410                 :         11 :         *this = QgsRectangle( x, y, x, y );
     411                 :            :       else
     412                 :            :       {
     413                 :        102 :         mXmin = ( ( mXmin < x ) ? mXmin : x );
     414                 :        102 :         mXmax = ( ( mXmax > x ) ? mXmax : x );
     415                 :            : 
     416                 :        102 :         mYmin = ( ( mYmin < y ) ? mYmin : y );
     417                 :        102 :         mYmax = ( ( mYmax > y ) ? mYmax : y );
     418                 :            :       }
     419                 :        113 :     }
     420                 :            : 
     421                 :            :     /**
     422                 :            :      * Expands the rectangle so that it covers both the original rectangle and the given point.
     423                 :            :      * \since QGIS 3.2
     424                 :            :      */
     425                 :          4 :     void combineExtentWith( const QgsPointXY &point )
     426                 :            :     {
     427                 :          4 :       combineExtentWith( point.x(), point.y() );
     428                 :          4 :     }
     429                 :            : 
     430                 :            :     /**
     431                 :            :      * Returns the distance from \a point to the nearest point on the boundary of the rectangle.
     432                 :            :      * \since QGIS 3.14
     433                 :            :      */
     434                 :            :     double distance( const QgsPointXY &point ) const
     435                 :            :     {
     436                 :            :       const double dx = std::max( std::max( mXmin - point.x(), 0.0 ), point.x() - mXmax );
     437                 :            :       const double dy = std::max( std::max( mYmin - point.y(), 0.0 ), point.y() - mYmax );
     438                 :            :       return std::sqrt( dx * dx + dy * dy );
     439                 :            :     }
     440                 :            : 
     441                 :            :     /**
     442                 :            :      * Returns a rectangle offset from this one in the direction of the reversed vector.
     443                 :            :      * \since QGIS 3.0
     444                 :            :      */
     445                 :            :     QgsRectangle operator-( QgsVector v ) const;
     446                 :            : 
     447                 :            :     /**
     448                 :            :      * Returns a rectangle offset from this one in the direction of the vector.
     449                 :            :      * \since QGIS 3.0
     450                 :            :      */
     451                 :            :     QgsRectangle operator+( QgsVector v ) const;
     452                 :            : 
     453                 :            :     /**
     454                 :            :      * Moves this rectangle in the direction of the reversed vector.
     455                 :            :      * \since QGIS 3.0
     456                 :            :      */
     457                 :            :     QgsRectangle &operator-=( QgsVector v );
     458                 :            : 
     459                 :            :     /**
     460                 :            :      * Moves this rectangle in the direction of the vector.
     461                 :            :      * \since QGIS 3.0
     462                 :            :      */
     463                 :            :     QgsRectangle &operator+=( QgsVector v );
     464                 :            : 
     465                 :            :     /**
     466                 :            :      * Returns TRUE if the rectangle is empty.
     467                 :            :      * An empty rectangle may still be non-null if it contains valid information (e.g. bounding box of a point).
     468                 :            :      */
     469                 :         16 :     bool isEmpty() const
     470                 :            :     {
     471                 :         16 :       return mXmax < mXmin || mYmax < mYmin || qgsDoubleNear( mXmax, mXmin ) || qgsDoubleNear( mYmax, mYmin );
     472                 :            :     }
     473                 :            : 
     474                 :            :     /**
     475                 :            :      * Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
     476                 :            :      * A null rectangle is also an empty rectangle.
     477                 :            :      * \since QGIS 2.4
     478                 :            :      */
     479                 :       8985 :     bool isNull() const
     480                 :            :     {
     481                 :            :       // rectangle created QgsRectangle() or with rect.setMinimal() ?
     482                 :      10475 :       return ( qgsDoubleNear( mXmin, 0.0 ) && qgsDoubleNear( mXmax, 0.0 ) && qgsDoubleNear( mYmin, 0.0 ) && qgsDoubleNear( mYmax, 0.0 ) ) ||
     483                 :       1490 :              ( qgsDoubleNear( mXmin, std::numeric_limits<double>::max() ) && qgsDoubleNear( mYmin, std::numeric_limits<double>::max() ) &&
     484                 :          0 :                qgsDoubleNear( mXmax, -std::numeric_limits<double>::max() ) && qgsDoubleNear( mYmax, -std::numeric_limits<double>::max() ) );
     485                 :            :     }
     486                 :            : 
     487                 :            :     /**
     488                 :            :      * Returns a string representation of the rectangle in WKT format.
     489                 :            :      */
     490                 :            :     QString asWktCoordinates() const;
     491                 :            : 
     492                 :            :     /**
     493                 :            :      * Returns a string representation of the rectangle as a WKT Polygon.
     494                 :            :      */
     495                 :            :     QString asWktPolygon() const;
     496                 :            : 
     497                 :            :     /**
     498                 :            :      * Returns a QRectF with same coordinates as the rectangle.
     499                 :            :      */
     500                 :          0 :     QRectF toRectF() const
     501                 :            :     {
     502                 :          0 :       return QRectF( static_cast< qreal >( mXmin ), static_cast< qreal >( mYmin ), static_cast< qreal >( mXmax - mXmin ), static_cast< qreal >( mYmax - mYmin ) );
     503                 :            :     }
     504                 :            : 
     505                 :            :     /**
     506                 :            :      * Returns a string representation of form xmin,ymin : xmax,ymax
     507                 :            :      * Coordinates will be truncated to the specified precision.
     508                 :            :      * If the specified precision is less than 0, a suitable minimum precision is used.
     509                 :            :      */
     510                 :            :     QString toString( int precision = 16 ) const;
     511                 :            : 
     512                 :            :     /**
     513                 :            :      * Returns the rectangle as a polygon.
     514                 :            :      */
     515                 :            :     QString asPolygon() const;
     516                 :            : 
     517                 :            :     /**
     518                 :            :      * Comparison operator
     519                 :            :      * \returns TRUE if rectangles are equal
     520                 :            :      */
     521                 :         91 :     bool operator==( const QgsRectangle &r1 ) const
     522                 :            :     {
     523                 :        153 :       return qgsDoubleNear( r1.xMaximum(), xMaximum() ) &&
     524                 :         62 :              qgsDoubleNear( r1.xMinimum(), xMinimum() ) &&
     525                 :         62 :              qgsDoubleNear( r1.yMaximum(), yMaximum() ) &&
     526                 :         62 :              qgsDoubleNear( r1.yMinimum(), yMinimum() );
     527                 :            :     }
     528                 :            : 
     529                 :            :     /**
     530                 :            :      * Comparison operator
     531                 :            :      * \returns FALSE if rectangles are equal
     532                 :            :      */
     533                 :          5 :     bool operator!=( const QgsRectangle &r1 ) const
     534                 :            :     {
     535                 :          5 :       return ( ! operator==( r1 ) );
     536                 :            :     }
     537                 :            : 
     538                 :            :     /**
     539                 :            :      * Assignment operator
     540                 :            :      * \param r1 QgsRectangle to assign from
     541                 :            :      */
     542                 :      23420 :     QgsRectangle &operator=( const QgsRectangle &r1 )
     543                 :            :     {
     544                 :      23420 :       if ( &r1 != this )
     545                 :            :       {
     546                 :      23420 :         mXmax = r1.xMaximum();
     547                 :      23420 :         mXmin = r1.xMinimum();
     548                 :      23420 :         mYmax = r1.yMaximum();
     549                 :      23420 :         mYmin = r1.yMinimum();
     550                 :      23420 :       }
     551                 :            : 
     552                 :      23420 :       return *this;
     553                 :            :     }
     554                 :            : 
     555                 :            :     /**
     556                 :            :      * Returns TRUE if the rectangle has finite boundaries. Will
     557                 :            :      * return FALSE if any of the rectangle boundaries are NaN or Inf.
     558                 :            :      */
     559                 :       1191 :     bool isFinite() const
     560                 :            :     {
     561                 :       1191 :       if ( std::isinf( mXmin ) || std::isinf( mYmin ) || std::isinf( mXmax ) || std::isinf( mYmax ) )
     562                 :            :       {
     563                 :          0 :         return false;
     564                 :            :       }
     565                 :       1191 :       if ( std::isnan( mXmin ) || std::isnan( mYmin ) || std::isnan( mXmax ) || std::isnan( mYmax ) )
     566                 :            :       {
     567                 :          0 :         return false;
     568                 :            :       }
     569                 :       1191 :       return true;
     570                 :       1191 :     }
     571                 :            : 
     572                 :            :     /**
     573                 :            :      * Swap x/y coordinates in the rectangle.
     574                 :            :      */
     575                 :            :     void invert()
     576                 :            :     {
     577                 :            :       std::swap( mXmin, mYmin );
     578                 :            :       std::swap( mXmax, mYmax );
     579                 :            :     }
     580                 :            : 
     581                 :            :     /**
     582                 :            :      * Converts the rectangle to a 3D box, with the specified
     583                 :            :      * \a zMin and \a zMax z values.
     584                 :            :      * \since QGIS 3.0
     585                 :            :      */
     586                 :            :     QgsBox3d toBox3d( double zMin, double zMax ) const;
     587                 :            : 
     588                 :            :     //! Allows direct construction of QVariants from rectangles.
     589                 :          0 :     operator QVariant() const
     590                 :            :     {
     591                 :          0 :       return QVariant::fromValue( *this );
     592                 :            :     }
     593                 :            : 
     594                 :            :     /**
     595                 :            :      * Returns a copy of this rectangle that is snapped to a grid with
     596                 :            :      * the specified \a spacing between the grid lines.
     597                 :            :      *
     598                 :            :      * \since QGIS 3.4
     599                 :            :      */
     600                 :            :     QgsRectangle snappedToGrid( double spacing ) const;
     601                 :            : 
     602                 :            : #ifdef SIP_RUN
     603                 :            :     SIP_PYOBJECT __repr__();
     604                 :            :     % MethodCode
     605                 :            :     QString str = QStringLiteral( "<QgsRectangle: %1>" ).arg( sipCpp->asWktCoordinates() );
     606                 :            :     sipRes = PyUnicode_FromString( str.toUtf8().constData() );
     607                 :            :     % End
     608                 :            : #endif
     609                 :            : 
     610                 :            :   private:
     611                 :            : 
     612                 :      43057 :     double mXmin = 0.0;
     613                 :      43057 :     double mYmin = 0.0;
     614                 :      43057 :     double mXmax = 0.0;
     615                 :      43057 :     double mYmax = 0.0;
     616                 :            : 
     617                 :            : };
     618                 :            : 
     619                 :          5 : Q_DECLARE_METATYPE( QgsRectangle )
     620                 :            : 
     621                 :            : #ifndef SIP_RUN
     622                 :            : 
     623                 :            : /**
     624                 :            :  * Writes the list rectangle to stream out. QGIS version compatibility is not guaranteed.
     625                 :            :  */
     626                 :            : CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsRectangle &rectangle );
     627                 :            : 
     628                 :            : /**
     629                 :            :  * Reads a rectangle from stream in into rectangle. QGIS version compatibility is not guaranteed.
     630                 :            :  */
     631                 :            : CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsRectangle &rectangle );
     632                 :            : 
     633                 :            : inline std::ostream &operator << ( std::ostream &os, const QgsRectangle &r )
     634                 :            : {
     635                 :            :   return os << r.toString().toLocal8Bit().data();
     636                 :            : }
     637                 :            : 
     638                 :            : #endif
     639                 :            : 
     640                 :            : #endif // QGSRECTANGLE_H

Generated by: LCOV version 1.14