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

	WaypointID 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

	Date 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

extern MemoryPool _waypoint_pool;

    28

    29

/**

    30

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

    31

 */

    32

static inline Waypoint *GetWaypoint(WaypointID index)

    33

{

    34

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

    35

}

    36

    37

/**

    38

 * Get the current size of the WaypointPool

    39

 */

    40

static inline uint16 GetWaypointPoolSize(void)

    41

{

    42

	return _waypoint_pool.total_items;

    43

}

    44

    45

/**

    46

 * Check if a Waypoint really exists.

    47

 */

    48

static inline bool IsValidWaypoint(const Waypoint *wp)

    49

{

    50

	return wp->xy != 0;

    51

}

    52

    53

static inline bool IsValidWaypointID(WaypointID index)

    54

{

    55

	return index < GetWaypointPoolSize() && IsValidWaypoint(GetWaypoint(index));

    56

}

    57

    58

void DestroyWaypoint(Waypoint *wp);

    59

    60

static inline void DeleteWaypoint(Waypoint *wp)

    61

{

    62

	DestroyWaypoint(wp);

    63

	wp->xy = 0;

    64

}

    65

    66

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

    67

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

    68

    69

    70

/**

    71

 * Fetch a waypoint by tile

    72

 * @param tile Tile of waypoint

    73

 * @return Waypoint

    74

 */

    75

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    76

{

    77

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

    78

	return GetWaypoint(_m[tile].m2);

    79

}

    80

    81

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

    82

Station *ComposeWaypointStation(TileIndex tile);

    83

void ShowRenameWaypointWindow(const Waypoint *cp);

    84

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

    85

void FixOldWaypoints(void);

    86

void UpdateAllWaypointSigns(void);

    87

void UpdateAllWaypointCustomGraphics(void);

    88

    89

#endif /* WAYPOINT_H */