1

#ifndef MAP_H

     2

#define MAP_H

     3

     4

#include "stdafx.h"

     5

     6

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

     7

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

     8

extern uint _map_log_x;

     9

extern uint _map_size_x;

    10

extern uint _map_size_y;

    11

extern uint _map_tile_mask;

    12

extern uint _map_size;

    13

    14

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

    15

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

    16

#define RANDOM_TILE(r) TILE_MASK(r)

    17

    18

typedef struct Tile {

    19

	byte type_height;

    20

	byte owner;

    21

	uint16 m2;

    22

	byte m3;

    23

	byte m4;

    24

	byte m5;

    25

	byte extra;

    26

} Tile;

    27

    28

extern Tile* _m;

    29

    30

void InitMap(uint log_x, uint log_y);

    31

    32

void AllocateMap(uint size_x, uint size_y);

    33

    34

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

    35

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

    36

/* The size of the map */

    37

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

    38

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

    39

/* The maximum coordinates */

    40

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

    41

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

    42

/* The number of tiles in the map */

    43

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

    44

    45

// Scale a number relative to the map size

    46

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

    47

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

    48

    49

typedef uint32 TileIndex;

    50

typedef int32 TileIndexDiff;

    51

    52

static inline TileIndex TileXY(uint x, uint y)

    53

{

    54

	return (y * MapSizeX()) + x;

    55

}

    56

    57

static inline TileIndexDiff TileDiffXY(int x, int y)

    58

{

    59

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

    60

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

    61

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

    62

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

    63

	return (y * MapSizeX()) + x;

    64

}

    65

    66

static inline TileIndex TileVirtXY(uint x, uint y)

    67

{

    68

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

    69

}

    70

    71

typedef enum {

    72

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

    73

	OWNER_NONE			= 0x10,	// nobody owns the tile

    74

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

    75

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

    76

} Owner;

    77

    78

enum {

    79

	INVALID_TILE = (TileIndex)-1

    80

};

    81

    82

enum {

    83

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

    84

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

    85

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

    86

};

    87

    88

    89

static inline uint TileX(TileIndex tile)

    90

{

    91

	return tile & MapMaxX();

    92

}

    93

    94

static inline uint TileY(TileIndex tile)

    95

{

    96

	return tile >> MapLogX();

    97

}

    98

    99

   100

typedef struct TileIndexDiffC {

   101

	int16 x;

   102

	int16 y;

   103

} TileIndexDiffC;

   104

   105

static inline TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)

   106

{

   107

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

   108

}

   109

   110

   111

#ifndef _DEBUG

   112

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

   113

#else

   114

	extern TileIndex TileAdd(TileIndex tile, TileIndexDiff add,

   115

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

   116

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

   117

#endif

   118

   119

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

   120

   121

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

   122

   123

static inline TileIndexDiffC TileIndexDiffCByDir(uint dir) {

   124

	extern const TileIndexDiffC _tileoffs_by_dir[4];

   125

	return _tileoffs_by_dir[dir];

   126

}

   127

   128

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

   129

 * outside of the map, INVALID_TILE is returned instead.

   130

 */

   131

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

   132

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

   133

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

   134

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

   135

		return INVALID_TILE;

   136

	else

   137

		return TileXY(x, y);

   138

}

   139

   140

// Functions to calculate distances

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   147

   148

   149

static inline TileIndexDiff TileOffsByDir(uint dir)

   150

{

   151

	extern const TileIndexDiffC _tileoffs_by_dir[4];

   152

   153

	assert(dir < lengthof(_tileoffs_by_dir));

   154

	return ToTileIndexDiff(_tileoffs_by_dir[dir]);

   155

}

   156

   157

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

   158

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

   159

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

   160

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

   161

 * rounding! Be careful when using this!

   162

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

   163

#define STRAIGHT_TRACK_LENGTH 7071/10000

   164

   165

#endif