1

/* $Id$ */

     2

     3

#ifndef AIRPORT_H

     4

#define AIRPORT_H

     5

     6

#include "direction.h"

     7

     8

enum {MAX_TERMINALS =  10};

     9

enum {MAX_HELIPADS  =   4};

    10

enum {MAX_ELEMENTS  = 255};

    11

enum {MAX_HEADINGS  =  22};

    12

    13

// Airport types

    14

enum {

    15

	AT_SMALL         =  0,

    16

	AT_LARGE         =  1,

    17

	AT_HELIPORT      =  2,

    18

	AT_METROPOLITAN  =  3,

    19

	AT_INTERNATIONAL =  4,

    20

	AT_COMMUTER      =  5,

    21

	AT_HELIDEPOT     =  6,

    22

	AT_INTERCON      =  7,

    23

	AT_HELISTATION   =  8,

    24

	AT_OILRIG        = 15

    25

};

    26

    27

// do not change unless you change v->subtype too. This aligns perfectly with its current setting

    28

enum AcceptPlanes {

    29

	ACC_BEGIN        = 0,

    30

	AIRCRAFT_ONLY    = 0,

    31

	ALL              = 1,

    32

	HELICOPTERS_ONLY = 2,

    33

	ACC_END

    34

};

    35

    36

/** Define basic enum properties */

    37

template <> struct EnumPropsT<AcceptPlanes> : MakeEnumPropsT<AcceptPlanes, byte, ACC_BEGIN, ACC_END, ACC_END> {};

    38

typedef TinyEnumT<AcceptPlanes> AcceptPlanesByte;

    39

    40

enum {

    41

	AMED_NOSPDCLAMP = 1 << 0,

    42

	AMED_TAKEOFF    = 1 << 1,

    43

	AMED_SLOWTURN   = 1 << 2,

    44

	AMED_LAND       = 1 << 3,

    45

	AMED_EXACTPOS   = 1 << 4,

    46

	AMED_BRAKE      = 1 << 5,

    47

	AMED_HELI_RAISE = 1 << 6,

    48

	AMED_HELI_LOWER = 1 << 7,

    49

};

    50

    51

/* Movement States on Airports (headings target) */

    52

enum {

    53

	TO_ALL         =  0,

    54

	HANGAR         =  1,

    55

	TERM1          =  2,

    56

	TERM2          =  3,

    57

	TERM3          =  4,

    58

	TERM4          =  5,

    59

	TERM5          =  6,

    60

	TERM6          =  7,

    61

	HELIPAD1       =  8,

    62

	HELIPAD2       =  9,

    63

	TAKEOFF        = 10,

    64

	STARTTAKEOFF   = 11,

    65

	ENDTAKEOFF     = 12,

    66

	HELITAKEOFF    = 13,

    67

	FLYING         = 14,

    68

	LANDING        = 15,

    69

	ENDLANDING     = 16,

    70

	HELILANDING    = 17,

    71

	HELIENDLANDING = 18,

    72

	TERM7          = 19,

    73

	TERM8          = 20,

    74

	HELIPAD3       = 21,

    75

	HELIPAD4       = 22

    76

};

    77

    78

/* Movement Blocks on Airports */

    79

// blocks (eg_airport_flags)

    80

enum {

    81

	TERM1_block              = 1 <<  0,

    82

	TERM2_block              = 1 <<  1,

    83

	TERM3_block              = 1 <<  2,

    84

	TERM4_block              = 1 <<  3,

    85

	TERM5_block              = 1 <<  4,

    86

	TERM6_block              = 1 <<  5,

    87

	HELIPAD1_block           = 1 <<  6,

    88

	HELIPAD2_block           = 1 <<  7,

    89

	RUNWAY_IN_OUT_block      = 1 <<  8,

    90

	RUNWAY_IN_block          = 1 <<  8,

    91

	AIRPORT_BUSY_block       = 1 <<  8,

    92

	RUNWAY_OUT_block         = 1 <<  9,

    93

	TAXIWAY_BUSY_block       = 1 << 10,

    94

	OUT_WAY_block            = 1 << 11,

    95

	IN_WAY_block             = 1 << 12,

    96

	AIRPORT_ENTRANCE_block   = 1 << 13,

    97

	TERM_GROUP1_block        = 1 << 14,

    98

	TERM_GROUP2_block        = 1 << 15,

    99

	HANGAR2_AREA_block       = 1 << 16,

   100

	TERM_GROUP2_ENTER1_block = 1 << 17,

   101

	TERM_GROUP2_ENTER2_block = 1 << 18,

   102

	TERM_GROUP2_EXIT1_block  = 1 << 19,

   103

	TERM_GROUP2_EXIT2_block  = 1 << 20,

   104

	PRE_HELIPAD_block        = 1 << 21,

   105

   106

// blocks for new airports

   107

	TERM7_block              = 1 << 22,

   108

	TERM8_block              = 1 << 23,

   109

	TERM9_block              = 1 << 24,

   110

	HELIPAD3_block           = 1 << 24,

   111

	TERM10_block             = 1 << 25,

   112

	HELIPAD4_block           = 1 << 25,

   113

	HANGAR1_AREA_block       = 1 << 26,

   114

	OUT_WAY2_block           = 1 << 27,

   115

	IN_WAY2_block            = 1 << 28,

   116

	RUNWAY_IN2_block         = 1 << 29,

   117

	RUNWAY_OUT2_block        = 1 << 10,   // note re-uses TAXIWAY_BUSY

   118

	HELIPAD_GROUP_block      = 1 << 13,   // note re-uses AIRPORT_ENTRANCE

   119

	OUT_WAY_block2           = 1 << 31,

   120

// end of new blocks

   121

   122

	NOTHING_block            = 1 << 30

   123

};

   124

   125

typedef struct AirportMovingData {

   126

	int16 x;

   127

	int16 y;

   128

	byte flag;

   129

	DirectionByte direction;

   130

} AirportMovingData;

   131

   132

struct AirportFTAbuildup;

   133

   134

// Finite sTate mAchine --> FTA

   135

typedef struct AirportFTAClass {

   136

	public:

   137

		AirportFTAClass(

   138

			const AirportMovingData *moving_data,

   139

			const byte *terminals,

   140

			const byte *helipads,

   141

			byte entry_point,

   142

			AcceptPlanes acc_planes,

   143

			const AirportFTAbuildup *apFA,

   144

			const TileIndexDiffC *depots,

   145

			byte nof_depots,

   146

			uint size_x,

   147

			uint size_y

   148

		);

   149

   150

		~AirportFTAClass();

   151

   152

		const AirportMovingData *MovingData(byte position) const

   153

		{

   154

			assert(position < nofelements);

   155

			return &moving_data[position];

   156

		}

   157

   158

	const AirportMovingData *moving_data;

   159

	struct AirportFTA *layout;            // state machine for airport

   160

	const byte *terminals;

   161

	const byte *helipads;

   162

	const TileIndexDiffC *airport_depots; // gives the position of the depots on the airports

   163

	byte nof_depots;                      // number of depots this airport has

   164

	byte nofelements;                     // number of positions the airport consists of

   165

	byte entry_point;                     // when an airplane arrives at this airport, enter it at position entry_point

   166

	AcceptPlanesByte acc_planes;          // accept airplanes or helicopters or both

   167

	byte size_x;

   168

	byte size_y;

   169

} AirportFTAClass;

   170

   171

// internal structure used in openttd - Finite sTate mAchine --> FTA

   172

typedef struct AirportFTA {

   173

	struct AirportFTA *next; // possible extra movement choices from this position

   174

	uint32 block;            // 32 bit blocks (st->airport_flags), should be enough for the most complex airports

   175

	byte position;           // the position that an airplane is at

   176

	byte next_position;      // next position from this position

   177

	byte heading;            // heading (current orders), guiding an airplane to its target on an airport

   178

} AirportFTA;

   179

   180

void InitializeAirports(void);

   181

void UnInitializeAirports(void);

   182

const AirportFTAClass *GetAirport(const byte airport_type);

   183

   184

/** Get buildable airport bitmask.

   185

 * @return get all buildable airports at this given time, bitmasked.

   186

 * Bit 0 means the small airport is buildable, etc.

   187

 * @todo set availability of airports by year, instead of airplane

   188

 */

   189

uint32 GetValidAirports(void);

   190

   191

#endif /* AIRPORT_H */