GeoBox.h

Go to the documentation of this file.

#ifndef OSMSCOUT_UTIL_GEOBOX_H
#define OSMSCOUT_UTIL_GEOBOX_H
 
/*
  This source is part of the libosmscout library
  Copyright (C) 2015  Tim Teulings
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/
 
#include <osmscout/lib/CoreImportExport.h>
 
#include <osmscout/GeoCoord.h>
 
#include <osmscout/system/Compiler.h>
#include <osmscout/util/Distance.h>
 
namespace osmscout {

  class OSMSCOUT_API GeoBox CLASS_FINAL
  {
  private:
    GeoCoord minCoord=GeoCoord(0.0,0.0);
    GeoCoord maxCoord=GeoCoord(0.0,0.0);
    bool     valid=false;
 
  public:
    GeoBox() = default;

    GeoBox(const GeoBox& other) = default;

    GeoBox(const GeoCoord& coordA,
           const GeoCoord& coordB);
 
    bool operator==(const GeoBox& other) const {
      return GetMinCoord()==other.GetMinCoord() &&
      GetMaxCoord()== other.GetMaxCoord();
    }
 
    bool operator!=(const GeoBox& other) const {
      return GetMinCoord()!=other.GetMinCoord() ||
             GetMaxCoord()!= other.GetMaxCoord();
    }

    void Invalidate()
    {
      valid=false;
      minCoord.Set(0.0,0.0);
      maxCoord.Set(0.0,0.0);
    }

    void Set(const GeoCoord& coordA,
             const GeoCoord& coordB);

    void Include(const GeoBox& other);

    void Include(const GeoCoord& point);

    template<typename P>
    bool Includes(const P& coord,
                  bool openInterval=true) const
    {
      if (!valid){
        return false;
      }
 
      if (openInterval) {
        return minCoord.GetLat()<=coord.GetLat() &&
               maxCoord.GetLat()>coord.GetLat() &&
               minCoord.GetLon()<=coord.GetLon() &&
               maxCoord.GetLon()>coord.GetLon();
      }
 
      return minCoord.GetLat()<=coord.GetLat() &&
             maxCoord.GetLat()>=coord.GetLat() &&
             minCoord.GetLon()<=coord.GetLon() &&
             maxCoord.GetLon()>=coord.GetLon();
    }

    bool Intersects(const GeoBox& other,
                    bool openInterval=true) const
    {
      if (!valid || !other.valid) {
        return false;
      }
 
      if (openInterval) {
        return !(other.GetMaxLon()<minCoord.GetLon() ||
                 other.GetMinLon()>=maxCoord.GetLon() ||
                 other.GetMaxLat()<minCoord.GetLat() ||
                 other.GetMinLat()>=maxCoord.GetLat());
      }
 
      return !(other.GetMaxLon()<minCoord.GetLon() ||
               other.GetMinLon()>maxCoord.GetLon() ||
               other.GetMaxLat()<minCoord.GetLat() ||
               other.GetMinLat()>maxCoord.GetLat());
    }

    GeoBox Intersection(const GeoBox& other) const;

    GeoBox CropTo(const GeoBox& other) const;

    bool IsValid() const
    {
      return valid;
    }

    GeoCoord GetMinCoord() const
    {
      return minCoord;
    }

    GeoCoord GetMaxCoord() const
    {
      return maxCoord;
    }
 
    GeoCoord GetCenter() const;

    double GetMinLat() const
    {
      return minCoord.GetLat();
    }

    double GetMinLon() const
    {
      return minCoord.GetLon();
    }

    double GetMaxLat() const
    {
      return maxCoord.GetLat();
    }

    double GetMaxLon() const
    {
      return maxCoord.GetLon();
    }

    double GetWidth() const
    {
      return maxCoord.GetLon()-minCoord.GetLon();
    }

    double GetHeight() const
    {
      return maxCoord.GetLat()-minCoord.GetLat();
    }

    double GetSize() const
    {
      return GetWidth()*GetHeight();
    }

    GeoCoord GetBottomLeft() const
    {
      return minCoord;
    }

    GeoCoord GetBottomRight() const
    {
      return GeoCoord(minCoord.GetLat(),
                      maxCoord.GetLon());
    }

    GeoCoord GetTopLeft() const
    {
      return GeoCoord(maxCoord.GetLat(),
                      minCoord.GetLon());
    }

    GeoCoord GetTopRight() const
    {
      return maxCoord;
    }

    std::string GetDisplayText() const;

    GeoBox& operator=(const GeoBox& other) = default;

    static GeoBox BoxByCenterAndRadius(const GeoCoord& center,const Distance& radius);
  };
}
 
#endif