1

/* $Id$ */

     2

     3

/** @file yapf.h Entry point for OpenTTD to YAPF. */

     4

     5

#ifndef  YAPF_H

     6

#define  YAPF_H

     7

     8

#include "../debug.h"

     9

#include "../depot_type.h"

    10

#include "../direction_type.h"

    11

#include "../pbs.h"

    12

    13

/** Finds the best path for given ship.

    14

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

    15

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

    16

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

    17

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

    18

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

    19

 */

    20

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

    21

    22

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

    23

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

    24

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

    25

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

    26

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

    27

 */

    28

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

    29

    30

/** Finds the best path for given train.

    31

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

    32

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

    33

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

    34

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

    35

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

    36

 * @param reserve_track indicates whether YAPF should try to reserve the found path

    37

 * @param target   [out] the target tile of the reservation, free is set to true if path was reserved

    38

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

    39

 */

    40

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

    41

    42

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

    43

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

    44

 * @param tile   destination tile

    45

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

    46

 */

    47

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

    48

    49

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

    50

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

    51

 */

    52

Depot* YapfFindNearestRoadDepot(const Vehicle *v);

    53

    54

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

    55

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

    56

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

    57

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

    58

 *                  was reached and no depot was seen)

    59

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

    60

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

    61

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

    62

 * @return       the true if depot was found.

    63

 */

    64

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

    65

    66

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

    67

bool YapfCheckReverseTrain(const Vehicle* v);

    68

    80

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

    81

void YapfNotifyTrackLayoutChange(TileIndex tile, Track track);

    82

    83

/** performance measurement helpers */

    84

void* NpfBeginInterval();

    85

int NpfEndInterval(void *perf);

    86

    87

    88

extern int _aystar_stats_open_size;

    89

extern int _aystar_stats_closed_size;

    90

    91

    92

/** Base tile length units */

    93

enum {

    94

	YAPF_TILE_LENGTH = 100,

    95

	YAPF_TILE_CORNER_LENGTH = 71

    96

};

    97

    98

#endif /* YAPF_H */