Freeze-melt adjust
[oweals/minetest.git] / src / voxel.h
index 3a4dacd4909b94d90b0a2dd51498e51b1290d37c..bed35b57e87a43acc9818995a4a24b91a07c37d9 100644 (file)
@@ -1,18 +1,18 @@
 /*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 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 General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+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.
 */
@@ -20,16 +20,37 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef VOXEL_HEADER
 #define VOXEL_HEADER
 
-#include "common_irrlicht.h"
-#include "mapblock.h"
+#include "irrlichttypes.h"
+#include "irr_v3d.h"
+#include <irrList.h>
 #include <iostream>
+#include "debug.h"
+#include "mapnode.h"
+#include <set>
+#include <list>
+
+class INodeDefManager;
+
+// For VC++
+#undef min
+#undef max
 
 /*
-       A fast voxel manipulator class
+       A fast voxel manipulator class.
+
+       In normal operation, it fetches more map when it is requested.
+       It can also be used so that all allowed area is fetched at the
+       start, using ManualMapVoxelManipulator.
 
        Not thread-safe.
 */
 
+/*
+       Debug stuff
+*/
+extern u32 emerge_time;
+extern u32 emerge_load_time;
+
 /*
        This class resembles aabbox3d<s16> a lot, but has inclusive
        edges for saner handling of integer sizes
@@ -53,8 +74,18 @@ public:
                MaxEdge(p)
        {
        }
+
+       /*
+               Modifying methods
+       */
+
        void addArea(VoxelArea &a)
        {
+               if(getExtent() == v3s16(0,0,0))
+               {
+                       *this = a;
+                       return;
+               }
                if(a.MinEdge.X < MinEdge.X) MinEdge.X = a.MinEdge.X;
                if(a.MinEdge.Y < MinEdge.Y) MinEdge.Y = a.MinEdge.Y;
                if(a.MinEdge.Z < MinEdge.Z) MinEdge.Z = a.MinEdge.Z;
@@ -64,6 +95,12 @@ public:
        }
        void addPoint(v3s16 p)
        {
+               if(getExtent() == v3s16(0,0,0))
+               {
+                       MinEdge = p;
+                       MaxEdge = p;
+                       return;
+               }
                if(p.X < MinEdge.X) MinEdge.X = p.X;
                if(p.Y < MinEdge.Y) MinEdge.Y = p.Y;
                if(p.Z < MinEdge.Z) MinEdge.Z = p.Z;
@@ -71,6 +108,30 @@ public:
                if(p.Y > MaxEdge.Y) MaxEdge.Y = p.Y;
                if(p.Z > MaxEdge.Z) MaxEdge.Z = p.Z;
        }
+
+       // Pad with d nodes
+       void pad(v3s16 d)
+       {
+               MinEdge -= d;
+               MaxEdge += d;
+       }
+
+       /*void operator+=(v3s16 off)
+       {
+               MinEdge += off;
+               MaxEdge += off;
+       }
+
+       void operator-=(v3s16 off)
+       {
+               MinEdge -= off;
+               MaxEdge -= off;
+       }*/
+
+       /*
+               const methods
+       */
+
        v3s16 getExtent() const
        {
                return MaxEdge - MinEdge + v3s16(1,1,1);
@@ -80,8 +141,13 @@ public:
                v3s16 e = getExtent();
                return (s32)e.X * (s32)e.Y * (s32)e.Z;
        }
-       bool contains(VoxelArea &a) const
+       bool contains(const VoxelArea &a) const
        {
+               // No area contains an empty area
+               // NOTE: Algorithms depend on this, so do not change.
+               if(a.getExtent() == v3s16(0,0,0))
+                       return false;
+
                return(
                        a.MinEdge.X >= MinEdge.X && a.MaxEdge.X <= MaxEdge.X &&
                        a.MinEdge.Y >= MinEdge.Y && a.MaxEdge.Y <= MaxEdge.Y &&
@@ -96,12 +162,105 @@ public:
                        p.Z >= MinEdge.Z && p.Z <= MaxEdge.Z
                );
        }
+       bool contains(s32 i) const
+       {
+               return (i >= 0 && i < getVolume());
+       }
        bool operator==(const VoxelArea &other) const
        {
                return (MinEdge == other.MinEdge
                                && MaxEdge == other.MaxEdge);
        }
-       
+
+       VoxelArea operator+(v3s16 off) const
+       {
+               return VoxelArea(MinEdge+off, MaxEdge+off);
+       }
+
+       VoxelArea operator-(v3s16 off) const
+       {
+               return VoxelArea(MinEdge-off, MaxEdge-off);
+       }
+
+       /*
+               Returns 0-6 non-overlapping areas that can be added to
+               a to make up this area.
+
+               a: area inside *this
+       */
+       void diff(const VoxelArea &a, std::list<VoxelArea> &result)
+       {
+               /*
+                       This can result in a maximum of 6 areas
+               */
+
+               // If a is an empty area, return the current area as a whole
+               if(a.getExtent() == v3s16(0,0,0))
+               {
+                       VoxelArea b = *this;
+                       if(b.getVolume() != 0)
+                               result.push_back(b);
+                       return;
+               }
+
+               assert(contains(a));
+
+               // Take back area, XY inclusive
+               {
+                       v3s16 min(MinEdge.X, MinEdge.Y, a.MaxEdge.Z+1);
+                       v3s16 max(MaxEdge.X, MaxEdge.Y, MaxEdge.Z);
+                       VoxelArea b(min, max);
+                       if(b.getVolume() != 0)
+                               result.push_back(b);
+               }
+
+               // Take front area, XY inclusive
+               {
+                       v3s16 min(MinEdge.X, MinEdge.Y, MinEdge.Z);
+                       v3s16 max(MaxEdge.X, MaxEdge.Y, a.MinEdge.Z-1);
+                       VoxelArea b(min, max);
+                       if(b.getVolume() != 0)
+                               result.push_back(b);
+               }
+
+               // Take top area, X inclusive
+               {
+                       v3s16 min(MinEdge.X, a.MaxEdge.Y+1, a.MinEdge.Z);
+                       v3s16 max(MaxEdge.X, MaxEdge.Y, a.MaxEdge.Z);
+                       VoxelArea b(min, max);
+                       if(b.getVolume() != 0)
+                               result.push_back(b);
+               }
+
+               // Take bottom area, X inclusive
+               {
+                       v3s16 min(MinEdge.X, MinEdge.Y, a.MinEdge.Z);
+                       v3s16 max(MaxEdge.X, a.MinEdge.Y-1, a.MaxEdge.Z);
+                       VoxelArea b(min, max);
+                       if(b.getVolume() != 0)
+                               result.push_back(b);
+               }
+
+               // Take left area, non-inclusive
+               {
+                       v3s16 min(MinEdge.X, a.MinEdge.Y, a.MinEdge.Z);
+                       v3s16 max(a.MinEdge.X-1, a.MaxEdge.Y, a.MaxEdge.Z);
+                       VoxelArea b(min, max);
+                       if(b.getVolume() != 0)
+                               result.push_back(b);
+               }
+
+               // Take right area, non-inclusive
+               {
+                       v3s16 min(a.MaxEdge.X+1, a.MinEdge.Y, a.MinEdge.Z);
+                       v3s16 max(MaxEdge.X, a.MaxEdge.Y, a.MaxEdge.Z);
+                       VoxelArea b(min, max);
+                       if(b.getVolume() != 0)
+                               result.push_back(b);
+               }
+
+       }
+
        /*
                Translates position from virtual coordinates to array index
        */
@@ -118,15 +277,41 @@ public:
                return index(p.X, p.Y, p.Z);
        }
 
+       // Translate index in the X coordinate
+       void add_x(const v3s16 &extent, u32 &i, s16 a)
+       {
+               i += a;
+       }
+       // Translate index in the Y coordinate
+       void add_y(const v3s16 &extent, u32 &i, s16 a)
+       {
+               i += a * extent.X;
+       }
+       // Translate index in the Z coordinate
+       void add_z(const v3s16 &extent, u32 &i, s16 a)
+       {
+               i += a * extent.X*extent.Y;
+       }
+       // Translate index in space
+       void add_p(const v3s16 &extent, u32 &i, v3s16 a)
+       {
+               i += a.Z*extent.X*extent.Y + a.Y*extent.X + a.X;
+       }
+
+       /*
+               Print method for debugging
+       */
        void print(std::ostream &o) const
        {
+               v3s16 e = getExtent();
                o<<"("<<MinEdge.X
                 <<","<<MinEdge.Y
                 <<","<<MinEdge.Z
                 <<")("<<MaxEdge.X
                 <<","<<MaxEdge.Y
                 <<","<<MaxEdge.Z
-                <<")";
+                <<")"
+                <<"="<<e.X<<"x"<<e.Y<<"x"<<e.Z<<"="<<getVolume();
        }
 
        // Edges are inclusive
@@ -139,18 +324,32 @@ public:
 // Checked as being inexistent in source
 #define VOXELFLAG_INEXISTENT (1<<1)
 // Algorithm-dependent
-#define VOXELFLAG_CHECKED (1<<2)
+#define VOXELFLAG_CHECKED1 (1<<2)
+// Algorithm-dependent
+#define VOXELFLAG_CHECKED2 (1<<3)
+// Algorithm-dependent
+#define VOXELFLAG_CHECKED3 (1<<4)
+// Algorithm-dependent
+#define VOXELFLAG_CHECKED4 (1<<5)
 
-class VoxelManipulator : public NodeContainer
+enum VoxelPrintMode
+{
+       VOXELPRINT_NOTHING,
+       VOXELPRINT_MATERIAL,
+       VOXELPRINT_WATERPRESSURE,
+       VOXELPRINT_LIGHT_DAY,
+};
+
+class VoxelManipulator /*: public NodeContainer*/
 {
 public:
        VoxelManipulator();
-       ~VoxelManipulator();
-       
+       virtual ~VoxelManipulator();
+
        /*
                Virtuals from NodeContainer
        */
-       virtual u16 nodeContainerId() const
+       /*virtual u16 nodeContainerId() const
        {
                return NODECONTAINER_ID_VOXELMANIPULATOR;
        }
@@ -158,34 +357,88 @@ public:
        {
                emerge(p);
                return !(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT);
-       }
-       // These are a bit slow and shouldn't be used internally
+       }*/
+
+       /*
+               These are a bit slow and shouldn't be used internally.
+               Use m_data[m_area.index(p)] instead.
+       */
        MapNode getNode(v3s16 p)
        {
                emerge(p);
 
                if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
                {
-                       dstream<<"ERROR: VoxelManipulator::getNode(): "
+                       /*dstream<<"EXCEPT: VoxelManipulator::getNode(): "
                                        <<"p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"
                                        <<", index="<<m_area.index(p)
                                        <<", flags="<<(int)m_flags[m_area.index(p)]
-                                       <<" is inexistent"<<std::endl;
+                                       <<" is inexistent"<<std::endl;*/
                        throw InvalidPositionException
                        ("VoxelManipulator: getNode: inexistent");
                }
 
                return m_data[m_area.index(p)];
        }
-       void setNode(v3s16 p, MapNode &n)
+       MapNode getNodeNoEx(v3s16 p)
+       {
+               emerge(p);
+
+               if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
+               {
+                       return MapNode(CONTENT_IGNORE);
+               }
+
+               return m_data[m_area.index(p)];
+       }
+       MapNode getNodeNoExNoEmerge(v3s16 p)
+       {
+               if(m_area.contains(p) == false)
+                       return MapNode(CONTENT_IGNORE);
+               if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
+                       return MapNode(CONTENT_IGNORE);
+               return m_data[m_area.index(p)];
+       }
+       // Stuff explodes if non-emerged area is touched with this.
+       // Emerge first, and check VOXELFLAG_INEXISTENT if appropriate.
+       MapNode & getNodeRefUnsafe(v3s16 p)
+       {
+               return m_data[m_area.index(p)];
+       }
+       u8 & getFlagsRefUnsafe(v3s16 p)
+       {
+               return m_flags[m_area.index(p)];
+       }
+       bool exists(v3s16 p)
+       {
+               return m_area.contains(p) &&
+                       !(getFlagsRefUnsafe(p) & VOXELFLAG_INEXISTENT);
+       }
+       MapNode & getNodeRef(v3s16 p)
        {
                emerge(p);
-               
+               if(getFlagsRefUnsafe(p) & VOXELFLAG_INEXISTENT)
+               {
+                       /*dstream<<"EXCEPT: VoxelManipulator::getNode(): "
+                                       <<"p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"
+                                       <<", index="<<m_area.index(p)
+                                       <<", flags="<<(int)getFlagsRefUnsafe(p)
+                                       <<" is inexistent"<<std::endl;*/
+                       throw InvalidPositionException
+                       ("VoxelManipulator: getNode: inexistent");
+               }
+               return getNodeRefUnsafe(p);
+       }
+       void setNode(v3s16 p, const MapNode &n)
+       {
+               emerge(p);
+
                m_data[m_area.index(p)] = n;
                m_flags[m_area.index(p)] &= ~VOXELFLAG_INEXISTENT;
                m_flags[m_area.index(p)] &= ~VOXELFLAG_NOT_LOADED;
        }
-       void setNodeNoRef(v3s16 p, MapNode n)
+       // TODO: Should be removed and replaced with setNode
+       void setNodeNoRef(v3s16 p, const MapNode &n)
        {
                setNode(p, n);
        }
@@ -206,32 +459,81 @@ public:
                //dstream<<"operator[] p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"<<std::endl;
                if(isValidPosition(p) == false)
                        emerge(VoxelArea(p));
-               
+
                return m_data[m_area.index(p)];
        }*/
 
+       /*
+               Set stuff if available without an emerge.
+               Return false if failed.
+               This is convenient but slower than playing around directly
+               with the m_data table with indices.
+       */
+       bool setNodeNoEmerge(v3s16 p, MapNode n)
+       {
+               if(m_area.contains(p) == false)
+                       return false;
+               m_data[m_area.index(p)] = n;
+               return true;
+       }
+       bool setNodeNoEmerge(s32 i, MapNode n)
+       {
+               if(m_area.contains(i) == false)
+                       return false;
+               m_data[i] = n;
+               return true;
+       }
+       /*bool setContentNoEmerge(v3s16 p, u8 c)
+       {
+               if(isValidPosition(p) == false)
+                       return false;
+               m_data[m_area.index(p)].d = c;
+       }*/
+
        /*
                Control
        */
 
-       void clear();
-       
-       void print(std::ostream &o);
-       
+       virtual void clear();
+
+       void print(std::ostream &o, INodeDefManager *nodemgr,
+                       VoxelPrintMode mode=VOXELPRINT_MATERIAL);
+
        void addArea(VoxelArea area);
 
+       /*
+               Copy data and set flags to 0
+               dst_area.getExtent() <= src_area.getExtent()
+       */
+       void copyFrom(MapNode *src, VoxelArea src_area,
+                       v3s16 from_pos, v3s16 to_pos, v3s16 size);
+
+       // Copy data
+       void copyTo(MapNode *dst, VoxelArea dst_area,
+                       v3s16 dst_pos, v3s16 from_pos, v3s16 size);
+
        /*
                Algorithms
        */
 
-       void interpolate(VoxelArea area);
+       void clearFlag(u8 flag);
 
-       void flowWater(v3s16 removed_pos);
+       // TODO: Move to voxelalgorithms.h
+
+       void unspreadLight(enum LightBank bank, v3s16 p, u8 oldlight,
+                       std::set<v3s16> & light_sources, INodeDefManager *nodemgr);
+       void unspreadLight(enum LightBank bank,
+                       std::map<v3s16, u8> & from_nodes,
+                       std::set<v3s16> & light_sources, INodeDefManager *nodemgr);
+
+       void spreadLight(enum LightBank bank, v3s16 p, INodeDefManager *nodemgr);
+       void spreadLight(enum LightBank bank,
+                       std::set<v3s16> & from_nodes, INodeDefManager *nodemgr);
 
        /*
                Virtual functions
        */
-       
+
        /*
                Get the contents of the requested area from somewhere.
                Shall touch only nodes that have VOXELFLAG_NOT_LOADED
@@ -239,7 +541,7 @@ public:
 
                If not found from source, add with VOXELFLAG_INEXISTENT
        */
-       virtual void emerge(VoxelArea a)
+       virtual void emerge(VoxelArea a, s32 caller_id=-1)
        {
                //dstream<<"emerge p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"<<std::endl;
                addArea(a);
@@ -265,31 +567,29 @@ public:
                MaxEdge is 1 higher than maximum allowed position
        */
        VoxelArea m_area;
+
        /*
                NULL if data size is 0 (extent (0,0,0))
                Data is stored as [z*h*w + y*h + x]
        */
        MapNode *m_data;
+
        /*
                Flags of all nodes
        */
        u8 *m_flags;
-private:
-};
 
-class Map;
+       //TODO: Use these or remove them
+       //TODO: Would these make any speed improvement?
+       //bool m_pressure_route_valid;
+       //v3s16 m_pressure_route_surface;
 
-class MapVoxelManipulator : public VoxelManipulator
-{
-public:
-       MapVoxelManipulator(Map *map);
-
-       virtual void emerge(VoxelArea a);
-
-       void blitBack(core::map<v3s16, MapBlock*> & modified_blocks);
+       /*
+               Some settings
+       */
+       //bool m_disable_water_climb;
 
 private:
-       Map *m_map;
 };
 
 #endif