qgsrectangle.h

Go to the documentation of this file.

/***************************************************************************
                          qgsrectangle.h  -  description
                             -------------------
    begin                : Sat Jun 22 2002
    copyright            : (C) 2002 by Gary E.Sherman
    email                : sherman at mrcc.com
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSRECTANGLE_H
#define QGSRECTANGLE_H

#include "qgis_core.h"
#include <iosfwd>
#include <QDomDocument>

class QString;
class QRectF;
class QgsBox3d;
#include "qgspointxy.h"


class CORE_EXPORT QgsRectangle
{
  public:

    QgsRectangle() = default; // optimised constructor for null rectangle - no need to call normalize here

    explicit QgsRectangle( double xMin, double yMin = 0, double xMax = 0, double yMax = 0 );
    QgsRectangle( const QgsPointXY &p1, const QgsPointXY &p2 );
    QgsRectangle( const QRectF &qRectF );
    QgsRectangle( const QgsRectangle &other );

    // IMPORTANT - while QgsRectangle is inherited by QgsReferencedRectangle, we do NOT want a virtual destructor here
    // because this class MUST be lightweight and we don't want the cost of the vtable here.
    // see https://github.com/qgis/QGIS/pull/4720#issuecomment-308652392
    ~QgsRectangle() = default;

    static QgsRectangle fromWkt( const QString &wkt );

    static QgsRectangle fromCenterAndSize( QgsPointXY center, double width, double height );

    void set( const QgsPointXY &p1, const QgsPointXY &p2 );

    void set( double mXmin, double mYmin, double mXmax, double mYmax );

    void setXMinimum( double x ) { mXmin = x; }

    void setXMaximum( double x ) { mXmax = x; }

    void setYMinimum( double y ) { mYmin = y; }

    void setYMaximum( double y ) { mYmax = y; }

    void setMinimal();

    double xMaximum() const { return mXmax; }

    double xMinimum() const { return mXmin; }

    double yMaximum() const { return mYmax; }

    double yMinimum() const { return mYmin; }

    void normalize();

    double width() const { return mXmax - mXmin; }

    double height() const { return mYmax - mYmin; }

    double area() const { return ( mXmax - mXmin ) * ( mYmax - mYmin ); }

    double perimeter() const { return 2 * ( mXmax - mXmin ) + 2 * ( mYmax - mYmin ); }

    QgsPointXY center() const { return QgsPointXY( mXmin + width() / 2, mYmin + height() / 2 ); }

    void scale( double scaleFactor, const QgsPointXY *c = nullptr );

    void scale( double scaleFactor, double centerX, double centerY );

    void grow( double delta );

    void include( const QgsPointXY &p );

    QgsRectangle buffered( double width ) const;

    QgsRectangle intersect( const QgsRectangle *rect ) const;

    bool intersects( const QgsRectangle &rect ) const;

    bool contains( const QgsRectangle &rect ) const;

    bool contains( const QgsPointXY &p ) const;

    void combineExtentWith( const QgsRectangle &rect );

    void combineExtentWith( double x, double y );

    QgsRectangle operator-( const QgsVector v ) const;

    QgsRectangle operator+( const QgsVector v ) const;

    QgsRectangle &operator-=( const QgsVector v );

    QgsRectangle &operator+=( const QgsVector v );

    bool isEmpty() const;

    bool isNull() const;

    QString asWktCoordinates() const;

    QString asWktPolygon() const;

    QRectF toRectF() const;

    QString toString( int precision = 16 ) const;

    QString asPolygon() const;

    bool operator==( const QgsRectangle &r1 ) const;

    bool operator!=( const QgsRectangle &r1 ) const;

    QgsRectangle &operator=( const QgsRectangle &r1 );

    bool isFinite() const;

    void invert();

    QgsBox3d toBox3d( double zMin, double zMax ) const;

    operator QVariant() const
    {
      return QVariant::fromValue( *this );
    }

  private:

    double mXmin = 0.0;
    double mYmin = 0.0;
    double mXmax = 0.0;
    double mYmax = 0.0;

};

Q_DECLARE_METATYPE( QgsRectangle )

#ifndef SIP_RUN

CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsRectangle &rectangle );

CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsRectangle &rectangle );

inline std::ostream &operator << ( std::ostream &os, const QgsRectangle &r )
{
  return os << r.toString().toLocal8Bit().data();
}

#endif

#endif // QGSRECTANGLE_H