3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include "common_irrlicht.h"
33 A fast voxel manipulator class
41 extern u32 emerge_time;
42 extern u32 emerge_load_time;
45 This class resembles aabbox3d<s16> a lot, but has inclusive
46 edges for saner handling of integer sizes
51 // Starts as zero sized
57 VoxelArea(v3s16 min_edge, v3s16 max_edge):
72 void addArea(VoxelArea &a)
74 if(getExtent() == v3s16(0,0,0))
79 if(a.MinEdge.X < MinEdge.X) MinEdge.X = a.MinEdge.X;
80 if(a.MinEdge.Y < MinEdge.Y) MinEdge.Y = a.MinEdge.Y;
81 if(a.MinEdge.Z < MinEdge.Z) MinEdge.Z = a.MinEdge.Z;
82 if(a.MaxEdge.X > MaxEdge.X) MaxEdge.X = a.MaxEdge.X;
83 if(a.MaxEdge.Y > MaxEdge.Y) MaxEdge.Y = a.MaxEdge.Y;
84 if(a.MaxEdge.Z > MaxEdge.Z) MaxEdge.Z = a.MaxEdge.Z;
86 void addPoint(v3s16 p)
88 if(getExtent() == v3s16(0,0,0))
94 if(p.X < MinEdge.X) MinEdge.X = p.X;
95 if(p.Y < MinEdge.Y) MinEdge.Y = p.Y;
96 if(p.Z < MinEdge.Z) MinEdge.Z = p.Z;
97 if(p.X > MaxEdge.X) MaxEdge.X = p.X;
98 if(p.Y > MaxEdge.Y) MaxEdge.Y = p.Y;
99 if(p.Z > MaxEdge.Z) MaxEdge.Z = p.Z;
109 /*void operator+=(v3s16 off)
115 void operator-=(v3s16 off)
125 v3s16 getExtent() const
127 return MaxEdge - MinEdge + v3s16(1,1,1);
129 s32 getVolume() const
131 v3s16 e = getExtent();
132 return (s32)e.X * (s32)e.Y * (s32)e.Z;
134 bool contains(const VoxelArea &a) const
136 // No area contains an empty area
137 // NOTE: Algorithms depend on this, so do not change.
138 if(a.getExtent() == v3s16(0,0,0))
142 a.MinEdge.X >= MinEdge.X && a.MaxEdge.X <= MaxEdge.X &&
143 a.MinEdge.Y >= MinEdge.Y && a.MaxEdge.Y <= MaxEdge.Y &&
144 a.MinEdge.Z >= MinEdge.Z && a.MaxEdge.Z <= MaxEdge.Z
147 bool contains(v3s16 p) const
150 p.X >= MinEdge.X && p.X <= MaxEdge.X &&
151 p.Y >= MinEdge.Y && p.Y <= MaxEdge.Y &&
152 p.Z >= MinEdge.Z && p.Z <= MaxEdge.Z
155 bool contains(s32 i) const
157 return (i >= 0 && i < getVolume());
159 bool operator==(const VoxelArea &other) const
161 return (MinEdge == other.MinEdge
162 && MaxEdge == other.MaxEdge);
165 VoxelArea operator+(v3s16 off) const
167 return VoxelArea(MinEdge+off, MaxEdge+off);
170 VoxelArea operator-(v3s16 off) const
172 return VoxelArea(MinEdge-off, MaxEdge-off);
176 Returns 0-6 non-overlapping areas that can be added to
177 a to make up this area.
181 void diff(const VoxelArea &a, core::list<VoxelArea> &result)
184 This can result in a maximum of 6 areas
187 // If a is an empty area, return the current area as a whole
188 if(a.getExtent() == v3s16(0,0,0))
191 if(b.getVolume() != 0)
198 // Take back area, XY inclusive
200 v3s16 min(MinEdge.X, MinEdge.Y, a.MaxEdge.Z+1);
201 v3s16 max(MaxEdge.X, MaxEdge.Y, MaxEdge.Z);
202 VoxelArea b(min, max);
203 if(b.getVolume() != 0)
207 // Take front area, XY inclusive
209 v3s16 min(MinEdge.X, MinEdge.Y, MinEdge.Z);
210 v3s16 max(MaxEdge.X, MaxEdge.Y, a.MinEdge.Z-1);
211 VoxelArea b(min, max);
212 if(b.getVolume() != 0)
216 // Take top area, X inclusive
218 v3s16 min(MinEdge.X, a.MaxEdge.Y+1, a.MinEdge.Z);
219 v3s16 max(MaxEdge.X, MaxEdge.Y, a.MaxEdge.Z);
220 VoxelArea b(min, max);
221 if(b.getVolume() != 0)
225 // Take bottom area, X inclusive
227 v3s16 min(MinEdge.X, MinEdge.Y, a.MinEdge.Z);
228 v3s16 max(MaxEdge.X, a.MinEdge.Y-1, a.MaxEdge.Z);
229 VoxelArea b(min, max);
230 if(b.getVolume() != 0)
234 // Take left area, non-inclusive
236 v3s16 min(MinEdge.X, a.MinEdge.Y, a.MinEdge.Z);
237 v3s16 max(a.MinEdge.X-1, a.MaxEdge.Y, a.MaxEdge.Z);
238 VoxelArea b(min, max);
239 if(b.getVolume() != 0)
243 // Take right area, non-inclusive
245 v3s16 min(a.MaxEdge.X+1, a.MinEdge.Y, a.MinEdge.Z);
246 v3s16 max(MaxEdge.X, a.MaxEdge.Y, a.MaxEdge.Z);
247 VoxelArea b(min, max);
248 if(b.getVolume() != 0)
255 Translates position from virtual coordinates to array index
257 s32 index(s16 x, s16 y, s16 z) const
259 v3s16 em = getExtent();
261 s32 i = (s32)(z-off.Z)*em.Y*em.X + (y-off.Y)*em.X + (x-off.X);
262 //dstream<<" i("<<x<<","<<y<<","<<z<<")="<<i<<" ";
265 s32 index(v3s16 p) const
267 return index(p.X, p.Y, p.Z);
270 // Translate index in the X coordinate
271 void add_x(const v3s16 &extent, u32 &i, s16 a)
275 // Translate index in the Y coordinate
276 void add_y(const v3s16 &extent, u32 &i, s16 a)
280 // Translate index in the Z coordinate
281 void add_z(const v3s16 &extent, u32 &i, s16 a)
283 i += a * extent.X*extent.Y;
285 // Translate index in space
286 void add_p(const v3s16 &extent, u32 &i, v3s16 a)
288 i += a.Z*extent.X*extent.Y + a.Y*extent.X + a.X;
292 Print method for debugging
294 void print(std::ostream &o) const
296 v3s16 e = getExtent();
304 <<"="<<e.X<<"x"<<e.Y<<"x"<<e.Z<<"="<<getVolume();
307 // Edges are inclusive
312 // Hasn't been copied from source (emerged)
313 #define VOXELFLAG_NOT_LOADED (1<<0)
314 // Checked as being inexistent in source
315 #define VOXELFLAG_INEXISTENT (1<<1)
316 // Algorithm-dependent
317 #define VOXELFLAG_CHECKED1 (1<<2)
318 // Algorithm-dependent
319 #define VOXELFLAG_CHECKED2 (1<<3)
320 // Algorithm-dependent
321 #define VOXELFLAG_CHECKED3 (1<<4)
322 // Algorithm-dependent
323 #define VOXELFLAG_CHECKED4 (1<<5)
329 VOXELPRINT_WATERPRESSURE,
332 class VoxelManipulator /*: public NodeContainer*/
336 virtual ~VoxelManipulator();
339 Virtuals from NodeContainer
341 /*virtual u16 nodeContainerId() const
343 return NODECONTAINER_ID_VOXELMANIPULATOR;
345 bool isValidPosition(v3s16 p)
348 return !(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT);
352 These are a bit slow and shouldn't be used internally.
353 Use m_data[m_area.index(p)] instead.
355 MapNode getNode(v3s16 p)
359 if(m_flags[m_area.index(p)] & VOXELFLAG_INEXISTENT)
361 dstream<<"EXCEPT: VoxelManipulator::getNode(): "
362 <<"p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"
363 <<", index="<<m_area.index(p)
364 <<", flags="<<(int)m_flags[m_area.index(p)]
365 <<" is inexistent"<<std::endl;
366 throw InvalidPositionException
367 ("VoxelManipulator: getNode: inexistent");
370 return m_data[m_area.index(p)];
372 void setNode(v3s16 p, MapNode &n)
376 m_data[m_area.index(p)] = n;
377 m_flags[m_area.index(p)] &= ~VOXELFLAG_INEXISTENT;
378 m_flags[m_area.index(p)] &= ~VOXELFLAG_NOT_LOADED;
380 void setNodeNoRef(v3s16 p, MapNode n)
385 /*void setExists(VoxelArea a)
388 for(s32 z=a.MinEdge.Z; z<=a.MaxEdge.Z; z++)
389 for(s32 y=a.MinEdge.Y; y<=a.MaxEdge.Y; y++)
390 for(s32 x=a.MinEdge.X; x<=a.MaxEdge.X; x++)
392 m_flags[m_area.index(x,y,z)] &= ~VOXELFLAG_INEXISTENT;
396 /*MapNode & operator[](v3s16 p)
398 //dstream<<"operator[] p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"<<std::endl;
399 if(isValidPosition(p) == false)
400 emerge(VoxelArea(p));
402 return m_data[m_area.index(p)];
409 virtual void clear();
411 void print(std::ostream &o, VoxelPrintMode mode=VOXELPRINT_MATERIAL);
413 void addArea(VoxelArea area);
416 Copy data and set flags to 0
417 dst_area.getExtent() <= src_area.getExtent()
419 void copyFrom(MapNode *src, VoxelArea src_area,
420 v3s16 from_pos, v3s16 to_pos, v3s16 size);
423 void copyTo(MapNode *dst, VoxelArea dst_area,
424 v3s16 dst_pos, v3s16 from_pos, v3s16 size);
430 void clearFlag(u8 flag);
432 void unspreadLight(enum LightBank bank, v3s16 p, u8 oldlight,
433 core::map<v3s16, bool> & light_sources);
434 void unspreadLight(enum LightBank bank,
435 core::map<v3s16, u8> & from_nodes,
436 core::map<v3s16, bool> & light_sources);
438 void spreadLight(enum LightBank bank, v3s16 p);
439 void spreadLight(enum LightBank bank,
440 core::map<v3s16, bool> & from_nodes);
447 Get the contents of the requested area from somewhere.
448 Shall touch only nodes that have VOXELFLAG_NOT_LOADED
449 Shall reset VOXELFLAG_NOT_LOADED
451 If not found from source, add with VOXELFLAG_INEXISTENT
453 virtual void emerge(VoxelArea a, s32 caller_id=-1)
455 //dstream<<"emerge p=("<<p.X<<","<<p.Y<<","<<p.Z<<")"<<std::endl;
457 for(s32 z=a.MinEdge.Z; z<=a.MaxEdge.Z; z++)
458 for(s32 y=a.MinEdge.Y; y<=a.MaxEdge.Y; y++)
459 for(s32 x=a.MinEdge.X; x<=a.MaxEdge.X; x++)
461 s32 i = m_area.index(x,y,z);
462 // Don't touch nodes that have already been loaded
463 if(!(m_flags[i] & VOXELFLAG_NOT_LOADED))
465 m_flags[i] = VOXELFLAG_INEXISTENT;
474 The area that is stored in m_data.
475 addInternalBox should not be used if getExtent() == v3s16(0,0,0)
476 MaxEdge is 1 higher than maximum allowed position
481 NULL if data size is 0 (extent (0,0,0))
482 Data is stored as [z*h*w + y*h + x]
491 //TODO: Use these or remove them
492 //TODO: Would these make any speed improvement?
493 //bool m_pressure_route_valid;
494 //v3s16 m_pressure_route_surface;
499 bool m_disable_water_climb;