1

/* $Id$ */

     2

     3

/** @file map.h */

     4

     5

#ifndef MAP_H

     6

#define MAP_H

     7

     8

#include "stdafx.h"

     9

    10

/* Putting externs inside inline functions seems to confuse the aliasing

    11

 * checking on MSVC6. Never use those variables directly. */

    12

extern uint _map_log_x;

    13

extern uint _map_size_x;

    14

extern uint _map_size_y;

    15

extern uint _map_tile_mask;

    16

extern uint _map_size;

    17

    18

#define TILE_MASK(x) ((x) & _map_tile_mask)

    19

#define TILE_ASSERT(x) assert(TILE_MASK(x) == (x));

    20

    22

	byte type_height;

    23

	byte m1;

    24

	uint16 m2;

    25

	byte m3;

    26

	byte m4;

    27

	byte m5;

    28

	byte m6;

    30

    31

extern Tile* _m;

    32

    33

void AllocateMap(uint size_x, uint size_y);

    34

    35

/* binary logarithm of the map size, try to avoid using this one */

    37

/* The size of the map */

    40

/* The maximum coordinates */

    43

/* The number of tiles in the map */

    45

    46

/* Scale a number relative to the map size */

    47

uint ScaleByMapSize(uint); // Scale relative to the number of tiles

    48

uint ScaleByMapSize1D(uint); // Scale relative to the circumference of the map

    49

    50

typedef uint32 TileIndex;

    51

typedef int32 TileIndexDiff;

    52

    53

static inline TileIndex TileXY(uint x, uint y)

    54

{

    55

	return (y * MapSizeX()) + x;

    56

}

    57

    58

static inline TileIndexDiff TileDiffXY(int x, int y)

    59

{

    60

	/* Multiplication gives much better optimization on MSVC than shifting.

    61

	 * 0 << shift isn't optimized to 0 properly.

    62

	 * Typically x and y are constants, and then this doesn't result

    63

	 * in any actual multiplication in the assembly code.. */

    64

	return (y * MapSizeX()) + x;

    65

}

    66

    67

static inline TileIndex TileVirtXY(uint x, uint y)

    68

{

    69

	return (y >> 4 << MapLogX()) + (x >> 4);

    70

}

    71

    72

    73

enum {

    74

	INVALID_TILE = (TileIndex)-1

    75

};

    76

    77

enum {

    78

	TILE_SIZE   = 16,   ///< Tiles are 16x16 "units" in size

    79

	TILE_PIXELS = 32,   ///< a tile is 32x32 pixels

    80

	TILE_HEIGHT =  8,   ///< The standard height-difference between tiles on two levels is 8 (z-diff 8)

    81

};

    82

    83

    84

static inline uint TileX(TileIndex tile)

    85

{

    86

	return tile & MapMaxX();

    87

}

    88

    89

static inline uint TileY(TileIndex tile)

    90

{

    91

	return tile >> MapLogX();

    92

}

    93

    94

    96

	int16 x;

    97

	int16 y;

    99

   100

static inline TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)

   101

{

   102

	return (tidc.y << MapLogX()) + tidc.x;

   103

}

   104

   105

   106

#ifndef _DEBUG

   107

	#define TILE_ADD(x,y) ((x) + (y))

   108

#else

   109

	extern TileIndex TileAdd(TileIndex tile, TileIndexDiff add,

   110

		const char *exp, const char *file, int line);

   111

	#define TILE_ADD(x, y) (TileAdd((x), (y), #x " + " #y, __FILE__, __LINE__))

   112

#endif

   113

   114

#define TILE_ADDXY(tile, x, y) TILE_ADD(tile, TileDiffXY(x, y))

   115

   116

uint TileAddWrap(TileIndex tile, int addx, int addy);

   117

   118

static inline TileIndexDiffC TileIndexDiffCByDiagDir(uint dir) {

   119

	extern const TileIndexDiffC _tileoffs_by_diagdir[4];

   120

   121

	assert(dir < lengthof(_tileoffs_by_diagdir));

   122

	return _tileoffs_by_diagdir[dir];

   123

}

   124

   125

/* Returns tile + the diff given in diff. If the result tile would end up

   126

 * outside of the map, INVALID_TILE is returned instead.

   127

 */

   128

static inline TileIndex AddTileIndexDiffCWrap(TileIndex tile, TileIndexDiffC diff) {

   129

	int x = TileX(tile) + diff.x;

   130

	int y = TileY(tile) + diff.y;

   131

	if (x < 0 || y < 0 || x > (int)MapMaxX() || y > (int)MapMaxY())

   132

		return INVALID_TILE;

   133

	else

   134

		return TileXY(x, y);

   135

}

   136

   137

/* Functions to calculate distances */

   138

uint DistanceManhattan(TileIndex, TileIndex); ///< also known as L1-Norm. Is the shortest distance one could go over diagonal tracks (or roads)

   139

uint DistanceSquare(TileIndex, TileIndex); ///< euclidian- or L2-Norm squared

   140

uint DistanceMax(TileIndex, TileIndex); ///< also known as L-Infinity-Norm

   141

uint DistanceMaxPlusManhattan(TileIndex, TileIndex); ///< Max + Manhattan

   142

uint DistanceFromEdge(TileIndex); ///< shortest distance from any edge of the map

   143

   144

   145

#define BEGIN_TILE_LOOP(var,w,h,tile)                      \

   146

	{                                                        \

   147

		int h_cur = h;                                         \

   148

		uint var = tile;                                       \

   149

		do {                                                   \

   150

			int w_cur = w;                                       \

   151

			do {

   152

   153

#define END_TILE_LOOP(var,w,h,tile)                        \

   154

			} while (++var, --w_cur != 0);                       \

   155

		} while (var += TileDiffXY(0, 1) - (w), --h_cur != 0); \

   156

	}

   157

   158

static inline TileIndexDiff TileOffsByDiagDir(uint dir)

   159

{

   160

	extern const TileIndexDiffC _tileoffs_by_diagdir[4];

   161

   162

	assert(dir < lengthof(_tileoffs_by_diagdir));

   163

	return ToTileIndexDiff(_tileoffs_by_diagdir[dir]);

   164

}

   165

   166

static inline TileIndexDiff TileOffsByDir(uint dir)

   167

{

   168

	extern const TileIndexDiffC _tileoffs_by_dir[8];

   169

   170

	assert(dir < lengthof(_tileoffs_by_dir));

   171

	return ToTileIndexDiff(_tileoffs_by_dir[dir]);

   172

}

   173

   174

typedef bool TestTileOnSearchProc(TileIndex tile, uint32 data);

   175

bool CircularTileSearch(TileIndex tile, uint size, TestTileOnSearchProc proc, uint32 data);

   176

   177

/* Approximation of the length of a straight track, relative to a diagonal

   178

 * track (ie the size of a tile side). #defined instead of const so it can

   179

 * stay integer. (no runtime float operations) Is this needed?

   180

 * Watch out! There are _no_ brackets around here, to prevent intermediate

   181

 * rounding! Be careful when using this!

   182

 * This value should be sqrt(2)/2 ~ 0.7071 */

   183

#define STRAIGHT_TRACK_LENGTH 7071/10000

   184

   185

#endif /* MAP_H */