1

#ifndef NPF_H

     2

#define NPF_H

     3

     4

#include "ttd.h"

     5

#include "aystar.h"

     6

#include "vehicle.h"

     7

     8

//mowing grass

     9

enum {

    10

	NPF_HASH_BITS = 12, /* The size of the hash used in pathfinding. Just changing this value should be sufficient to change the hash size. Should be an even value. */

    11

	/* Do no change below values */

    12

	NPF_HASH_SIZE = 1 << NPF_HASH_BITS,

    13

	NPF_HASH_HALFBITS = NPF_HASH_BITS / 2,

    14

	NPF_HASH_HALFMASK = (1 << NPF_HASH_HALFBITS) - 1

    15

};

    16

    17

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

    18

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

    19

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

    20

} NPFFindStationOrTileData;

    21

    22

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

    23

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

    24

	NPF_OWNER, /* Contains an Owner value */

    25

};

    26

    27

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

    28

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

    29

	NPF_NODE_FLAGS,

    30

};

    31

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

    32

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

    33

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

    34

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

    35

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

    36

														 that they have evaluated this node. When this

    37

														 flag is on, NPF_FLAG_IS_TARGET is on when the

    38

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

    39

														 never be used directly, only by the end node

    40

														 checking functions for caching of results. */

    41

	NPF_FLAG_IS_TARGET, /* See comment for NPF_FLAG_TARGET_CHECKED */

    42

} NPFNodeFlag;

    43

    44

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

    45

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

    46

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

    47

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

    48

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

    49

} NPFFoundTargetData;

    50

    51

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

    52

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

    62

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

    63

    64

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

    65

 * heuristic, such as railway/road */

    66

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

    67

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

    68

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

    69

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

    70

    71

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

    72

    73

    74

/*

    75

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

    76

 */

    77

    78

/**

    79

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

    80

 */

    81

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

    82

{

    83

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

    84

}

    85

    86

/**

    87

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

    88

 */

    89

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

    90

{

    91

	if (value)

    92

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

    93

	else

    94

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

    95

}

    96

    97

/*

    98

 * Some tables considering tracks, directions and signals.

    99

 * XXX: Better place to but these?

   100

 */

   101

   102

/**

   103

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

   104

 * direction along with the trackdir.

   105

 */

   106

const byte _signal_along_trackdir[14];

   107

   108

/**

   109

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

   110

 * direction against the trackdir.

   111

 */

   112

const byte _signal_against_trackdir[14];

   113

   114

/**

   115

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

   116

 * entering the next tile.

   117

 */

   118

const uint16 _trackdir_reaches_trackdirs[14];

   119

   120

/**

   121

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

   122

 */

   123

const uint16 _trackdir_crosses_trackdirs[14];

   124

   125

/**

   126

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

   127

 */

   128

const byte _track_crosses_tracks[6];

   129

   130

/**

   131

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

   132

 * that trackdir.

   133

 */

   134

const byte _trackdir_to_exitdir[14];

   135

   136

/**

   137

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

   138

 * with the exit in the given direction.

   139

 */

   140

const byte _track_exitdir_to_trackdir[6][4];

   141

   142

/**

   143

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

   144

 * the track running in the given direction.

   145

 */

   146

const byte _track_direction_to_trackdir[6][8];

   147

   148

/**

   149

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

   150

 * direction.

   151

 */

   152

const byte _dir_to_diag_trackdir[4];

   153

   154

/**

   155

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

   156

 */

   157

const byte _reverse_dir[4];

   158

   159

/**

   160

 * Maps a trackdir to the reverse trackdir.

   161

 */

   162

const byte _reverse_trackdir[14];

   163

   164

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

   165

   166

#endif // NPF_H