tron@2186: /* $Id$ */ tron@2186: rubidium@10429: /** @file vehicle_gui.h Functions related to the vehicle's GUIs. */ belugas@6919: darkvater@164: #ifndef VEHICLE_GUI_H darkvater@164: #define VEHICLE_GUI_H darkvater@164: rubidium@10596: #include "sortlist_type.h" rubidium@10596: #include "window_type.h" rubidium@8640: #include "vehicle_type.h" rubidium@9267: #include "order_type.h" rubidium@9265: #include "station_type.h" rubidium@9273: #include "engine_type.h" matthijs@1752: Darkvater@2436: void DrawVehicleProfitButton(const Vehicle *v, int x, int y); bjarni@4712: void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order); darkvater@164: darkvater@168: #define PERIODIC_RESORT_DAYS 10 darkvater@164: rubidium@7139: extern const StringID _vehicle_sort_listing[]; rubidium@7139: smatz@8846: /** Constants of vehicle view widget indices */ smatz@8846: enum VehicleViewWindowWidgets { smatz@8846: VVW_WIDGET_CLOSEBOX = 0, smatz@8846: VVW_WIDGET_CAPTION, smatz@8846: VVW_WIDGET_STICKY, smatz@8846: VVW_WIDGET_PANEL, smatz@8846: VVW_WIDGET_VIEWPORT, smatz@8846: VVW_WIDGET_START_STOP_VEH, smatz@8846: VVW_WIDGET_CENTER_MAIN_VIEH, smatz@8846: VVW_WIDGET_GOTO_DEPOT, smatz@8846: VVW_WIDGET_REFIT_VEH, smatz@8846: VVW_WIDGET_SHOW_ORDERS, smatz@8846: VVW_WIDGET_SHOW_DETAILS, smatz@8846: VVW_WIDGET_CLONE_VEH, smatz@8846: VVW_WIDGET_EMPTY_BOTTOM_RIGHT, smatz@8846: VVW_WIDGET_RESIZE, smatz@8846: VVW_WIDGET_TURN_AROUND, smatz@8846: VVW_WIDGET_FORCE_PROCEED, smatz@8846: }; smatz@8846: smatz@8846: /** Start of functions regarding vehicle list windows */ rubidium@7139: enum { rubidium@7139: PLY_WND_PRC__OFFSET_TOP_WIDGET = 26, rubidium@7139: PLY_WND_PRC__SIZE_OF_ROW_TINY = 13, rubidium@7139: PLY_WND_PRC__SIZE_OF_ROW_SMALL = 26, rubidium@7139: PLY_WND_PRC__SIZE_OF_ROW_BIG = 36, rubidium@7139: PLY_WND_PRC__SIZE_OF_ROW_BIG2 = 39, rubidium@7139: }; rubidium@7139: smatz@8846: /** Vehicle List Window type flags */ bjarni@4449: enum { Darkvater@4546: VLW_STANDARD = 0 << 8, bjarni@4449: VLW_SHARED_ORDERS = 1 << 8, bjarni@4449: VLW_STATION_LIST = 2 << 8, bjarni@4681: VLW_DEPOT_LIST = 3 << 8, rubidium@7139: VLW_GROUP_LIST = 4 << 8, Darkvater@4546: VLW_MASK = 0x700, bjarni@4449: }; bjarni@4449: bjarni@4506: static inline bool ValidVLWFlags(uint16 flags) bjarni@4506: { rubidium@7139: return (flags == VLW_STANDARD || flags == VLW_SHARED_ORDERS || flags == VLW_STATION_LIST || flags == VLW_DEPOT_LIST || flags == VLW_GROUP_LIST); bjarni@4506: } bjarni@4506: maedhros@6711: int DrawVehiclePurchaseInfo(int x, int y, uint w, EngineID engine_number); bjarni@842: rubidium@8640: void DrawTrainImage(const Vehicle *v, int x, int y, VehicleID selection, int count, int skip); rubidium@8640: void DrawRoadVehImage(const Vehicle *v, int x, int y, VehicleID selection, int count); bjarni@4442: void DrawShipImage(const Vehicle *v, int x, int y, VehicleID selection); Darkvater@4542: void DrawAircraftImage(const Vehicle *v, int x, int y, VehicleID selection); bjarni@4442: rubidium@7134: void ShowBuildVehicleWindow(TileIndex tile, VehicleType type); bjarni@4442: peter1138@4932: uint ShowAdditionalText(int x, int y, uint w, EngineID engine); peter1138@4932: uint ShowRefitOptionsList(int x, int y, uint w, EngineID engine); bjarni@2552: bjarni@5996: void ShowVehicleListWindow(const Vehicle *v); rubidium@7134: void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type); rubidium@7134: void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type, StationID station); rubidium@7134: void ShowVehicleListWindow(PlayerID player, VehicleType vehicle_type, TileIndex depot_tile); bjarni@4668: rubidium@7139: void DrawSmallOrderList(const Vehicle *v, int x, int y); bjarni@4734: rubidium@8640: void DrawVehicleImage(const Vehicle *v, int x, int y, VehicleID selection, int count, int skip); bjarni@4734: bjarni@10371: bjarni@10371: /* ChangeVehicleViewWindow() moves all windows for one vehicle to another vehicle. bjarni@10371: * For ease of use it can be called with both Vehicle pointers and VehicleIDs. */ bjarni@10371: void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index); bjarni@10371: rubidium@7134: static inline uint GetVehicleListHeight(VehicleType type) bjarni@4796: { rubidium@6585: return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24; bjarni@4796: } bjarni@4796: smatz@10321: /** Get WindowClass for vehicle list of given vehicle type smatz@10321: * @param vt vehicle type to check smatz@10321: * @return corresponding window class smatz@10321: * @note works only for player buildable vehicle types smatz@10321: */ smatz@10321: static inline WindowClass GetWindowClassForVehicleType(VehicleType vt) smatz@10321: { smatz@10321: switch (vt) { smatz@10321: default: NOT_REACHED(); smatz@10321: case VEH_TRAIN: return WC_TRAINS_LIST; smatz@10321: case VEH_ROAD: return WC_ROADVEH_LIST; smatz@10321: case VEH_SHIP: return WC_SHIPS_LIST; smatz@10321: case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST; smatz@10321: } smatz@10321: } smatz@10321: rubidium@7982: /* Unified window procedure */ rubidium@7982: void ShowVehicleViewWindow(const Vehicle *v); rubidium@7982: rubidium@10502: Vehicle *CheckClickOnVehicle(const struct ViewPort *vp, int x, int y); rubidium@10502: rubidium@10502: typedef GUIList GUIVehicleList; rubidium@10502: rubidium@10503: struct VehicleListBase { rubidium@10502: GUIVehicleList vehicles; ///< The list of vehicles rubidium@10502: Listing *sorting; ///< Pointer to the vehicle type related sorting. rubidium@10502: VehicleType vehicle_type; ///< The vehicle type that is sorted rubidium@10502: }; rubidium@10502: rubidium@10502: struct Sorting { rubidium@10502: Listing aircraft; rubidium@10502: Listing roadveh; rubidium@10502: Listing ship; rubidium@10502: Listing train; rubidium@10502: }; rubidium@10502: rubidium@10502: extern Sorting _sorting; rubidium@10502: rubidium@10502: /* sorter stuff */ rubidium@10503: void SortVehicleList(VehicleListBase *vl); rubidium@10503: void BuildVehicleList(VehicleListBase *vl, PlayerID owner, uint16 index, uint16 window_type); rubidium@9269: darkvater@164: #endif /* VEHICLE_GUI_H */