1

#ifndef NPF_H

     2

#define NPF_H

     3

     4

#include "ttd.h"

     5

#include "aystar.h"

     6

#include "vehicle.h"

     7

     8

//#define NPF_DEBUG

     9

//#define NPF_MARKROUTE //Mark the routes considered by the pathfinder by

    10

//mowing grass

    11

    12

typedef struct NPFFindStationOrTileData { /* Meant to be stored in AyStar.targetdata */

    13

	TileIndex dest_coords; /* An indication of where the station is, for heuristic purposes, or the target tile */

    14

	int station_index; /* station index we're heading for, or -1 when we're heading for a tile */

    15

} NPFFindStationOrTileData;

    16

    17

enum { /* Indices into AyStar.userdata[] */

    18

	NPF_TYPE = 0, /* Contains a TransportTypes value */

    19

	NPF_OWNER, /* Contains an Owner value */

    20

};

    21

    22

enum { /* Indices into AyStarNode.userdata[] */

    23

	NPF_TRACKDIR_CHOICE = 0, /* The trackdir chosen to get here */

    24

	NPF_NODE_FLAGS,

    25

};

    26

typedef enum { /* Flags for AyStarNode.userdata[NPF_NODE_FLAGS]. Use NPFGetBit() and NPFGetBit() to use them. */

    27

	NPF_FLAG_SEEN_SIGNAL, /* Used to mark that a signal was seen on the way, for rail only */

    28

	NPF_FLAG_REVERSE, /* Used to mark that this node was reached from the second start node, if applicable */

    29

	NPF_FLAG_LAST_SIGNAL_RED, /* Used to mark that the last signal on this path was red */

    30

	NPF_FLAG_TARGET_CHECKED, /* Used by end node checking function of npf to mark

    31

														 that they have evaluated this node. When this

    32

														 flag is on, NPF_FLAG_IS_TARGET is on when the

    33

														 node is a target, and off when it is not. Should

    34

														 never be used directly, only by the end node

    35

														 checking functions for caching of results. */

    36

	NPF_FLAG_IS_TARGET, /* See comment for NPF_FLAG_TARGET_CHECKED */

    37

} NPFNodeFlag;

    38

    39

typedef struct NPFFoundTargetData { /* Meant to be stored in AyStar.userpath */

    40

	uint best_bird_dist; /* The best heuristic found. Is 0 if the target was found */

    41

	uint best_path_dist; /* The shortest path. Is (uint)-1 if no path is found */

    42

	byte best_trackdir; /* The trackdir that leads to the shortest path/closest birds dist */

    43

	AyStarNode node; /* The node within the target the search led us to */

    44

} NPFFoundTargetData;

    45

    46

/* These functions below are _not_ re-entrant, in favor of speed! */

    47

    48

/* Will search from the given tile and direction, for a route to the given

    49

 * station for the given transport type. See the declaration of

    50

 * NPFFoundTargetData above for the meaning of the result. */

    51

NPFFoundTargetData NPFRouteToStationOrTile(TileIndex tile, byte trackdir, NPFFindStationOrTileData* target, TransportType type, Owner owner);

    52

/* Will search as above, but with two start nodes, the second being the

    53

 * reverse. Look at the NPF_FLAG_REVERSE flag in the result node to see which

    54

 * direction was taken (NPFGetBit(result.node, NPF_FLAG_REVERSE)) */

    55

NPFFoundTargetData NPFRouteToStationOrTileTwoWay(TileIndex tile1, byte trackdir1, TileIndex tile2, byte trackdir2, NPFFindStationOrTileData* target, TransportType type, Owner owner);

    56

    57

/* Will search a route to the closest depot. */

    58

    59

/* Search using breadth first. Good for little track choice and inaccurate

    60

 * heuristic, such as railway/road */

    61

NPFFoundTargetData NPFRouteToDepotBreadthFirst(TileIndex tile, byte trackdir, TransportType type, Owner owner);

    62

/* Search by trying each depot in order of Manhattan Distance. Good for lots

    63

 * of choices and accurate heuristics, such as water. */

    64

NPFFoundTargetData NPFRouteToDepotTrialError(TileIndex tile, byte trackdir, TransportType type, Owner owner);

    65

    66

void NPFFillWithOrderData(NPFFindStationOrTileData* fstd, Vehicle* v);

    67

    68

    69

/*

    70

 * Functions to manipulate the various NPF related flags on an AyStarNode.

    71

 */

    72

    73

/**

    74

 * Returns the current value of the given flag on the given AyStarNode.

    75

 */

    76

static inline bool NPFGetFlag(const AyStarNode* node, NPFNodeFlag flag)

    77

{

    78

	return HASBIT(node->user_data[NPF_NODE_FLAGS], flag);

    79

}

    80

    81

/**

    82

 * Sets the given flag on the given AyStarNode to the given value.

    83

 */

    84

static inline void NPFSetFlag(AyStarNode* node, NPFNodeFlag flag, bool value)

    85

{

    86

	if (value)

    87

		SETBIT(node->user_data[NPF_NODE_FLAGS], flag);

    88

	else

    89

		CLRBIT(node->user_data[NPF_NODE_FLAGS], flag);

    90

}

    91

    92

/*

    93

 * Some tables considering tracks, directions and signals.

    94

 * XXX: Better place to but these?

    95

 */

    96

    97

/**

    98

 * Maps a trackdir to the bit that stores its status in the map arrays, in the

    99

 * direction along with the trackdir.

   100

 */

   101

const byte _signal_along_trackdir[14];

   102

   103

/**

   104

 * Maps a trackdir to the bit that stores its status in the map arrays, in the

   105

 * direction against the trackdir.

   106

 */

   107

const byte _signal_against_trackdir[14];

   108

   109

/**

   110

 * Maps a trackdir to the trackdirs that can be reached from it (ie, when

   111

 * entering the next tile.

   112

 */

   113

const uint16 _trackdir_reaches_trackdirs[14];

   114

   115

/**

   116

 * Maps a trackdir to all trackdirs that make 90 deg turns with it.

   117

 */

   118

const uint16 _trackdir_crosses_trackdirs[14];

   119

   120

/**

   121

 * Maps a track to all tracks that make 90 deg turns with it.

   122

 */

   123

const byte _track_crosses_tracks[6];

   124

   125

/**

   126

 * Maps a trackdir to the (4-way) direction the tile is exited when following

   127

 * that trackdir.

   128

 */

   129

const byte _trackdir_to_exitdir[14];

   130

   131

/**

   132

 * Maps a track and an (4-way) dir to the trackdir that represents the track

   133

 * with the exit in the given direction.

   134

 */

   135

const byte _track_exitdir_to_trackdir[6][4];

   136

   137

/**

   138

 * Maps a track and a full (8-way) direction to the trackdir that represents

   139

 * the track running in the given direction.

   140

 */

   141

const byte _track_direction_to_trackdir[6][8];

   142

   143

/**

   144

 * Maps a (4-way) direction to the diagonal track that runs in that

   145

 * direction.

   146

 */

   147

const byte _dir_to_diag_trackdir[4];

   148

   149

/**

   150

 * Maps a (4-way) direction to the reverse.

   151

 */

   152

const byte _reverse_dir[4];

   153

   154

/**

   155

 * Maps a trackdir to the reverse trackdir.

   156

 */

   157

const byte _reverse_trackdir[14];

   158

   159

#define REVERSE_TRACKDIR(trackdir) (trackdir ^ 0x8)

   160

   161

#endif // NPF_H