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

#define RANDOM_TILE(r) TILE_MASK(r)

    19

    20

typedef struct Tile {

    21

	byte type_height;

    22

	byte owner;

    23

	uint16 m2;

    24

	byte m3;

    25

	byte m4;

    26

	byte m5;

    27

	byte extra;

    28

} Tile;

    29

    30

extern Tile* _m;

    31

    32

void InitMap(uint log_x, uint log_y);

    33

    34

void AllocateMap(uint size_x, uint size_y);

    35

    36

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

    37

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

    38

/* The size of the map */

    39

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

    40

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

    41

/* The maximum coordinates */

    42

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

    43

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

    44

/* The number of tiles in the map */

    45

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

    46

    47

// Scale a number relative to the map size

    48

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

    49

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

    50

    51

typedef uint32 TileIndex;

    52

typedef int32 TileIndexDiff;

    53

    54

static inline TileIndex TileXY(uint x, uint y)

    55

{

    56

	return (y * MapSizeX()) + x;

    57

}

    58

    59

static inline TileIndexDiff TileDiffXY(int x, int y)

    60

{

    61

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

    62

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

    63

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

    64

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

    65

	return (y * MapSizeX()) + x;

    66

}

    67

    68

static inline TileIndex TileVirtXY(uint x, uint y)

    69

{

    70

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

    71

}

    72

    73

typedef enum {

    74

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

    75

	OWNER_NONE			= 0x10,	// nobody owns the tile

    76

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

    77

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

    78

} Owner;

    79

    80

enum {

    81

	INVALID_TILE = (TileIndex)-1

    82

};

    83

    84

enum {

    85

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

    86

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

    87

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

    88

};

    89

    90

    91

static inline uint TileX(TileIndex tile)

    92

{

    93

	return tile & MapMaxX();

    94

}

    95

    96

static inline uint TileY(TileIndex tile)

    97

{

    98

	return tile >> MapLogX();

    99

}

   100

   101

   102

typedef struct TileIndexDiffC {

   103

	int16 x;

   104

	int16 y;

   105

} TileIndexDiffC;

   106

   107

static inline TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)

   108

{

   109

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

   110

}

   111

   112

   113

#ifndef _DEBUG

   114

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

   115

#else

   116

	extern TileIndex TileAdd(TileIndex tile, TileIndexDiff add,

   117

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

   118

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

   119

#endif

   120

   121

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

   122

   123

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

   124

   125

static inline TileIndexDiffC TileIndexDiffCByDir(uint dir) {

   126

	extern const TileIndexDiffC _tileoffs_by_dir[4];

   127

	return _tileoffs_by_dir[dir];

   128

}

   129

   130

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

   131

 * outside of the map, INVALID_TILE is returned instead.

   132

 */

   133

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

   134

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

   135

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

   136

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

   137

		return INVALID_TILE;

   138

	else

   139

		return TileXY(x, y);

   140

}

   141

   142

// Functions to calculate distances

   143

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

   144

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

   145

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

   146

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

   147

uint DistanceTrack(TileIndex, TileIndex); // Returns the shortest distance one could go over tracks

   148

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

   149

   150

   151

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

   152

	{                                                        \

   153

		int h_cur = h;                                         \

   154

		uint var = tile;                                       \

   155

		do {                                                   \

   156

			int w_cur = w;                                       \

   157

			do {

   158

   159

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

   160

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

   161

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

   162

	}

   163

   164

   165

static inline TileIndexDiff TileOffsByDir(uint dir)

   166

{

   167

	extern const TileIndexDiffC _tileoffs_by_dir[4];

   168

   169

	assert(dir < lengthof(_tileoffs_by_dir));

   170

	return ToTileIndexDiff(_tileoffs_by_dir[dir]);

   171

}

   172

   173

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

   174

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

   175

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

   176

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

   177

 * rounding! Be careful when using this!

   178

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

   179

#define STRAIGHT_TRACK_LENGTH 7071/10000

   180

   181

#endif