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

    10

#include "vehicle_type.h"

    11

#include "order_type.h"

    12

#include "station_type.h"

    13

#include "engine_type.h"

    14

#include "vehicle_base.h"

    15

    16

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

    17

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

    18

    19

#define PERIODIC_RESORT_DAYS 10

    20

    21

extern const StringID _vehicle_sort_listing[];

    22

    23

/** Constants of vehicle view widget indices */

    24

enum VehicleViewWindowWidgets {

    25

	VVW_WIDGET_CLOSEBOX = 0,

    26

	VVW_WIDGET_CAPTION,

    27

	VVW_WIDGET_STICKY,

    28

	VVW_WIDGET_PANEL,

    29

	VVW_WIDGET_VIEWPORT,

    30

	VVW_WIDGET_START_STOP_VEH,

    31

	VVW_WIDGET_CENTER_MAIN_VIEH,

    32

	VVW_WIDGET_GOTO_DEPOT,

    33

	VVW_WIDGET_REFIT_VEH,

    34

	VVW_WIDGET_SHOW_ORDERS,

    35

	VVW_WIDGET_SHOW_DETAILS,

    36

	VVW_WIDGET_CLONE_VEH,

    37

	VVW_WIDGET_EMPTY_BOTTOM_RIGHT,

    38

	VVW_WIDGET_RESIZE,

    39

	VVW_WIDGET_TURN_AROUND,

    40

	VVW_WIDGET_FORCE_PROCEED,

    41

};

    42

    43

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

    44

enum {

    45

	PLY_WND_PRC__OFFSET_TOP_WIDGET = 26,

    46

	PLY_WND_PRC__SIZE_OF_ROW_TINY  = 13,

    47

	PLY_WND_PRC__SIZE_OF_ROW_SMALL = 26,

    48

	PLY_WND_PRC__SIZE_OF_ROW_BIG   = 36,

    49

	PLY_WND_PRC__SIZE_OF_ROW_BIG2  = 39,

    50

};

    51

    52

/** Vehicle List Window type flags */

    53

enum {

    54

	VLW_STANDARD      = 0 << 8,

    55

	VLW_SHARED_ORDERS = 1 << 8,

    56

	VLW_STATION_LIST  = 2 << 8,

    57

	VLW_DEPOT_LIST    = 3 << 8,

    58

	VLW_GROUP_LIST    = 4 << 8,

    59

	VLW_MASK          = 0x700,

    60

};

    61

    62

static inline bool ValidVLWFlags(uint16 flags)

    63

{

    64

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

    65

}

    66

    67

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

    68

    69

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

    70

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

    71

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

    72

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

    73

    74

void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);

    75

    76

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

    77

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

    78

    79

void ShowVehicleListWindow(const Vehicle *v);

    80

void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type);

    81

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

    82

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

    83

    84

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

    85

    86

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

    87

    88

    89

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

    90

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

    91

void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);

    92

    93

static inline void ChangeVehicleViewWindow(const Vehicle *from_v, VehicleID to_index)

    94

{

    95

	ChangeVehicleViewWindow(from_v->index, to_index);

    96

}

    97

    98

static inline void ChangeVehicleViewWindow(VehicleID from_index, const Vehicle *to_v)

    99

{

   100

	ChangeVehicleViewWindow(from_index, to_v->index);

   101

}

   102

   103

static inline void ChangeVehicleViewWindow(const Vehicle *from_v, const Vehicle *to_v)

   104

{

   105

	ChangeVehicleViewWindow(from_v->index, to_v->index);

   106

}

   107

   108

static inline uint GetVehicleListHeight(VehicleType type)

   109

{

   110

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

   111

}

   112

   113

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

   114

 * @param vt vehicle type to check

   115

 * @return corresponding window class

   116

 * @note works only for player buildable vehicle types

   117

 */

   118

static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)

   119

{

   120

	switch (vt) {

   121

		default: NOT_REACHED();

   122

		case VEH_TRAIN:    return WC_TRAINS_LIST;

   123

		case VEH_ROAD:     return WC_ROADVEH_LIST;

   124

		case VEH_SHIP:     return WC_SHIPS_LIST;

   125

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

   126

	}

   127

}

   128

   129

/* Unified window procedure */

   130

void ShowVehicleViewWindow(const Vehicle *v);

   131

   132

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

   133

   134

typedef GUIList<const Vehicle*> GUIVehicleList;

   135

   136

struct VehicleListBase {

   137

	GUIVehicleList vehicles;  ///< The list of vehicles

   138

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

   139

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

   140

};

   141

   142

struct Sorting {

   143

	Listing aircraft;

   144

	Listing roadveh;

   145

	Listing ship;

   146

	Listing train;

   147

};

   148

   149

extern Sorting _sorting;

   150

   151

/* sorter stuff */

   152

void RebuildVehicleLists();

   153

void ResortVehicleLists();

   154

void SortVehicleList(VehicleListBase *vl);

   155

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

   156

   157

#endif /* VEHICLE_GUI_H */