1

/* $Id$ */

     2

     3

/** @file vehicle_gui.h */

     4

     5

#ifndef VEHICLE_GUI_H

     6

#define VEHICLE_GUI_H

     7

     8

#include "window_gui.h"

     9

#include "vehicle_type.h"

    10

#include "order_type.h"

    11

#include "station_type.h"

    12

#include "engine_type.h"

    13

    14

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

    15

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

    16

void InitializeVehiclesGuiList();

    17

    18

/* sorter stuff */

    19

void RebuildVehicleLists();

    20

void ResortVehicleLists();

    21

void SortVehicleList(vehiclelist_d *vl);

    22

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

    23

    24

#define PERIODIC_RESORT_DAYS 10

    25

    26

extern const StringID _vehicle_sort_listing[];

    27

    28

/** Constants of vehicle view widget indices */

    29

enum VehicleViewWindowWidgets {

    30

	VVW_WIDGET_CLOSEBOX = 0,

    31

	VVW_WIDGET_CAPTION,

    32

	VVW_WIDGET_STICKY,

    33

	VVW_WIDGET_PANEL,

    34

	VVW_WIDGET_VIEWPORT,

    35

	VVW_WIDGET_START_STOP_VEH,

    36

	VVW_WIDGET_CENTER_MAIN_VIEH,

    37

	VVW_WIDGET_GOTO_DEPOT,

    38

	VVW_WIDGET_REFIT_VEH,

    39

	VVW_WIDGET_SHOW_ORDERS,

    40

	VVW_WIDGET_SHOW_DETAILS,

    41

	VVW_WIDGET_CLONE_VEH,

    42

	VVW_WIDGET_EMPTY_BOTTOM_RIGHT,

    43

	VVW_WIDGET_RESIZE,

    44

	VVW_WIDGET_TURN_AROUND,

    45

	VVW_WIDGET_FORCE_PROCEED,

    46

};

    47

    48

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

    49

enum {

    50

	PLY_WND_PRC__OFFSET_TOP_WIDGET = 26,

    51

	PLY_WND_PRC__SIZE_OF_ROW_TINY  = 13,

    52

	PLY_WND_PRC__SIZE_OF_ROW_SMALL = 26,

    53

	PLY_WND_PRC__SIZE_OF_ROW_BIG   = 36,

    54

	PLY_WND_PRC__SIZE_OF_ROW_BIG2  = 39,

    55

};

    56

    57

/** Vehicle List Window type flags */

    58

enum {

    59

	VLW_STANDARD      = 0 << 8,

    60

	VLW_SHARED_ORDERS = 1 << 8,

    61

	VLW_STATION_LIST  = 2 << 8,

    62

	VLW_DEPOT_LIST    = 3 << 8,

    63

	VLW_GROUP_LIST    = 4 << 8,

    64

	VLW_MASK          = 0x700,

    65

};

    66

    67

static inline bool ValidVLWFlags(uint16 flags)

    68

{

    69

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

    70

}

    71

    72

void PlayerVehWndProc(Window *w, WindowEvent *e);

    73

    74

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

    75

    76

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

    77

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

    78

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

    79

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

    80

    81

void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);

    82

    83

void ChangeVehicleViewWindow(const Vehicle *from_v, const Vehicle *to_v);

    84

    85

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

    86

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

    87

    88

void ShowVehicleListWindow(const Vehicle *v);

    89

void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type);

    90

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

    91

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

    92

    93

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

    94

    95

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

    96

    97

static inline uint GetVehicleListHeight(VehicleType type)

    98

{

    99

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

   100

}

   101

   102

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

   103

 * @param vt vehicle type to check

   104

 * @return corresponding window class

   105

 * @note works only for player buildable vehicle types

   106

 */

   107

static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)

   108

{

   109

	switch (vt) {

   110

		default: NOT_REACHED();

   111

		case VEH_TRAIN:    return WC_TRAINS_LIST;

   112

		case VEH_ROAD:     return WC_ROADVEH_LIST;

   113

		case VEH_SHIP:     return WC_SHIPS_LIST;

   114

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

   115

	}

   116

}

   117

   118

/* Unified window procedure */

   119

void ShowVehicleViewWindow(const Vehicle *v);

   120

   121

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

   122

   123

#endif /* VEHICLE_GUI_H */