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

/** Constants of vehicle view widget indices */

    19

enum VehicleViewWindowWidgets {

    20

	VVW_WIDGET_CLOSEBOX = 0,

    21

	VVW_WIDGET_CAPTION,

    22

	VVW_WIDGET_STICKY,

    23

	VVW_WIDGET_PANEL,

    24

	VVW_WIDGET_VIEWPORT,

    25

	VVW_WIDGET_START_STOP_VEH,

    26

	VVW_WIDGET_CENTER_MAIN_VIEH,

    27

	VVW_WIDGET_GOTO_DEPOT,

    28

	VVW_WIDGET_REFIT_VEH,

    29

	VVW_WIDGET_SHOW_ORDERS,

    30

	VVW_WIDGET_SHOW_DETAILS,

    31

	VVW_WIDGET_CLONE_VEH,

    32

	VVW_WIDGET_EMPTY_BOTTOM_RIGHT,

    33

	VVW_WIDGET_RESIZE,

    34

	VVW_WIDGET_TURN_AROUND,

    35

	VVW_WIDGET_FORCE_PROCEED,

    36

};

    37

    38

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

    39

enum {

    40

	PLY_WND_PRC__OFFSET_TOP_WIDGET = 26,

    41

	PLY_WND_PRC__SIZE_OF_ROW_TINY  = 13,

    42

	PLY_WND_PRC__SIZE_OF_ROW_SMALL = 26,

    43

	PLY_WND_PRC__SIZE_OF_ROW_BIG   = 36,

    44

	PLY_WND_PRC__SIZE_OF_ROW_BIG2  = 39,

    45

};

    46

    47

/** Vehicle List Window type flags */

    48

enum {

    49

	VLW_STANDARD      = 0 << 8,

    50

	VLW_SHARED_ORDERS = 1 << 8,

    51

	VLW_STATION_LIST  = 2 << 8,

    52

	VLW_DEPOT_LIST    = 3 << 8,

    53

	VLW_GROUP_LIST    = 4 << 8,

    54

	VLW_MASK          = 0x700,

    55

};

    56

    57

static inline bool ValidVLWFlags(uint16 flags)

    58

{

    59

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

    60

}

    61

    62

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

    63

    64

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

    65

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

    66

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

    67

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

    68

    69

void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);

    70

    71

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

    72

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

    73

    74

void ShowVehicleListWindow(const Vehicle *v);

    75

void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type);

    76

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

    77

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

    78

    79

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

    80

    81

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

    82

    83

    84

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

    85

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

    86

void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);

    87

    88

static inline uint GetVehicleListHeight(VehicleType type)

    89

{

    90

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

    91

}

    92

    93

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

    94

 * @param vt vehicle type to check

    95

 * @return corresponding window class

    96

 * @note works only for player buildable vehicle types

    97

 */

    98

static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)

    99

{

   100

	switch (vt) {

   101

		default: NOT_REACHED();

   102

		case VEH_TRAIN:    return WC_TRAINS_LIST;

   103

		case VEH_ROAD:     return WC_ROADVEH_LIST;

   104

		case VEH_SHIP:     return WC_SHIPS_LIST;

   105

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

   106

	}

   107

}

   108

   109

/* Unified window procedure */

   110

void ShowVehicleViewWindow(const Vehicle *v);

   111

   112

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

   113

   114

typedef GUIList<const Vehicle*> GUIVehicleList;

   115

   116

struct VehicleListBase {

   117

	GUIVehicleList vehicles;  ///< The list of vehicles

   118

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

   119

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

   120

   121

	static const StringID vehicle_sorter_names[];

   122

	static GUIVehicleList::SortFunction *const vehicle_sorter_funcs[];

   123

   124

	VehicleListBase()

   125

	{

   126

		this->vehicles.SetSortFuncs(this->vehicle_sorter_funcs);

   127

	}

   128

};

   129

   130

struct Sorting {

   131

	Listing aircraft;

   132

	Listing roadveh;

   133

	Listing ship;

   134

	Listing train;

   135

};

   136

   137

extern Sorting _sorting;

   138

   139

/* sorter stuff */

   140

void SortVehicleList(VehicleListBase *vl);

   141

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

   142

   143

#endif /* VEHICLE_GUI_H */