1

/* $Id$ */

     2

     3

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

     4

     5

#ifndef AIRPORT_H

     6

#define AIRPORT_H

     7

     8

#include "direction_type.h"

     9

#include "map_type.h"

    10

#include "tile_type.h"

    11

    12

enum {MAX_TERMINALS =  10};

    13

enum {MAX_HELIPADS  =   4};

    14

enum {MAX_ELEMENTS  = 255};

    15

enum {MAX_HEADINGS  =  22};

    16

    17

/* Airport types */

    18

enum {

    19

	AT_SMALL         =   0,

    20

	AT_LARGE         =   1,

    21

	AT_HELIPORT      =   2,

    22

	AT_METROPOLITAN  =   3,

    23

	AT_INTERNATIONAL =   4,

    24

	AT_COMMUTER      =   5,

    25

	AT_HELIDEPOT     =   6,

    26

	AT_INTERCON      =   7,

    27

	AT_HELISTATION   =   8,

    28

	AT_OILRIG        =  15,

    29

	AT_DUMMY         = 255

    30

};

    31

    32

    33

enum {

    34

	AMED_NOSPDCLAMP = 1 << 0,

    35

	AMED_TAKEOFF    = 1 << 1,

    36

	AMED_SLOWTURN   = 1 << 2,

    37

	AMED_LAND       = 1 << 3,

    38

	AMED_EXACTPOS   = 1 << 4,

    39

	AMED_BRAKE      = 1 << 5,

    40

	AMED_HELI_RAISE = 1 << 6,

    41

	AMED_HELI_LOWER = 1 << 7,

    42

	AMED_HOLD       = 1 << 8

    43

};

    44

    45

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

    46

enum {

    47

	TO_ALL         =  0,

    48

	HANGAR         =  1,

    49

	TERM1          =  2,

    50

	TERM2          =  3,

    51

	TERM3          =  4,

    52

	TERM4          =  5,

    53

	TERM5          =  6,

    54

	TERM6          =  7,

    55

	HELIPAD1       =  8,

    56

	HELIPAD2       =  9,

    57

	TAKEOFF        = 10,

    58

	STARTTAKEOFF   = 11,

    59

	ENDTAKEOFF     = 12,

    60

	HELITAKEOFF    = 13,

    61

	FLYING         = 14,

    62

	LANDING        = 15,

    63

	ENDLANDING     = 16,

    64

	HELILANDING    = 17,

    65

	HELIENDLANDING = 18,

    66

	TERM7          = 19,

    67

	TERM8          = 20,

    68

	HELIPAD3       = 21,

    69

	HELIPAD4       = 22

    70

};

    71

    72

/* Movement Blocks on Airports */

    73

/* blocks (eg_airport_flags) */

    74

static const uint64

    75

	TERM1_block              = 1ULL <<  0,

    76

	TERM2_block              = 1ULL <<  1,

    77

	TERM3_block              = 1ULL <<  2,

    78

	TERM4_block              = 1ULL <<  3,

    79

	TERM5_block              = 1ULL <<  4,

    80

	TERM6_block              = 1ULL <<  5,

    81

	HELIPAD1_block           = 1ULL <<  6,

    82

	HELIPAD2_block           = 1ULL <<  7,

    83

	RUNWAY_IN_OUT_block      = 1ULL <<  8,

    84

	RUNWAY_IN_block          = 1ULL <<  8,

    85

	AIRPORT_BUSY_block       = 1ULL <<  8,

    86

	RUNWAY_OUT_block         = 1ULL <<  9,

    87

	TAXIWAY_BUSY_block       = 1ULL << 10,

    88

	OUT_WAY_block            = 1ULL << 11,

    89

	IN_WAY_block             = 1ULL << 12,

    90

	AIRPORT_ENTRANCE_block   = 1ULL << 13,

    91

	TERM_GROUP1_block        = 1ULL << 14,

    92

	TERM_GROUP2_block        = 1ULL << 15,

    93

	HANGAR2_AREA_block       = 1ULL << 16,

    94

	TERM_GROUP2_ENTER1_block = 1ULL << 17,

    95

	TERM_GROUP2_ENTER2_block = 1ULL << 18,

    96

	TERM_GROUP2_EXIT1_block  = 1ULL << 19,

    97

	TERM_GROUP2_EXIT2_block  = 1ULL << 20,

    98

	PRE_HELIPAD_block        = 1ULL << 21,

    99

   100

/* blocks for new airports */

   101

	TERM7_block              = 1ULL << 22,

   102

	TERM8_block              = 1ULL << 23,

   103

	TERM9_block              = 1ULL << 24,

   104

	HELIPAD3_block           = 1ULL << 24,

   105

	TERM10_block             = 1ULL << 25,

   106

	HELIPAD4_block           = 1ULL << 25,

   107

	HANGAR1_AREA_block       = 1ULL << 26,

   108

	OUT_WAY2_block           = 1ULL << 27,

   109

	IN_WAY2_block            = 1ULL << 28,

   110

	RUNWAY_IN2_block         = 1ULL << 29,

   111

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

   112

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

   113

	OUT_WAY_block2           = 1ULL << 31,

   114

/* end of new blocks */

   115

   116

	NOTHING_block            = 1ULL << 30;

   117

   118

struct AirportMovingData {

   119

	int16 x;

   120

	int16 y;

   121

	uint16 flag;

   122

	DirectionByte direction;

   123

};

   124

   125

struct AirportFTAbuildup;

   126

   127

/** Finite sTate mAchine --> FTA */

   128

struct AirportFTAClass {

   129

	public:

   130

		enum Flags {

   131

			AIRPLANES   = 0x1,

   132

			HELICOPTERS = 0x2,

   133

			ALL         = AIRPLANES | HELICOPTERS,

   134

			SHORT_STRIP = 0x4

   135

		};

   136

   137

		AirportFTAClass(

   138

			const AirportMovingData *moving_data,

   139

			const byte *terminals,

   140

			const byte *helipads,

   141

			const byte *entry_points,

   142

			Flags flags,

   143

			const AirportFTAbuildup *apFA,

   144

			const TileIndexDiffC *depots,

   145

			byte nof_depots,

   146

			uint size_x,

   147

			uint size_y,

   148

			uint8 noise_level,

   149

			byte delta_z,

   150

			byte catchment

   151

		);

   152

   153

		~AirportFTAClass();

   154

   155

		const AirportMovingData *MovingData(byte position) const

   156

		{

   157

			assert(position < nofelements);

   158

			return &moving_data[position];

   159

		}

   160

   161

	const AirportMovingData *moving_data;

   162

	struct AirportFTA *layout;            ///< state machine for airport

   163

	const byte *terminals;

   164

	const byte *helipads;

   165

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

   166

	Flags flags;

   167

	byte nof_depots;                      ///< number of depots this airport has

   168

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

   169

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

   170

	byte size_x;

   171

	byte size_y;

   172

	uint8 noise_level;                    ///< noise that this airport generates

   173

	byte delta_z;                         ///< Z adjustment for helicopter pads

   174

	byte catchment;

   175

};

   176

   177

DECLARE_ENUM_AS_BIT_SET(AirportFTAClass::Flags)

   178

   179

   180

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

   181

struct AirportFTA {

   182

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

   183

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

   184

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

   185

	byte next_position;      ///< next position from this position

   186

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

   187

};

   188

   189

void InitializeAirports();

   190

void UnInitializeAirports();

   191

const AirportFTAClass *GetAirport(const byte airport_type);

   192

   193

/** Get buildable airport bitmask.

   194

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

   195

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

   196

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

   197

 */

   198

uint32 GetValidAirports();

   199

   200

   201

/* Calculate the noise this type airport will generate */

   202

uint8 GetAirportNoiseLevelForTown(const AirportFTAClass *afc, TileIndex town_tile, TileIndex tile);

   203

   204

#endif /* AIRPORT_H */