]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/mapblock.h
Use system sqlite3/jthread libs if available
[dragonfireclient.git] / src / mapblock.h
index 2743d8397c9609ee3a1da839808d637d25215770..8f3b8464a83bedbaa714555211045b18f56235c3 100644 (file)
@@ -31,10 +31,18 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "constants.h"
 #include "mapblockobject.h"
 #include "voxel.h"
+#include "nodemetadata.h"
+#include "staticobject.h"
+#include "mapblock_nodemod.h"
+#ifndef SERVER
+       #include "mapblock_mesh.h"
+#endif
+
+class Map;
 
-#define MAP_BLOCKSIZE 16
+#define BLOCK_TIMESTAMP_UNDEFINED 0xffffffff
 
-// Named by looking towards z+
+/*// Named by looking towards z+
 enum{
        FACE_BACK=0,
        FACE_TOP,
@@ -42,31 +50,39 @@ enum{
        FACE_FRONT,
        FACE_BOTTOM,
        FACE_LEFT
-};
+};*/
 
-struct FastFace
+enum ModifiedState
 {
-       TileSpec tile;
-       video::S3DVertex vertices[4]; // Precalculated vertices
+       // Has not been modified.
+       MOD_STATE_CLEAN = 0,
+       MOD_RESERVED1 = 1,
+       // Has been modified, and will be saved when being unloaded.
+       MOD_STATE_WRITE_AT_UNLOAD = 2,
+       MOD_RESERVED3 = 3,
+       // Has been modified, and will be saved as soon as possible.
+       MOD_STATE_WRITE_NEEDED = 4,
+       MOD_RESERVED5 = 5,
 };
 
-enum NodeModType
+// NOTE: If this is enabled, set MapBlock to be initialized with
+//       CONTENT_IGNORE.
+/*enum BlockGenerationStatus
 {
-       NODEMOD_NONE,
-       NODEMOD_CHANGECONTENT, //param is content id
-       NODEMOD_CRACK // param is crack progression
-};
-
-struct NodeMod
-{
-       NodeMod()
-       {
-               type = NODEMOD_NONE;
-       }
-       enum NodeModType type;
-       u16 param;
-};
-
+       // Completely non-generated (filled with CONTENT_IGNORE).
+       BLOCKGEN_UNTOUCHED=0,
+       // Trees or similar might have been blitted from other blocks to here.
+       // Otherwise, the block contains CONTENT_IGNORE
+       BLOCKGEN_FROM_NEIGHBORS=2,
+       // Has been generated, but some neighbors might put some stuff in here
+       // when they are generated.
+       // Does not contain any CONTENT_IGNORE
+       BLOCKGEN_SELF_GENERATED=4,
+       // The block and all its neighbors have been generated
+       BLOCKGEN_FULLY_GENERATED=6
+};*/
+
+#if 0
 enum
 {
        NODECONTAINER_ID_MAPBLOCK,
@@ -83,55 +99,119 @@ class NodeContainer
        virtual MapNode getNode(v3s16 p) = 0;
        virtual void setNode(v3s16 p, MapNode & n) = 0;
        virtual u16 nodeContainerId() const = 0;
+
+       MapNode getNodeNoEx(v3s16 p)
+       {
+               try{
+                       return getNode(p);
+               }
+               catch(InvalidPositionException &e){
+                       return MapNode(CONTENT_IGNORE);
+               }
+       }
 };
+#endif
 
-class MapBlock : public NodeContainer
+/*
+       MapBlock itself
+*/
+
+class MapBlock /*: public NodeContainer*/
 {
 public:
-
-       //scene::SMesh *mesh[DAYNIGHT_CACHE_COUNT];
-       scene::SMesh *mesh;
-       JMutex mesh_mutex;
-
-       MapBlock(NodeContainer *parent, v3s16 pos, bool dummy=false);
+       MapBlock(Map *parent, v3s16 pos, bool dummy=false);
        ~MapBlock();
        
-       virtual u16 nodeContainerId() const
+       /*virtual u16 nodeContainerId() const
        {
                return NODECONTAINER_ID_MAPBLOCK;
+       }*/
+       
+       Map * getParent()
+       {
+               return m_parent;
        }
 
-       NodeContainer * getParent()
+       void reallocate()
        {
-               return m_parent;
+               if(data != NULL)
+                       delete[] data;
+               u32 l = MAP_BLOCKSIZE * MAP_BLOCKSIZE * MAP_BLOCKSIZE;
+               data = new MapNode[l];
+               for(u32 i=0; i<l; i++){
+                       //data[i] = MapNode();
+                       data[i] = MapNode(CONTENT_IGNORE);
+               }
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
 
+       /*
+               Flags
+       */
+
        bool isDummy()
        {
                return (data == NULL);
        }
-
        void unDummify()
        {
                assert(isDummy());
                reallocate();
        }
        
-       bool getChangedFlag()
+       /*
+               This is called internally or externally after the block is
+               modified, so that the block is saved and possibly not deleted from
+               memory.
+       */
+       // DEPRECATED, use *Modified()
+       void setChangedFlag()
        {
-               return changed;
+               //dstream<<"Deprecated setChangedFlag() called"<<std::endl;
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
-
+       // DEPRECATED, use *Modified()
        void resetChangedFlag()
        {
-               changed = false;
+               //dstream<<"Deprecated resetChangedFlag() called"<<std::endl;
+               resetModified();
        }
-
-       void setChangedFlag()
+       // DEPRECATED, use *Modified()
+       bool getChangedFlag()
+       {
+               //dstream<<"Deprecated getChangedFlag() called"<<std::endl;
+               if(getModified() == MOD_STATE_CLEAN)
+                       return false;
+               else
+                       return true;
+       }
+       
+       // m_modified methods
+       void raiseModified(u32 mod)
+       {
+               m_modified = MYMAX(m_modified, mod);
+       }
+       u32 getModified()
+       {
+               return m_modified;
+       }
+       void resetModified()
+       {
+               m_modified = MOD_STATE_CLEAN;
+       }
+       
+       // is_underground getter/setter
+       bool getIsUnderground()
+       {
+               return is_underground;
+       }
+       void setIsUnderground(bool a_is_underground)
        {
-               changed = true;
+               is_underground = a_is_underground;
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
 
+#ifndef SERVER
        void setMeshExpired(bool expired)
        {
                m_mesh_expired = expired;
@@ -141,28 +221,51 @@ class MapBlock : public NodeContainer
        {
                return m_mesh_expired;
        }
+#endif
 
-       v3s16 getPos()
+       void setLightingExpired(bool expired)
        {
-               return m_pos;
+               m_lighting_expired = expired;
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
-               
-       v3s16 getPosRelative()
+       bool getLightingExpired()
        {
-               return m_pos * MAP_BLOCKSIZE;
+               return m_lighting_expired;
        }
-               
-       bool getIsUnderground()
+
+       bool isGenerated()
        {
-               return is_underground;
+               return m_generated;
+       }
+       void setGenerated(bool b)
+       {
+               raiseModified(MOD_STATE_WRITE_NEEDED);
+               m_generated = b;
        }
 
-       void setIsUnderground(bool a_is_underground)
+       bool isValid()
        {
-               is_underground = a_is_underground;
-               setChangedFlag();
+               if(m_lighting_expired)
+                       return false;
+               if(data == NULL)
+                       return false;
+               return true;
        }
 
+       /*
+               Position stuff
+       */
+
+       v3s16 getPos()
+       {
+               return m_pos;
+       }
+               
+       v3s16 getPosRelative()
+       {
+               return m_pos * MAP_BLOCKSIZE;
+       }
+               
        core::aabbox3d<s16> getBox()
        {
                return core::aabbox3d<s16>(getPosRelative(),
@@ -170,19 +273,11 @@ class MapBlock : public NodeContainer
                                + v3s16(MAP_BLOCKSIZE, MAP_BLOCKSIZE, MAP_BLOCKSIZE)
                                - v3s16(1,1,1));
        }
-       
-       void reallocate()
-       {
-               if(data != NULL)
-                       delete[] data;
-               u32 l = MAP_BLOCKSIZE * MAP_BLOCKSIZE * MAP_BLOCKSIZE;
-               data = new MapNode[l];
-               for(u32 i=0; i<l; i++){
-                       data[i] = MapNode();
-               }
-               setChangedFlag();
-       }
 
+       /*
+               Regular MapNode get-setters
+       */
+       
        bool isValidPosition(v3s16 p)
        {
                if(data == NULL)
@@ -192,10 +287,6 @@ class MapBlock : public NodeContainer
                                && p.Z >= 0 && p.Z < MAP_BLOCKSIZE);
        }
 
-       /*
-               Regular MapNode get-setters
-       */
-       
        MapNode getNode(s16 x, s16 y, s16 z)
        {
                if(data == NULL)
@@ -211,6 +302,15 @@ class MapBlock : public NodeContainer
                return getNode(p.X, p.Y, p.Z);
        }
        
+       MapNode getNodeNoEx(v3s16 p)
+       {
+               try{
+                       return getNode(p.X, p.Y, p.Z);
+               }catch(InvalidPositionException &e){
+                       return MapNode(CONTENT_IGNORE);
+               }
+       }
+       
        void setNode(s16 x, s16 y, s16 z, MapNode & n)
        {
                if(data == NULL)
@@ -219,7 +319,7 @@ class MapBlock : public NodeContainer
                if(y < 0 || y >= MAP_BLOCKSIZE) throw InvalidPositionException();
                if(z < 0 || z >= MAP_BLOCKSIZE) throw InvalidPositionException();
                data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x] = n;
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        
        void setNode(v3s16 p, MapNode & n)
@@ -248,7 +348,7 @@ class MapBlock : public NodeContainer
                if(data == NULL)
                        throw InvalidPositionException();
                data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x] = n;
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        
        void setNodeNoCheck(v3s16 p, MapNode & n)
@@ -273,14 +373,22 @@ class MapBlock : public NodeContainer
                                        setNode(x0+x, y0+y, z0+z, node);
        }
 
-       static void makeFastFace(TileSpec tile, u8 light, v3f p,
-                       v3s16 dir, v3f scale, v3f posRelative_f,
-                       core::array<FastFace> &dest);
+       /*
+               Graphics-related methods
+       */
        
+       /*// A quick version with nodes passed as parameters
        u8 getFaceLight(u32 daynight_ratio, MapNode n, MapNode n2,
-                       v3s16 face_dir);
-       
+                       v3s16 face_dir);*/
+       /*// A more convenient version
        u8 getFaceLight(u32 daynight_ratio, v3s16 p, v3s16 face_dir)
+       {
+               return getFaceLight(daynight_ratio,
+                               getNodeParentNoEx(p),
+                               getNodeParentNoEx(p + face_dir),
+                               face_dir);
+       }*/
+       u8 getFaceLight2(u32 daynight_ratio, v3s16 p, v3s16 face_dir)
        {
                return getFaceLight(daynight_ratio,
                                getNodeParentNoEx(p),
@@ -288,69 +396,64 @@ class MapBlock : public NodeContainer
                                face_dir);
        }
        
-       TileSpec getNodeTile(MapNode mn, v3s16 p, v3s16 face_dir);
-       u8 getNodeContent(v3s16 p, MapNode mn);
+#ifndef SERVER // Only on client
 
+#if 1
        /*
-               startpos:
-               translate_dir: unit vector with only one of x, y or z
-               face_dir: unit vector with only one of x, y or z
+               Thread-safely updates the whole mesh of the mapblock.
+               NOTE: Prefer generating the mesh separately and then using
+               replaceMesh().
        */
-       void updateFastFaceRow(
-                       u32 daynight_ratio,
-                       v3f posRelative_f,
-                       v3s16 startpos,
-                       u16 length,
-                       v3s16 translate_dir,
-                       v3f translate_dir_f,
-                       v3s16 face_dir,
-                       v3f face_dir_f,
-                       core::array<FastFace> &dest);
-
        void updateMesh(u32 daynight_ratio);
-       /*void updateMesh(s32 daynight_i);
-       // Updates all DAYNIGHT_CACHE_COUNT meshes
-       void updateMeshes(s32 first_i=0);*/
-
-       bool propagateSunlight(core::map<v3s16, bool> & light_sources);
+#endif
+       // Replace the mesh with a new one
+       void replaceMesh(scene::SMesh *mesh_new);
+#endif
+       
+       // See comments in mapblock.cpp
+       bool propagateSunlight(core::map<v3s16, bool> & light_sources,
+                       bool remove_light=false, bool *black_air_left=NULL);
        
        // Copies data to VoxelManipulator to getPosRelative()
        void copyTo(VoxelManipulator &dst);
+       // Copies data from VoxelManipulator getPosRelative()
+       void copyFrom(VoxelManipulator &dst);
 
        /*
-               Object stuff
+               MapBlockObject stuff
+               DEPRECATED
        */
        
-       void serializeObjects(std::ostream &os, u8 version)
+       /*void serializeObjects(std::ostream &os, u8 version)
        {
                m_objects.serialize(os, version);
-       }
+       }*/
        // If smgr!=NULL, new objects are added to the scene
        void updateObjects(std::istream &is, u8 version,
-                       scene::ISceneManager *smgr)
+                       scene::ISceneManager *smgr, u32 daynight_ratio)
        {
-               m_objects.update(is, version, smgr);
+               m_objects.update(is, version, smgr, daynight_ratio);
 
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        void clearObjects()
        {
                m_objects.clear();
 
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        void addObject(MapBlockObject *object)
                        throw(ContainerFullException, AlreadyExistsException)
        {
                m_objects.add(object);
 
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        void removeObject(s16 id)
        {
                m_objects.remove(id);
 
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        MapBlockObject * getObject(s16 id)
        {
@@ -360,19 +463,11 @@ class MapBlock : public NodeContainer
        {
                return m_objects.getLock();
        }
-       void stepObjects(float dtime, bool server)
-       {
-               m_objects.step(dtime, server);
-
-               setChangedFlag();
-       }
 
-       /*void wrapObject(MapBlockObject *object)
-       {
-               m_objects.wrapObject(object);
-
-               setChangedFlag();
-       }*/
+       /*
+               Moves objects, deletes objects and spawns new objects
+       */
+       void stepObjects(float dtime, bool server, u32 daynight_ratio);
 
        // origin is relative to block
        void getObjects(v3f origin, f32 max_d,
@@ -381,39 +476,64 @@ class MapBlock : public NodeContainer
                m_objects.getObjects(origin, max_d, dest);
        }
 
-       /*void getPseudoObjects(v3f origin, f32 max_d,
-                       core::array<DistanceSortedObject> &dest);*/
-
        s32 getObjectCount()
        {
                return m_objects.getCount();
        }
-       
+
+#ifndef SERVER // Only on client
        /*
                Methods for setting temporary modifications to nodes for
                drawing
+
+               returns true if the mod was different last time
        */
-       void setTempMod(v3s16 p, NodeMod mod)
+       bool setTempMod(v3s16 p, const NodeMod &mod)
        {
-               m_temp_mods[p] = mod;
+               /*dstream<<"setTempMod called on block"
+                               <<" ("<<p.X<<","<<p.Y<<","<<p.Z<<")"
+                               <<", mod.type="<<mod.type
+                               <<", mod.param="<<mod.param
+                               <<std::endl;*/
+               JMutexAutoLock lock(m_temp_mods_mutex);
+
+               return m_temp_mods.set(p, mod);
        }
-       void clearTempMod(v3s16 p)
+       // Returns true if there was one
+       bool getTempMod(v3s16 p, NodeMod *mod)
        {
-               if(m_temp_mods.find(p))
-                       m_temp_mods.remove(p);
+               JMutexAutoLock lock(m_temp_mods_mutex);
+
+               return m_temp_mods.get(p, mod);
        }
-       void clearTempMods()
+       bool clearTempMod(v3s16 p)
        {
-               m_temp_mods.clear();
+               JMutexAutoLock lock(m_temp_mods_mutex);
+
+               return m_temp_mods.clear(p);
        }
+       bool clearTempMods()
+       {
+               JMutexAutoLock lock(m_temp_mods_mutex);
+               
+               return m_temp_mods.clear();
+       }
+       void copyTempMods(NodeModMap &dst)
+       {
+               JMutexAutoLock lock(m_temp_mods_mutex);
+               m_temp_mods.copy(dst);
+       }
+#endif
 
        /*
-               Day-night lighting difference
+               Update day-night lighting difference flag.
+               
+               Sets m_day_night_differs to appropriate value.
                
                These methods don't care about neighboring blocks.
                It means that to know if a block really doesn't need a mesh
                update between day and night, the neighboring blocks have
-               to be taken into account.
+               to be taken into account. Use Map::dayNightDiffed().
        */
        void updateDayNightDiff();
 
@@ -422,16 +542,69 @@ class MapBlock : public NodeContainer
                return m_day_night_differs;
        }
 
+       /*
+               Miscellaneous stuff
+       */
+       
+       /*
+               Tries to measure ground level.
+               Return value:
+                       -1 = only air
+                       -2 = only ground
+                       -3 = random fail
+                       0...MAP_BLOCKSIZE-1 = ground level
+       */
+       s16 getGroundLevel(v2s16 p2d);
+
+       /*
+               Timestamp (see m_timestamp)
+               NOTE: BLOCK_TIMESTAMP_UNDEFINED=0xffffffff means there is no timestamp.
+       */
+       void setTimestamp(u32 time)
+       {
+               m_timestamp = time;
+               raiseModified(MOD_STATE_WRITE_AT_UNLOAD);
+       }
+       void setTimestampNoChangedFlag(u32 time)
+       {
+               m_timestamp = time;
+       }
+       u32 getTimestamp()
+       {
+               return m_timestamp;
+       }
+       
+       /*
+               See m_usage_timer
+       */
+       void resetUsageTimer()
+       {
+               m_usage_timer = 0;
+       }
+       void incrementUsageTimer(float dtime)
+       {
+               m_usage_timer += dtime;
+       }
+       u32 getUsageTimer()
+       {
+               return m_usage_timer;
+       }
+
        /*
                Serialization
        */
        
-       // Doesn't write version by itself
+       // These don't write or read version by itself
        void serialize(std::ostream &os, u8 version);
-
        void deSerialize(std::istream &is, u8 version);
+       // Used after the basic ones when writing on disk (serverside)
+       void serializeDiskExtra(std::ostream &os, u8 version);
+       void deSerializeDiskExtra(std::istream &is, u8 version);
 
 private:
+       /*
+               Private methods
+       */
 
        /*
                Used only internally, because changes can't be tracked
@@ -439,6 +612,8 @@ class MapBlock : public NodeContainer
 
        MapNode & getNodeRef(s16 x, s16 y, s16 z)
        {
+               if(data == NULL)
+                       throw InvalidPositionException();
                if(x < 0 || x >= MAP_BLOCKSIZE) throw InvalidPositionException();
                if(y < 0 || y >= MAP_BLOCKSIZE) throw InvalidPositionException();
                if(z < 0 || z >= MAP_BLOCKSIZE) throw InvalidPositionException();
@@ -449,38 +624,94 @@ class MapBlock : public NodeContainer
                return getNodeRef(p.X, p.Y, p.Z);
        }
 
+public:
+       /*
+               Public member variables
+       */
+
+#ifndef SERVER // Only on client
+       scene::SMesh *mesh;
+       JMutex mesh_mutex;
+#endif
+       
+       NodeMetadataList m_node_metadata;
+       StaticObjectList m_static_objects;
        
-       NodeContainer *m_parent;
+private:
+       /*
+               Private member variables
+       */
+
+       // NOTE: Lots of things rely on this being the Map
+       Map *m_parent;
        // Position in blocks on parent
        v3s16 m_pos;
+       
        /*
                If NULL, block is a dummy block.
                Dummy blocks are used for caching not-found-on-disk blocks.
        */
        MapNode * data;
+
        /*
-               - On the client, this is used for checking whether to
-                 recalculate the face cache. (Is it anymore?)
                - On the server, this is used for telling whether the
-                 block has been changed from the one on disk.
+                 block has been modified from the one on disk.
+               - On the client, this is used for nothing.
        */
-       bool changed;
+       u32 m_modified;
+
        /*
-               Used for some initial lighting stuff.
-               At least /has been/ used. 8)
+               When propagating sunlight and the above block doesn't exist,
+               sunlight is assumed if this is false.
+
+               In practice this is set to true if the block is completely
+               undeground with nothing visible above the ground except
+               caves.
        */
        bool is_underground;
 
-       bool m_mesh_expired;
+       /*
+               Set to true if changes has been made that make the old lighting
+               values wrong but the lighting hasn't been actually updated.
+
+               If this is false, lighting is exactly right.
+               If this is true, lighting might be wrong or right.
+       */
+       bool m_lighting_expired;
        
        // Whether day and night lighting differs
        bool m_day_night_differs;
+
+       bool m_generated;
        
+       // DEPRECATED
        MapBlockObjectList m_objects;
+
+#ifndef SERVER // Only on client
+       /*
+               Set to true if the mesh has been ordered to be updated
+               sometime in the background.
+               In practice this is set when the day/night lighting switches.
+       */
+       bool m_mesh_expired;
        
        // Temporary modifications to nodes
        // These are only used when drawing
-       core::map<v3s16, NodeMod> m_temp_mods;
+       NodeModMap m_temp_mods;
+       JMutex m_temp_mods_mutex;
+#endif
+       
+       /*
+               When block is removed from active blocks, this is set to gametime.
+               Value BLOCK_TIMESTAMP_UNDEFINED=0xffffffff means there is no timestamp.
+       */
+       u32 m_timestamp;
+
+       /*
+               When the block is accessed, this is set to 0.
+               Map will unload the block when this reaches a timeout.
+       */
+       float m_usage_timer;
 };
 
 inline bool blockpos_over_limit(v3s16 p)