1

/* $Id$ */

     2

     3

#ifndef  YAPF_H

     4

#define  YAPF_H

     5

     6

#include "../debug.h"

     7

     8

/** Finds the best path for given ship.

     9

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

    10

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

    11

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

    12

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

    13

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

    14

 */

    15

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

    16

    17

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

    18

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

    19

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

    20

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

    21

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

    22

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

    23

 */

    24

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

    25

    26

/** Finds the best path for given train.

    27

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

    28

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

    29

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

    30

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

    31

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

    32

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

    33

 */

    34

Trackdir YapfChooseRailTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir, TrackdirBits trackdirs, bool *path_not_found);

    35

    36

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

    37

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

    38

 * @param tile   destination tile

    39

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

    40

 */

    41

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

    42

    43

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

    44

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

    45

 */

    46

Depot* YapfFindNearestRoadDepot(const Vehicle *v);

    47

    48

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

    49

 * @v            train that needs to go to some depot

    50

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

    51

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

    52

 *                  was reached and no depot was seen)

    53

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

    54

 * @depot_tile   receives the depot tile if depot was found

    55

 * @reversed     receives true if train needs to reversed first

    56

 * @return       the true if depot was found.

    57

 */

    58

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

    59

    60

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

    61

bool YapfCheckReverseTrain(Vehicle* v);

    62

    63

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

    64

void YapfNotifyTrackLayoutChange(TileIndex tile, Track track);

    65

    66

/** performance measurement helpers */

    67

void* NpfBeginInterval(void);

    68

int NpfEndInterval(void* perf);

    69

    70

    71

extern int _aystar_stats_open_size;

    72

extern int _aystar_stats_closed_size;

    73

    74

    75

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

    76

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

    77

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

    78

 * If you will need to use it:

    79

 *   1. allocate/declare FollowTrack_t structure;

    80

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

    81

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

    82

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

    83

 *   5. look at FollowTrack_t structure for the result

    84

 *   6. optionally repeat steps 3..5

    85

 *   7. in case of troubles contact KUDr

    86

 */

    87

    88

/** Base struct for track followers. */

    89

typedef struct FollowTrack_t

    90

{

    91

	const Vehicle*      m_veh;           ///< moving vehicle

    92

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

    93

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

    94

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

    95

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

    96

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

    97

	bool                m_is_tunnel;     ///< last turn passed tunnel

    98

	bool                m_is_station;    ///< last turn passed station

    99

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

   100

} FollowTrack_t;

   101

   102

/** Initializes FollowTrack_t structure */

   103

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

   104

   105

/** Main track follower routines */

   106

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

   107

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

   108

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

   109

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

   110

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

   111

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

   112

   113

/** Base tile length units */

   114

enum {

   115

	YAPF_TILE_LENGTH = 100,

   116

	YAPF_TILE_CORNER_LENGTH = 71

   117

};

   118

   119

#endif /* YAPF_H */