games/minimal/mods/default/textures/default_bookshelf.png

/*
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 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 Lesser General Public License for more details.

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.
*/

#ifndef MAPBLOCK_HEADER
#define MAPBLOCK_HEADER

#include <set>
#include "debug.h"
#include "irr_v3d.h"
#include "mapnode.h"
#include "exceptions.h"
#include "constants.h"
#include "staticobject.h"
#include "nodemetadata.h"
#include "nodetimer.h"
#include "modifiedstate.h"
#include "util/numeric.h" // getContainerPos
#include "settings.h"

class Map;
class NodeMetadataList;
class IGameDef;
class MapBlockMesh;
class VoxelManipulator;

#define BLOCK_TIMESTAMP_UNDEFINED 0xffffffff

/*// Named by looking towards z+
enum{
	FACE_BACK=0,
	FACE_TOP,
	FACE_RIGHT,
	FACE_FRONT,
	FACE_BOTTOM,
	FACE_LEFT
};*/

// NOTE: If this is enabled, set MapBlock to be initialized with
//       CONTENT_IGNORE.
/*enum BlockGenerationStatus
{
	// 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,
	NODECONTAINER_ID_MAPSECTOR,
	NODECONTAINER_ID_MAP,
	NODECONTAINER_ID_MAPBLOCKCACHE,
	NODECONTAINER_ID_VOXELMANIPULATOR,
};

class NodeContainer
{
public:
	virtual bool isValidPosition(v3s16 p) = 0;
	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

////
//// MapBlock modified reason flags
////

#define MOD_REASON_INITIAL                   (1 << 0)
#define MOD_REASON_REALLOCATE                (1 << 1)
#define MOD_REASON_SET_IS_UNDERGROUND        (1 << 2)
#define MOD_REASON_SET_LIGHTING_EXPIRED      (1 << 3)
#define MOD_REASON_SET_GENERATED             (1 << 4)
#define MOD_REASON_SET_NODE                  (1 << 5)
#define MOD_REASON_SET_NODE_NO_CHECK         (1 << 6)
#define MOD_REASON_SET_TIMESTAMP             (1 << 7)
#define MOD_REASON_REPORT_META_CHANGE        (1 << 8)
#define MOD_REASON_CLEAR_ALL_OBJECTS         (1 << 9)
#define MOD_REASON_BLOCK_EXPIRED             (1 << 10)
#define MOD_REASON_ADD_ACTIVE_OBJECT_RAW     (1 << 11)
#define MOD_REASON_REMOVE_OBJECTS_REMOVE     (1 << 12)
#define MOD_REASON_REMOVE_OBJECTS_DEACTIVATE (1 << 13)
#define MOD_REASON_TOO_MANY_OBJECTS          (1 << 14)
#define MOD_REASON_STATIC_DATA_ADDED         (1 << 15)
#define MOD_REASON_STATIC_DATA_REMOVED       (1 << 16)
#define MOD_REASON_STATIC_DATA_CHANGED       (1 << 17)
#define MOD_REASON_EXPIRE_DAYNIGHTDIFF       (1 << 18)
#define MOD_REASON_UNKNOWN                   (1 << 19)

////
//// MapBlock itself
////

class MapBlock /*: public NodeContainer*/
{
public:
	MapBlock(Map *parent, v3s16 pos, IGameDef *gamedef, bool dummy=false);
	~MapBlock();

	/*virtual u16 nodeContainerId() const
	{
		return NODECONTAINER_ID_MAPBLOCK;
	}*/

	Map * getParent()
	{
		return m_parent;
	}

	void reallocate()
	{
		delete[] data;
		data = new MapNode[nodecount];
		for (u32 i = 0; i < nodecount; i++)
			data[i] = MapNode(CONTENT_IGNORE);

		raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_REALLOCATE);
	}

	////
	//// Modification tracking methods
	////
	void raiseModified(u32 mod, u32 reason=MOD_REASON_UNKNOWN)
	{
		if (mod > m_modified) {
			m_modified = mod;
			m_modified_reason = reason;
			if (m_modified >= MOD_STATE_WRITE_AT_UNLOAD)
				m_disk_timestamp = m_timestamp;
		} else if (mod == m_modified) {
			m_modified_reason |= reason;
		}
	}

	inline u32 getModified()
	{
		return m_modified;
	}

	inline u32 getModifiedReason()
	{
		return m_modified_reason;
	}

	std::string getModifiedReasonString();

	inline void resetModified()
	{
		m_modified = MOD_STATE_CLEAN;
		m_modified_reason = 0;
	}

	////
	//// Flags
	////

	inline bool isDummy()
	{
		return (data == NULL);
	}

	inline void unDummify()
	{
		assert(isDummy()); // Pre-condition
		reallocate();
	}

	// is_underground getter/setter
	inline bool getIsUnderground()
	{
		return is_underground;
	}

	inline void setIsUnderground(bool a_is_underground)
	{
		is_underground = a_is_underground;
		raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_SET_IS_UNDERGROUND);
	}

	inline void setLightingExpired(bool expired)
	{
		if (expired != m_lighting_expired){
			m_lighting_expired = expired;
			raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_SET_LIGHTING_EXPIRED);
		}
	}

	inline bool getLightingExpired()
	{
		return m_lighting_expired;
	}

	inline bool isGenerated()
	{
		return m_generated;
	}

	inline void setGenerated(bool b)
	{
		if (b != m_generated) {
ofs	hex dump	ascii
0000	89 50 4e 47 0d 0a 1a 0a 00 00 00 0d 49 48 44 52 00 00 00 10 00 00 00 10 08 03 00 00 00 28 2d 0f	.PNG........IHDR.............(-.
0020	53 00 00 00 ff 50 4c 54 45 20 4a 87 29 14 00 2b 13 00 2e 34 36 2f 15 01 2f 17 00 30 36 38 33 13	S....PLTE.J.)..+...46/../..0683.
0040	00 34 1b 05 34 65 a4 36 18 00 3b 1d 01 3c 14 00 3f 24 08 43 1d 00 49 24 05 4e 9a 06 4f 35 14 4f	.4..4e.6..;..<..?$.C..I$.N..O5.O
0060	3b 23 51 28 05 53 3f 29 54 29 03 54 38 11 58 3f 26 58 40 29 58 41 2a 5a 43 29 5b 48 2a 5c 35 66	;#Q(.S?)T).T8.X?&X@)XAZC)[H\5f
0080	5c 43 2d 5e 4f 3d 60 49 21 62 49 32 63 3b 0f 63 4c 36 63 50 3b 63 53 39 63 53 3d 67 54 41 68 39	\C-^O=`I!bI2c;.cL6cP;cS9cS=gTAh9
00a0	0a 68 39 0c 6a 54 22 6b 56 24 6c 4d 1c 6c 54 1c 6f 57 41 70 59 43 73 57 23 73 58 1f 73 5c 30 74	.h9.jT"kV$lM.lT.oWApYCsW#sX.s\0t
00c0	61 33 74 61 34 75 50 7b 78 5d 42 78 5f 2e 78 60 49 7e 5d 28 7f 64 49 80 6d 52 81 64 2f 82 5d 25	a3ta4uP{x]Bx_.x`I~](.dI.mR.d/.]%
00e0	84 61 2a 84 67 33 86 61 29 87 69 33 87 6d 3a 88 69 37 88 8a 85 89 72 43 8b 71 40 8c 6a 37 8f 59	.a*.g3.a).i3.m:.i7....rC.q@.j7.Y
0100	02 8f 5a 03 90 76 44 92 83 5e 93 79 43 97 7e 4a 9d 89 58 a4 00 00 a6 9a 76 ba bd b6 c1 7d 11 c4	..Z..vD..^.yC.~J..X.....v....}..
0120	a0 00 cc 00 00 ce 5c 00 8e a5 4f 3e 00 00 00 bf 49 44 41 54 18 57 75 ce 6b 57 01 51 18 05 e0 5d	......\...O>....IDAT.Wu.kW.Q...]
0140	c3 71 8b 8e 10 42 ca fd 5e 18 e4 1a 0e 8d c8 38 5e f3 ff 7f 4b 67 66 96 0f 7d 68 7f db cf 7a df	.q...B..^......8^...Kgf..}h...z.
0160	b5 36 16 eb f9 b0 df 6b d4 5b ef 6f d3 e5 ea f0 83 6f 66 67 b7 63 6e b6 88 12 31 0b 0a 4c 55 81	.6.....k.[.o.....ofg.cn...1..LU.
0180	57 74 a5 e4 36 f0 0b d3 99 10 5f 68 12 29 38 9f f9 85 74 02 3e 91 bf 82 e9 c0 07 1e 1d 50 2f 2e	Wt..6....._h.)8...t.>........P/.
01a0	cc 70 e3 f1 87 bc b7 41 df 5d 24 92 b8 8f d5 aa f8 67 87 1b ce d5 8e bd 94 52 63 59 55 35 4b 08	.p.....A.]$......g.......RcYU5K.
01c0	3a 62 23 84 30 4d dd 00 23 8b 73 3a 21 ac 2e 6c 08 b8 90 41 d9 81 ac 01 d2 6c 98 e0 f9 2f 14 50	:b#.0M..#.s:!..l...A.....l.../.P
01e0	29 96 52 c9 a7 87 78 fa 25 d7 ee 8c c6 83 5f e7 fe 2c 06 25 e1 ea f7 00 00 00 00 49 45 4e 44 ae	).R...x.%....._..,.%.......IEND.
0200	42 60 82	B`.