1

/* $Id$ */

     2

     3

#ifndef MAP_H

     4

#define MAP_H

     5

     6

#include "stdafx.h"

     7

     8

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

     9

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

    10

extern uint _map_log_x;

    11

extern uint _map_size_x;

    12

extern uint _map_size_y;

    13

extern uint _map_tile_mask;

    14

extern uint _map_size;

    15

    16

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

    17

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

    18

    19

typedef struct Tile {

    20

	byte type_height;

    21

	byte m1;

    22

	uint16 m2;

    23

	byte m3;

    24

	byte m4;

    25

	byte m5;

    26

	byte extra;

    27

} Tile;

    28

    29

extern Tile* _m;

    30

    31

void AllocateMap(uint size_x, uint size_y);

    32

    33

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

    34

static inline uint MapLogX(void)  { return _map_log_x; }

    35

/* The size of the map */

    36

static inline uint MapSizeX(void) { return _map_size_x; }

    37

static inline uint MapSizeY(void) { return _map_size_y; }

    38

/* The maximum coordinates */

    39

static inline uint MapMaxX(void) { return _map_size_x - 1; }

    40

static inline uint MapMaxY(void) { return _map_size_y - 1; }

    41

/* The number of tiles in the map */

    42

static inline uint MapSize(void) { return _map_size; }

    43

    44

// Scale a number relative to the map size

    45

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

    46

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

    47

    48

typedef uint32 TileIndex;

    49

typedef int32 TileIndexDiff;

    50

    51

static inline TileIndex TileXY(uint x, uint y)

    52

{

    53

	return (y * MapSizeX()) + x;

    54

}

    55

    56

static inline TileIndexDiff TileDiffXY(int x, int y)

    57

{

    58

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

    59

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

    60

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

    61

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

    62

	return (y * MapSizeX()) + x;

    63

}

    64

    65

static inline TileIndex TileVirtXY(uint x, uint y)

    66

{

    67

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

    68

}

    69

    70

typedef enum Owner {

    71

	OWNER_TOWN      = 0x0F, // a town owns the tile

    72

	OWNER_NONE      = 0x10, // nobody owns the tile

    73

	OWNER_WATER     = 0x11, // "water" owns the tile

    74

	OWNER_SPECTATOR = 0xFF, // spectator in MP or in scenario editor

    75

} Owner;

    76

    77

enum {

    78

	INVALID_TILE = (TileIndex)-1

    79

};

    80

    81

enum {

    82

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

    83

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

    84

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

    85

};

    86

    87

    88

static inline uint TileX(TileIndex tile)

    89

{

    90

	return tile & MapMaxX();

    91

}

    92

    93

static inline uint TileY(TileIndex tile)

    94

{

    95

	return tile >> MapLogX();

    96

}

    97

    98

    99

typedef struct TileIndexDiffC {

   100

	int16 x;

   101

	int16 y;

   102

} TileIndexDiffC;

   103

   104

static inline TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)

   105

{

   106

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

   107

}

   108

   109

   110

#ifndef _DEBUG

   111

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

   112

#else

   113

	extern TileIndex TileAdd(TileIndex tile, TileIndexDiff add,

   114

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

   115

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

   116

#endif

   117

   118

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

   119

   120

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

   121

   122

static inline TileIndexDiffC TileIndexDiffCByDiagDir(uint dir) {

   123

	extern const TileIndexDiffC _tileoffs_by_diagdir[4];

   124

   125

	assert(dir < lengthof(_tileoffs_by_diagdir));

   126

	return _tileoffs_by_diagdir[dir];

   127

}

   128

   129

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

   130

 * outside of the map, INVALID_TILE is returned instead.

   131

 */

   132

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

   133

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

   134

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

   135

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

   136

		return INVALID_TILE;

   137

	else

   138

		return TileXY(x, y);

   139

}

   140

   141

// Functions to calculate distances

   142

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

   143

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

   144

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

   145

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

   146

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

   147

   148

   149

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

   150

	{                                                        \

   151

		int h_cur = h;                                         \

   152

		uint var = tile;                                       \

   153

		do {                                                   \

   154

			int w_cur = w;                                       \

   155

			do {

   156

   157

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

   158

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

   159

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

   160

	}

   161

   162

static inline TileIndexDiff TileOffsByDiagDir(uint dir)

   163

{

   164

	extern const TileIndexDiffC _tileoffs_by_diagdir[4];

   165

   166

	assert(dir < lengthof(_tileoffs_by_diagdir));

   167

	return ToTileIndexDiff(_tileoffs_by_diagdir[dir]);

   168

}

   169

   170

static inline TileIndexDiff TileOffsByDir(uint dir)

   171

{

   172

	extern const TileIndexDiffC _tileoffs_by_dir[8];

   173

   174

	assert(dir < lengthof(_tileoffs_by_dir));

   175

	return ToTileIndexDiff(_tileoffs_by_dir[dir]);

   176

}

   177

   178

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

   179

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

   180

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

   181

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

   182

 * rounding! Be careful when using this!

   183

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

   184

#define STRAIGHT_TRACK_LENGTH 7071/10000

   185

   186

#endif /* MAP_H */