1

/* $Id$ */

     2

     3

/** @file npf.h */

     4

     5

#ifndef NPF_H

     6

#define NPF_H

     7

     8

#include "aystar.h"

     9

#include "station_type.h"

    10

#include "rail_type.h"

    11

#include "player_type.h"

    12

#include "vehicle_type.h"

    13

#include "tile_type.h"

    14

#include "track_type.h"

    15

#include "core/bitmath_func.hpp"

    16

    17

/* mowing grass */

    18

enum {

    19

	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.

    20

	/* Do no change below values */

    21

	NPF_HASH_SIZE = 1 << NPF_HASH_BITS,

    22

	NPF_HASH_HALFBITS = NPF_HASH_BITS / 2,

    23

	NPF_HASH_HALFMASK = (1 << NPF_HASH_HALFBITS) - 1

    24

};

    25

    26

/* For new pathfinding. Define here so it is globally available without having

    27

 * to include npf.h */

    28

enum {

    29

	NPF_TILE_LENGTH = 100

    30

};

    31

    32

enum {

    33

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

    34

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

    35

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

    36

	 * total path cost might overflow..

    37

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

    38

	 * this in a nicer way :-)

    39

	 */

    40

	NPF_INFINITE_PENALTY = 1000 * NPF_TILE_LENGTH

    41

};

    42

    43

/* Meant to be stored in AyStar.targetdata */

    44

struct NPFFindStationOrTileData {

    45

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

    46

	StationID station_index; ///< station index we're heading for, or INVALID_STATION when we're heading for a tile

    47

};

    48

    49

/* Indices into AyStar.userdata[] */

    50

enum {

    51

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

    52

	NPF_SUB_TYPE,  ///< Contains the sub transport type

    53

	NPF_OWNER,     ///< Contains an Owner value

    54

	NPF_RAILTYPES, ///< Contains a bitmask the compatible RailTypes of the engine when NPF_TYPE == TRANSPORT_RAIL. Unused otherwise.

    55

};

    56

    57

/* Indices into AyStarNode.userdata[] */

    58

enum {

    59

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

    60

	NPF_NODE_FLAGS,

    61

};

    62

    63

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

    64

enum NPFNodeFlag {

    65

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

    66

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

    67

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

    68

	NPF_FLAG_IGNORE_START_TILE, ///< Used to mark that the start tile is invalid, and searching should start from the second tile on

    69

};

    70

    71

/* Meant to be stored in AyStar.userpath */

    72

struct NPFFoundTargetData {

    73

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

    74

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

    75

	Trackdir best_trackdir; ///< The trackdir that leads to the shortest path/closest birds dist

    76

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

    77

};

    78

    79

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

    80

    81

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

    82

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

    83

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

    84

NPFFoundTargetData NPFRouteToStationOrTile(TileIndex tile, Trackdir trackdir, bool ignore_start_tile, NPFFindStationOrTileData* target, TransportType type, uint sub_type, Owner owner, RailTypes railtypes);

    85

    86

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

    87

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

    88

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

    89

NPFFoundTargetData NPFRouteToStationOrTileTwoWay(TileIndex tile1, Trackdir trackdir1, bool ignore_start_tile1, TileIndex tile2, Trackdir trackdir2, bool ignore_start_tile2, NPFFindStationOrTileData* target, TransportType type, uint sub_type, Owner owner, RailTypes railtypes);

    90

    91

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

    92

    93

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

    94

 * heuristic, such as railway/road.*/

    95

NPFFoundTargetData NPFRouteToDepotBreadthFirst(TileIndex tile, Trackdir trackdir, bool ignore_start_tile, TransportType type, uint sub_type, Owner owner, RailTypes railtypes);

    96

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

    97

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

    98

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

    99

 * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full

   100

 * tile).

   101

 */

   102

NPFFoundTargetData NPFRouteToDepotBreadthFirstTwoWay(TileIndex tile1, Trackdir trackdir1, bool ignore_start_tile1, TileIndex tile2, Trackdir trackdir2, bool ignore_start_tile2, TransportType type, uint sub_type, Owner owner, RailTypes railtypes, uint reverse_penalty);

   103

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

   104

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

   105

NPFFoundTargetData NPFRouteToDepotTrialError(TileIndex tile, Trackdir trackdir, bool ignore_start_tile, TransportType type, uint sub_type, Owner owner, RailTypes railtypes);

   106

   107

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

   108

   109

   110

/*

   111

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

   112

 */

   113

   114

/**

   115

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

   116

 */

   117

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

   118

{

   119

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

   120

}

   121

   122

/**

   123

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

   124

 */

   125

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

   126

{

   127

	if (value)

   128

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

   129

	else

   130

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

   131

}

   132

   133

#endif /* NPF_H */