1

/* $Id$ */

     2

     3

/** @file vehicle_gui.h Functions related to the vehicle's GUIs. */

     4

     5

#ifndef VEHICLE_GUI_H

     6

#define VEHICLE_GUI_H

     7

     8

#include "sortlist_type.h"

     9

#include "window_type.h"

    10

#include "vehicle_type.h"

    11

#include "order_type.h"

    12

#include "station_type.h"

    13

#include "engine_type.h"

    14

    15

void DrawVehicleProfitButton(const Vehicle *v, int x, int y);

    16

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order);

    17

    18

#define PERIODIC_RESORT_DAYS 10

    19

    20

extern const StringID _vehicle_sort_listing[];

    21

    22

/** Constants of vehicle view widget indices */

    23

enum VehicleViewWindowWidgets {

    24

	VVW_WIDGET_CLOSEBOX = 0,

    25

	VVW_WIDGET_CAPTION,

    26

	VVW_WIDGET_STICKY,

    27

	VVW_WIDGET_PANEL,

    28

	VVW_WIDGET_VIEWPORT,

    29

	VVW_WIDGET_START_STOP_VEH,

    30

	VVW_WIDGET_CENTER_MAIN_VIEH,

    31

	VVW_WIDGET_GOTO_DEPOT,

    32

	VVW_WIDGET_REFIT_VEH,

    33

	VVW_WIDGET_SHOW_ORDERS,

    34

	VVW_WIDGET_SHOW_DETAILS,

    35

	VVW_WIDGET_CLONE_VEH,

    36

	VVW_WIDGET_EMPTY_BOTTOM_RIGHT,

    37

	VVW_WIDGET_RESIZE,

    38

	VVW_WIDGET_TURN_AROUND,

    39

	VVW_WIDGET_FORCE_PROCEED,

    40

};

    41

    42

/** Start of functions regarding vehicle list windows */

    43

enum {

    44

	PLY_WND_PRC__OFFSET_TOP_WIDGET = 26,

    45

	PLY_WND_PRC__SIZE_OF_ROW_TINY  = 13,

    46

	PLY_WND_PRC__SIZE_OF_ROW_SMALL = 26,

    47

	PLY_WND_PRC__SIZE_OF_ROW_BIG   = 36,

    48

	PLY_WND_PRC__SIZE_OF_ROW_BIG2  = 39,

    49

};

    50

    51

/** Vehicle List Window type flags */

    52

enum {

    53

	VLW_STANDARD      = 0 << 8,

    54

	VLW_SHARED_ORDERS = 1 << 8,

    55

	VLW_STATION_LIST  = 2 << 8,

    56

	VLW_DEPOT_LIST    = 3 << 8,

    57

	VLW_GROUP_LIST    = 4 << 8,

    58

	VLW_MASK          = 0x700,

    59

};

    60

    61

static inline bool ValidVLWFlags(uint16 flags)

    62

{

    63

	return (flags == VLW_STANDARD || flags == VLW_SHARED_ORDERS || flags == VLW_STATION_LIST || flags == VLW_DEPOT_LIST || flags == VLW_GROUP_LIST);

    64

}

    65

    66

int DrawVehiclePurchaseInfo(int x, int y, uint w, EngineID engine_number);

    67

    68

void DrawTrainImage(const Vehicle *v, int x, int y, VehicleID selection, int count, int skip);

    69

void DrawRoadVehImage(const Vehicle *v, int x, int y, VehicleID selection, int count);

    70

void DrawShipImage(const Vehicle *v, int x, int y, VehicleID selection);

    71

void DrawAircraftImage(const Vehicle *v, int x, int y, VehicleID selection);

    72

    73

void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);

    74

    75

uint ShowAdditionalText(int x, int y, uint w, EngineID engine);

    76

uint ShowRefitOptionsList(int x, int y, uint w, EngineID engine);

    77

    78

void ShowVehicleListWindow(const Vehicle *v);

    79

void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type);

    80

void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type, StationID station);

    81

void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type, TileIndex depot_tile);

    82

    83

void DrawSmallOrderList(const Vehicle *v, int x, int y);

    84

    85

void DrawVehicleImage(const Vehicle *v, int x, int y, VehicleID selection, int count, int skip);

    86

    87

    88

/* ChangeVehicleViewWindow() moves all windows for one vehicle to another vehicle.

    89

 * For ease of use it can be called with both Vehicle pointers and VehicleIDs. */

    90

void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);

    91

    92

static inline uint GetVehicleListHeight(VehicleType type)

    93

{

    94

	return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;

    95

}

    96

    97

/** Get WindowClass for vehicle list of given vehicle type

    98

 * @param vt vehicle type to check

    99

 * @return corresponding window class

   100

 * @note works only for player buildable vehicle types

   101

 */

   102

static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)

   103

{

   104

	switch (vt) {

   105

		default: NOT_REACHED();

   106

		case VEH_TRAIN:    return WC_TRAINS_LIST;

   107

		case VEH_ROAD:     return WC_ROADVEH_LIST;

   108

		case VEH_SHIP:     return WC_SHIPS_LIST;

   109

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

   110

	}

   111

}

   112

   113

/* Unified window procedure */

   114

void ShowVehicleViewWindow(const Vehicle *v);

   115

   116

Vehicle *CheckClickOnVehicle(const struct ViewPort *vp, int x, int y);

   117

   118

typedef GUIList<const Vehicle*> GUIVehicleList;

   119

   120

struct VehicleListBase {

   121

	GUIVehicleList vehicles;  ///< The list of vehicles

   122

	Listing *sorting;         ///< Pointer to the vehicle type related sorting.

   123

	VehicleType vehicle_type; ///< The vehicle type that is sorted

   124

};

   125

   126

struct Sorting {

   127

	Listing aircraft;

   128

	Listing roadveh;

   129

	Listing ship;

   130

	Listing train;

   131

};

   132

   133

extern Sorting _sorting;

   134

   135

/* sorter stuff */

   136

void SortVehicleList(VehicleListBase *vl);

   137

void BuildVehicleList(VehicleListBase *vl, PlayerID owner, uint16 index, uint16 window_type);

   138

   139

#endif /* VEHICLE_GUI_H */