src/map.cpp
author maedhros
Tue, 06 Mar 2007 19:12:56 +0000
changeset 6227 e38177bd77c4
parent 6201 bee01dc45e39
child 6332 f3f436dcd7d0
permissions -rw-r--r--
(svn r9029) -Fix (r7326): Only call the gradual loading amount callback if the bit for it is set in the vehicle's callbackmask.
2186
db48cf29b983 (svn r2701) Insert Id tags into all source files
tron
parents: 2159
diff changeset
     1
/* $Id$ */
db48cf29b983 (svn r2701) Insert Id tags into all source files
tron
parents: 2159
diff changeset
     2
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
     3
/** @file map.cpp */
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
     4
679
04ca2cd69420 (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
862800791170 (svn r2397) - CodeChange: rename all "ttd" files to "openttd" files.
Darkvater
parents: 1677
diff changeset
     6
#include "openttd.h"
1299
39c06aba09aa (svn r1803) Move debugging stuff into files of it's own
tron
parents: 1247
diff changeset
     7
#include "debug.h"
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
     8
#include "functions.h"
2159
f6284cf5fab0 (svn r2669) Shuffle some more stuff around to reduce dependencies
tron
parents: 2051
diff changeset
     9
#include "macros.h"
679
04ca2cd69420 (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
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
    11
#include "direction.h"
5587
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
    12
#include "helpers.hpp"
679
04ca2cd69420 (svn r1117) Move map arrays and some related macros into their own files map.c and map.h
tron
parents:
diff changeset
    13
2482
374f6395847d (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! */
374f6395847d (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?? */
5587
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
    16
extern "C" _CRTIMP void __cdecl _assert(void *, void *, unsigned);
2482
374f6395847d (svn r3008) [ 1247535 ] Native Support for Win64 (compile&run only) (michi_cc)
Darkvater
parents: 2403
diff changeset
    17
#endif
374f6395847d (svn r3008) [ 1247535 ] Native Support for Win64 (compile&run only) (michi_cc)
Darkvater
parents: 2403
diff changeset
    18
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    19
uint _map_log_x;
2051
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    20
uint _map_size_x;
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    21
uint _map_size_y;
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    22
uint _map_tile_mask;
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    23
uint _map_size;
689
5a4b1536db82 (svn r1130) Add helper functions to query map size
tron
parents: 679
diff changeset
    24
2049
538e73c53f54 (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
    25
Tile* _m = NULL;
863
6a1444534f62 (svn r1344) Use MapSize[XY]() (or MapSize()/MapMax[XY]() where appropriate) instead of TILES_[XY]
tron
parents: 817
diff changeset
    26
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    27
2051
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    28
void AllocateMap(uint size_x, uint size_y)
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    29
{
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
    30
	/* Make sure that the map size is within the limits and that
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
    31
	 * the x axis size is a power of 2. */
2051
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    32
	if (size_x < 64 || size_x > 2048 ||
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    33
			size_y < 64 || size_y > 2048 ||
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    34
			(size_x&(size_x-1)) != 0 ||
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    35
			(size_y&(size_y-1)) != 0)
1244
421dd4852f17 (svn r1748) Enforce map size limits
tron
parents: 1233
diff changeset
    36
		error("Invalid map size");
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    37
5380
8ea58542b6e0 (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents: 5170
diff changeset
    38
	DEBUG(map, 1, "Allocating map of size %dx%d", size_x, size_y);
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    39
2051
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    40
	_map_log_x = FindFirstBit(size_x);
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    41
	_map_size_x = size_x;
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    42
	_map_size_y = size_y;
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    43
	_map_size = size_x * size_y;
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    44
	_map_tile_mask = _map_size - 1;
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    45
2049
538e73c53f54 (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
    46
	free(_m);
5609
dc6a58930ba4 (svn r8066) - Codechange: MallocT(), CallocT(), ReallocT() now return the pointer to allocated memory instead of modifying the pointer given as parameter
KUDr
parents: 5587
diff changeset
    47
	_m = CallocT<Tile>(_map_size);
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    48
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
    49
	/* XXX TODO handle memory shortage more gracefully */
2049
538e73c53f54 (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
    50
	if (_m == NULL) error("Failed to allocate memory for the map");
1218
c6a624956ac6 (svn r1722) -Feature: Bigger maps - anyone?
tron
parents: 1202
diff changeset
    51
}
900
27eb21ced433 (svn r1386) Move TileIndexDiff to map.h
tron
parents: 863
diff changeset
    52
955
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    53
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    54
#ifdef _DEBUG
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    55
TileIndex TileAdd(TileIndex tile, TileIndexDiff add,
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    56
	const char *exp, const char *file, int line)
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    57
{
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    58
	int dx;
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    59
	int dy;
62b8588f50c8 (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
	uint x;
62b8588f50c8 (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
	uint y;
62b8588f50c8 (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
62b8588f50c8 (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
	dx = add & MapMaxX();
957
a1cb5aac6a6f (svn r1449) -Fix: signed/unsigned error on windows
darkvater
parents: 955
diff changeset
    64
	if (dx >= (int)MapSizeX() / 2) dx -= MapSizeX();
955
62b8588f50c8 (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
	dy = (add - dx) / (int)MapSizeX();
62b8588f50c8 (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
62b8588f50c8 (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
	x = TileX(tile) + dx;
62b8588f50c8 (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
	y = TileY(tile) + dy;
62b8588f50c8 (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
62b8588f50c8 (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
	if (x >= MapSizeX() || y >= MapSizeY()) {
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    71
		char buf[512];
62b8588f50c8 (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
5170
817550aa5a5f (svn r7280) -Codechange: Replace some sprintf() functions with the safer snprintf() functions
Darkvater
parents: 5118
diff changeset
    73
		snprintf(buf, lengthof(buf), "TILE_ADD(%s) when adding 0x%.4X and 0x%.4X failed",
955
62b8588f50c8 (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
			exp, tile, add);
62b8588f50c8 (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
#if !defined(_MSC_VER)
62b8588f50c8 (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
		fprintf(stderr, "%s:%d %s\n", file, line, buf);
62b8588f50c8 (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
#else
62b8588f50c8 (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
		_assert(buf, (char*)file, line);
62b8588f50c8 (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
#endif
62b8588f50c8 (svn r1447) Move TILE_ADD(), TILE_ADDXY() and SafeTileAdd() to map.[ch] and make the latter map size agnostic
tron
parents: 927
diff changeset
    80
	}
62b8588f50c8 (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
1981
3c9c682f1212 (svn r2487) Replace TILE_XY by TileXY/TileDiffXY
tron
parents: 1891
diff changeset
    82
	assert(TileXY(x,y) == TILE_MASK(tile + add));
955
62b8588f50c8 (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
1981
3c9c682f1212 (svn r2487) Replace TILE_XY by TileXY/TileDiffXY
tron
parents: 1891
diff changeset
    84
	return TileXY(x,y);
955
62b8588f50c8 (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
}
62b8588f50c8 (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
62b8588f50c8 (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
62b8588f50c8 (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
1202
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    89
uint ScaleByMapSize(uint n)
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    90
{
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
    91
	/* First shift by 12 to prevent integer overflow for large values of n.
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
    92
	 * >>12 is safe since the min mapsize is 64x64
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
    93
	 * Add (1<<4)-1 to round upwards. */
2051
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
    94
	return (n * (MapSize() >> 12) + (1<<4) - 1) >> 4;
1202
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    95
}
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    96
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    97
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
    98
/* Scale relative to the circumference of the map */
1202
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
    99
uint ScaleByMapSize1D(uint n)
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   100
{
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   101
	/* Normal circumference for the X+Y is 256+256 = 1<<9
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   102
	 * Note, not actually taking the full circumference into account,
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   103
	 * just half of it.
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   104
	 * (1<<9) - 1 is there to scale upwards. */
2051
e369160ce2f3 (svn r2560) Fix: various minor code changes.
ludde
parents: 2049
diff changeset
   105
	return (n * (MapSizeX() + MapSizeY()) + (1<<9) - 1) >> 9;
1202
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   106
}
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   107
4d2a20c50760 (svn r1706) Implement ScaleByMapSize() and ScaleByMapSize1D()
tron
parents: 957
diff changeset
   108
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   109
/* This function checks if we add addx/addy to tile, if we
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   110
 *  do wrap around the edges. For example, tile = (10,2) and
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   111
 *  addx = +3 and addy = -4. This function will now return
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   112
 *  INVALID_TILE, because the y is wrapped. This is needed in
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   113
 *  for example, farmland. When the tile is not wrapped,
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   114
 *  the result will be tile + TileDiffXY(addx, addy) */
1247
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   115
uint TileAddWrap(TileIndex tile, int addx, int addy)
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   116
{
2548
49c8a096033f (svn r3077) static, const, bracing, indentation, 0 -> '\0'/NULL, typos in comments, excess empty lines, minor other changes
tron
parents: 2482
diff changeset
   117
	uint x = TileX(tile) + addx;
49c8a096033f (svn r3077) static, const, bracing, indentation, 0 -> '\0'/NULL, typos in comments, excess empty lines, minor other changes
tron
parents: 2482
diff changeset
   118
	uint y = TileY(tile) + addy;
1247
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   119
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   120
	/* Are we about to wrap? */
1981
3c9c682f1212 (svn r2487) Replace TILE_XY by TileXY/TileDiffXY
tron
parents: 1891
diff changeset
   121
	if (x < MapMaxX() && y < MapMaxY())
3c9c682f1212 (svn r2487) Replace TILE_XY by TileXY/TileDiffXY
tron
parents: 1891
diff changeset
   122
		return tile + TileDiffXY(addx, addy);
1247
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   123
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   124
	return INVALID_TILE;
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   125
}
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   126
5587
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   127
extern const TileIndexDiffC _tileoffs_by_diagdir[] = {
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   128
	{-1,  0}, ///< DIAGDIR_NE
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   129
	{ 0,  1}, ///< DIAGDIR_SE
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   130
	{ 1,  0}, ///< DIAGDIR_SW
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   131
	{ 0, -1}  ///< DIAGDIR_NW
4559
aa0c13e39840 (svn r6406) -Codechange: Rename TileOffsByDir to TileOffsByDiagDir because it accepts
Darkvater
parents: 3717
diff changeset
   132
};
aa0c13e39840 (svn r6406) -Codechange: Rename TileOffsByDir to TileOffsByDiagDir because it accepts
Darkvater
parents: 3717
diff changeset
   133
5587
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   134
extern const TileIndexDiffC _tileoffs_by_dir[] = {
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   135
	{-1, -1}, ///< DIR_N
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   136
	{-1,  0}, ///< DIR_NE
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   137
	{-1,  1}, ///< DIR_E
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   138
	{ 0,  1}, ///< DIR_SE
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   139
	{ 1,  1}, ///< DIR_S
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   140
	{ 1,  0}, ///< DIR_SW
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   141
	{ 1, -1}, ///< DIR_W
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   142
	{ 0, -1}  ///< DIR_NW
1247
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   143
};
3851739bfd09 (svn r1751) - Feature: New PathFinder (NPF).
matthijs
parents: 1245
diff changeset
   144
1245
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   145
uint DistanceManhattan(TileIndex t0, TileIndex t1)
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   146
{
5587
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   147
	const uint dx = delta(TileX(t0), TileX(t1));
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   148
	const uint dy = delta(TileY(t0), TileY(t1));
1677
d534f0c8c845 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   149
	return dx + dy;
1245
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   150
}
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   151
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   152
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   153
uint DistanceSquare(TileIndex t0, TileIndex t1)
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   154
{
1677
d534f0c8c845 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   155
	const int dx = TileX(t0) - TileX(t1);
d534f0c8c845 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   156
	const int dy = TileY(t0) - TileY(t1);
d534f0c8c845 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   157
	return dx * dx + dy * dy;
1245
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   158
}
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   159
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   160
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   161
uint DistanceMax(TileIndex t0, TileIndex t1)
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   162
{
5587
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   163
	const uint dx = delta(TileX(t0), TileX(t1));
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   164
	const uint dy = delta(TileY(t0), TileY(t1));
1677
d534f0c8c845 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   165
	return dx > dy ? dx : dy;
1245
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   166
}
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   167
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   168
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   169
uint DistanceMaxPlusManhattan(TileIndex t0, TileIndex t1)
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   170
{
5587
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   171
	const uint dx = delta(TileX(t0), TileX(t1));
167d9a91ef02 (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5584
diff changeset
   172
	const uint dy = delta(TileY(t0), TileY(t1));
1677
d534f0c8c845 (svn r2181) - Add: DistanceTrack() to calculate the distance over optimally laid out tracks.
matthijs
parents: 1410
diff changeset
   173
	return dx > dy ? 2 * dx + dy : 2 * dy + dx;
1245
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   174
}
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   175
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   176
uint DistanceFromEdge(TileIndex tile)
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   177
{
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   178
	const uint xl = TileX(tile);
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   179
	const uint yl = TileY(tile);
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   180
	const uint xh = MapSizeX() - 1 - xl;
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   181
	const uint yh = MapSizeY() - 1 - yl;
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   182
	const uint minl = xl < yl ? xl : yl;
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   183
	const uint minh = xh < yh ? xh : yh;
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   184
	return minl < minh ? minl : minh;
3822f77cbc53 (svn r1749) Move the functions which calculate distances to map.[ch] and give the more meaningful names
tron
parents: 1244
diff changeset
   185
}
5118
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   186
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   187
/**
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   188
 * Function performing a search around a center tile and going outward, thus in circle.
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   189
 * Although it really is a square search...
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   190
 * Every tile will be tested by means of the callback function proc,
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   191
 * which will determine if yes or no the given tile meets criteria of search.
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   192
 * @param tile to start the search from
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   193
 * @param size: number of tiles per side of the desired search area
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   194
 * @param proc: callback testing function pointer.
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   195
 * @param data to be passed to the callback function. Depends on the implementation
6201
bee01dc45e39 (svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
belugas
parents: 5609
diff changeset
   196
 * @return result of the search
5118
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   197
 * @pre proc != NULL
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   198
 * @pre size > 0
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   199
 */
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   200
bool CircularTileSearch(TileIndex tile, uint size, TestTileOnSearchProc proc, uint32 data)
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   201
{
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   202
	uint n, x, y;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   203
	DiagDirection dir;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   204
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   205
	assert(proc != NULL);
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   206
	assert(size > 0);
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   207
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   208
	x = TileX(tile);
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   209
	y = TileY(tile);
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   210
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   211
	if (size % 2 == 1) {
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   212
		/* If the length of the side is uneven, the center has to be checked
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   213
		 * separately, as the pattern of uneven sides requires to go around the center */
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   214
		n = 2;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   215
		if (proc(TileXY(x, y), data)) return true;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   216
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   217
		/* If tile test is not successfull, get one tile down and left,
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   218
		 * ready for a test in first circle around center tile */
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   219
		x += _tileoffs_by_dir[DIR_W].x;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   220
		y += _tileoffs_by_dir[DIR_W].y;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   221
	} else {
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   222
		n = 1;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   223
		/* To use _tileoffs_by_diagdir's order, we must relocate to
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   224
		 * another tile, as we now first go 'up', 'right', 'down', 'left'
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   225
		 * instead of 'right', 'down', 'left', 'up', which the calling
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   226
		 * function assume. */
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   227
		x++;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   228
	}
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   229
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   230
	for (; n < size; n += 2) {
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   231
		for (dir = DIAGDIR_NE; dir < DIAGDIR_END; dir++) {
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   232
			uint j;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   233
			for (j = n; j != 0; j--) {
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   234
				if (x <= MapMaxX() && y <= MapMaxY() && ///< Is the tile within the map?
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   235
						proc(TileXY(x, y), data)) {     ///< Is the callback successfulll?
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   236
					return true;                        ///< then stop the search
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   237
				}
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   238
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   239
				/* Step to the next 'neighbour' in the circular line */
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   240
				x += _tileoffs_by_diagdir[dir].x;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   241
				y += _tileoffs_by_diagdir[dir].y;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   242
			}
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   243
		}
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   244
		/* Jump to next circle to test */
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   245
		x += _tileoffs_by_dir[DIR_W].x;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   246
		y += _tileoffs_by_dir[DIR_W].y;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   247
	}
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   248
	return false;
9640617e1abb (svn r7198) -Codechange: Implement a circular tile search function.
belugas
parents: 4559
diff changeset
   249
}