QGIS API Documentation  3.5.0-Master (dabd649)
qgsrectangle.h
Go to the documentation of this file.
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 
41 class CORE_EXPORT QgsRectangle
42 {
43  public:
44 
46  QgsRectangle() = default; // optimised constructor for null rectangle - no need to call normalize here
47 
49  explicit QgsRectangle( double xMin, double yMin = 0, double xMax = 0, double yMax = 0 )
50  : mXmin( xMin )
51  , mYmin( yMin )
52  , mXmax( xMax )
53  , mYmax( yMax )
54  {
55  normalize();
56  }
57 
59  QgsRectangle( const QgsPointXY &p1, const QgsPointXY &p2 )
60  {
61  set( p1, p2 );
62  }
63 
65  QgsRectangle( const QRectF &qRectF )
66  {
67  mXmin = qRectF.topLeft().x();
68  mYmin = qRectF.topLeft().y();
69  mXmax = qRectF.bottomRight().x();
70  mYmax = qRectF.bottomRight().y();
71  }
72 
74  QgsRectangle( const QgsRectangle &other )
75  {
76  mXmin = other.xMinimum();
77  mYmin = other.yMinimum();
78  mXmax = other.xMaximum();
79  mYmax = other.yMaximum();
80  }
81 
82  // IMPORTANT - while QgsRectangle is inherited by QgsReferencedRectangle, we do NOT want a virtual destructor here
83  // because this class MUST be lightweight and we don't want the cost of the vtable here.
84  // see https://github.com/qgis/QGIS/pull/4720#issuecomment-308652392
85  ~QgsRectangle() = default;
86 
92  static QgsRectangle fromWkt( const QString &wkt );
93 
99  static QgsRectangle fromCenterAndSize( QgsPointXY center, double width, double height );
100 
105  void set( const QgsPointXY &p1, const QgsPointXY &p2 )
106  {
107  mXmin = p1.x();
108  mXmax = p2.x();
109  mYmin = p1.y();
110  mYmax = p2.y();
111  normalize();
112  }
113 
118  void set( double xMin, double yMin, double xMax, double yMax )
119  {
120  mXmin = xMin;
121  mYmin = yMin;
122  mXmax = xMax;
123  mYmax = yMax;
124  normalize();
125  }
126 
130  void setXMinimum( double x ) { mXmin = x; }
131 
135  void setXMaximum( double x ) { mXmax = x; }
136 
140  void setYMinimum( double y ) { mYmin = y; }
141 
145  void setYMaximum( double y ) { mYmax = y; }
146 
151  void setMinimal()
152  {
153  mXmin = std::numeric_limits<double>::max();
154  mYmin = std::numeric_limits<double>::max();
155  mXmax = -std::numeric_limits<double>::max();
156  mYmax = -std::numeric_limits<double>::max();
157  }
158 
162  double xMaximum() const { return mXmax; }
163 
167  double xMinimum() const { return mXmin; }
168 
172  double yMaximum() const { return mYmax; }
173 
177  double yMinimum() const { return mYmin; }
178 
182  void normalize()
183  {
184  if ( isNull() )
185  return;
186 
187  if ( mXmin > mXmax )
188  {
189  std::swap( mXmin, mXmax );
190  }
191  if ( mYmin > mYmax )
192  {
193  std::swap( mYmin, mYmax );
194  }
195  }
196 
202  double width() const { return mXmax - mXmin; }
203 
209  double height() const { return mYmax - mYmin; }
210 
218  double area() const { return ( mXmax - mXmin ) * ( mYmax - mYmin ); }
219 
225  double perimeter() const { return 2 * ( mXmax - mXmin ) + 2 * ( mYmax - mYmin ); }
226 
230  QgsPointXY center() const { return QgsPointXY( mXmin + width() / 2, mYmin + height() / 2 ); }
231 
235  void scale( double scaleFactor, const QgsPointXY *c = nullptr )
236  {
237  // scale from the center
238  double centerX, centerY;
239  if ( c )
240  {
241  centerX = c->x();
242  centerY = c->y();
243  }
244  else
245  {
246  centerX = mXmin + width() / 2;
247  centerY = mYmin + height() / 2;
248  }
249  scale( scaleFactor, centerX, centerY );
250  }
251 
255  void scale( double scaleFactor, double centerX, double centerY )
256  {
257  double newWidth = width() * scaleFactor;
258  double newHeight = height() * scaleFactor;
259  mXmin = centerX - newWidth / 2.0;
260  mXmax = centerX + newWidth / 2.0;
261  mYmin = centerY - newHeight / 2.0;
262  mYmax = centerY + newHeight / 2.0;
263  }
264 
269  QgsRectangle scaled( double scaleFactor, const QgsPointXY *center = nullptr ) const;
270 
275  void grow( double delta )
276  {
277  mXmin -= delta;
278  mXmax += delta;
279  mYmin -= delta;
280  mYmax += delta;
281  }
282 
286  void include( const QgsPointXY &p )
287  {
288  if ( p.x() < xMinimum() )
289  setXMinimum( p.x() );
290  else if ( p.x() > xMaximum() )
291  setXMaximum( p.x() );
292  if ( p.y() < yMinimum() )
293  setYMinimum( p.y() );
294  if ( p.y() > yMaximum() )
295  setYMaximum( p.y() );
296  }
297 
304  QgsRectangle buffered( double width ) const
305  {
306  return QgsRectangle( mXmin - width, mYmin - width, mXmax + width, mYmax + width );
307  }
308 
312  QgsRectangle intersect( const QgsRectangle &rect ) const
313  {
314  QgsRectangle intersection = QgsRectangle();
315  if ( intersects( rect ) )
316  {
317  intersection.setXMinimum( mXmin > rect.xMinimum() ? mXmin : rect.xMinimum() );
318  intersection.setXMaximum( mXmax < rect.xMaximum() ? mXmax : rect.xMaximum() );
319  intersection.setYMinimum( mYmin > rect.yMinimum() ? mYmin : rect.yMinimum() );
320  intersection.setYMaximum( mYmax < rect.yMaximum() ? mYmax : rect.yMaximum() );
321  }
322  return intersection;
323  }
324 
328  bool intersects( const QgsRectangle &rect ) const
329  {
330  double x1 = ( mXmin > rect.mXmin ? mXmin : rect.mXmin );
331  double x2 = ( mXmax < rect.mXmax ? mXmax : rect.mXmax );
332  if ( x1 > x2 )
333  return false;
334  double y1 = ( mYmin > rect.mYmin ? mYmin : rect.mYmin );
335  double y2 = ( mYmax < rect.mYmax ? mYmax : rect.mYmax );
336  return y1 <= y2;
337  }
338 
342  bool contains( const QgsRectangle &rect ) const
343  {
344  return ( rect.mXmin >= mXmin && rect.mXmax <= mXmax && rect.mYmin >= mYmin && rect.mYmax <= mYmax );
345  }
346 
350  bool contains( const QgsPointXY &p ) const
351  {
352  return mXmin <= p.x() && p.x() <= mXmax &&
353  mYmin <= p.y() && p.y() <= mYmax;
354  }
355 
359  void combineExtentWith( const QgsRectangle &rect )
360  {
361  if ( isNull() )
362  *this = rect;
363  else if ( !rect.isNull() )
364  {
365  mXmin = std::min( mXmin, rect.xMinimum() );
366  mXmax = std::max( mXmax, rect.xMaximum() );
367  mYmin = std::min( mYmin, rect.yMinimum() );
368  mYmax = std::max( mYmax, rect.yMaximum() );;
369  }
370  }
371 
375  void combineExtentWith( double x, double y )
376  {
377  if ( isNull() )
378  *this = QgsRectangle( x, y, x, y );
379  else
380  {
381  mXmin = ( ( mXmin < x ) ? mXmin : x );
382  mXmax = ( ( mXmax > x ) ? mXmax : x );
383 
384  mYmin = ( ( mYmin < y ) ? mYmin : y );
385  mYmax = ( ( mYmax > y ) ? mYmax : y );
386  }
387  }
388 
393  void combineExtentWith( const QgsPointXY &point )
394  {
395  combineExtentWith( point.x(), point.y() );
396  }
397 
402  QgsRectangle operator-( QgsVector v ) const;
403 
408  QgsRectangle operator+( QgsVector v ) const;
409 
414  QgsRectangle &operator-=( QgsVector v );
415 
420  QgsRectangle &operator+=( QgsVector v );
421 
426  bool isEmpty() const
427  {
428  return mXmax < mXmin || mYmax < mYmin || qgsDoubleNear( mXmax, mXmin ) || qgsDoubleNear( mYmax, mYmin );
429  }
430 
436  bool isNull() const
437  {
438  // rectangle created QgsRectangle() or with rect.setMinimal() ?
439  return ( qgsDoubleNear( mXmin, 0.0 ) && qgsDoubleNear( mXmax, 0.0 ) && qgsDoubleNear( mYmin, 0.0 ) && qgsDoubleNear( mYmax, 0.0 ) ) ||
440  ( qgsDoubleNear( mXmin, std::numeric_limits<double>::max() ) && qgsDoubleNear( mYmin, std::numeric_limits<double>::max() ) &&
441  qgsDoubleNear( mXmax, -std::numeric_limits<double>::max() ) && qgsDoubleNear( mYmax, -std::numeric_limits<double>::max() ) );
442  }
443 
447  QString asWktCoordinates() const;
448 
452  QString asWktPolygon() const;
453 
457  QRectF toRectF() const
458  {
459  return QRectF( static_cast< qreal >( mXmin ), static_cast< qreal >( mYmin ), static_cast< qreal >( mXmax - mXmin ), static_cast< qreal >( mYmax - mYmin ) );
460  }
461 
467  QString toString( int precision = 16 ) const;
468 
472  QString asPolygon() const;
473 
478  bool operator==( const QgsRectangle &r1 ) const
479  {
480  return qgsDoubleNear( r1.xMaximum(), xMaximum() ) &&
481  qgsDoubleNear( r1.xMinimum(), xMinimum() ) &&
482  qgsDoubleNear( r1.yMaximum(), yMaximum() ) &&
483  qgsDoubleNear( r1.yMinimum(), yMinimum() );
484  }
485 
490  bool operator!=( const QgsRectangle &r1 ) const
491  {
492  return ( ! operator==( r1 ) );
493  }
494 
500  {
501  if ( &r1 != this )
502  {
503  mXmax = r1.xMaximum();
504  mXmin = r1.xMinimum();
505  mYmax = r1.yMaximum();
506  mYmin = r1.yMinimum();
507  }
508 
509  return *this;
510  }
511 
516  bool isFinite() const
517  {
518  if ( std::isinf( mXmin ) || std::isinf( mYmin ) || std::isinf( mXmax ) || std::isinf( mYmax ) )
519  {
520  return false;
521  }
522  if ( std::isnan( mXmin ) || std::isnan( mYmin ) || std::isnan( mXmax ) || std::isnan( mYmax ) )
523  {
524  return false;
525  }
526  return true;
527  }
528 
532  void invert()
533  {
534  std::swap( mXmin, mYmin );
535  std::swap( mXmax, mYmax );
536  }
537 
543  QgsBox3d toBox3d( double zMin, double zMax ) const;
544 
546  operator QVariant() const
547  {
548  return QVariant::fromValue( *this );
549  }
550 
557  QgsRectangle snappedToGrid( double spacing ) const;
558 
559 #ifdef SIP_RUN
560  SIP_PYOBJECT __repr__();
561  % MethodCode
562  QString str = QStringLiteral( "<QgsRectangle: %1>" ).arg( sipCpp->asWktCoordinates() );
563  sipRes = PyUnicode_FromString( str.toUtf8().constData() );
564  % End
565 #endif
566 
567  private:
568 
569  double mXmin = 0.0;
570  double mYmin = 0.0;
571  double mXmax = 0.0;
572  double mYmax = 0.0;
573 
574 };
575 
577 
578 #ifndef SIP_RUN
579 
583 CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsRectangle &rectangle );
584 
588 CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsRectangle &rectangle );
589 
590 inline std::ostream &operator << ( std::ostream &os, const QgsRectangle &r )
591 {
592  return os << r.toString().toLocal8Bit().data();
593 }
594 
595 #endif
596 
597 #endif // QGSRECTANGLE_H
QgsRectangle(const QgsPointXY &p1, const QgsPointXY &p2)
Construct a rectangle from two points. The rectangle is normalized after construction.
Definition: qgsrectangle.h:59
bool contains(const QgsRectangle &rect) const
Returns true when rectangle contains other rectangle.
Definition: qgsrectangle.h:342
int precision
A rectangle specified with double values.
Definition: qgsrectangle.h:41
void setMinimal()
Set a rectangle so that min corner is at max and max corner is at min.
Definition: qgsrectangle.h:151
QgsRectangle(const QRectF &qRectF)
Construct a rectangle from a QRectF. The rectangle is normalized after construction.
Definition: qgsrectangle.h:65
void setXMaximum(double x)
Set the maximum x value.
Definition: qgsrectangle.h:135
void combineExtentWith(const QgsPointXY &point)
Expands the rectangle so that it covers both the original rectangle and the given point...
Definition: qgsrectangle.h:393
double y
Definition: qgspointxy.h:48
A class to represent a 2D point.
Definition: qgspointxy.h:43
void scale(double scaleFactor, const QgsPointXY *c=nullptr)
Scale the rectangle around its center point.
Definition: qgsrectangle.h:235
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition: qgis.h:265
void include(const QgsPointXY &p)
Updates the rectangle to include the specified point.
Definition: qgsrectangle.h:286
double perimeter() const
Returns the perimeter of the rectangle.
Definition: qgsrectangle.h:225
A 3-dimensional box composed of x, y, z coordinates.
Definition: qgsbox3d.h:36
Q_DECLARE_METATYPE(QModelIndex)
CORE_EXPORT QDataStream & operator<<(QDataStream &out, const QgsRectangle &rectangle)
Writes the list rectangle to stream out.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
QgsRectangle & operator=(const QgsRectangle &r1)
Assignment operator.
Definition: qgsrectangle.h:499
QgsRectangle buffered(double width) const
Gets rectangle enlarged by buffer.
Definition: qgsrectangle.h:304
void grow(double delta)
Grows the rectangle in place by the specified amount.
Definition: qgsrectangle.h:275
bool isEmpty() const
Returns true if the rectangle is empty.
Definition: qgsrectangle.h:426
double width() const
Returns the width of the rectangle.
Definition: qgsrectangle.h:202
void setYMinimum(double y)
Set the minimum y value.
Definition: qgsrectangle.h:140
bool contains(const QgsPointXY &p) const
Returns true when rectangle contains a point.
Definition: qgsrectangle.h:350
QgsRectangle intersect(const QgsRectangle &rect) const
Returns the intersection with the given rectangle.
Definition: qgsrectangle.h:312
QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the sp...
QDateTime operator+(const QDateTime &start, QgsInterval interval)
bool isFinite() const
Returns true if the rectangle has finite boundaries.
Definition: qgsrectangle.h:516
double x
Definition: qgspointxy.h:47
A class to represent a vector.
Definition: qgsvector.h:29
QgsInterval operator-(const QDateTime &dt1, const QDateTime &dt2)
Returns the interval between two datetimes.
double area() const
Returns the area of the rectangle.
Definition: qgsrectangle.h:218
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
Definition: qgsrectangle.h:177
double xMaximum() const
Returns the x maximum value (right side of rectangle).
Definition: qgsrectangle.h:162
QgsRectangle(double xMin, double yMin=0, double xMax=0, double yMax=0)
Constructor.
Definition: qgsrectangle.h:49
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given rectangle...
Definition: qgsrectangle.h:359
bool operator==(const QgsRectangle &r1) const
Comparison operator.
Definition: qgsrectangle.h:478
QRectF toRectF() const
Returns a QRectF with same coordinates as the rectangle.
Definition: qgsrectangle.h:457
CORE_EXPORT QDataStream & operator>>(QDataStream &in, QgsRectangle &rectangle)
Reads a rectangle from stream in into rectangle.
void setYMaximum(double y)
Set the maximum y value.
Definition: qgsrectangle.h:145
bool isNull() const
Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
Definition: qgsrectangle.h:436
double xMinimum() const
Returns the x minimum value (left side of rectangle).
Definition: qgsrectangle.h:167
void combineExtentWith(double x, double y)
Expands the rectangle so that it covers both the original rectangle and the given point...
Definition: qgsrectangle.h:375
double yMaximum() const
Returns the y maximum value (top side of rectangle).
Definition: qgsrectangle.h:172
QgsPointXY center() const
Returns the center point of the rectangle.
Definition: qgsrectangle.h:230
void normalize()
Normalize the rectangle so it has non-negative width/height.
Definition: qgsrectangle.h:182
QgsRectangle(const QgsRectangle &other)
Copy constructor.
Definition: qgsrectangle.h:74
bool operator!=(const QgsRectangle &r1) const
Comparison operator.
Definition: qgsrectangle.h:490
bool intersects(const QgsRectangle &rect) const
Returns true when rectangle intersects with other rectangle.
Definition: qgsrectangle.h:328
void scale(double scaleFactor, double centerX, double centerY)
Scale the rectangle around its center point.
Definition: qgsrectangle.h:255
void setXMinimum(double x)
Set the minimum x value.
Definition: qgsrectangle.h:130
void invert()
Swap x/y coordinates in the rectangle.
Definition: qgsrectangle.h:532
double height() const
Returns the height of the rectangle.
Definition: qgsrectangle.h:209