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

enum {

    18

	/** This penalty is the equivalent of "inifite", which means that paths that

    19

	 * get this penalty will be chosen, but only if there is no other route

    20

	 * without it. Be careful with not applying this penalty to often, or the

    21

	 * total path cost might overflow..

    22

	 * For now, this is just a Very Big Penalty, we might actually implement

    23

	 * this in a nicer way :-)

    24

	 */

    25

	NPF_INFINITE_PENALTY = 1000 * NPF_TILE_LENGTH

    26

};

    27

    28

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

    29

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

    30

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

    31

} NPFFindStationOrTileData;

    32

    33

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

    34

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

    35

	NPF_OWNER, /* Contains an Owner value */

    36

};

    37

    38

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

    39

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

    40

	NPF_NODE_FLAGS,

    41

};

    42

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

    43

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

    44

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

    45

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

    46

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

    47

														 that they have evaluated this node. When this

    48

														 flag is on, NPF_FLAG_IS_TARGET is on when the

    49

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

    50

														 never be used directly, only by the end node

    51

														 checking functions for caching of results. */

    52

	NPF_FLAG_IS_TARGET, /* See comment for NPF_FLAG_TARGET_CHECKED */

    53

} NPFNodeFlag;

    54

    55

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

    56

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

    57

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

    58

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

    59

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

    60

} NPFFoundTargetData;

    61

    62

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

    63

    64

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

    65

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

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

    73

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

    74

    75

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

    76

 * heuristic, such as railway/road.*/

    77

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

    78

/* Same as above but with two start nodes, the second being the reverse. Call

    79

 * NPFGetBit(result.node, NPF_FLAG_REVERSE) to see from which node the path

    80

 * orginated. All pathfs from the second node will have the given

    81

 * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full

    82

 * tile).

    83

 */

    84

NPFFoundTargetData NPFRouteToDepotBreadthFirstTwoWay(TileIndex tile1, byte trackdir1, TileIndex tile2, byte trackdir2, TransportType type, Owner owner, uint reverse_penalty);

    85

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

    86

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

    87

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

    88

    89

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

    90

    91

    92

/*

    93

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

    94

 */

    95

    96

/**

    97

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

    98

 */

    99

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

   100

{

   101

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

   102

}

   103

   104

/**

   105

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

   106

 */

   107

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

   108

{

   109

	if (value)

   110

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

   111

	else

   112

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

   113

}

   114

   115

/*

   116

 * Some tables considering tracks, directions and signals.

   117

 * XXX: Better place to but these?

   118

 */

   119

   120

/**

   121

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

   122

 * direction along with the trackdir.

   123

 */

   124

const byte _signal_along_trackdir[14];

   125

   126

/**

   127

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

   128

 * direction against the trackdir.

   129

 */

   130

const byte _signal_against_trackdir[14];

   131

   132

/**

   133

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

   134

 * entering the next tile.

   135

 */

   136

const uint16 _trackdir_reaches_trackdirs[14];

   137

   138

/**

   139

 * Maps a trackdir to the trackdir that you will end up on if you go straight

   140

 * ahead. This will be the same trackdir for diagonal trackdirs, but a

   141

 * different (alternating) one for straight trackdirs */

   142

const uint16 _next_trackdir[14];

   143

/**

   144

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

   145

 */

   146

const uint16 _trackdir_crosses_trackdirs[14];

   147

   148

/**

   149

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

   150

 */

   151

const byte _track_crosses_tracks[6];

   152

   153

/**

   154

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

   155

 * that trackdir.

   156

 */

   157

const byte _trackdir_to_exitdir[14];

   158

   159

/**

   160

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

   161

 * with the exit in the given direction.

   162

 */

   163

const byte _track_exitdir_to_trackdir[6][4];

   164

   165

/**

   166

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

   167

 * the track running in the given direction.

   168

 */

   169

const byte _track_direction_to_trackdir[6][8];

   170

   171

/**

   172

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

   173

 * direction.

   174

 */

   175

const byte _dir_to_diag_trackdir[4];

   176

   177

/**

   178

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

   179

 */

   180

const byte _reverse_dir[4];

   181

   182

/**

   183

 * Maps a trackdir to the reverse trackdir.

   184

 */

   185

const byte _reverse_trackdir[14];

   186

   187

/* Returns the Track that a given Trackdir represents */

   188

static inline byte TrackdirToTrack(byte trackdir) { return trackdir & 0x7; }

   189

   190

/* Returns a Trackdir for the given Track. Since every Track corresponds to

   191

 * two Trackdirs, we choose the one which points between N and SE.

   192

 * Note that the actual implementation is quite futile, but this might change

   193

 * in the future.

   194

 */

   195

static inline byte TrackToTrackdir(byte track) { return track; }

   196

   197

/* Checks if a given Track is diagonal */

   198

static inline bool IsDiagonalTrack(byte track) { return track == 0x0 || track == 0x1; }

   199

   200

/* Checks if a given Trackdir is diagonal. */

   201

static inline bool IsDiagonalTrackdir(byte trackdir) { return IsDiagonalTrack(TrackdirToTrack(trackdir)); }

   202

   203

   204

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

   205

   206

#endif // NPF_H