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

/** Base tile length units */

    77

enum {

    78

	YAPF_TILE_LENGTH = 100,

    79

	YAPF_TILE_CORNER_LENGTH = 71

    80

};

    81

    82

#endif /* YAPF_H */