1

/* $Id$ */

     2

     3

#ifndef WAYPOINT_H

     4

#define WAYPOINT_H

     5

     6

#include "pool.h"

     7

#include "rail_map.h"

     8

     9

struct Waypoint {

    10

	TileIndex xy;      ///< Tile of waypoint

    11

	StationID index;   ///< Index of waypoint

    12

    13

	TownID town_index; ///< Town associated with the waypoint

    14

	byte town_cn;      ///< The Nth waypoint for this town (consecutive number)

    15

	StringID string;   ///< If this is zero (i.e. no custom name), town + town_cn is used for naming

    16

    17

	ViewportSign sign; ///< Dimensions of sign (not saved)

    18

	uint16 build_date; ///< Date of construction

    19

    20

	byte stat_id;      ///< ID of waypoint within the waypoint class (not saved)

    21

	uint32 grfid;      ///< ID of GRF file

    22

	byte localidx;     ///< Index of station within GRF file

    23

    24

	byte deleted;      ///< Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.

    25

};

    26

    27

enum {

    28

	RAIL_TYPE_WAYPOINT = 0xC4,

    29

	RAIL_WAYPOINT_TRACK_MASK = 1,

    30

};

    31

    32

extern MemoryPool _waypoint_pool;

    33

    34

/**

    35

 * Get the pointer to the waypoint with index 'index'

    36

 */

    37

static inline Waypoint *GetWaypoint(uint index)

    38

{

    39

	return (Waypoint*)GetItemFromPool(&_waypoint_pool, index);

    40

}

    41

    42

/**

    43

 * Get the current size of the WaypointPool

    44

 */

    45

static inline uint16 GetWaypointPoolSize(void)

    46

{

    47

	return _waypoint_pool.total_items;

    48

}

    49

    50

static inline bool IsWaypointIndex(uint index)

    51

{

    52

	return index < GetWaypointPoolSize();

    53

}

    54

    55

#define FOR_ALL_WAYPOINTS_FROM(wp, start) for (wp = GetWaypoint(start); wp != NULL; wp = (wp->index + 1 < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1) : NULL)

    56

#define FOR_ALL_WAYPOINTS(wp) FOR_ALL_WAYPOINTS_FROM(wp, 0)

    57

    58

static inline bool IsRailWaypoint(TileIndex tile)

    59

{

    60

	return (_m[tile].m5 & 0xFC) == 0xC4;

    61

}

    62

    63

/**

    64

 * Fetch a waypoint by tile

    65

 * @param tile Tile of waypoint

    66

 * @return Waypoint

    67

 */

    68

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    69

{

    70

	assert(IsTileType(tile, MP_RAILWAY) && IsRailWaypoint(tile));

    71

	return GetWaypoint(_m[tile].m2);

    72

}

    73

    74

int32 RemoveTrainWaypoint(TileIndex tile, uint32 flags, bool justremove);

    75

Station *ComposeWaypointStation(TileIndex tile);

    76

void ShowRenameWaypointWindow(const Waypoint *cp);

    77

void DrawWaypointSprite(int x, int y, int image, RailType railtype);

    78

void FixOldWaypoints(void);

    79

void UpdateAllWaypointSigns(void);

    80

void UpdateAllWaypointCustomGraphics(void);

    81

    82

#endif /* WAYPOINT_H */