]> git.lizzy.rs Git - minetest.git/blobdiff - src/voxel.h
Light update for map blocks
[minetest.git] / src / voxel.h
index 80d292891d61eac2e515f899eda2294644576352..58ad39be4a890d7f1fe6fe4ab1db6519dd4a024f 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,17 +20,28 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef VOXEL_HEADER
 #define VOXEL_HEADER
 
-#include "common_irrlicht.h"
+#include "irrlichttypes.h"
+#include "irr_v3d.h"
 #include <iostream>
 #include "debug.h"
+#include "exceptions.h"
 #include "mapnode.h"
+#include <set>
+#include <list>
+#include <map>
+
+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.
 */
@@ -64,14 +75,14 @@ class VoxelArea
                MaxEdge(p)
        {
        }
-       
+
        /*
                Modifying methods
        */
 
-       void addArea(VoxelArea &a)
+       void addArea(const VoxelArea &a)
        {
-               if(getExtent() == v3s16(0,0,0))
+               if (hasEmptyExtent())
                {
                        *this = a;
                        return;
@@ -83,9 +94,9 @@ class VoxelArea
                if(a.MaxEdge.Y > MaxEdge.Y) MaxEdge.Y = a.MaxEdge.Y;
                if(a.MaxEdge.Z > MaxEdge.Z) MaxEdge.Z = a.MaxEdge.Z;
        }
-       void addPoint(v3s16 p)
+       void addPoint(const v3s16 &p)
        {
-               if(getExtent() == v3s16(0,0,0))
+               if(hasEmptyExtent())
                {
                        MinEdge = p;
                        MaxEdge = p;
@@ -98,14 +109,14 @@ class VoxelArea
                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)
+       void pad(const v3s16 &d)
        {
                MinEdge -= d;
                MaxEdge += d;
        }
-       
+
        /*void operator+=(v3s16 off)
        {
                MinEdge += off;
@@ -126,6 +137,15 @@ class VoxelArea
        {
                return MaxEdge - MinEdge + v3s16(1,1,1);
        }
+
+       /* Because MaxEdge and MinEdge are included in the voxel area an empty extent
+        * is not represented by (0, 0, 0), but instead (-1, -1, -1)
+        */
+       bool hasEmptyExtent() const
+       {
+               return MaxEdge - MinEdge == v3s16(-1, -1, -1);
+       }
+
        s32 getVolume() const
        {
                v3s16 e = getExtent();
@@ -135,7 +155,7 @@ class VoxelArea
        {
                // No area contains an empty area
                // NOTE: Algorithms depend on this, so do not change.
-               if(a.getExtent() == v3s16(0,0,0))
+               if(a.hasEmptyExtent())
                        return false;
 
                return(
@@ -152,6 +172,10 @@ class VoxelArea
                        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
@@ -174,7 +198,7 @@ class VoxelArea
 
                a: area inside *this
        */
-       void diff(const VoxelArea &a, core::list<VoxelArea> &result)
+       void diff(const VoxelArea &a, std::list<VoxelArea> &result)
        {
                /*
                        This can result in a maximum of 6 areas
@@ -189,8 +213,8 @@ class VoxelArea
                        return;
                }
 
-               assert(contains(a));
-               
+               assert(contains(a));    // pre-condition
+
                // Take back area, XY inclusive
                {
                        v3s16 min(MinEdge.X, MinEdge.Y, a.MaxEdge.Z+1);
@@ -246,7 +270,7 @@ class VoxelArea
                }
 
        }
-       
+
        /*
                Translates position from virtual coordinates to array index
        */
@@ -263,6 +287,30 @@ class VoxelArea
                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();
@@ -281,21 +329,17 @@ class VoxelArea
        v3s16 MaxEdge;
 };
 
-// Hasn't been copied from source (emerged)
-#define VOXELFLAG_NOT_LOADED (1<<0)
-// Checked as being inexistent in source
-#define VOXELFLAG_INEXISTENT (1<<1)
+// unused 
+#define VOXELFLAG_UNUSED   (1<<0)
+// no data about that node
+#define VOXELFLAG_NO_DATA  (1<<1)
 // Algorithm-dependent
-// flowWater: "visited"
-#define VOXELFLAG_CHECKED (1<<2)
+#define VOXELFLAG_CHECKED1 (1<<2)
 // Algorithm-dependent
-// getWaterPressure: "visited"
 #define VOXELFLAG_CHECKED2 (1<<3)
 // Algorithm-dependent
-// spreadWaterPressure: "visited"
 #define VOXELFLAG_CHECKED3 (1<<4)
 // Algorithm-dependent
-// water: "pressure check route node"
 #define VOXELFLAG_CHECKED4 (1<<5)
 
 enum VoxelPrintMode
@@ -303,6 +347,7 @@ enum VoxelPrintMode
        VOXELPRINT_NOTHING,
        VOXELPRINT_MATERIAL,
        VOXELPRINT_WATERPRESSURE,
+       VOXELPRINT_LIGHT_DAY,
 };
 
 class VoxelManipulator /*: public NodeContainer*/
@@ -310,7 +355,7 @@ class VoxelManipulator /*: public NodeContainer*/
 public:
        VoxelManipulator();
        virtual ~VoxelManipulator();
-       
+
        /*
                Virtuals from NodeContainer
        */
@@ -320,8 +365,8 @@ class VoxelManipulator /*: public NodeContainer*/
        }
        bool isValidPosition(v3s16 p)
        {
-               emerge(p);
-               return !(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT);
+               addArea(p);
+               return !(m_flags[m_area.index(p)] & VOXELFLAG_NO_DATA);
        }*/
 
        /*
@@ -330,42 +375,106 @@ class VoxelManipulator /*: public NodeContainer*/
        */
        MapNode getNode(v3s16 p)
        {
-               emerge(p);
+               VoxelArea voxel_area(p);
+               addArea(voxel_area);
 
-               if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
+               if(m_flags[m_area.index(p)] & VOXELFLAG_NO_DATA)
                {
-                       dstream<<"EXCEPT: 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)
+       {
+               VoxelArea voxel_area(p);
+               addArea(voxel_area);
+
+               if(m_flags[m_area.index(p)] & VOXELFLAG_NO_DATA)
+               {
+                       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_NO_DATA)
+                       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_NO_DATA if appropriate.
+       MapNode & getNodeRefUnsafe(const v3s16 &p)
+       {
+               return m_data[m_area.index(p)];
+       }
+
+       const MapNode & getNodeRefUnsafeCheckFlags(const v3s16 &p)
+       {
+               s32 index = m_area.index(p);
+
+               if (m_flags[index] & VOXELFLAG_NO_DATA)
+                       return ContentIgnoreNode;
+
+               return m_data[index];
+       }
+
+       u8 & getFlagsRefUnsafe(v3s16 p)
+       {
+               return m_flags[m_area.index(p)];
+       }
+       bool exists(v3s16 p)
+       {
+               return m_area.contains(p) &&
+                       !(getFlagsRefUnsafe(p) & VOXELFLAG_NO_DATA);
+       }
+       MapNode & getNodeRef(v3s16 p)
+       {
+               VoxelArea voxel_area(p);
+               addArea(voxel_area);
+               if(getFlagsRefUnsafe(p) & VOXELFLAG_NO_DATA)
+               {
+                       /*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);
-               
+               VoxelArea voxel_area(p);
+               addArea(voxel_area);
+
                m_data[m_area.index(p)] = n;
-               m_flags[m_area.index(p)] &= ~VOXELFLAG_INEXISTENT;
-               m_flags[m_area.index(p)] &= ~VOXELFLAG_NOT_LOADED;
+               m_flags[m_area.index(p)] &= ~VOXELFLAG_NO_DATA;
        }
-       void setNodeNoRef(v3s16 p, MapNode n)
+       // TODO: Should be removed and replaced with setNode
+       void setNodeNoRef(v3s16 p, const MapNode &n)
        {
                setNode(p, n);
        }
 
        /*void setExists(VoxelArea a)
        {
-               emerge(a);
+               addArea(a);
                for(s32 z=a.MinEdge.Z; z<=a.MaxEdge.Z; z++)
                for(s32 y=a.MinEdge.Y; y<=a.MaxEdge.Y; y++)
                for(s32 x=a.MinEdge.X; x<=a.MaxEdge.X; x++)
                {
-                       m_flags[m_area.index(x,y,z)] &= ~VOXELFLAG_INEXISTENT;
+                       m_flags[m_area.index(x,y,z)] &= ~VOXELFLAG_NO_DATA;
                }
        }*/
 
@@ -373,126 +482,81 @@ class VoxelManipulator /*: public NodeContainer*/
        {
                //dstream<<"operator[] p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"<<std::endl;
                if(isValidPosition(p) == false)
-                       emerge(VoxelArea(p));
-               
+                       addArea(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
        */
 
        virtual void clear();
 
-       void print(std::ostream &o, VoxelPrintMode mode=VOXELPRINT_MATERIAL);
-       
-       void addArea(VoxelArea area);
+       void print(std::ostream &o, INodeDefManager *nodemgr,
+                       VoxelPrintMode mode=VOXELPRINT_MATERIAL);
+
+       void addArea(const VoxelArea &area);
 
        /*
                Copy data and set flags to 0
                dst_area.getExtent() <= src_area.getExtent()
        */
-       void copyFrom(MapNode *src, VoxelArea src_area,
+       void copyFrom(MapNode *src, const VoxelArea& src_area,
                        v3s16 from_pos, v3s16 to_pos, v3s16 size);
 
+       // Copy data
+       void copyTo(MapNode *dst, const VoxelArea& dst_area,
+                       v3s16 dst_pos, v3s16 from_pos, v3s16 size);
+
        /*
                Algorithms
        */
 
        void clearFlag(u8 flag);
-       
-       void unspreadLight(enum LightBank bank, v3s16 p, u8 oldlight,
-                       core::map<v3s16, bool> & light_sources);
-       void unspreadLight(enum LightBank bank,
-                       core::map<v3s16, u8> & from_nodes,
-                       core::map<v3s16, bool> & light_sources);
-       
-       void spreadLight(enum LightBank bank, v3s16 p);
-       void spreadLight(enum LightBank bank,
-                       core::map<v3s16, bool> & from_nodes);
-       
-#if 0
-       // VOXELFLAG_CHECKED2s must usually be cleared before calling
-       // -1: dead end, 0-255: pressure
-       // highest_y: Highest found water y is stored here.
-       //            Must be initialized to -32768
-       int getWaterPressure(v3s16 p, s16 &highest_y, int recur_count);
 
-       /*
-               VOXELFLAG_CHECKED3s must usually be cleared before calling.
+       // TODO: Move to voxelalgorithms.h
 
-               active_nodes: surface-touching air nodes with flow-causing
-               pressure. set-like dummy map container.
-
-               Spreads pressure pr at node p to request_area or as far as
-               there is invalid pressure.
-       */
-       void spreadWaterPressure(v3s16 p, int pr,
-                       VoxelArea request_area,
-                       core::map<v3s16, u8> &active_nodes,
-                       int recur_count);
-       
-       /*
-               VOXELFLAG_CHECKED3s must usually be cleared before calling.
-       */
-       void updateAreaWaterPressure(VoxelArea a,
-                       core::map<v3s16, u8> &active_nodes,
-                       bool checked3_is_clear=false);
-       
-       /*
-               Returns true if moved something
-       */
-       bool flowWater(v3s16 removed_pos,
-                       core::map<v3s16, u8> &active_nodes,
-                       int recursion_depth=0,
-                       bool debugprint=false,
-                       u32 stoptime=0
-       );
+       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);
 
-       /*
-               To flow some water, call this with the target node in
-               active_nodes
-               TODO: Make the active_nodes map to contain some vectors
-                     that are properly sorted according to water flow order.
-                         The current order makes water flow strangely if the
-                         first one is always taken.
-                         No, active_nodes should preserve the order stuff is
-                         added to it, in addition to adhering the water flow
-                         order.
-       */
-       void flowWater(core::map<v3s16, u8> &active_nodes,
-                       int recursion_depth=0,
-                       bool debugprint=false,
-                       u32 timelimit=50
-       );
-#endif
+       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
-               Shall reset VOXELFLAG_NOT_LOADED
-
-               If not found from source, add with VOXELFLAG_INEXISTENT
-       */
-       virtual void emerge(VoxelArea a, s32 caller_id=-1)
-       {
-               //dstream<<"emerge p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"<<std::endl;
-               addArea(a);
-               for(s32 z=a.MinEdge.Z; z<=a.MaxEdge.Z; z++)
-               for(s32 y=a.MinEdge.Y; y<=a.MaxEdge.Y; y++)
-               for(s32 x=a.MinEdge.X; x<=a.MaxEdge.X; x++)
-               {
-                       s32 i = m_area.index(x,y,z);
-                       // Don't touch nodes that have already been loaded
-                       if(!(m_flags[i] & VOXELFLAG_NOT_LOADED))
-                               continue;
-                       m_flags[i] = VOXELFLAG_INEXISTENT;
-               }
-       }
 
        /*
                Member variables
@@ -504,7 +568,7 @@ class VoxelManipulator /*: public NodeContainer*/
                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]
@@ -515,7 +579,9 @@ class VoxelManipulator /*: public NodeContainer*/
                Flags of all nodes
        */
        u8 *m_flags;
-       
+
+       static const MapNode ContentIgnoreNode;
+
        //TODO: Use these or remove them
        //TODO: Would these make any speed improvement?
        //bool m_pressure_route_valid;
@@ -524,7 +590,7 @@ class VoxelManipulator /*: public NodeContainer*/
        /*
                Some settings
        */
-       bool m_disable_water_climb;
+       //bool m_disable_water_climb;
 
 private:
 };