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 <ostream> // for operator<<
#include <memory>
 
namespace geos {
namespace geom { // geos::geom
 
class Envelope;
 
GEOS_DLL std::ostream& operator<< (std::ostream& os, const Envelope& o);
 
class Coordinate;
 
class GEOS_DLL Envelope {
 
public:
 
    friend std::ostream& operator<< (std::ostream& os, const Envelope& o);
 
    typedef std::unique_ptr<Envelope> Ptr;
 
    Envelope();
 
    Envelope(double x1, double x2, double y1, double y2);
 
    Envelope(const Coordinate& p1, const Coordinate& p2);
 
    explicit Envelope(const Coordinate& p);
 
    explicit Envelope(const std::string& str);
 
    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);
 
    bool intersects(const Coordinate& a, const Coordinate& b) const;
 
    void init();
 
    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();
 
    bool isNull() const;
 
    double getWidth() const;
 
    double getHeight() 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 p_distance)
    {
        expandBy(p_distance, p_distance);
    }
 
 
    void expandToInclude(const Coordinate& p);
 
    void expandToInclude(double x, double y);
 
    void expandToInclude(const Envelope* other);
    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 disjoint(const Envelope* other) const;
 
    bool disjoint(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() const;
 
    double distance(const Envelope& env) const;
 
    double distanceSquared(const Envelope& env) const;
 
    static double distanceToCoordinate(const Coordinate & c, const Coordinate & p1, const Coordinate & p2);
 
    static double distanceSquaredToCoordinate(const Coordinate & c, const Coordinate & p1, const Coordinate & p2);
 
    std::size_t hashCode() const;
 
private:
 
    static 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);
 
GEOS_DLL bool operator!=(const Envelope& a, const Envelope& b);
 
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