src/core/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 QGSRECT_H
#define QGSRECT_H

#include <iosfwd>
#include <QDomDocument>

class QString;
class QRectF;
#include "qgspoint.h"


class CORE_EXPORT QgsRectangle
{
  public:
    QgsRectangle( double xmin = 0, double ymin = 0, double xmax = 0, double ymax = 0 );
    QgsRectangle( const QgsPoint & p1, const QgsPoint & p2 );
    //@note added in 2.0
    QgsRectangle( const QRectF & qRectF );
    QgsRectangle( const QgsRectangle &other );
    ~QgsRectangle();
    //normalised after construction.
    void set( const QgsPoint& p1, const QgsPoint& p2 );
    //  normalised after construction.
    void set( double xmin, double ymin, double xmax, double ymax );
    void setXMinimum( double x );
    void setXMaximum( double x );
    void setYMinimum( double y );
    void setYMaximum( double y );
    // and max corner is at min. It is NOT normalized.
    void setMinimal();
    double xMaximum() const;
    double xMinimum() const;
    double yMaximum() const;
    double yMinimum() const;
    void normalize();
    double width() const;
    double height() const;
    QgsPoint center() const;
    void scale( double scaleFactor, const QgsPoint *c = 0 );
    QgsRectangle intersect( const QgsRectangle *rect ) const;
    bool intersects( const QgsRectangle& rect ) const;
    bool contains( const QgsRectangle& rect ) const;
    bool contains( const QgsPoint &p ) const;
    void combineExtentWith( QgsRectangle *rect );
    void combineExtentWith( double x, double y );
    bool isEmpty() const;
    QString asWktCoordinates() const;
    //@note added in 2.0
    QString asWktPolygon() const;
    //@note added in 2.0
    QRectF toRectF() const;
    QString toString( bool automaticPrecision = false ) const;
    QString toString( int thePrecision ) const;
    QString asPolygon() const;
    bool operator==( const QgsRectangle &r1 ) const;
    bool operator!=( const QgsRectangle &r1 ) const;
    QgsRectangle & operator=( const QgsRectangle &r1 );

    void unionRect( const QgsRectangle& rect );

    bool isFinite() const;

    void invert();

  protected:

    // These are protected instead of private so that things like
    // the QgsPostGisBox3d can get at them.

    double xmin;
    double ymin;
    double xmax;
    double ymax;

};


inline QgsRectangle::~QgsRectangle()
{
}

inline void QgsRectangle::setXMinimum( double x )
{
  xmin = x;
}

inline void QgsRectangle::setXMaximum( double x )
{
  xmax = x;
}

inline void QgsRectangle::setYMinimum( double y )
{
  ymin = y;
}

inline void QgsRectangle::setYMaximum( double y )
{
  ymax = y;
}

inline double QgsRectangle::xMaximum() const
{
  return xmax;
}

inline double QgsRectangle::xMinimum() const
{
  return xmin;
}

inline double QgsRectangle::yMaximum() const
{
  return ymax;
}

inline double QgsRectangle::yMinimum() const
{
  return ymin;
}

inline double QgsRectangle::width() const
{
  return xmax - xmin;
}

inline double QgsRectangle::height() const
{
  return ymax - ymin;
}

inline QgsPoint QgsRectangle::center() const
{
  return QgsPoint( xmin + width() / 2,  ymin + height() / 2 );
}
inline std::ostream& operator << ( std::ostream& os, const QgsRectangle &r )
{
  return os << r.toString().toLocal8Bit().data();
}

#endif // QGSRECT_H