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

#include "waypoint.h"

    15

    16

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

    17

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

    18

    19

/** Constants of vehicle view widget indices */

    20

enum VehicleViewWindowWidgets {

    21

	VVW_WIDGET_CLOSEBOX = 0,

    22

	VVW_WIDGET_CAPTION,

    23

	VVW_WIDGET_STICKY,

    24

	VVW_WIDGET_PANEL,

    25

	VVW_WIDGET_VIEWPORT,

    26

	VVW_WIDGET_START_STOP_VEH,

    27

	VVW_WIDGET_CENTER_MAIN_VIEH,

    28

	VVW_WIDGET_GOTO_DEPOT,

    29

	VVW_WIDGET_REFIT_VEH,

    30

	VVW_WIDGET_SHOW_ORDERS,

    31

	VVW_WIDGET_SHOW_DETAILS,

    32

	VVW_WIDGET_CLONE_VEH,

    33

	VVW_WIDGET_EMPTY_BOTTOM_RIGHT,

    34

	VVW_WIDGET_RESIZE,

    35

	VVW_WIDGET_TURN_AROUND,

    36

	VVW_WIDGET_FORCE_PROCEED,

    37

};

    38

    39

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

    40

enum {

    41

	PLY_WND_PRC__OFFSET_TOP_WIDGET = 26,

    42

	PLY_WND_PRC__SIZE_OF_ROW_TINY  = 13,

    43

	PLY_WND_PRC__SIZE_OF_ROW_SMALL = 26,

    44

	PLY_WND_PRC__SIZE_OF_ROW_BIG   = 36,

    45

	PLY_WND_PRC__SIZE_OF_ROW_BIG2  = 39,

    46

};

    47

    48

/** Vehicle List Window type flags */

    49

enum {

    50

	VLW_STANDARD      = 0 << 8,

    51

	VLW_SHARED_ORDERS = 1 << 8,

    52

	VLW_STATION_LIST  = 2 << 8,

    53

	VLW_DEPOT_LIST    = 3 << 8,

    54

	VLW_GROUP_LIST    = 4 << 8,

    56

	VLW_MASK          = 0x700,

    57

};

    58

    59

static inline bool ValidVLWFlags(uint16 flags)

    60

{

    61

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

    62

}

    63

    64

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

    65

    66

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

    67

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

    68

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

    69

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

    70

    71

void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);

    72

    73

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

    74

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

    75

    76

void ShowVehicleListWindow(const Vehicle *v);

    77

void ShowVehicleListWindow(const Waypoint *wp);

    78

void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type);

    79

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

    80

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

    81

    82

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

    83

    84

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

    85

    86

    87

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

    88

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

    89

void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);

    90

    91

static inline uint GetVehicleListHeight(VehicleType type)

    92

{

    93

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

    94

}

    95

    96

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

    97

 * @param vt vehicle type to check

    98

 * @return corresponding window class

    99

 * @note works only for player buildable vehicle types

   100

 */

   101

static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)

   102

{

   103

	switch (vt) {

   104

		default: NOT_REACHED();

   105

		case VEH_TRAIN:    return WC_TRAINS_LIST;

   106

		case VEH_ROAD:     return WC_ROADVEH_LIST;

   107

		case VEH_SHIP:     return WC_SHIPS_LIST;

   108

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

   109

	}

   110

}

   111

   112

/* Unified window procedure */

   113

void ShowVehicleViewWindow(const Vehicle *v);

   114

   115

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

   116

   117

typedef GUIList<const Vehicle*> GUIVehicleList;

   118

   119

struct VehicleListBase {

   120

	GUIVehicleList vehicles;  ///< The list of vehicles

   121

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

   122

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

   123

   124

	static const StringID vehicle_sorter_names[];

   125

	static GUIVehicleList::SortFunction *const vehicle_sorter_funcs[];

   126

   127

	VehicleListBase()

   128

	{

   129

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

   130

	}

   131

};

   132

   133

struct Sorting {

   134

	Listing aircraft;

   135

	Listing roadveh;

   136

	Listing ship;

   137

	Listing train;

   138

};

   139

   140

extern Sorting _sorting;

   141

   142

/* sorter stuff */

   143

void SortVehicleList(VehicleListBase *vl);

   144

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

   145

   146

#endif /* VEHICLE_GUI_H */