Envelope.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2006 Refractions Research Inc.
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation. 
 * See the COPYING file for more information.
 *
 **********************************************************************
 *
 * Last port: geom/Envelope.java rev 1.46 (JTS-1.10)
 *
 **********************************************************************/
 
#ifndef GEOS_GEOM_ENVELOPE_H
#define GEOS_GEOM_ENVELOPE_H
 
 
#include <geos/export.h>
#include <geos/inline.h>
#include <geos/geom/Coordinate.h>
 
#include <string>
#include <vector>
#include <memory>
 
namespace geos {
namespace geom { // geos::geom
 
class Coordinate;

class GEOS_DLL Envelope {
 
public:
 
        typedef std::auto_ptr<Envelope> AutoPtr;

        Envelope(void);

        Envelope(double x1, double x2, double y1, double y2);

        Envelope(const Coordinate& p1, const Coordinate& p2);

        Envelope(const Coordinate& p);

        Envelope(const Envelope &env);

        Envelope& operator=(const Envelope& e);

        Envelope(const std::string &str);
 
        ~Envelope(void);

        static bool intersects(const Coordinate& p1, const Coordinate& p2,
                        const Coordinate& q);

        static bool intersects(const Coordinate& p1, const Coordinate& p2,
                        const Coordinate& q1, const Coordinate& q2);

        void init(void);

        void init(double x1, double x2, double y1, double y2);

        void init(const Coordinate& p1, const Coordinate& p2);

        void init(const Coordinate& p);
 
        // use assignment operator instead
        //void init(Envelope env);

        void setToNull(void);

        bool isNull(void) const;

        double getWidth(void) const;

        double getHeight(void) const;

        double getArea() const
        {
                return getWidth() * getHeight();
        }

        double getMaxY() const;

        double getMaxX() const;

        double getMinY() const;

        double getMinX() const;

        bool centre(Coordinate& centre) const;

        bool intersection(const Envelope& env, Envelope& result) const;

        void translate(double transX, double transY);

        void expandBy(double deltaX, double deltaY);

        void expandBy(double distance) { expandBy(distance, distance); }
 

        void expandToInclude(const Coordinate& p);

        void expandToInclude(double x, double y);

        void expandToInclude(const Envelope* other);

        bool contains(const Envelope& other) const {
                return covers(other);
        }
 
        bool contains(const Envelope* other) const {
                return contains(*other);
        }

        bool contains(const Coordinate& p) const {
                return covers(p.x, p.y);
        }

        bool contains(double x, double y) const {
                return covers(x, y);
        }

        bool intersects(const Coordinate& p) const;

        bool intersects(double x, double y) const;

        bool intersects(const Envelope* other) const;
 
        bool intersects(const Envelope& other) const;

        bool covers(double x, double y) const;

        bool covers(const Coordinate *p) const;

        bool covers(const Envelope& other) const;
 
        bool covers(const Envelope* other) const {
                return covers(*other);
        }
 

        bool equals(const Envelope* other) const;

        std::string toString(void) const;

        double distance(const Envelope* env) const;
 
        int hashCode() const;
 
private:

        std::vector<std::string> split(const std::string &str,
                        const std::string &delimiters = " ");
 
        static double distance(double x0,double y0,double x1,double y1);

        double minx;

        double maxx;

        double miny;

        double maxy;
};

GEOS_DLL bool operator==(const Envelope& a, const Envelope& b);
 
} // namespace geos::geom
} // namespace geos
 
#ifdef GEOS_INLINE
# include "geos/geom/Envelope.inl"
#endif
 
#endif // ndef GEOS_GEOM_ENVELOPE_H