Node highlighting.
[oweals/minetest.git] / src / voxel.h
index 291b51e036fd95c2cbabf67cef30ba0f74c746f3..033ad3e4564bbf716cd8cb4cf573b2c46041b605 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,10 +20,15 @@ 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;
 
@@ -70,7 +75,7 @@ public:
                MaxEdge(p)
        {
        }
-       
+
        /*
                Modifying methods
        */
@@ -104,14 +109,14 @@ 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;
@@ -184,7 +189,7 @@ public:
 
                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
@@ -200,7 +205,7 @@ public:
                }
 
                assert(contains(a));
-               
+
                // Take back area, XY inclusive
                {
                        v3s16 min(MinEdge.X, MinEdge.Y, a.MaxEdge.Z+1);
@@ -256,7 +261,7 @@ public:
                }
 
        }
-       
+
        /*
                Translates position from virtual coordinates to array index
        */
@@ -272,7 +277,7 @@ 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)
        {
@@ -315,10 +320,10 @@ public:
        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
 #define VOXELFLAG_CHECKED1 (1<<2)
 // Algorithm-dependent
@@ -333,6 +338,7 @@ enum VoxelPrintMode
        VOXELPRINT_NOTHING,
        VOXELPRINT_MATERIAL,
        VOXELPRINT_WATERPRESSURE,
+       VOXELPRINT_LIGHT_DAY,
 };
 
 class VoxelManipulator /*: public NodeContainer*/
@@ -340,7 +346,7 @@ class VoxelManipulator /*: public NodeContainer*/
 public:
        VoxelManipulator();
        virtual ~VoxelManipulator();
-       
+
        /*
                Virtuals from NodeContainer
        */
@@ -350,8 +356,8 @@ public:
        }
        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);
        }*/
 
        /*
@@ -360,9 +366,9 @@ public:
        */
        MapNode getNode(v3s16 p)
        {
-               emerge(p);
+               addArea(p);
 
-               if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
+               if(m_flags[m_area.index(p)] & VOXELFLAG_NO_DATA)
                {
                        /*dstream<<"EXCEPT: VoxelManipulator::getNode(): "
                                        <<"p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"
@@ -377,9 +383,9 @@ public:
        }
        MapNode getNodeNoEx(v3s16 p)
        {
-               emerge(p);
+               addArea(p);
 
-               if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
+               if(m_flags[m_area.index(p)] & VOXELFLAG_NO_DATA)
                {
                        return MapNode(CONTENT_IGNORE);
                }
@@ -390,48 +396,61 @@ public:
        {
                if(m_area.contains(p) == false)
                        return MapNode(CONTENT_IGNORE);
-               if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
+               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(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_NO_DATA);
+       }
        MapNode & getNodeRef(v3s16 p)
        {
-               emerge(p);
-
-               if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
+               addArea(p);
+               if(getFlagsRefUnsafe(p) & VOXELFLAG_NO_DATA)
                {
                        /*dstream<<"EXCEPT: VoxelManipulator::getNode(): "
                                        <<"p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"
                                        <<", index="<<m_area.index(p)
-                                       <<", flags="<<(int)m_flags[m_area.index(p)]
+                                       <<", flags="<<(int)getFlagsRefUnsafe(p)
                                        <<" is inexistent"<<std::endl;*/
                        throw InvalidPositionException
                        ("VoxelManipulator: getNode: inexistent");
                }
-
-               return m_data[m_area.index(p)];
+               return getNodeRefUnsafe(p);
        }
-       void setNode(v3s16 p, MapNode &n)
+       void setNode(v3s16 p, const MapNode &n)
        {
-               emerge(p);
-               
+               addArea(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;
+               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;
                }
        }*/
 
@@ -439,11 +458,11 @@ public:
        {
                //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.
@@ -479,18 +498,18 @@ public:
 
        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,
+       void copyFrom(MapNode *src, const VoxelArea& src_area,
                        v3s16 from_pos, v3s16 to_pos, v3s16 size);
-       
+
        // Copy data
-       void copyTo(MapNode *dst, VoxelArea dst_area,
+       void copyTo(MapNode *dst, const VoxelArea& dst_area,
                        v3s16 dst_pos, v3s16 from_pos, v3s16 size);
 
        /*
@@ -498,43 +517,22 @@ public:
        */
 
        void clearFlag(u8 flag);
-       
+
+       // TODO: Move to voxelalgorithms.h
+
        void unspreadLight(enum LightBank bank, v3s16 p, u8 oldlight,
-                       core::map<v3s16, bool> & light_sources, INodeDefManager *nodemgr);
+                       std::set<v3s16> & light_sources, INodeDefManager *nodemgr);
        void unspreadLight(enum LightBank bank,
-                       core::map<v3s16, u8> & from_nodes,
-                       core::map<v3s16, bool> & light_sources, INodeDefManager *nodemgr);
-       
+                       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,
-                       core::map<v3s16, bool> & from_nodes, INodeDefManager *nodemgr);
-       
+                       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
@@ -546,7 +544,7 @@ 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]
@@ -557,7 +555,7 @@ public:
                Flags of all nodes
        */
        u8 *m_flags;
-       
+
        //TODO: Use these or remove them
        //TODO: Would these make any speed improvement?
        //bool m_pressure_route_valid;