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 "window_type.h"

     9

#include "vehicle_type.h"

    10

#include "order_type.h"

    11

#include "station_type.h"

    12

#include "engine_type.h"

    13

#include "waypoint.h"

    14

    15

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

    16

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

    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

/** Vehicle List Window type flags */

    39

enum {

    40

	VLW_STANDARD      = 0 << 8,

    41

	VLW_SHARED_ORDERS = 1 << 8,

    42

	VLW_STATION_LIST  = 2 << 8,

    43

	VLW_DEPOT_LIST    = 3 << 8,

    44

	VLW_GROUP_LIST    = 4 << 8,

    45

	VLW_WAYPOINT_LIST = 5 << 8,

    46

	VLW_MASK          = 0x700,

    47

};

    48

    49

static inline bool ValidVLWFlags(uint16 flags)

    50

{

    51

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

    52

}

    53

    54

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

    55

    56

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

    57

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

    58

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

    59

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

    60

    61

void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);

    62

    63

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

    64

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

    65

    66

void ShowVehicleListWindow(const Vehicle *v);

    67

void ShowVehicleListWindow(const Waypoint *wp);

    68

void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);

    69

void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);

    70

void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);

    71

    72

    73

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

    74

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

    75

void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);

    76

    77

static inline uint GetVehicleListHeight(VehicleType type)

    78

{

    79

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

    80

}

    81

    82

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

    83

 * @param vt vehicle type to check

    84

 * @return corresponding window class

    85

 * @note works only for company buildable vehicle types

    86

 */

    87

static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)

    88

{

    89

	switch (vt) {

    90

		default: NOT_REACHED();

    91

		case VEH_TRAIN:    return WC_TRAINS_LIST;

    92

		case VEH_ROAD:     return WC_ROADVEH_LIST;

    93

		case VEH_SHIP:     return WC_SHIPS_LIST;

    94

		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;

    95

	}

    96

}

    97

    98

/* Unified window procedure */

    99

void ShowVehicleViewWindow(const Vehicle *v);

   100

   101

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

   102

   103

#endif /* VEHICLE_GUI_H */