Add basic AreaStore method documentation

This commit is contained in:
ShadowNinja 2015-10-30 01:25:44 -04:00
parent 6e9d71342a
commit 8ae1e1f4d2

@ -67,21 +67,36 @@ public:
virtual void reserve(size_t count) {}; virtual void reserve(size_t count) {};
size_t size() const { return areas_map.size(); } size_t size() const { return areas_map.size(); }
// Updates the area's ID /// Add an area to the store.
/// Updates the area's ID.
virtual bool insertArea(Area *a) = 0; virtual bool insertArea(Area *a) = 0;
/// Removes an area from the store by ID.
/// @return Whether the area was in the store and removed.
virtual bool removeArea(u32 id) = 0; virtual bool removeArea(u32 id) = 0;
/// Finds areas that the passed position is contained in.
/// Stores output in passed vector.
void getAreasForPos(std::vector<Area *> *result, v3s16 pos); void getAreasForPos(std::vector<Area *> *result, v3s16 pos);
/// Finds areas that are completely contained inside the area defined
/// by the passed edges. If @p accept_overlap is true this finds any
/// areas that intersect with the passed area at any point.
virtual void getAreasInArea(std::vector<Area *> *result, virtual void getAreasInArea(std::vector<Area *> *result,
v3s16 minedge, v3s16 maxedge, bool accept_overlap) = 0; v3s16 minedge, v3s16 maxedge, bool accept_overlap) = 0;
/// Sets cache parameters.
void setCacheParams(bool enabled, u8 block_radius, size_t limit); void setCacheParams(bool enabled, u8 block_radius, size_t limit);
/// Returns a pointer to the area coresponding to the passed ID,
/// or NULL if it doesn't exist.
const Area *getArea(u32 id) const; const Area *getArea(u32 id) const;
#if 0 #if 0
typedef bool (*ForEachCallback)(const Area *a, void *arg); typedef bool (*ForEachCallback)(const Area *a, void *arg);
// Calls a passed function for every stored area, until the /// Calls a passed function for every stored area, until the
// callback returns true. If that happens, it returns true, /// callback returns true. If that happens, it returns true,
// if the search is exhausted, it returns false. /// if the search is exhausted, it returns false.
virtual bool forEach(ForEachCallback, void *arg=NULL) const = 0; virtual bool forEach(ForEachCallback, void *arg=NULL) const = 0;
void serialize(std::ostream &is) const; void serialize(std::ostream &is) const;
@ -89,8 +104,15 @@ public:
#endif #endif
protected: protected:
/// Invalidates the getAreasForPos cache.
/// Call after adding or removing an area.
void invalidateCache(); void invalidateCache();
/// Implementation of getAreasForPos.
/// getAreasForPos calls this if the cache is disabled.
virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos) = 0; virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos) = 0;
/// Returns the next area ID and increments it.
u32 getNextId() { return m_next_id++; } u32 getNextId() { return m_next_id++; }
// Note: This can't be an unordered_map, since all // Note: This can't be an unordered_map, since all
@ -99,10 +121,13 @@ protected:
AreaMap areas_map; AreaMap areas_map;
private: private:
/// Called by the cache when a value isn't found in the cache.
static void cacheMiss(void *data, const v3s16 &mpos, std::vector<Area *> *dest); static void cacheMiss(void *data, const v3s16 &mpos, std::vector<Area *> *dest);
bool m_cache_enabled; bool m_cache_enabled;
u8 m_cacheblock_radius; // if you modify this, call invalidateCache() /// Range, in nodes, of the getAreasForPos cache.
/// If you modify this, call invalidateCache()
u8 m_cacheblock_radius;
LRUCache<v3s16, std::vector<Area *> > m_res_cache; LRUCache<v3s16, std::vector<Area *> > m_res_cache;
u32 m_next_id; u32 m_next_id;