minetest/src/map.h
sfan5 6d5103900f Some refactoring and fixes to VoxelArea and VoxelManip
In particular this validates the edges of VoxelArea and fixes
all the nonsense tests uncovered by it.
2024-10-12 22:37:17 +02:00

363 lines
10 KiB
C++

/*
Minetest
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program 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 program 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 program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#pragma once
#include <iostream>
#include <set>
#include <map>
#include "irrlichttypes_bloated.h"
#include "mapblock.h"
#include "mapnode.h"
#include "constants.h"
#include "voxel.h"
#include "modifiedstate.h"
#include "util/numeric.h"
#include "nodetimer.h"
#include "debug.h"
class MapSector;
class NodeMetadata;
class IGameDef;
class IRollbackManager;
/*
MapEditEvent
*/
enum MapEditEventType {
// Node added (changed from air or something else to something)
MEET_ADDNODE,
// Node removed (changed to air)
MEET_REMOVENODE,
// Node swapped (changed without metadata change)
MEET_SWAPNODE,
// Node metadata changed
MEET_BLOCK_NODE_METADATA_CHANGED,
// Anything else (modified_blocks are set unsent)
MEET_OTHER
};
struct MapEditEvent
{
MapEditEventType type = MEET_OTHER;
v3s16 p;
MapNode n = CONTENT_AIR;
std::vector<v3s16> modified_blocks; // Represents a set
bool is_private_change = false;
MapEditEvent() = default;
// Sets the event's position and marks the block as modified.
void setPositionModified(v3s16 pos)
{
assert(modified_blocks.empty()); // only meant for initialization (once)
p = pos;
modified_blocks.push_back(getNodeBlockPos(pos));
}
void setModifiedBlocks(const std::map<v3s16, MapBlock *>& blocks)
{
assert(modified_blocks.empty()); // only meant for initialization (once)
modified_blocks.reserve(blocks.size());
for (const auto &block : blocks)
modified_blocks.push_back(block.first);
}
VoxelArea getArea() const
{
switch(type){
case MEET_ADDNODE:
case MEET_REMOVENODE:
case MEET_SWAPNODE:
case MEET_BLOCK_NODE_METADATA_CHANGED:
return VoxelArea(p);
case MEET_OTHER:
{
VoxelArea a;
for (v3s16 p : modified_blocks) {
v3s16 np1 = p*MAP_BLOCKSIZE;
v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
a.addPoint(np1);
a.addPoint(np2);
}
return a;
}
}
return VoxelArea();
}
};
class MapEventReceiver
{
public:
// event shall be deleted by caller after the call.
virtual void onMapEditEvent(const MapEditEvent &event) = 0;
};
class Map /*: public NodeContainer*/
{
public:
Map(IGameDef *gamedef);
virtual ~Map();
DISABLE_CLASS_COPY(Map);
void addEventReceiver(MapEventReceiver *event_receiver);
void removeEventReceiver(MapEventReceiver *event_receiver);
// event shall be deleted by caller after the call.
void dispatchEvent(const MapEditEvent &event);
// On failure returns NULL
MapSector * getSectorNoGenerateNoLock(v2s16 p2d);
// Same as the above (there exists no lock anymore)
MapSector * getSectorNoGenerate(v2s16 p2d);
/*
This is overloaded by ClientMap and ServerMap to allow
their differing fetch methods.
*/
virtual MapSector * emergeSector(v2s16 p){ return NULL; }
// Returns InvalidPositionException if not found
MapBlock * getBlockNoCreate(v3s16 p);
// Returns NULL if not found
MapBlock * getBlockNoCreateNoEx(v3s16 p);
/* Server overrides */
virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
{ return getBlockNoCreateNoEx(p); }
inline const NodeDefManager * getNodeDefManager() { return m_nodedef; }
bool isValidPosition(v3s16 p);
// throws InvalidPositionException if not found
void setNode(v3s16 p, MapNode n);
// Returns a CONTENT_IGNORE node if not found
// If is_valid_position is not NULL then this will be set to true if the
// position is valid, otherwise false
MapNode getNode(v3s16 p, bool *is_valid_position = NULL);
/*
These handle lighting but not faces.
*/
virtual void addNodeAndUpdate(v3s16 p, MapNode n,
std::map<v3s16, MapBlock*> &modified_blocks,
bool remove_metadata = true);
void removeNodeAndUpdate(v3s16 p,
std::map<v3s16, MapBlock*> &modified_blocks);
/*
Wrappers for the latter ones.
These emit events.
Return true if succeeded, false if not.
*/
bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
bool removeNodeWithEvent(v3s16 p);
// Call these before and after saving of many blocks
virtual void beginSave() {}
virtual void endSave() {}
virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
/*
Return true unless the map definitely cannot save blocks.
*/
virtual bool maySaveBlocks() { return true; }
// Server implements these.
// Client leaves them as no-op.
virtual bool saveBlock(MapBlock *block) { return false; }
virtual bool deleteBlock(v3s16 blockpos) { return false; }
/*
Updates usage timers and unloads unused blocks and sectors.
Saves modified blocks before unloading if possible.
*/
void timerUpdate(float dtime, float unload_timeout, s32 max_loaded_blocks,
std::vector<v3s16> *unloaded_blocks=NULL);
/*
Unloads all blocks with a zero refCount().
Saves modified blocks before unloading if possible.
*/
void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
// Deletes sectors and their blocks from memory
// Takes cache into account
// If deleted sector is in sector cache, clears cache
void deleteSectors(std::vector<v2s16> &list);
// For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
virtual void PrintInfo(std::ostream &out);
/*
Node metadata
These are basically coordinate wrappers to MapBlock
*/
std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2);
NodeMetadata *getNodeMetadata(v3s16 p);
/**
* Sets metadata for a node.
* This method sets the metadata for a given node.
* On success, it returns @c true and the object pointed to
* by @p meta is then managed by the system and should
* not be deleted by the caller.
*
* In case of failure, the method returns @c false and the
* caller is still responsible for deleting the object!
*
* @param p node coordinates
* @param meta pointer to @c NodeMetadata object
* @return @c true on success, false on failure
*/
bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
void removeNodeMetadata(v3s16 p);
/*
Node Timers
These are basically coordinate wrappers to MapBlock
*/
NodeTimer getNodeTimer(v3s16 p);
void setNodeTimer(const NodeTimer &t);
void removeNodeTimer(v3s16 p);
/*
Utilities
*/
// Iterates through all nodes in the area in an unspecified order.
// The given callback takes the position as its first argument and the node
// as its second. If it returns false, forEachNodeInArea returns early.
template<typename F>
void forEachNodeInArea(v3s16 minp, v3s16 maxp, F func)
{
v3s16 bpmin = getNodeBlockPos(minp);
v3s16 bpmax = getNodeBlockPos(maxp);
for (s16 bz = bpmin.Z; bz <= bpmax.Z; bz++)
for (s16 bx = bpmin.X; bx <= bpmax.X; bx++)
for (s16 by = bpmin.Y; by <= bpmax.Y; by++) {
// y is iterated innermost to make use of the sector cache.
v3s16 bp(bx, by, bz);
MapBlock *block = getBlockNoCreateNoEx(bp);
v3s16 basep = bp * MAP_BLOCKSIZE;
s16 minx_block = rangelim(minp.X - basep.X, 0, MAP_BLOCKSIZE - 1);
s16 miny_block = rangelim(minp.Y - basep.Y, 0, MAP_BLOCKSIZE - 1);
s16 minz_block = rangelim(minp.Z - basep.Z, 0, MAP_BLOCKSIZE - 1);
s16 maxx_block = rangelim(maxp.X - basep.X, 0, MAP_BLOCKSIZE - 1);
s16 maxy_block = rangelim(maxp.Y - basep.Y, 0, MAP_BLOCKSIZE - 1);
s16 maxz_block = rangelim(maxp.Z - basep.Z, 0, MAP_BLOCKSIZE - 1);
for (s16 z_block = minz_block; z_block <= maxz_block; z_block++)
for (s16 y_block = miny_block; y_block <= maxy_block; y_block++)
for (s16 x_block = minx_block; x_block <= maxx_block; x_block++) {
v3s16 p = basep + v3s16(x_block, y_block, z_block);
MapNode n = block ?
block->getNodeNoCheck(x_block, y_block, z_block) :
MapNode(CONTENT_IGNORE);
if (!func(p, n))
return;
}
}
}
bool isBlockOccluded(MapBlock *block, v3s16 cam_pos_nodes)
{
return isBlockOccluded(block->getPosRelative(), cam_pos_nodes, false);
}
bool isBlockOccluded(v3s16 pos_relative, v3s16 cam_pos_nodes, bool simple_check = false);
protected:
IGameDef *m_gamedef;
std::set<MapEventReceiver*> m_event_receivers;
std::unordered_map<v2s16, MapSector*> m_sectors;
// Be sure to set this to NULL when the cached sector is deleted
MapSector *m_sector_cache = nullptr;
v2s16 m_sector_cache_p;
// This stores the properties of the nodes on the map.
const NodeDefManager *m_nodedef;
// Can be implemented by child class
virtual void reportMetrics(u64 save_time_us, u32 saved_blocks, u32 all_blocks) {}
bool determineAdditionalOcclusionCheck(v3s16 pos_camera,
const core::aabbox3d<s16> &block_bounds, v3s16 &to_check);
bool isOccluded(v3s16 pos_camera, v3s16 pos_target,
float step, float stepfac, float start_offset, float end_offset,
u32 needed_count);
};
#define VMANIP_BLOCK_DATA_INEXIST 1
#define VMANIP_BLOCK_CONTAINS_CIGNORE 2
class MMVManip : public VoxelManipulator
{
public:
MMVManip(Map *map);
virtual ~MMVManip() = default;
virtual void clear()
{
VoxelManipulator::clear();
m_loaded_blocks.clear();
}
void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
bool load_if_inexistent = true);
// This is much faster with big chunks of generated data
void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
bool overwrite_generated = true) const;
/*
Creates a copy of this VManip including contents, the copy will not be
associated with a Map.
*/
MMVManip *clone() const;
// Reassociates a copied VManip to a map
void reparent(Map *map);
// Is it impossible to call initialEmerge / blitBackAll?
inline bool isOrphan() const { return !m_map; }
bool m_is_dirty = false;
protected:
MMVManip() {};
// may be null
Map *m_map = nullptr;
/*
key = blockpos
value = flags describing the block
*/
std::map<v3s16, u8> m_loaded_blocks;
};