1

#include "stdafx.h"

     2

#include "ttd.h"

     3

#include "debug.h"

     4

#include "npf.h"

     5

#include "aystar.h"

     6

#include "macros.h"

     7

#include "pathfind.h"

     8

#include "station.h"

     9

#include "tile.h"

    10

#include "depot.h"

    11

    12

AyStar _train_find_station;

    13

AyStar _train_find_depot;

    14

AyStar _road_find_station;

    15

AyStar _road_find_depot;

    16

AyStar _npf_aystar;

    17

    18

/* Maps a trackdir to the bit that stores its status in the map arrays, in the

    19

 * direction along with the trackdir */

    20

const byte _signal_along_trackdir[14] = {

    21

	0x80, 0x80, 0x80, 0x20, 0x40, 0x10, 0, 0,

    22

	0x40, 0x40, 0x40, 0x10, 0x80, 0x20

    23

};

    24

    25

/* Maps a trackdir to the bit that stores its status in the map arrays, in the

    26

 * direction against the trackdir */

    27

const byte _signal_against_trackdir[14] = {

    28

	0x40, 0x40, 0x40, 0x10, 0x80, 0x20, 0, 0,

    29

	0x80, 0x80, 0x80, 0x20, 0x40, 0x10

    30

};

    31

    32

/* Maps a trackdir to the trackdirs that can be reached from it (ie, when

    33

 * entering the next tile */

    34

const uint16 _trackdir_reaches_trackdirs[14] = {

    35

	0x1009, 0x0016, 0x1009, 0x0016, 0x0520, 0x0016, 0, 0,

    36

	0x0520, 0x2A00, 0x2A00, 0x0520, 0x2A00, 0x1009

    37

};

    38

    39

/* Maps a trackdir to all trackdirs that make 90 deg turns with it. */

    40

const uint16 _trackdir_crosses_trackdirs[14] = {

    41

	0x0202, 0x0101, 0x3030, 0x3030, 0x0C0C, 0x0C0C, 0, 0,

    42

	0x0202, 0x0101, 0x3030, 0x3030, 0x0C0C, 0x0C0C

    43

};

    44

    45

/* Maps a track to all tracks that make 90 deg turns with it. */

    46

const byte _track_crosses_tracks[6] = {

    47

	0x2, /* Track 1 -> Track 2 */

    48

	0x1, /* Track 2 -> Track 1 */

    49

	0x30, /* Upper -> Left | Right */

    50

	0x30, /* Lower -> Left | Right */

    51

	0x0C, /* Left -> Upper | Lower */

    52

	0x0C, /* Right -> Upper | Lower */

    53

};

    54

    55

/* Maps a trackdir to the (4-way) direction the tile is exited when following

    56

 * that trackdir */

    57

const byte _trackdir_to_exitdir[14] = {

    58

	0,1,0,1,2,1, 0,0,

    59

	2,3,3,2,3,0,

    60

};

    61

    62

const byte _track_exitdir_to_trackdir[6][4] = {

    63

	{0,    0xff, 8,    0xff},

    64

	{0xff, 1,    0xff, 9},

    65

	{2,    0xff, 0xff, 10},

    66

	{0xff, 3,    11,   0xf},

    67

	{0xff, 0xff, 4,    12},

    68

	{13,   5,    0xff, 0xff}

    69

};

    70

    71

const byte _track_direction_to_trackdir[6][8] = {

    72

	{0xff, 0,    0xff, 0xff, 0xff, 8,    0xff, 0xff},

    73

	{0xff, 0xff, 0xff, 1,    0xff, 0xff, 0xff, 9},

    74

	{0xff, 0xff, 2,    0xff, 0xff, 0xff, 10,   0xff},

    75

	{0xff, 0xff, 3,    0xff, 0xff, 0xff, 11,   0xff},

    76

	{12,   0xff, 0xff, 0xff, 4,    0xff, 0xff, 0xff},

    77

	{13,   0xff, 0xff, 0xff, 5,    0xff, 0xff, 0xff}

    78

};

    79

    80

const byte _dir_to_diag_trackdir[4] = {

    81

	0, 1, 8, 9,

    82

};

    83

    84

const byte _reverse_dir[4] = {

    85

	2, 3, 0, 1

    86

};

    87

    88

const byte _reverse_trackdir[14] = {

    89

	8, 9, 10, 11, 12, 13, 0xFF, 0xFF,

    90

	0, 1, 2,  3,  4,  5

    91

};

    92

    93

/* The cost of each trackdir. A diagonal piece is the full NPF_TILE_LENGTH,

    94

 * the shorter piece is sqrt(2)/2*NPF_TILE_LENGTH =~ 0.7071

    95

 */

    96

#define NPF_STRAIGHT_LENGTH (uint)(NPF_TILE_LENGTH * 0.7071)

    97

static const uint _trackdir_length[14] = {

    98

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH,

    99

	0, 0,

   100

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH

   101

};

   102

   103

uint NTPHash(uint key1, uint key2)

   104

{

   105

	return PATHFIND_HASH_TILE(key1);

   106

}

   107

   108

int32 NPFCalcZero(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   109

	return 0;

   110

}

   111

   112

/* Calcs the tile of given station that is closest to a given tile

   113

 * for this we assume the station is a rectangle,

   114

 * as defined by its top tile (st->train_tile) and its width/height (st->trainst_w, st->trainst_h)

   115

 */

   116

TileIndex CalcClosestStationTile(int station, TileIndex tile) {

   117

	const Station* st = GetStation(station);

   118

   119

	int x1,x2,x3,tx;

   120

	int y1,y2,y3,ty;

   121

   122

	x1 = TileX(st->train_tile);  y1 = TileY(st->train_tile);  // topmost corner of station

   123

	x2 = x1 + st->trainst_w - 1; y2 = y1 + st->trainst_h - 1; // lowermost corner of station

   124

	x3 = TileX(tile);            y3 = TileY(tile);            // tile we take the distance from

   125

   126

	// we are going the aim for the x coordinate of the closest corner

   127

	// but if we are between those coordinates, we will aim for our own x coordinate

   128

	if (x3 < x1)

   129

		tx = x1;

   130

	else if (x3 > x2)

   131

		tx = x2;

   132

	else

   133

		tx = x3;

   134

   135

	// same for y coordinate, see above comment

   136

	if (y3 < y1)

   137

		ty = y1;

   138

	else if (y3 > y2)

   139

		ty = y2;

   140

	else

   141

		ty = y3;

   142

   143

	// return the tile of our target coordinates

   144

	return TILE_XY(tx,ty);

   145

};

   146

   147

/* Calcs the heuristic to the target tile (using NPFFindStationOrTileData).

   148

 * If the target is a station, the heuristic is probably "wrong"! Normally

   149

 * this shouldn't matter, but if it turns out to be a problem, we could use

   150

 * the heuristic below?

   151

 * Afterthis  will save the heuristic into NPFFoundTargetData if it is the

   152

 * smallest until now. It will then also save

   153

 * AyStarNode.user_data[NPF_TRACKDIR_CHOICE] in best_trackdir

   154

 */

   155

int32 NPFCalcTileHeuristic(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   156

	NPFFindStationOrTileData* fstd = (NPFFindStationOrTileData*)as->user_target;

   157

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   158

	TileIndex from = current->tile;

   159

	TileIndex to = fstd->dest_coords;

   160

	uint dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   161

   162

	if (dist < ftd->best_bird_dist) {

   163

		ftd->best_bird_dist = dist;

   164

		ftd->best_trackdir = current->user_data[NPF_TRACKDIR_CHOICE];

   165

	}

   166

#ifdef NPF_DEBUG

   167

	debug("Calculating H for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), dist);

   168

#endif

   169

	return dist;

   170

}

   171

   172

/* Calcs the heuristic to the target station or tile. Almost the same as above

   173

 * function, but calculates the distance to train stations with

   174

 * CalcClosestStationTile instead. So is somewhat more correct for stations

   175

 * (truly optimistic), but this added correctness is not really required we

   176

 * believe (matthijs & Hackykid)

   177

 */

   178

int32 NPFCalcStationOrTileHeuristic(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   179

	NPFFindStationOrTileData* fstd = (NPFFindStationOrTileData*)as->user_target;

   180

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   181

	TileIndex from = current->tile;

   182

	TileIndex to = fstd->dest_coords;

   183

	uint dist;

   184

   185

	// for train-stations, we are going to aim for the closest station tile

   186

	if ((as->user_data[NPF_TYPE] == TRANSPORT_RAIL) && (fstd->station_index != -1))

   187

		to = CalcClosestStationTile(fstd->station_index, from);

   188

   189

	dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   190

   191

	if (dist < ftd->best_bird_dist) {

   192

		ftd->best_bird_dist = dist;

   193

		ftd->best_trackdir = current->user_data[NPF_TRACKDIR_CHOICE];

   194

	}

   195

#ifdef NPF_DEBUG

   196

	debug("Calculating H for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), dist);

   197

#endif

   198

	return dist;

   199

}

   200

   201

   202

/* Fills AyStarNode.user_data[NPF_TRACKDIRCHOICE] with the chosen direction to

   203

 * get here, either getting it from the current choice or from the parent's

   204

 * choice */

   205

void NPFFillTrackdirChoice(AyStarNode* current, OpenListNode* parent)

   206

{

   207

	if (parent->path.parent == NULL) {

   208

		byte trackdir = current->direction;

   209

		/* This is a first order decision, so we'd better save the

   210

		 * direction we chose */

   211

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   212

#ifdef NPF_DEBUG

   213

		debug("Saving trackdir: %#x", trackdir);

   214

#endif

   215

	} else {

   216

		/* We've already made the decision, so just save our parent's

   217

		 * decision */

   218

		current->user_data[NPF_TRACKDIR_CHOICE] = parent->path.node.user_data[NPF_TRACKDIR_CHOICE];

   219

	}

   220

   221

}

   222

   223

/* Will return the cost of the tunnel. If it is an entry, it will return the

   224

 * cost of that tile. If the tile is an exit, it will return the tunnel length

   225

 * including the exit tile. Requires that this is a Tunnel tile */

   226

uint NPFTunnelCost(AyStarNode* current) {

   227

	byte exitdir = _trackdir_to_exitdir[current->direction];

   228

	TileIndex tile = current->tile;

   229

	if ( (uint)(_map5[tile] & 3) == _reverse_dir[exitdir]) {

   230

		/* We just popped out if this tunnel, since were

   231

		 * facing the tunnel exit */

   232

		FindLengthOfTunnelResult flotr;

   233

		flotr = FindLengthOfTunnel(tile, _reverse_dir[exitdir]);

   234

		return flotr.length * NPF_TILE_LENGTH;

   235

		//TODO: Penalty for tunnels?

   236

	} else {

   237

		/* We are entering the tunnel, the enter tile is just a

   238

		 * straight track */

   239

		return NPF_TILE_LENGTH;

   240

	}

   241

}

   242

   243

uint NPFSlopeCost(AyStarNode* current) {

   244

	TileIndex next = current->tile + TileOffsByDir(_trackdir_to_exitdir[current->direction]);

   245

	int x,y;

   246

	int8 z1,z2;

   247

   248

	x = TileX(current->tile) * 16;

   249

	y = TileY(current->tile) * 16;

   250

	z1 = GetSlopeZ(x+8, y+8);

   251

   252

	x = TileX(next) * 16;

   253

	y = TileY(next) * 16;

   254

	z2 = GetSlopeZ(x+8, y+8);

   255

   256

	if ((z2 - z1) > 1) {

   257

		/* Slope up */

   258

		return _patches.npf_rail_slope_penalty;

   259

	}

   260

	return 0;

   261

	/* Should we give a bonus for slope down? Probably not, we

   262

	 * could just substract that bonus from the penalty, because

   263

	 * there is only one level of steepness... */

   264

}

   265

   266

void NPFMarkTile(TileIndex tile) {

   267

	switch(GetTileType(tile)) {

   268

		case MP_RAILWAY:

   269

		case MP_STREET:

   270

			/* DEBUG: mark visited tiles by mowing the grass under them

   271

			 * ;-) */

   272

			_map2[tile] &= ~15;

   273

			MarkTileDirtyByTile(tile);

   274

			break;

   275

		default:

   276

			break;

   277

	}

   278

}

   279

   280

int32 NPFWaterPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   281

	//TileIndex tile = current->tile;

   282

	int32 cost = 0;

   283

	byte trackdir = current->direction;

   284

   285

	cost = _trackdir_length[trackdir]; /* Should be different for diagonal tracks */

   286

   287

	/* TODO Penalties? */

   288

   289

	return cost;

   290

}

   291

   292

/* Determine the cost of this node, for road tracks */

   293

int32 NPFRoadPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   294

	TileIndex tile = current->tile;

   295

	int32 cost = 0;

   296

	/* Determine base length */

   297

	switch (GetTileType(tile)) {

   298

		case MP_TUNNELBRIDGE:

   299

			if ((_map5[tile] & 0xF0)==0) {

   300

				cost = NPFTunnelCost(current);

   301

				break;

   302

			}

   303

			/* Fall through if above if is false, it is a bridge

   304

			 * then. We treat that as ordinary rail */

   305

		case MP_STREET:

   306

			cost = NPF_TILE_LENGTH;

   307

			break;

   308

		default:

   309

			break;

   310

	}

   311

   312

	/* Determine extra costs */

   313

   314

	/* Check for slope */

   315

	cost += NPFSlopeCost(current);

   316

   317

	/* Check for turns */

   318

	//TODO

   319

   320

#ifdef NPF_MARKROUTE

   321

	NPFMarkTile(tile);

   322

#endif

   323

#ifdef NPF_DEBUG

   324

	debug("Calculating G for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), cost);

   325

#endif

   326

	return cost;

   327

}

   328

   329

   330

/* Determine the cost of this node, for railway tracks */

   331

int32 NPFRailPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent) {

   332

	TileIndex tile = current->tile;

   333

	byte trackdir = current->direction;

   334

	int32 cost = 0;

   335

	/* Determine base length */

   336

	switch (GetTileType(tile)) {

   337

		case MP_TUNNELBRIDGE:

   338

			if ((_map5[tile] & 0xF0)==0) {

   339

				cost = NPFTunnelCost(current);

   340

				break;

   341

			}

   342

			/* Fall through if above if is false, it is a bridge

   343

			 * then. We treat that as ordinary rail */

   344

		case MP_RAILWAY:

   345

			cost = _trackdir_length[trackdir]; /* Should be different for diagonal tracks */

   346

			break;

   347

		case MP_STREET: /* Railway crossing */

   348

			cost = NPF_TILE_LENGTH;

   349

			break;

   350

		case MP_STATION:

   351

			/* We give a station tile a penalty. Logically we would only

   352

					* want to give station tiles that are not our destination

   353

					* this penalty. This would discourage trains to drive through

   354

					* busy stations. But, we can just give any station tile a

   355

					* penalty, because every possible route will get this penalty

   356

					* exactly once, on its end tile (if it's a station) and it

   357

			* will therefore not make a difference. */

   358

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   359

			break;

   360

		default:

   361

			break;

   362

	}

   363

   364

	/* Determine extra costs */

   365

   366

	/* Check for signals */

   367

	if (IsTileType(tile, MP_RAILWAY) && (_map5[tile] & 0xC0) == 0x40 && (_map3_lo[tile] & _signal_along_trackdir[trackdir]) != 0) {

   368

		/* Ordinary track with signals */

   369

		if ((_map2[tile] & _signal_along_trackdir[trackdir]) == 0) {

   370

			/* Signal facing us is red */

   371

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   372

				/* Penalize the first signal we

   373

				 * encounter, if it is red */

   374

				cost += _patches.npf_rail_firstred_penalty;

   375

			}

   376

			/* Record the state of this signal */

   377

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   378

		} else {

   379

			/* Record the state of this signal */

   380

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   381

		}

   382

		NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);

   383

	}

   384

   385

	/* Penalise the tile if it is a target tile and the last signal was

   386

	 * red */

   387

	if (as->EndNodeCheck(as, current)==AYSTAR_FOUND_END_NODE && NPFGetFlag(current, NPF_FLAG_LAST_SIGNAL_RED))

   388

		cost += _patches.npf_rail_lastred_penalty;

   389

   390

	/* Check for slope */

   391

	cost += NPFSlopeCost(current);

   392

   393

	/* Check for turns */

   394

	if (current->direction != parent->path.node.direction)

   395

		cost += _patches.npf_rail_curve_penalty;

   396

	//TODO, with realistic acceleration, also the amount of straight track between

   397

	//      curves should be taken into account, as this affects the speed limit.

   398

   399

	/* Check for occupied track */

   400

	//TODO

   401

   402

#ifdef NPF_MARKROUTE

   403

	NPFMarkTile(tile);

   404

#endif

   405

#ifdef NPF_DEBUG

   406

	debug("Calculating G for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), cost);

   407

#endif

   408

	return cost;

   409

}

   410

   411

/* Will find any depot */

   412

int32 NPFFindDepot(AyStar* as, AyStarNode *node) {

   413

	TileIndex tile = node->tile;

   414

	if (IsTileDepotType(tile, as->user_data[NPF_TYPE]))

   415

		return AYSTAR_FOUND_END_NODE;

   416

	else

   417

		return AYSTAR_DONE;

   418

}

   419

   420

/* Will find a station identified using the NPFFindStationOrTileData */

   421

int32 NPFFindStationOrTile(AyStar* as, AyStarNode *node) {

   422

	NPFFindStationOrTileData* fstd = (NPFFindStationOrTileData*)as->user_target;

   423

	TileIndex tile = node->tile;

   424

   425

	/* See if we checked this before */

   426

	if (NPFGetFlag(node, NPF_FLAG_TARGET_CHECKED))

   427

		return NPFGetFlag(node, NPF_FLAG_IS_TARGET);

   428

	/* We're gonna check this now and store the result, let's mark that */

   429

	NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, true);

   430

   431

	/* If GetNeighbours said we could get here, we assume the station type

   432

	 * is correct */

   433

	if (

   434

		(fstd->station_index == -1 && tile == fstd->dest_coords) || /* We've found the tile, or */

   435

		(IsTileType(tile, MP_STATION) && _map2[tile] == fstd->station_index) /* the station */

   436

	) {

   437

		NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, true);

   438

		return AYSTAR_FOUND_END_NODE;

   439

	} else {

   440

		NPFSetFlag(node, NPF_FLAG_TARGET_CHECKED, false);

   441

		return AYSTAR_DONE;

   442

	}

   443

}

   444

   445

/* To be called when current contains the (shortest route to) the target node.

   446

 * Will fill the contents of the NPFFoundTargetData using

   447

 * AyStarNode[NPF_TRACKDIR_CHOICE].

   448

 */

   449

void NPFSaveTargetData(AyStar* as, OpenListNode* current) {

   450

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   451

	ftd->best_trackdir = current->path.node.user_data[NPF_TRACKDIR_CHOICE];

   452

	ftd->best_path_dist = current->g;

   453

	ftd->best_bird_dist = 0;

   454

	ftd->node = current->path.node;

   455

}

   456

   457

/* Will just follow the results of GetTileTrackStatus concerning where we can

   458

 * go and where not. Uses AyStar.user_data[NPF_TYPE] as the transport type and

   459

 * an argument to GetTileTrackStatus. Will skip tunnels, meaning that the

   460

 * entry and exit are neighbours. Will fill

   461

 * AyStarNode.user_data[NPF_TRACKDIR_CHOICE] with an appropriate value, and

   462

 * copy AyStarNode.user_data[NPF_NODE_FLAGS] from the parent */

   463

void NPFFollowTrack(AyStar* aystar, OpenListNode* current) {

   464

	byte src_trackdir = current->path.node.direction;

   465

	TileIndex src_tile = current->path.node.tile;

   466

	byte src_exitdir = _trackdir_to_exitdir[src_trackdir];

   467

	FindLengthOfTunnelResult flotr;

   468

	TileIndex dst_tile;

   469

	int i = 0;

   470

	uint trackdirs, ts;

   471

	TransportType type = aystar->user_data[NPF_TYPE];

   472

	/* Initialize to 0, so we can jump out (return) somewhere an have no neighbours */

   473

	aystar->num_neighbours = 0;

   474

#ifdef NPF_DEBUG

   475

	debug("Expanding: (%d, %d, %d) [%d]", TileX(src_tile), TileY(src_tile), src_trackdir, src_tile);

   476

#endif

   477

   478

	/* Find dest tile */

   479

	if (IsTileType(src_tile, MP_TUNNELBRIDGE) && (_map5[src_tile] & 0xF0)==0 && (_map5[src_tile] & 3) == src_exitdir) {

   480

		/* This is a tunnel. We know this tunnel is our type,

   481

		 * otherwise we wouldn't have got here. It is also facing us,

   482

		 * so we should skip it's body */

   483

		flotr = FindLengthOfTunnel(src_tile, src_exitdir);

   484

		dst_tile = flotr.tile;

   485

	} else {

   486

		if (IsTileDepotType(src_tile, type)){

   487

			/* This is a road station or a train or road depot. We can enter and exit

   488

			 * those from one side only. Trackdirs don't support that (yet), so we'll

   489

			 * do this here. */

   490

   491

			byte exitdir;

   492

			/* Find out the exit direction first */

   493

			if (IsRoadStationTile(src_tile))

   494

				exitdir = GetRoadStationDir(src_tile);

   495

			else /* Train or road depot. Direction is stored the same for both, in map5 */

   496

				exitdir = _map5[src_tile] & 3; /* Extract the direction from the map */

   497

   498

			/* Let's see if were headed the right way */

   499

			if (src_trackdir != _dir_to_diag_trackdir[exitdir])

   500

				/* Not going out of the station/depot through the exit, but the back. No

   501

				 * neighbours then. */

   502

				return;

   503

		}

   504

		/* This a normal tile, a bridge, a tunnel exit, etc. */

   505

		dst_tile = AddTileIndexDiffCWrap(src_tile, TileIndexDiffCByDir(_trackdir_to_exitdir[src_trackdir]));

   506

		if (dst_tile == INVALID_TILE) {

   507

			/* We reached the border of the map */

   508

			/* TODO Nicer control flow for this */

   509

			return;

   510

		}

   511

	}

   512

   513

	// TODO: check correct rail type (mono, maglev, etc)