src/tree_map.h
author KUDr
Sat, 21 Apr 2007 08:23:57 +0000
branchcpp_gui
changeset 6308 646711c5feaa
parent 6307 f40e88cff863
child 6870 ca3fd1fbe311
permissions -rw-r--r--
(svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
     1
/* $Id$ */
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
     2
6307
f40e88cff863 (svn r9639) [cpp_gui] -Sync with trunk (r9476:9633)
KUDr
parents: 6298
diff changeset
     3
/** @file tree_map.h */
f40e88cff863 (svn r9639) [cpp_gui] -Sync with trunk (r9476:9633)
KUDr
parents: 6298
diff changeset
     4
3145
349b745dfbf4 (svn r3765) Fix some naming glitches in r3763 and add missing svn properties
tron
parents: 3144
diff changeset
     5
#ifndef TREE_MAP_H
349b745dfbf4 (svn r3765) Fix some naming glitches in r3763 and add missing svn properties
tron
parents: 3144
diff changeset
     6
#define TREE_MAP_H
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
     7
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
     8
#include "macros.h"
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
     9
6298
c30fe89622df (svn r9119) [cpp_gui] -Sync with trunk (r9003:9100)
bjarni
parents: 5838
diff changeset
    10
enum TreeType {
3441
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    11
	TREE_INVALID      = -1,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    12
	TREE_TEMPERATE    = 0,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    13
	TREE_SUB_ARCTIC   = 12,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    14
	TREE_RAINFOREST   = 20,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    15
	TREE_CACTUS       = 27,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    16
	TREE_SUB_TROPICAL = 28,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    17
	TREE_TOYLAND      = 32
6298
c30fe89622df (svn r9119) [cpp_gui] -Sync with trunk (r9003:9100)
bjarni
parents: 5838
diff changeset
    18
};
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    19
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    20
enum {
3441
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    21
	TREE_COUNT_TEMPERATE    = TREE_SUB_ARCTIC   - TREE_TEMPERATE,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    22
	TREE_COUNT_SUB_ARCTIC   = TREE_RAINFOREST   - TREE_SUB_ARCTIC,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    23
	TREE_COUNT_RAINFOREST   = TREE_CACTUS       - TREE_RAINFOREST,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    24
	TREE_COUNT_SUB_TROPICAL = TREE_SUB_TROPICAL - TREE_CACTUS,
d1cef7047cd4 (svn r4271) s/\<TR_/TREE_/ resp. s/\<TR_/TREE_GROUND/
tron
parents: 3369
diff changeset
    25
	TREE_COUNT_TOYLAND      = 9
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    26
};
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    27
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    28
/* ground type, m2 bits 4...5
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    29
 * valid densities (bits 6...7) in comments after the enum */
6298
c30fe89622df (svn r9119) [cpp_gui] -Sync with trunk (r9003:9100)
bjarni
parents: 5838
diff changeset
    30
enum TreeGround {
6307
f40e88cff863 (svn r9639) [cpp_gui] -Sync with trunk (r9476:9633)
KUDr
parents: 6298
diff changeset
    31
	TREE_GROUND_GRASS       = 0, ///< 0
f40e88cff863 (svn r9639) [cpp_gui] -Sync with trunk (r9476:9633)
KUDr
parents: 6298
diff changeset
    32
	TREE_GROUND_ROUGH       = 1, ///< 0
f40e88cff863 (svn r9639) [cpp_gui] -Sync with trunk (r9476:9633)
KUDr
parents: 6298
diff changeset
    33
	TREE_GROUND_SNOW_DESERT = 2  ///< 0-3 for snow, 3 for desert
6298
c30fe89622df (svn r9119) [cpp_gui] -Sync with trunk (r9003:9100)
bjarni
parents: 5838
diff changeset
    34
};
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    35
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    36
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    37
static inline TreeType GetTreeType(TileIndex t)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    38
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    39
	assert(IsTileType(t, MP_TREES));
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5726
diff changeset
    40
	return (TreeType)_m[t].m3;
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    41
}
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    42
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    43
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    44
static inline TreeGround GetTreeGround(TileIndex t)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    45
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    46
	assert(IsTileType(t, MP_TREES));
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5726
diff changeset
    47
	return (TreeGround)GB(_m[t].m2, 4, 2);
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    48
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    49
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    50
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    51
static inline uint GetTreeDensity(TileIndex t)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    52
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    53
	assert(IsTileType(t, MP_TREES));
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    54
	return GB(_m[t].m2, 6, 2);
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    55
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    56
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    57
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    58
static inline void SetTreeGroundDensity(TileIndex t, TreeGround g, uint d)
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    59
{
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    60
	assert(IsTileType(t, MP_TREES)); // XXX incomplete
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    61
	SB(_m[t].m2, 4, 2, g);
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    62
	SB(_m[t].m2, 6, 2, d);
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    63
}
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    64
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    65
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    66
static inline uint GetTreeCount(TileIndex t)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    67
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    68
	assert(IsTileType(t, MP_TREES));
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    69
	return GB(_m[t].m5, 6, 2);
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    70
}
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
    71
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    72
static inline void AddTreeCount(TileIndex t, int c)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    73
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    74
	assert(IsTileType(t, MP_TREES)); // XXX incomplete
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    75
	_m[t].m5 += c << 6;
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    76
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    77
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    78
static inline void SetTreeCount(TileIndex t, uint c)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    79
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    80
	assert(IsTileType(t, MP_TREES)); // XXX incomplete
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    81
	SB(_m[t].m5, 6, 2, c);
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    82
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    83
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    84
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    85
static inline uint GetTreeGrowth(TileIndex t)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    86
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    87
	assert(IsTileType(t, MP_TREES));
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    88
	return GB(_m[t].m5, 0, 3);
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    89
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    90
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    91
static inline void AddTreeGrowth(TileIndex t, int a)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    92
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    93
	assert(IsTileType(t, MP_TREES)); // XXX incomplete
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    94
	_m[t].m5 += a;
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    95
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    96
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    97
static inline void SetTreeGrowth(TileIndex t, uint g)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    98
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
    99
	assert(IsTileType(t, MP_TREES)); // XXX incomplete
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   100
	SB(_m[t].m5, 0, 3, g);
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   101
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   102
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   103
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   104
static inline uint GetTreeCounter(TileIndex t)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   105
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   106
	assert(IsTileType(t, MP_TREES));
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   107
	return GB(_m[t].m2, 0, 4);
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   108
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   109
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   110
static inline void AddTreeCounter(TileIndex t, int a)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   111
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   112
	assert(IsTileType(t, MP_TREES)); // XXX incomplete
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   113
	_m[t].m2 += a;
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   114
}
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   115
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   116
static inline void SetTreeCounter(TileIndex t, uint c)
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   117
{
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   118
	assert(IsTileType(t, MP_TREES)); // XXX incomplete
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   119
	SB(_m[t].m2, 0, 4, c);
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3145
diff changeset
   120
}
2981
31760b6a88aa (svn r3556) Add accessors for handling tree tiles
tron
parents:
diff changeset
   121
3079
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   122
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   123
static inline void MakeTree(TileIndex t, TreeType type, uint count, uint growth, TreeGround ground, uint density)
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   124
{
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   125
	SetTileType(t, MP_TREES);
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   126
	SetTileOwner(t, OWNER_NONE);
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   127
	_m[t].m2 = density << 6 | ground << 4 | 0;
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   128
	_m[t].m3 = type;
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   129
	_m[t].m4 = 0 << 5 | 0 << 2;
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   130
	_m[t].m5 = count << 6 | growth;
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   131
}
d6541c027250 (svn r3668) Add a function to turn a tile into a tree tile
tron
parents: 2981
diff changeset
   132
4666
850b5b6e4bac (svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents: 3441
diff changeset
   133
#endif /* TREE_MAP_H */