1

/* $Id$ */

     2

     3

/** @file airport.h Various declarations for airports */

     4

     5

#ifndef AIRPORT_H

     6

#define AIRPORT_H

     7

     8

#include "direction.h"

     9

    10

enum {MAX_TERMINALS =  10};

    11

enum {MAX_HELIPADS  =   4};

    12

enum {MAX_ELEMENTS  = 255};

    13

enum {MAX_HEADINGS  =  22};

    14

    15

// Airport types

    16

enum {

    17

	AT_SMALL         =   0,

    18

	AT_LARGE         =   1,

    19

	AT_HELIPORT      =   2,

    20

	AT_METROPOLITAN  =   3,

    21

	AT_INTERNATIONAL =   4,

    22

	AT_COMMUTER      =   5,

    23

	AT_HELIDEPOT     =   6,

    24

	AT_INTERCON      =   7,

    25

	AT_HELISTATION   =   8,

    26

	AT_OILRIG        =  15,

    27

	AT_DUMMY         = 255

    28

};

    29

    30

    31

enum {

    32

	AMED_NOSPDCLAMP = 1 << 0,

    33

	AMED_TAKEOFF    = 1 << 1,

    34

	AMED_SLOWTURN   = 1 << 2,

    35

	AMED_LAND       = 1 << 3,

    36

	AMED_EXACTPOS   = 1 << 4,

    37

	AMED_BRAKE      = 1 << 5,

    38

	AMED_HELI_RAISE = 1 << 6,

    39

	AMED_HELI_LOWER = 1 << 7,

    40

	AMED_HOLD       = 1 << 8

    41

};

    42

    43

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

    44

enum {

    45

	TO_ALL         =  0,

    46

	HANGAR         =  1,

    47

	TERM1          =  2,

    48

	TERM2          =  3,

    49

	TERM3          =  4,

    50

	TERM4          =  5,

    51

	TERM5          =  6,

    52

	TERM6          =  7,

    53

	HELIPAD1       =  8,

    54

	HELIPAD2       =  9,

    55

	TAKEOFF        = 10,

    56

	STARTTAKEOFF   = 11,

    57

	ENDTAKEOFF     = 12,

    58

	HELITAKEOFF    = 13,

    59

	FLYING         = 14,

    60

	LANDING        = 15,

    61

	ENDLANDING     = 16,

    62

	HELILANDING    = 17,

    63

	HELIENDLANDING = 18,

    64

	TERM7          = 19,

    65

	TERM8          = 20,

    66

	HELIPAD3       = 21,

    67

	HELIPAD4       = 22

    68

};

    69

    70

/* Movement Blocks on Airports */

    71

// blocks (eg_airport_flags)

    72

static const uint64

    73

	TERM1_block              = 1 <<  0,

    74

	TERM2_block              = 1 <<  1,

    75

	TERM3_block              = 1 <<  2,

    76

	TERM4_block              = 1 <<  3,

    77

	TERM5_block              = 1 <<  4,

    78

	TERM6_block              = 1 <<  5,

    79

	HELIPAD1_block           = 1 <<  6,

    80

	HELIPAD2_block           = 1 <<  7,

    81

	RUNWAY_IN_OUT_block      = 1 <<  8,

    82

	RUNWAY_IN_block          = 1 <<  8,

    83

	AIRPORT_BUSY_block       = 1 <<  8,

    84

	RUNWAY_OUT_block         = 1 <<  9,

    85

	TAXIWAY_BUSY_block       = 1 << 10,

    86

	OUT_WAY_block            = 1 << 11,

    87

	IN_WAY_block             = 1 << 12,

    88

	AIRPORT_ENTRANCE_block   = 1 << 13,

    89

	TERM_GROUP1_block        = 1 << 14,

    90

	TERM_GROUP2_block        = 1 << 15,

    91

	HANGAR2_AREA_block       = 1 << 16,

    92

	TERM_GROUP2_ENTER1_block = 1 << 17,

    93

	TERM_GROUP2_ENTER2_block = 1 << 18,

    94

	TERM_GROUP2_EXIT1_block  = 1 << 19,

    95

	TERM_GROUP2_EXIT2_block  = 1 << 20,

    96

	PRE_HELIPAD_block        = 1 << 21,

    97

    98

// blocks for new airports

    99

	TERM7_block              = 1 << 22,

   100

	TERM8_block              = 1 << 23,

   101

	TERM9_block              = 1 << 24,

   102

	HELIPAD3_block           = 1 << 24,

   103

	TERM10_block             = 1 << 25,

   104

	HELIPAD4_block           = 1 << 25,

   105

	HANGAR1_AREA_block       = 1 << 26,

   106

	OUT_WAY2_block           = 1 << 27,

   107

	IN_WAY2_block            = 1 << 28,

   108

	RUNWAY_IN2_block         = 1 << 29,

   109

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

   110

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

   111

	OUT_WAY_block2           = 1 << 31,

   112

// end of new blocks

   113

   114

	NOTHING_block            = 1 << 30;

   115

   116

struct AirportMovingData {

   117

	int16 x;

   118

	int16 y;

   119

	uint16 flag;

   120

	DirectionByte direction;

   121

};

   122

   123

struct AirportFTAbuildup;

   124

   125

// Finite sTate mAchine --> FTA

   126

struct AirportFTAClass {

   127

	public:

   128

		enum Flags {

   129

			AIRPLANES   = 0x1,

   130

			HELICOPTERS = 0x2,

   131

			ALL         = AIRPLANES | HELICOPTERS,

   132

			SHORT_STRIP = 0x4

   133

		};

   134

   135

		AirportFTAClass(

   136

			const AirportMovingData *moving_data,

   137

			const byte *terminals,

   138

			const byte *helipads,

   139

			const byte *entry_points,

   140

			Flags flags,

   141

			const AirportFTAbuildup *apFA,

   142

			const TileIndexDiffC *depots,

   143

			byte nof_depots,

   144

			uint size_x,

   145

			uint size_y,

   146

			byte delta_z,

   147

			byte catchment

   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

	Flags flags;

   164

	byte nof_depots;                      // number of depots this airport has

   165

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

   166

	const byte *entry_points;             ///< when an airplane arrives at this airport, enter it at position entry_point, index depends on direction

   167

	byte size_x;

   168

	byte size_y;

   169

	byte delta_z;                         // Z adjustment for helicopter pads

   170

	byte catchment;

   171

};

   172

   173

DECLARE_ENUM_AS_BIT_SET(AirportFTAClass::Flags)

   174

   175

   176

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

   177

struct AirportFTA {

   178

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

   179

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

   180

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

   181

	byte next_position;      // next position from this position

   182

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

   183

};

   184

   185

void InitializeAirports();

   186

void UnInitializeAirports();

   187

const AirportFTAClass *GetAirport(const byte airport_type);

   188

   189

/** Get buildable airport bitmask.

   190

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

   191

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

   192

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

   193

 */

   194

uint32 GetValidAirports();

   195

   196

#endif /* AIRPORT_H */