1

/* $Id$ */

     2

     3

/** @file yapf_road.cpp */

     4

     5

#include "../stdafx.h"

     6

     7

#include "yapf.hpp"

     8

#include "yapf_node_road.hpp"

     9

    10

    11

template <class Types>

    12

class CYapfCostRoadT

    13

{

    14

public:

    15

	typedef typename Types::Tpf Tpf; ///< pathfinder (derived from THIS class)

    16

	typedef typename Types::TrackFollower TrackFollower; ///< track follower helper

    17

	typedef typename Types::NodeList::Titem Node; ///< this will be our node type

    18

	typedef typename Node::Key Key;    ///< key to hash tables

    19

    20

protected:

    21

	/// to access inherited path finder

    22

	Tpf& Yapf() {return *static_cast<Tpf*>(this);}

    23

    24

	int SlopeCost(TileIndex tile, TileIndex next_tile, Trackdir trackdir)

    25

	{

    26

		// height of the center of the current tile

    27

		int x1 = TileX(tile) * TILE_SIZE;

    28

		int y1 = TileY(tile) * TILE_SIZE;

    29

		int z1 = GetSlopeZ(x1 + TILE_SIZE / 2, y1 + TILE_SIZE / 2);

    30

    31

		// height of the center of the next tile

    32

		int x2 = TileX(next_tile) * TILE_SIZE;

    33

		int y2 = TileY(next_tile) * TILE_SIZE;

    34

		int z2 = GetSlopeZ(x2 + TILE_SIZE / 2, y2 + TILE_SIZE / 2);

    35

    36

		if (z2 - z1 > 1) {

    37

			/* Slope up */

    38

			return Yapf().PfGetSettings().road_slope_penalty;

    39

		}

    40

		return 0;

    41

	}

    42

    43

	/** return one tile cost */

    44

	FORCEINLINE int OneTileCost(TileIndex tile, Trackdir trackdir)

    45

	{

    46

		int cost = 0;

    47

		// set base cost

    48

		if (IsDiagonalTrackdir(trackdir)) {

    49

			cost += YAPF_TILE_LENGTH;

    50

			switch (GetTileType(tile)) {

    51

				case MP_STREET:

    52

					/* Increase the cost for level crossings */

    53

					if (IsLevelCrossing(tile))

    54

						cost += Yapf().PfGetSettings().road_crossing_penalty;

    55

					break;

    56

				case MP_STATION:

    57

					if (IsDriveThroughStopTile(tile))

    58

						cost += Yapf().PfGetSettings().road_stop_penalty;

    59

					break;

    60

    61

				default:

    62

					break;

    63

			}

    64

		} else {

    65

			// non-diagonal trackdir

    66

			cost = YAPF_TILE_CORNER_LENGTH + Yapf().PfGetSettings().road_curve_penalty;

    67

		}

    68

		return cost;

    69

	}

    70

    71

public:

    72

	/** Called by YAPF to calculate the cost from the origin to the given node.

    73

	 *  Calculates only the cost of given node, adds it to the parent node cost

    74

	 *  and stores the result into Node::m_cost member */

    75

	FORCEINLINE bool PfCalcCost(Node& n, const TrackFollower &tf)

    76

	{

    77

		int segment_cost = 0;

    78

		// start at n.m_key.m_tile / n.m_key.m_td and walk to the end of segment

    79

		TileIndex tile = n.m_key.m_tile;

    80

		Trackdir trackdir = n.m_key.m_td;

    81

		while (true) {

    82

			// base tile cost depending on distance between edges

    83

			segment_cost += Yapf().OneTileCost(tile, trackdir);

    84

    85

			const Vehicle* v = Yapf().GetVehicle();

    86

			// we have reached the vehicle's destination - segment should end here to avoid target skipping

    87

			if (v->current_order.type == OT_GOTO_STATION && tile == v->dest_tile) break;

    88

    89

			// stop if we have just entered the depot

    90

			if (IsTileDepotType(tile, TRANSPORT_ROAD) && trackdir == DiagdirToDiagTrackdir(ReverseDiagDir(GetRoadDepotDirection(tile)))) {

    91

				// next time we will reverse and leave the depot

    92

				break;

    93

			}

    94

    95

			// if there are no reachable trackdirs on new tile, we have end of road

    96

			TrackFollower F(Yapf().GetVehicle());

    97

			if (!F.Follow(tile, trackdir)) break;

    98

    99

			// if there are more trackdirs available & reachable, we are at the end of segment

   100

			if (KillFirstBit2x64(F.m_new_td_bits) != 0) break;

   101

   102

			Trackdir new_td = (Trackdir)FindFirstBit2x64(F.m_new_td_bits);

   103

   104

			// stop if RV is on simple loop with no junctions

   105

			if (F.m_new_tile == n.m_key.m_tile && new_td == n.m_key.m_td) return false;

   106

   107

			// if we skipped some tunnel tiles, add their cost

   108

			segment_cost += F.m_tiles_skipped * YAPF_TILE_LENGTH;

   109

   110

			// add hilly terrain penalty

   111

			segment_cost += Yapf().SlopeCost(tile, F.m_new_tile, trackdir);

   112

   113

			// add min/max speed penalties

   114

			int min_speed = 0;

   115

			int max_speed = F.GetSpeedLimit(&min_speed);

   116

			if (max_speed < v->max_speed) segment_cost += 1 * (v->max_speed - max_speed);

   117

			if (min_speed > v->max_speed) segment_cost += 10 * (min_speed - v->max_speed);

   118

   119

			// move to the next tile

   120

			tile = F.m_new_tile;

   121

			trackdir = new_td;

   122

		};

   123

   124

		// save end of segment back to the node

   125

		n.m_segment_last_tile = tile;

   126

		n.m_segment_last_td = trackdir;

   127

   128

		// save also tile cost

   129

		int parent_cost = (n.m_parent != NULL) ? n.m_parent->m_cost : 0;

   130

		n.m_cost = parent_cost + segment_cost;

   131

		return true;

   132

	}

   133

};

   134

   135

   136

template <class Types>

   137

class CYapfDestinationAnyDepotRoadT

   138

{

   139

public:

   140

	typedef typename Types::Tpf Tpf;                     ///< the pathfinder class (derived from THIS class)

   141

	typedef typename Types::TrackFollower TrackFollower;

   142

	typedef typename Types::NodeList::Titem Node;        ///< this will be our node type

   143

	typedef typename Node::Key Key;                      ///< key to hash tables

   144

   145

	/// to access inherited path finder

   146

	Tpf& Yapf() {return *static_cast<Tpf*>(this);}

   147

   148

	/// Called by YAPF to detect if node ends in the desired destination

   149

	FORCEINLINE bool PfDetectDestination(Node& n)

   150

	{

   151

		bool bDest = IsTileDepotType(n.m_segment_last_tile, TRANSPORT_ROAD);

   152

		return bDest;

   153

	}

   154

   155

	/** Called by YAPF to calculate cost estimate. Calculates distance to the destination

   156

	 *  adds it to the actual cost from origin and stores the sum to the Node::m_estimate */

   157

	FORCEINLINE bool PfCalcEstimate(Node& n)

   158

	{

   159

		n.m_estimate = n.m_cost;

   160

		return true;

   161

	}

   162

};

   163

   164

   165

template <class Types>

   166

class CYapfDestinationTileRoadT

   167

{

   168

public:

   169

	typedef typename Types::Tpf Tpf;                     ///< the pathfinder class (derived from THIS class)

   170

	typedef typename Types::TrackFollower TrackFollower;

   171

	typedef typename Types::NodeList::Titem Node;        ///< this will be our node type

   172

	typedef typename Node::Key Key;                      ///< key to hash tables

   173

   174

protected:

   175

	TileIndex    m_destTile;

   176

	TrackdirBits m_destTrackdirs;

   177

   178

public:

   179

	void SetDestination(TileIndex tile, TrackdirBits trackdirs)

   180

	{

   181

		m_destTile = tile;

   182

		m_destTrackdirs = trackdirs;

   183

	}

   184

   185

protected:

   186

	/// to access inherited path finder

   187

	Tpf& Yapf() {return *static_cast<Tpf*>(this);}

   188

   189

public:

   190

	/// Called by YAPF to detect if node ends in the desired destination

   191

	FORCEINLINE bool PfDetectDestination(Node& n)

   192

	{

   193

		bool bDest = (n.m_segment_last_tile == m_destTile) && ((m_destTrackdirs & TrackdirToTrackdirBits(n.m_segment_last_td)) != TRACKDIR_BIT_NONE);

   194

		return bDest;

   195

	}

   196

   197

	/** Called by YAPF to calculate cost estimate. Calculates distance to the destination

   198

	 *  adds it to the actual cost from origin and stores the sum to the Node::m_estimate */

   199

	inline bool PfCalcEstimate(Node& n)

   200

	{

   201

		static int dg_dir_to_x_offs[] = {-1, 0, 1, 0};

   202

		static int dg_dir_to_y_offs[] = {0, 1, 0, -1};

   203

		if (PfDetectDestination(n)) {

   204

			n.m_estimate = n.m_cost;

   205

			return true;

   206

		}

   207

   208

		TileIndex tile = n.m_segment_last_tile;

   209

		DiagDirection exitdir = TrackdirToExitdir(n.m_segment_last_td);

   210

		int x1 = 2 * TileX(tile) + dg_dir_to_x_offs[(int)exitdir];

   211

		int y1 = 2 * TileY(tile) + dg_dir_to_y_offs[(int)exitdir];

   212

		int x2 = 2 * TileX(m_destTile);

   213

		int y2 = 2 * TileY(m_destTile);

   214

		int dx = abs(x1 - x2);

   215

		int dy = abs(y1 - y2);

   216

		int dmin = min(dx, dy);

   217

		int dxy = abs(dx - dy);

   218

		int d = dmin * YAPF_TILE_CORNER_LENGTH + (dxy - 1) * (YAPF_TILE_LENGTH / 2);

   219

		n.m_estimate = n.m_cost + d;

   220

		assert(n.m_estimate >= n.m_parent->m_estimate);

   221

		return true;

   222

	}

   223

};

   224

   225

   226

   227

template <class Types>

   228

class CYapfFollowRoadT

   229

{

   230

public:

   231

	typedef typename Types::Tpf Tpf;                     ///< the pathfinder class (derived from THIS class)

   232

	typedef typename Types::TrackFollower TrackFollower;

   233

	typedef typename Types::NodeList::Titem Node;        ///< this will be our node type

   234

	typedef typename Node::Key Key;                      ///< key to hash tables

   235

   236

protected:

   237

	/// to access inherited path finder

   238

	FORCEINLINE Tpf& Yapf() {return *static_cast<Tpf*>(this);}

   239

   240

public:

   241

   242

	/** Called by YAPF to move from the given node to the next tile. For each

   243

	 *  reachable trackdir on the new tile creates new node, initializes it

   244

	 *  and adds it to the open list by calling Yapf().AddNewNode(n) */

   245

	inline void PfFollowNode(Node& old_node)

   246

	{

   247

		TrackFollower F(Yapf().GetVehicle());

   248

		if (F.Follow(old_node.m_segment_last_tile, old_node.m_segment_last_td))

   249

			Yapf().AddMultipleNodes(&old_node, F);

   250

	}

   251

   252

	/// return debug report character to identify the transportation type

   253

	FORCEINLINE char TransportTypeChar() const {return 'r';}

   254

   255

	static Trackdir stChooseRoadTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir)

   256

	{

   257

		Tpf pf;

   258

		return pf.ChooseRoadTrack(v, tile, enterdir);

   259

	}

   260

   261

	FORCEINLINE Trackdir ChooseRoadTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir)

   262

	{

   263

		// handle special case - when next tile is destination tile

   264

		if (tile == v->dest_tile) {

   265

			// choose diagonal trackdir reachable from enterdir

   266

			return (Trackdir)DiagdirToDiagTrackdir(enterdir);

   267

		}

   268

		// our source tile will be the next vehicle tile (should be the given one)

   269

		TileIndex src_tile = tile;

   270

		// get available trackdirs on the start tile

   271

		uint ts = GetTileTrackStatus(tile, TRANSPORT_ROAD);

   272

		TrackdirBits src_trackdirs = (TrackdirBits)(ts & TRACKDIR_BIT_MASK);

   273

		// select reachable trackdirs only

   274

		src_trackdirs &= DiagdirReachesTrackdirs(enterdir);

   275

   276

		// get available trackdirs on the destination tile

   277

		TileIndex dest_tile = v->dest_tile;

   278

		uint dest_ts = GetTileTrackStatus(dest_tile, TRANSPORT_ROAD);

   279

		TrackdirBits dest_trackdirs = (TrackdirBits)(dest_ts & TRACKDIR_BIT_MASK);

   280

   281

		// set origin and destination nodes

   282

		Yapf().SetOrigin(src_tile, src_trackdirs);

   283

		Yapf().SetDestination(dest_tile, dest_trackdirs);

   284

   285

		// find the best path

   286

		Yapf().FindPath(v);

   287

   288

		// if path not found - return INVALID_TRACKDIR

   289

		Trackdir next_trackdir = INVALID_TRACKDIR;

   290

		Node* pNode = &Yapf().GetBestNode();

   291

		if (pNode != NULL) {

   292

			// path was found or at least suggested

   293

			// walk through the path back to its origin

   294

			while (pNode->m_parent != NULL) {

   295

				pNode = pNode->m_parent;

   296

			}

   297

			// return trackdir from the best origin node (one of start nodes)

   298

			Node& best_next_node = *pNode;

   299

			assert(best_next_node.GetTile() == tile);

   300

			next_trackdir = best_next_node.GetTrackdir();

   301

		}

   302

		return next_trackdir;

   303

	}

   304

   305

	static uint stDistanceToTile(const Vehicle *v, TileIndex tile)

   306

	{

   307

		Tpf pf;

   308

		return pf.DistanceToTile(v, tile);

   309

	}

   310

   311

	FORCEINLINE uint DistanceToTile(const Vehicle *v, TileIndex dst_tile)

   312

	{

   313

		// handle special case - when current tile is the destination tile

   314

		if (dst_tile == v->tile) {

   315

			// distance is zero in this case

   316

			return 0;

   317

		}

   318

   319

		if (!SetOriginFromVehiclePos(v)) return UINT_MAX;

   320

   321

		// set destination tile, trackdir

   322

		//   get available trackdirs on the destination tile

   323

		uint dest_ts = GetTileTrackStatus(dst_tile, TRANSPORT_ROAD);

   324

		TrackdirBits dst_td_bits = (TrackdirBits)(dest_ts & TRACKDIR_BIT_MASK);

   325

		Yapf().SetDestination(dst_tile, dst_td_bits);

   326

   327

		// find the best path

   328

		Yapf().FindPath(v);

   329

   330

		// if path not found - return distance = UINT_MAX

   331

		uint dist = UINT_MAX;

   332

		Node* pNode = &Yapf().GetBestNode();

   333

		if (pNode != NULL) {

   334

			// path was found or at least suggested

   335

			// get the path cost estimate

   336

			dist = pNode->GetCostEstimate();

   337

		}

   338

   339

		return dist;

   340

	}

   341

   342

	/** Return true if the valid origin (tile/trackdir) was set from the current vehicle position. */

   343

	FORCEINLINE bool SetOriginFromVehiclePos(const Vehicle *v)

   344

	{

   345

		// set origin (tile, trackdir)

   346

		TileIndex src_tile = v->tile;

   347

		Trackdir src_td = GetVehicleTrackdir(v);

   348

		if ((GetTileTrackStatus(src_tile, TRANSPORT_ROAD) & TrackdirToTrackdirBits(src_td)) == 0) {

   349

			// sometimes the roadveh is not on the road (it resides on non-existing track)

   350

			// how should we handle that situation?

   351

			return false;

   352

		}

   353

		Yapf().SetOrigin(src_tile, TrackdirToTrackdirBits(src_td));

   354

		return true;

   355

	}

   356

   357

	static Depot* stFindNearestDepot(const Vehicle* v, TileIndex tile, Trackdir td)

   358

	{

   359

		Tpf pf;

   360

		return pf.FindNearestDepot(v, tile, td);

   361

	}

   362

   363

	FORCEINLINE Depot* FindNearestDepot(const Vehicle* v, TileIndex tile, Trackdir td)

   364

	{

   365

		// set origin and destination nodes

   366

		Yapf().SetOrigin(tile, TrackdirToTrackdirBits(td));

   367

   368

		// find the best path

   369

		bool bFound = Yapf().FindPath(v);

   370

		if (!bFound) return false;

   371

   372

		// some path found

   373

		// get found depot tile

   374

		Node& n = Yapf().GetBestNode();

   375

		TileIndex depot_tile = n.m_segment_last_tile;

   376

		assert(IsTileDepotType(depot_tile, TRANSPORT_ROAD));

   377

		Depot* ret = GetDepotByTile(depot_tile);

   378

		return ret;

   379

	}

   380

};

   381

   382

template <class Tpf_, class Tnode_list, template <class Types> class Tdestination>

   383

struct CYapfRoad_TypesT

   384

{

   385

	typedef CYapfRoad_TypesT<Tpf_, Tnode_list, Tdestination>  Types;

   386

   387

	typedef Tpf_                              Tpf;

   388

	typedef CFollowTrackRoad                  TrackFollower;

   389

	typedef Tnode_list                        NodeList;

   390

	typedef CYapfBaseT<Types>                 PfBase;

   391

	typedef CYapfFollowRoadT<Types>           PfFollow;

   392

	typedef CYapfOriginTileT<Types>           PfOrigin;

   393

	typedef Tdestination<Types>               PfDestination;

   394

	typedef CYapfSegmentCostCacheNoneT<Types> PfCache;

   395

	typedef CYapfCostRoadT<Types>             PfCost;

   396

};

   397

   398

struct CYapfRoad1         : CYapfT<CYapfRoad_TypesT<CYapfRoad1        , CRoadNodeListTrackDir, CYapfDestinationTileRoadT    > > {};

   399

struct CYapfRoad2         : CYapfT<CYapfRoad_TypesT<CYapfRoad2        , CRoadNodeListExitDir , CYapfDestinationTileRoadT    > > {};

   400

   401

struct CYapfRoadAnyDepot1 : CYapfT<CYapfRoad_TypesT<CYapfRoadAnyDepot1, CRoadNodeListTrackDir, CYapfDestinationAnyDepotRoadT> > {};

   402

struct CYapfRoadAnyDepot2 : CYapfT<CYapfRoad_TypesT<CYapfRoadAnyDepot2, CRoadNodeListExitDir , CYapfDestinationAnyDepotRoadT> > {};

   403

   404

   405

Trackdir YapfChooseRoadTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir)

   406

{

   407

	// default is YAPF type 2

   408

	typedef Trackdir (*PfnChooseRoadTrack)(Vehicle*, TileIndex, DiagDirection);

   409

	PfnChooseRoadTrack pfnChooseRoadTrack = &CYapfRoad2::stChooseRoadTrack; // default: ExitDir, allow 90-deg

   410

   411

	// check if non-default YAPF type should be used

   412

	if (_patches.yapf.disable_node_optimization)

   413

		pfnChooseRoadTrack = &CYapfRoad1::stChooseRoadTrack; // Trackdir, allow 90-deg

   414

   415

	Trackdir td_ret = pfnChooseRoadTrack(v, tile, enterdir);

   416

	return td_ret;

   417

}

   418

   419

uint YapfRoadVehDistanceToTile(const Vehicle* v, TileIndex tile)

   420

{

   421

	// default is YAPF type 2

   422

	typedef uint (*PfnDistanceToTile)(const Vehicle*, TileIndex);

   423

	PfnDistanceToTile pfnDistanceToTile = &CYapfRoad2::stDistanceToTile; // default: ExitDir, allow 90-deg

   424

   425

	// check if non-default YAPF type should be used

   426

	if (_patches.yapf.disable_node_optimization)

   427

		pfnDistanceToTile = &CYapfRoad1::stDistanceToTile; // Trackdir, allow 90-deg

   428

   429

	// measure distance in YAPF units

   430

	uint dist = pfnDistanceToTile(v, tile);

   431

	// convert distance to tiles

   432

	if (dist != UINT_MAX)

   433

		dist = (dist + YAPF_TILE_LENGTH - 1) / YAPF_TILE_LENGTH;

   434

	return dist;

   435

}

   436

   437

Depot* YapfFindNearestRoadDepot(const Vehicle *v)

   438

{

   439

	TileIndex tile = v->tile;

   440

	Trackdir trackdir = GetVehicleTrackdir(v);

   441

	if ((GetTileTrackStatus(tile, TRANSPORT_ROAD) & TrackdirToTrackdirBits(trackdir)) == 0)

   442

		return NULL;

   443

   444

	// handle the case when our vehicle is already in the depot tile

   445

	if (IsTileType(tile, MP_STREET) && IsTileDepotType(tile, TRANSPORT_ROAD)) {

   446

		// only what we need to return is the Depot*

   447

		return GetDepotByTile(tile);

   448

	}

   449

   450

	// default is YAPF type 2

   451

	typedef Depot* (*PfnFindNearestDepot)(const Vehicle*, TileIndex, Trackdir);

   452

	PfnFindNearestDepot pfnFindNearestDepot = &CYapfRoadAnyDepot2::stFindNearestDepot;

   453

   454

	// check if non-default YAPF type should be used

   455

	if (_patches.yapf.disable_node_optimization)

   456

		pfnFindNearestDepot = &CYapfRoadAnyDepot1::stFindNearestDepot; // Trackdir, allow 90-deg

   457

   458

	Depot* ret = pfnFindNearestDepot(v, tile, trackdir);

   459

	return ret;

   460

}