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

    21

struct Tile {

    22

	byte type_height;

    23

	byte m1;

    24

	uint16 m2;

    25

	byte m3;

    26

	byte m4;

    27

	byte m5;

    28

	byte m6;

    29

};

    30

    37

    38

void AllocateMap(uint size_x, uint size_y);

    39

    40

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

    41

static inline uint MapLogX()  { return _map_log_x; }

    42

/* The size of the map */

    43

static inline uint MapSizeX() { return _map_size_x; }

    44

static inline uint MapSizeY() { return _map_size_y; }

    45

/* The maximum coordinates */

    46

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

    47

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

    48

/* The number of tiles in the map */

    49

static inline uint MapSize() { return _map_size; }

    50

    51

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

    52

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

    53

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

    54

    55

typedef uint32 TileIndex;

    56

typedef int32 TileIndexDiff;

    57

    58

static inline TileIndex TileXY(uint x, uint y)

    59

{

    60

	return (y * MapSizeX()) + x;

    61

}

    62

    63

static inline TileIndexDiff TileDiffXY(int x, int y)

    64

{

    65

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

    66

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

    67

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

    68

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

    69

	return (y * MapSizeX()) + x;

    70

}

    71

    72

static inline TileIndex TileVirtXY(uint x, uint y)

    73

{

    74

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

    75

}

    76

    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

struct TileIndexDiffC {

   101

	int16 x;

   102

	int16 y;

   103

};

   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 TileIndexDiffCByDiagDir(uint dir) {

   124

	extern const TileIndexDiffC _tileoffs_by_diagdir[4];

   125

   126

	assert(dir < lengthof(_tileoffs_by_diagdir));

   127

	return _tileoffs_by_diagdir[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 DistanceFromEdge(TileIndex); ///< shortest distance from any edge of the map

   148

   149

   150

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

   151

	{                                                        \

   152

		int h_cur = h;                                         \

   153

		uint var = tile;                                       \

   154

		do {                                                   \

   155

			int w_cur = w;                                       \

   156

			do {

   157

   158

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

   159

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

   160

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

   161

	}

   162

   163

static inline TileIndexDiff TileOffsByDiagDir(uint dir)

   164

{

   165

	extern const TileIndexDiffC _tileoffs_by_diagdir[4];

   166

   167

	assert(dir < lengthof(_tileoffs_by_diagdir));

   168

	return ToTileIndexDiff(_tileoffs_by_diagdir[dir]);

   169

}

   170

   171

static inline TileIndexDiff TileOffsByDir(uint dir)

   172

{

   173

	extern const TileIndexDiffC _tileoffs_by_dir[8];

   174

   175

	assert(dir < lengthof(_tileoffs_by_dir));

   176

	return ToTileIndexDiff(_tileoffs_by_dir[dir]);

   177

}

   178

   179

typedef bool TestTileOnSearchProc(TileIndex tile, uint32 data);

   180

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

   181

   182

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

   183

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

   184

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

   185

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

   186

 * rounding! Be careful when using this!

   187

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

   188

#define STRAIGHT_TRACK_LENGTH 7071/10000

   189

   190

#endif /* MAP_H */