src/util/areastore.h

   1 /*
   2 Minetest
   3 Copyright (C) 2015 est31 <mtest31@outlook.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef AREA_STORE_H_
  21 #define AREA_STORE_H_
  22
  23 #include "irr_v3d.h"
  24 #include "noise.h" // for PcgRandom
  25 #include <map>
  26 #include <list>
  27 #include <vector>
  28 #include <istream>
  29 #include "util/container.h"
  30 #include "util/numeric.h"
  31 #ifndef ANDROID
  32         #include "cmake_config.h"
  33 #endif
  34 #if USE_SPATIAL
  35         #include <spatialindex/SpatialIndex.h>
  36         #include "util/serialize.h"
  37 #endif
  38
  39
  40 struct Area {
  41         Area() {}
  42         Area(const v3s16 &mine, const v3s16 &maxe) :
  43                 minedge(mine), maxedge(maxe)
  44         {
  45                 sortBoxVerticies(minedge, maxedge);
  46         }
  47
  48         u32 id;
  49         v3s16 minedge, maxedge;
  50         std::string data;
  51 };
  52
  53
  54 class AreaStore {
  55 public:
  56         AreaStore() :
  57                 m_cache_enabled(true),
  58                 m_cacheblock_radius(64),
  59                 m_res_cache(1000, &cacheMiss, this),
  60                 m_next_id(0)
  61         {}
  62
  63         virtual ~AreaStore() {}
  64
  65         static AreaStore *getOptimalImplementation();
  66
  67         virtual void reserve(size_t count) {};
  68         size_t size() const { return areas_map.size(); }
  69
  70         /// Add an area to the store.
  71         /// Updates the area's ID.
  72         virtual bool insertArea(Area *a) = 0;
  73
  74         /// Removes an area from the store by ID.
  75         /// @return Whether the area was in the store and removed.
  76         virtual bool removeArea(u32 id) = 0;
  77
  78         /// Finds areas that the passed position is contained in.
  79         /// Stores output in passed vector.
  80         void getAreasForPos(std::vector<Area *> *result, v3s16 pos);
  81
  82         /// Finds areas that are completely contained inside the area defined
  83         /// by the passed edges.  If @p accept_overlap is true this finds any
  84         /// areas that intersect with the passed area at any point.
  85         virtual void getAreasInArea(std::vector<Area *> *result,
  86                 v3s16 minedge, v3s16 maxedge, bool accept_overlap) = 0;
  87
  88         /// Sets cache parameters.
  89         void setCacheParams(bool enabled, u8 block_radius, size_t limit);
  90
  91         /// Returns a pointer to the area coresponding to the passed ID,
  92         /// or NULL if it doesn't exist.
  93         const Area *getArea(u32 id) const;
  94
  95         /// Serializes the store's areas to a binary ostream.
  96         void serialize(std::ostream &is) const;
  97
  98         /// Deserializes the Areas from a binary istream.
  99         /// This does not currently clear the AreaStore before adding the
 100         /// areas, making it possible to deserialize multiple serialized
 101         /// AreaStores.
 102         void deserialize(std::istream &is);
 103
 104 protected:
 105         /// Invalidates the getAreasForPos cache.
 106         /// Call after adding or removing an area.
 107         void invalidateCache();
 108
 109         /// Implementation of getAreasForPos.
 110         /// getAreasForPos calls this if the cache is disabled.
 111         virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos) = 0;
 112
 113         /// Returns the next area ID and increments it.
 114         u32 getNextId() { return m_next_id++; }
 115
 116         // Note: This can't be an unordered_map, since all
 117         // references would be invalidated on rehash.
 118         typedef std::map<u32, Area> AreaMap;
 119         AreaMap areas_map;
 120
 121 private:
 122         /// Called by the cache when a value isn't found in the cache.
 123         static void cacheMiss(void *data, const v3s16 &mpos, std::vector<Area *> *dest);
 124
 125         bool m_cache_enabled;
 126         /// Range, in nodes, of the getAreasForPos cache.
 127         /// If you modify this, call invalidateCache()
 128         u8 m_cacheblock_radius;
 129         LRUCache<v3s16, std::vector<Area *> > m_res_cache;
 130
 131         u32 m_next_id;
 132 };
 133
 134
 135 class VectorAreaStore : public AreaStore {
 136 public:
 137         virtual void reserve(size_t count) { m_areas.reserve(count); }
 138         virtual bool insertArea(Area *a);
 139         virtual bool removeArea(u32 id);
 140         virtual void getAreasInArea(std::vector<Area *> *result,
 141                 v3s16 minedge, v3s16 maxedge, bool accept_overlap);
 142
 143 protected:
 144         virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos);
 145
 146 private:
 147         std::vector<Area *> m_areas;
 148 };
 149
 150
 151 #if USE_SPATIAL
 152
 153 class SpatialAreaStore : public AreaStore {
 154 public:
 155         SpatialAreaStore();
 156         virtual ~SpatialAreaStore();
 157
 158         virtual bool insertArea(Area *a);
 159         virtual bool removeArea(u32 id);
 160         virtual void getAreasInArea(std::vector<Area *> *result,
 161                 v3s16 minedge, v3s16 maxedge, bool accept_overlap);
 162
 163 protected:
 164         virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos);
 165
 166 private:
 167         SpatialIndex::ISpatialIndex *m_tree;
 168         SpatialIndex::IStorageManager *m_storagemanager;
 169
 170         class VectorResultVisitor : public SpatialIndex::IVisitor {
 171         public:
 172                 VectorResultVisitor(std::vector<Area *> *result, SpatialAreaStore *store) :
 173                         m_store(store),
 174                         m_result(result)
 175                 {}
 176                 ~VectorResultVisitor() {}
 177
 178                 virtual void visitNode(const SpatialIndex::INode &in) {}
 179
 180                 virtual void visitData(const SpatialIndex::IData &in)
 181                 {
 182                         u32 id = in.getIdentifier();
 183
 184                         std::map<u32, Area>::iterator itr = m_store->areas_map.find(id);
 185                         assert(itr != m_store->areas_map.end());
 186                         m_result->push_back(&itr->second);
 187                 }
 188
 189                 virtual void visitData(std::vector<const SpatialIndex::IData *> &v)
 190                 {
 191                         for (size_t i = 0; i < v.size(); i++)
 192                                 visitData(*(v[i]));
 193                 }
 194
 195         private:
 196                 SpatialAreaStore *m_store;
 197                 std::vector<Area *> *m_result;
 198         };
 199 };
 200
 201 #endif // USE_SPATIAL
 202
 203 #endif // AREA_STORE_H_