src/map.cpp
author KUDr
Sat, 21 Apr 2007 08:23:57 +0000
branchcpp_gui
changeset 6308 646711c5feaa
parent 6303 84c215fc8eb8
child 9620 31e38d28a0af
permissions -rw-r--r--
(svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
2186
461a2aff3486 (svn r2701) Insert Id tags into all source files
tron
parents: 2159
diff changeset
     1
/* $Id$ */
461a2aff3486 (svn r2701) Insert Id tags into all source files
tron
parents: 2159
diff changeset
     2
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
     3
/** @file map.cpp */
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
     4
679
e959706a3e4d (svn r1117) Move map arrays and some related macros into their own files map.c and map.h
tron
parents:
diff changeset
     5
#include "stdafx.h"
1891
92a3b0aa0946 (svn r2397) - CodeChange: rename all "ttd" files to "openttd" files.
Darkvater
parents: 1677
diff changeset
     6
#include "openttd.h"
1299
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own
tron
parents: 1247
diff changeset
     7
#include "debug.h"
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
     8
#include "functions.h"
2159
3b634157c3b2 (svn r2669) Shuffle some more stuff around to reduce dependencies
tron
parents: 2051
diff changeset
     9
#include "macros.h"
679
e959706a3e4d (svn r1117) Move map arrays and some related macros into their own files map.c and map.h
tron
parents:
diff changeset
    10
#include "map.h"
5118
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
    11
#include "direction.h"
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
    12
#include "helpers.hpp"
679
e959706a3e4d (svn r1117) Move map arrays and some related macros into their own files map.c and map.h
tron
parents:
diff changeset
    13
2482
dffcca243dbc (svn r3008) [ 1247535 ] Native Support for Win64 (compile&run only) (michi_cc)
Darkvater
parents: 2403
diff changeset
    14
#if defined(_MSC_VER) && _MSC_VER >= 1400 /* VStudio 2005 is stupid! */
dffcca243dbc (svn r3008) [ 1247535 ] Native Support for Win64 (compile&run only) (michi_cc)
Darkvater
parents: 2403
diff changeset
    15
/* Why the hell is that not in all MSVC headers?? */
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
    16
extern "C" _CRTIMP void __cdecl _assert(void *, void *, unsigned);
2482
dffcca243dbc (svn r3008) [ 1247535 ] Native Support for Win64 (compile&run only) (michi_cc)
Darkvater
parents: 2403
diff changeset
    17
#endif
dffcca243dbc (svn r3008) [ 1247535 ] Native Support for Win64 (compile&run only) (michi_cc)
Darkvater
parents: 2403
diff changeset
    18
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    19
uint _map_log_x;
2051
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    20
uint _map_size_x;
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    21
uint _map_size_y;
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    22
uint _map_tile_mask;
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    23
uint _map_size;
689
1412bc834a8d (svn r1130) Add helper functions to query map size
tron
parents: 679
diff changeset
    24
6303
84c215fc8eb8 (svn r9486) [cpp_gui] -Sync with trunk (r9100:9476)
KUDr
parents: 6285
diff changeset
    25
Tile *_m = NULL;
84c215fc8eb8 (svn r9486) [cpp_gui] -Sync with trunk (r9100:9476)
KUDr
parents: 6285
diff changeset
    26
TileExtended *_me = NULL;
863
8d09f9331a80 (svn r1344) Use MapSize[XY]() (or MapSize()/MapMax[XY]() where appropriate) instead of TILES_[XY]
tron
parents: 817
diff changeset
    27
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    28
2051
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    29
void AllocateMap(uint size_x, uint size_y)
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    30
{
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
    31
	/* Make sure that the map size is within the limits and that
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
    32
	 * the x axis size is a power of 2. */
2051
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    33
	if (size_x < 64 || size_x > 2048 ||
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    34
			size_y < 64 || size_y > 2048 ||
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    35
			(size_x&(size_x-1)) != 0 ||
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    36
			(size_y&(size_y-1)) != 0)
1244
7c87de28da3c (svn r1748) Enforce map size limits
tron
parents: 1233
diff changeset
    37
		error("Invalid map size");
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    38
5568
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents: 5170
diff changeset
    39
	DEBUG(map, 1, "Allocating map of size %dx%d", size_x, size_y);
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    40
2051
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    41
	_map_log_x = FindFirstBit(size_x);
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    42
	_map_size_x = size_x;
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    43
	_map_size_y = size_y;
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    44
	_map_size = size_x * size_y;
44b6b091beb3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    45
	_map_tile_mask = _map_size - 1;
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    46
2049
ad0d49c916d4 (svn r2558) Change the internal map format from 7 arrays to one array of structs, this doesn't change the saved format for now. It's a stepping stone for further changes.
tron
parents: 2043
diff changeset
    47
	free(_m);
6303
84c215fc8eb8 (svn r9486) [cpp_gui] -Sync with trunk (r9100:9476)
KUDr
parents: 6285
diff changeset
    48
	free(_me);
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    49
6303
84c215fc8eb8 (svn r9486) [cpp_gui] -Sync with trunk (r9100:9476)
KUDr
parents: 6285
diff changeset
    50
	_m = CallocT<Tile>(_map_size);
6308
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
    51
	_me = CallocT<TileExtended>(_map_size);
6303
84c215fc8eb8 (svn r9486) [cpp_gui] -Sync with trunk (r9100:9476)
KUDr
parents: 6285
diff changeset
    52
6308
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
    53
	/* XXX @todo handle memory shortage more gracefully
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
    54
	 * Maybe some attemps could be made to try with smaller maps down to 64x64
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
    55
	 * Maybe check for available memory before doing the calls, after all, we know how big
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
    56
	 * the map is */
6303
84c215fc8eb8 (svn r9486) [cpp_gui] -Sync with trunk (r9100:9476)
KUDr
parents: 6285
diff changeset
    57
	if ((_m == NULL) || (_me == NULL)) error("Failed to allocate memory for the map");
1218
353a7773bc3c (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    58
}
900
feed1801fd35 (svn r1386) Move TileIndexDiff to map.h
tron
parents: 863
diff changeset
    59
955
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    60
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    61
#ifdef _DEBUG
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    62
TileIndex TileAdd(TileIndex tile, TileIndexDiff add,
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    63
	const char *exp, const char *file, int line)
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    64
{
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    65
	int dx;
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    66
	int dy;
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    67
	uint x;
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    68
	uint y;
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    69
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    70
	dx = add & MapMaxX();
957
d1dd9429e417 (svn r1449) -Fix: signed/unsigned error on windows
darkvater
parents: 955
diff changeset
    71
	if (dx >= (int)MapSizeX() / 2) dx -= MapSizeX();
955
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    72
	dy = (add - dx) / (int)MapSizeX();
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    73
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    74
	x = TileX(tile) + dx;
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    75
	y = TileY(tile) + dy;
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    76
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    77
	if (x >= MapSizeX() || y >= MapSizeY()) {
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    78
		char buf[512];
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    79
5170
56c12a62af49 (svn r7280) -Codechange: Replace some sprintf() functions with the safer snprintf() functions
Darkvater
parents: 5118
diff changeset
    80
		snprintf(buf, lengthof(buf), "TILE_ADD(%s) when adding 0x%.4X and 0x%.4X failed",
955
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    81
			exp, tile, add);
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    82
#if !defined(_MSC_VER)
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    83
		fprintf(stderr, "%s:%d %s\n", file, line, buf);
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    84
#else
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    85
		_assert(buf, (char*)file, line);
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    86
#endif
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    87
	}
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    88
6308
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
    89
	assert(TileXY(x, y) == TILE_MASK(tile + add));
955
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    90
6308
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
    91
	return TileXY(x, y);
955
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    92
}
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    93
#endif
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    94
25bc5b97e3e2 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    95
1202
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    96
uint ScaleByMapSize(uint n)
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    97
{
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
    98
	/* First shift by 12 to prevent integer overflow for large values of n.
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
    99
	 * >>12 is safe since the min mapsize is 64x64
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   100
	 * Add (1<<4)-1 to round upwards. */
6308
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
   101
	return (n * (MapSize() >> 12) + (1 << 4) - 1) >> 4;
1202
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   102
}
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   103
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   104
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   105
/* Scale relative to the circumference of the map */
1202
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   106
uint ScaleByMapSize1D(uint n)
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   107
{
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   108
	/* Normal circumference for the X+Y is 256+256 = 1<<9
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   109
	 * Note, not actually taking the full circumference into account,
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   110
	 * just half of it.
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   111
	 * (1<<9) - 1 is there to scale upwards. */
6308
646711c5feaa (svn r9708) [cpp_gui] -Sync with trunk (r9633:9707)
KUDr
parents: 6303
diff changeset
   112
	return (n * (MapSizeX() + MapSizeY()) + (1 << 9) - 1) >> 9;
1202
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   113
}
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   114
7d8b86bd8ba2 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   115
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   116
/* This function checks if we add addx/addy to tile, if we
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   117
 *  do wrap around the edges. For example, tile = (10,2) and
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   118
 *  addx = +3 and addy = -4. This function will now return
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   119
 *  INVALID_TILE, because the y is wrapped. This is needed in
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   120
 *  for example, farmland. When the tile is not wrapped,
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   121
 *  the result will be tile + TileDiffXY(addx, addy) */
1247
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   122
uint TileAddWrap(TileIndex tile, int addx, int addy)
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   123
{
2548
97ada3bd2702 (svn r3077) static, const, bracing, indentation, 0 -> '\0'/NULL, typos in comments, excess empty lines, minor other changes
tron
parents: 2482
diff changeset
   124
	uint x = TileX(tile) + addx;
97ada3bd2702 (svn r3077) static, const, bracing, indentation, 0 -> '\0'/NULL, typos in comments, excess empty lines, minor other changes
tron
parents: 2482
diff changeset
   125
	uint y = TileY(tile) + addy;
1247
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   126
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   127
	/* Are we about to wrap? */
1981
de031d2aed47 (svn r2487) Replace TILE_XY by TileXY/TileDiffXY
tron
parents: 1891
diff changeset
   128
	if (x < MapMaxX() && y < MapMaxY())
de031d2aed47 (svn r2487) Replace TILE_XY by TileXY/TileDiffXY
tron
parents: 1891
diff changeset
   129
		return tile + TileDiffXY(addx, addy);
1247
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   130
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   131
	return INVALID_TILE;
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   132
}
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   133
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   134
extern const TileIndexDiffC _tileoffs_by_diagdir[] = {
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   135
	{-1,  0}, ///< DIAGDIR_NE
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   136
	{ 0,  1}, ///< DIAGDIR_SE
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   137
	{ 1,  0}, ///< DIAGDIR_SW
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   138
	{ 0, -1}  ///< DIAGDIR_NW
4559
c853d2440065 (svn r6406) -Codechange: Rename TileOffsByDir to TileOffsByDiagDir because it accepts
Darkvater
parents: 3717
diff changeset
   139
};
c853d2440065 (svn r6406) -Codechange: Rename TileOffsByDir to TileOffsByDiagDir because it accepts
Darkvater
parents: 3717
diff changeset
   140
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   141
extern const TileIndexDiffC _tileoffs_by_dir[] = {
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   142
	{-1, -1}, ///< DIR_N
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   143
	{-1,  0}, ///< DIR_NE
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   144
	{-1,  1}, ///< DIR_E
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   145
	{ 0,  1}, ///< DIR_SE
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   146
	{ 1,  1}, ///< DIR_S
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   147
	{ 1,  0}, ///< DIR_SW
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   148
	{ 1, -1}, ///< DIR_W
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   149
	{ 0, -1}  ///< DIR_NW
1247
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   150
};
01711347f9ac (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   151
1245
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   152
uint DistanceManhattan(TileIndex t0, TileIndex t1)
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   153
{
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   154
	const uint dx = delta(TileX(t0), TileX(t1));
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   155
	const uint dy = delta(TileY(t0), TileY(t1));
1677
c18884ca76d5 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   156
	return dx + dy;
1245
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   157
}
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   158
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   159
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   160
uint DistanceSquare(TileIndex t0, TileIndex t1)
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   161
{
1677
c18884ca76d5 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   162
	const int dx = TileX(t0) - TileX(t1);
c18884ca76d5 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   163
	const int dy = TileY(t0) - TileY(t1);
c18884ca76d5 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   164
	return dx * dx + dy * dy;
1245
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   165
}
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   166
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   167
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   168
uint DistanceMax(TileIndex t0, TileIndex t1)
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   169
{
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   170
	const uint dx = delta(TileX(t0), TileX(t1));
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   171
	const uint dy = delta(TileY(t0), TileY(t1));
1677
c18884ca76d5 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   172
	return dx > dy ? dx : dy;
1245
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   173
}
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   174
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   175
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   176
uint DistanceMaxPlusManhattan(TileIndex t0, TileIndex t1)
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   177
{
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   178
	const uint dx = delta(TileX(t0), TileX(t1));
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5835
diff changeset
   179
	const uint dy = delta(TileY(t0), TileY(t1));
1677
c18884ca76d5 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   180
	return dx > dy ? 2 * dx + dy : 2 * dy + dx;
1245
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   181
}
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   182
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   183
uint DistanceFromEdge(TileIndex tile)
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   184
{
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   185
	const uint xl = TileX(tile);
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   186
	const uint yl = TileY(tile);
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   187
	const uint xh = MapSizeX() - 1 - xl;
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   188
	const uint yh = MapSizeY() - 1 - yl;
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   189
	const uint minl = xl < yl ? xl : yl;
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   190
	const uint minh = xh < yh ? xh : yh;
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   191
	return minl < minh ? minl : minh;
768d9bc95aaa (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   192
}
5118
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   193
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   194
/**
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   195
 * Function performing a search around a center tile and going outward, thus in circle.
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   196
 * Although it really is a square search...
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   197
 * Every tile will be tested by means of the callback function proc,
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   198
 * which will determine if yes or no the given tile meets criteria of search.
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   199
 * @param tile to start the search from
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   200
 * @param size: number of tiles per side of the desired search area
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   201
 * @param proc: callback testing function pointer.
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   202
 * @param data to be passed to the callback function. Depends on the implementation
6285
187e3ef04cc9 (svn r9004) [cpp_gui] -Sync with trunk (r8900..r9003)
KUDr
parents: 5860
diff changeset
   203
 * @return result of the search
5118
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   204
 * @pre proc != NULL
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   205
 * @pre size > 0
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   206
 */
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   207
bool CircularTileSearch(TileIndex tile, uint size, TestTileOnSearchProc proc, uint32 data)
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   208
{
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   209
	uint n, x, y;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   210
	DiagDirection dir;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   211
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   212
	assert(proc != NULL);
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   213
	assert(size > 0);
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   214
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   215
	x = TileX(tile);
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   216
	y = TileY(tile);
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   217
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   218
	if (size % 2 == 1) {
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   219
		/* If the length of the side is uneven, the center has to be checked
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   220
		 * separately, as the pattern of uneven sides requires to go around the center */
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   221
		n = 2;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   222
		if (proc(TileXY(x, y), data)) return true;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   223
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   224
		/* If tile test is not successfull, get one tile down and left,
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   225
		 * ready for a test in first circle around center tile */
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   226
		x += _tileoffs_by_dir[DIR_W].x;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   227
		y += _tileoffs_by_dir[DIR_W].y;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   228
	} else {
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   229
		n = 1;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   230
		/* To use _tileoffs_by_diagdir's order, we must relocate to
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   231
		 * another tile, as we now first go 'up', 'right', 'down', 'left'
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   232
		 * instead of 'right', 'down', 'left', 'up', which the calling
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   233
		 * function assume. */
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   234
		x++;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   235
	}
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   236
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   237
	for (; n < size; n += 2) {
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   238
		for (dir = DIAGDIR_NE; dir < DIAGDIR_END; dir++) {
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   239
			uint j;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   240
			for (j = n; j != 0; j--) {
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   241
				if (x <= MapMaxX() && y <= MapMaxY() && ///< Is the tile within the map?
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   242
						proc(TileXY(x, y), data)) {     ///< Is the callback successfulll?
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   243
					return true;                        ///< then stop the search
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   244
				}
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   245
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   246
				/* Step to the next 'neighbour' in the circular line */
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   247
				x += _tileoffs_by_diagdir[dir].x;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   248
				y += _tileoffs_by_diagdir[dir].y;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   249
			}
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   250
		}
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   251
		/* Jump to next circle to test */
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   252
		x += _tileoffs_by_dir[DIR_W].x;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   253
		y += _tileoffs_by_dir[DIR_W].y;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   254
	}
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   255
	return false;
5a56a0f12206 (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   256
}