TileId.h

Go to the documentation of this file.

#ifndef OSMSCOUT_TILEID_H
#define OSMSCOUT_TILEID_H

/*
  This source is part of the libosmscout library
  Copyright (C) 2016  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 <memory>
#include <tuple>

#include <osmscout/CoreImportExport.h>

#include <osmscout/Pixel.h>

#include <osmscout/util/GeoBox.h>
#include <osmscout/util/Magnification.h>

namespace osmscout {

  class OSMSCOUT_API TileId
  {
  private:
    uint32_t x;             
    uint32_t y;             

  public:
    TileId(uint32_t x,
           uint32_t y);

    uint32_t GetX() const
    {
      return x;
    }

    uint32_t GetY() const
    {
      return y;
    }

    Pixel AsPixel() const
    {
      return {x,y};
    }

    std::string GetDisplayText() const;

    bool operator==(const TileId& other) const
    {
      return y==other.y &&
             x==other.x;
    }

    bool operator!=(const TileId& other) const
    {
      return y!=other.y ||
             x!=other.x;
    }

    bool operator<(const TileId& other) const
    {
      return std::tie(y, x) < std::tie(other.y, other.x);
    }

    GeoCoord GetTopLeftCoord(const Magnification& magnification) const;
    GeoBox GetBoundingBox(const MagnificationLevel& level) const;
    GeoBox GetBoundingBox(const Magnification& magnification) const;

    static TileId GetTile(const Magnification& magnification,
                          const GeoCoord& coord);

    static TileId GetTile(const MagnificationLevel& level,
                          const GeoCoord& coord);
  };

  struct OSMSCOUT_API TileIdHasher
  {
    std::size_t operator()(const TileId& id) const noexcept
    {
      auto h1 = static_cast<size_t>(id.GetX());
      auto h2 = static_cast<size_t>(id.GetY());
      return h1 ^ (h2 << 16u);
    }
  };

  class OSMSCOUT_API TileKey
  {
  private:
    uint32_t level;
    TileId   id;

  public:
    TileKey(const Magnification& magnification,
           const TileId& id);

    uint32_t GetLevel() const
    {
      return level;
    }

    TileId GetId() const
    {
      return id;
    }

    GeoBox GetBoundingBox() const;

    std::string GetDisplayText() const;

    TileKey GetParent() const;

    bool operator==(const TileKey& other) const;
    bool operator!=(const TileKey& other) const;
    bool operator<(const TileKey& other) const;
  };

  class OSMSCOUT_API TileIdBoxConstIterator CLASS_FINAL
  {
  public:
    using self_type         = TileIdBoxConstIterator;
    using value_type        = TileId;
    using reference         = const TileId&;
    using pointer           = TileId;
    using iterator_category = std::input_iterator_tag;

  private:
    TileId currentTile;
    TileId minTile;
    TileId maxTile;

  public:
    TileIdBoxConstIterator(const TileId& currentTile,
                           const TileId& minTile,
                           const TileId& maxTile)
      : currentTile(currentTile),
        minTile(minTile),
        maxTile(maxTile)
    {
      // no code
    }

    TileIdBoxConstIterator(const TileIdBoxConstIterator& other) = default;

    TileIdBoxConstIterator& operator++()
    {
      if (currentTile.GetX()>=maxTile.GetX()) {
        currentTile=TileId(minTile.GetX(),
                           currentTile.GetY()+1);
      }
      else {
        currentTile=TileId(currentTile.GetX()+1,
                           currentTile.GetY());
      }

      return *this;
    }

    TileIdBoxConstIterator operator++(int)
    {
      TileIdBoxConstIterator tmp(*this);

      operator++();

      return tmp;
    }

    bool operator==(const TileIdBoxConstIterator& other) const
    {
      return currentTile==other.currentTile;
    }

    bool operator!=(const TileIdBoxConstIterator& other) const
    {
      return currentTile!=other.currentTile;
    }

    const TileId& operator*() const
    {
      return currentTile;
    }

    TileId operator->() const
    {
      return currentTile;
    }
  };

  class OSMSCOUT_API TileIdBox CLASS_FINAL
  {
  private:
    TileId minTile;
    TileId maxTile;

  public:
    TileIdBox(const TileId& a,
              const TileId& b);

    TileIdBox(const Magnification& magnification,
              const GeoBox& boundingBox)
    : TileIdBox(TileId::GetTile(magnification,
                                boundingBox.GetMinCoord()),
                TileId::GetTile(magnification,
                                boundingBox.GetMaxCoord()))
    {
    }

    TileId GetMin() const
    {
      return minTile;
    }

    TileId GetMax() const
    {
      return maxTile;
    }

    uint32_t GetMinX() const
    {
      return minTile.GetX();
    }

    uint32_t GetMaxX() const
    {
      return maxTile.GetX();
    }

    uint32_t GetMinY() const
    {
      return minTile.GetY();
    }

    uint32_t GetMaxY() const
    {
      return maxTile.GetY();
    }

    uint32_t GetWidth() const
    {
      return maxTile.GetX()-minTile.GetX()+1;
    }

    uint32_t GetHeight() const
    {
      return maxTile.GetY()-minTile.GetY()+1;
    }

    uint32_t GetCount() const
    {
      return GetWidth()*GetHeight();
    }

    TileIdBoxConstIterator begin() const
    {
      return TileIdBoxConstIterator(minTile,
                                    minTile,
                                    maxTile);
    }

    TileIdBoxConstIterator end() const
    {
      return TileIdBoxConstIterator(TileId(minTile.GetX(),
                                           maxTile.GetY()+1),
                                       minTile,
                                       maxTile);
    }

    bool operator==(const TileIdBox& other) const
    {
      return minTile==other.minTile &&
             maxTile==other.maxTile;
    }

    GeoBox GetBoundingBox(const Magnification& magnification) const;

    TileIdBox Include(const TileId& tileId) const;
    TileIdBox Include(const TileIdBox& other) const;
    TileIdBox Intersection(const TileIdBox& other) const;

    bool Intersects(const TileIdBox& other) const;

    std::string GetDisplayText() const
    {
      return std::string("["+minTile.GetDisplayText()+" - "+maxTile.GetDisplayText()+"]");
    }
  };

}

#endif