1

/* $Id$ */

     2

     3

/** @file yapf.h */

     4

     5

#ifndef  YAPF_H

     6

#define  YAPF_H

     7

     8

#include "../debug.h"

    10

    11

/** Finds the best path for given ship.

    12

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

    13

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

    14

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

    15

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

    16

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

    17

 */

    18

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

    19

    20

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

    21

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

    22

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

    23

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

    24

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

    25

 */

    26

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

    27

    28

/** Finds the best path for given train.

    29

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

    30

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

    31

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

    32

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

    33

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

    34

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

    35

 */

    36

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

    37

    38

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

    39

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

    40

 * @param tile   destination tile

    41

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

    42

 */

    43

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

    44

    45

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

    46

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

    47

 */

    48

Depot* YapfFindNearestRoadDepot(const Vehicle *v);

    49

    50

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

    51

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

    52

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

    53

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

    54

 *                  was reached and no depot was seen)

    55

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

    56

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

    57

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

    58

 * @return       the true if depot was found.

    59

 */

    60

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

    61

    62

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

    63

bool YapfCheckReverseTrain(Vehicle* v);

    64

    65

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

    66

void YapfNotifyTrackLayoutChange(TileIndex tile, Track track);

    67

    68

/** performance measurement helpers */

    69

void* NpfBeginInterval();

    70

int NpfEndInterval(void* perf);

    71

    72

    73

extern int _aystar_stats_open_size;

    74

extern int _aystar_stats_closed_size;

    75

    76

    77

/** Base tile length units */

    78

enum {

    79

	YAPF_TILE_LENGTH = 100,

    80

	YAPF_TILE_CORNER_LENGTH = 71

    81

};

    82

    83

#endif /* YAPF_H */