1

/* $Id$ */

     2

     3

/** @file yapf.h */

     4

     5

#ifndef  YAPF_H

     6

#define  YAPF_H

     7

     8

#include "../debug.h"

     9

    10

/** Finds the best path for given ship.

    11

 * @param v        the ship that needs to find a path

    12

 * @param tile     the tile to find the path from (should be next tile the ship is about to enter)

    13

 * @param enterdir diagonal direction which the ship will enter this new tile from

    14

 * @param tracks   available tracks on the new tile (to choose from)

    15

 * @return         the best trackdir for next turn or INVALID_TRACKDIR if the path could not be found

    16

 */

    17

Trackdir YapfChooseShipTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks);

    18

    19

/** Finds the best path for given road vehicle.

    20

 * @param v        the RV that needs to find a path

    21

 * @param tile     the tile to find the path from (should be next tile the RV is about to enter)

    22

 * @param enterdir diagonal direction which the RV will enter this new tile from

    23

 * @return         the best trackdir for next turn or INVALID_TRACKDIR if the path could not be found

    24

 */

    25

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

    26

    27

/** Finds the best path for given train.

    28

 * @param v        the train that needs to find a path

    29

 * @param tile     the tile to find the path from (should be next tile the train is about to enter)

    30

 * @param enterdir diagonal direction which the RV will enter this new tile from

    31

 * @param tracks   available trackdirs on the new tile (to choose from)

    32

 * @param path_not_found [out] true is returned if no path can be found (returned Trackdir is only a 'guess')

    33

 * @return         the best trackdir for next turn or INVALID_TRACKDIR if the path could not be found

    34

 */

    35

Trackdir YapfChooseRailTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool *path_not_found);

    36

    37

/** Used by RV multistop feature to find the nearest road stop that has a free slot.

    38

 * @param v      RV (its current tile will be the origin)

    39

 * @param tile   destination tile

    40

 * @return       distance from origin tile to the destination (number of road tiles) or UINT_MAX if path not found

    41

 */

    42

uint YapfRoadVehDistanceToTile(const Vehicle* v, TileIndex tile);

    43

    44

/** Used when user sends RV to the nearest depot or if RV needs servicing.

    45

 * Returns the nearest depot (or NULL if depot was not found).

    46

 */

    47

Depot* YapfFindNearestRoadDepot(const Vehicle *v);

    48

    49

/** Used when user sends train to the nearest depot or if train needs servicing.

    50

 * @param v            train that needs to go to some depot

    51

 * @param max_distance max distance (number of track tiles) from the current train position

    52

 *                  (used also as optimization - the pathfinder can stop path finding if max_distance

    53

 *                  was reached and no depot was seen)

    54

 * @param reverse_penalty penalty that should be added for the path that requires reversing the train first

    55

 * @param depot_tile   receives the depot tile if depot was found

    56

 * @param reversed     receives true if train needs to reversed first

    57

 * @return       the true if depot was found.

    58

 */

    59

bool YapfFindNearestRailDepotTwoWay(Vehicle *v, int max_distance, int reverse_penalty, TileIndex* depot_tile, bool* reversed);

    60

    61

/** Returns true if it is better to reverse the train before leaving station */

    62

bool YapfCheckReverseTrain(Vehicle* v);

    63

    64

/** Use this function to notify YAPF that track layout (or signal configuration) has change */

    65

void YapfNotifyTrackLayoutChange(TileIndex tile, Track track);

    66

    67

/** performance measurement helpers */

    68

void* NpfBeginInterval();

    69

int NpfEndInterval(void* perf);

    70

    71

    72

extern int _aystar_stats_open_size;

    73

extern int _aystar_stats_closed_size;

    74

    75

    76

/** Track followers. They should help whenever any new code will need to walk through

    77

 * tracks, road or water tiles (pathfinders, signal controllers, vehicle controllers).

    78

 * It is an attempt to introduce API that should simplify tasks listed above.

    79

 * If you will need to use it:

    80

 *   1. allocate/declare FollowTrack_t structure;

    81

 *   2. call FollowTrackInit() and provide vehicle (if relevant)

    82

 *   3. call one of 6 FollowTrackXxxx() APIs below

    83

 *   4. check return value (if true then continue else stop)

    84

 *   5. look at FollowTrack_t structure for the result

    85

 *   6. optionally repeat steps 3..5

    86

 *   7. in case of troubles contact KUDr

    87

 */

    88

    89

/** Base struct for track followers. */

    90

struct FollowTrack_t

    91

{

    92

	enum ErrorCode {

    93

		EC_NONE,

    94

		EC_OWNER,

    95

		EC_RAIL_TYPE,

    96

		EC_90DEG,

    97

		EC_NO_WAY,

    98

	};

    99

   100

	const Vehicle*      m_veh;           ///< moving vehicle

   101

	TileIndex           m_old_tile;      ///< the origin (vehicle moved from) before move

   102

	Trackdir            m_old_td;        ///< the trackdir (the vehicle was on) before move

   103

	TileIndex           m_new_tile;      ///< the new tile (the vehicle has entered)

   104

	TrackdirBits        m_new_td_bits;   ///< the new set of available trackdirs

   105

	DiagDirection       m_exitdir;       ///< exit direction (leaving the old tile)

   106

	bool                m_is_tunnel;     ///< last turn passed tunnel

   107

	bool                m_is_bridge;     ///< last turn passed bridge ramp

   108

	bool                m_is_station;    ///< last turn passed station

   109

	int                 m_tiles_skipped; ///< number of skipped tunnel or station tiles

   110

	ErrorCode           m_err;

   111

};

   112

   113

/** Initializes FollowTrack_t structure */

   114

void FollowTrackInit(FollowTrack_t *This, const Vehicle* v);

   115

   116

/** Main track follower routines */

   117

bool FollowTrackWater    (FollowTrack_t *This, TileIndex old_tile, Trackdir old_td);

   118

bool FollowTrackRoad     (FollowTrack_t *This, TileIndex old_tile, Trackdir old_td);

   119

bool FollowTrackRail     (FollowTrack_t *This, TileIndex old_tile, Trackdir old_td);

   120

bool FollowTrackWaterNo90(FollowTrack_t *This, TileIndex old_tile, Trackdir old_td);

   121

bool FollowTrackRoadNo90 (FollowTrack_t *This, TileIndex old_tile, Trackdir old_td);

   122

bool FollowTrackRailNo90 (FollowTrack_t *This, TileIndex old_tile, Trackdir old_td);

   123

   124

/** Base tile length units */

   125

enum {

   126

	YAPF_TILE_LENGTH = 100,

   127

	YAPF_TILE_CORNER_LENGTH = 71

   128

};

   129

   130

#endif /* YAPF_H */