src/vehicle_gui.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file vehicle_gui.h Functions related to the vehicle's GUIs. */
  11
  12 #ifndef VEHICLE_GUI_H
  13 #define VEHICLE_GUI_H
  14
  15 #include "window_type.h"
  16 #include "vehicle_type.h"
  17 #include "order_type.h"
  18 #include "station_type.h"
  19 #include "engine_type.h"
  20 #include "company_type.h"
  21
  22 void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit = false);
  23
  24 /** The tabs in the train details window */
  25 enum TrainDetailsWindowTabs {
  26         TDW_TAB_CARGO = 0, ///< Tab with cargo carried by the vehicles
  27         TDW_TAB_INFO,      ///< Tab with name and value of the vehicles
  28         TDW_TAB_CAPACITY,  ///< Tab with cargo capacity of the vehicles
  29         TDW_TAB_TOTALS,    ///< Tab with sum of total cargo transported
  30 };
  31
  32 /** Special values for vehicle-related windows for the data parameter of #InvalidateWindowData. */
  33 enum VehicleInvalidateWindowData {
  34         VIWD_REMOVE_ALL_ORDERS = -1, ///< Removed / replaced all orders (after deleting / sharing).
  35         VIWD_MODIFY_ORDERS     = -2, ///< Other order modifications.
  36         VIWD_CONSIST_CHANGED   = -3, ///< Vehicle composition was changed.
  37         VIWD_AUTOREPLACE       = -4, ///< Autoreplace replaced the vehicle.
  38 };
  39
  40 int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number);
  41
  42 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest = INVALID_VEHICLE);
  43 void DrawRoadVehImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip = 0);
  44 void DrawShipImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
  45 void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
  46
  47 void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);
  48
  49 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine);
  50 StringID GetCargoSubtypeText(const Vehicle *v);
  51
  52 void ShowVehicleListWindow(const Vehicle *v);
  53 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);
  54 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);
  55 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);
  56
  57 /**
  58  * Get the height of a single vehicle in the GUIs.
  59  * @param type the vehicle type to look at
  60  * @return the height
  61  */
  62 static inline uint GetVehicleHeight(VehicleType type)
  63 {
  64         return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;
  65 }
  66
  67 int GetVehicleWidth(Vehicle *v, EngineImageType image_type);
  68
  69 /** Dimensions of a cell in the purchase/depot windows. */
  70 struct VehicleCellSize {
  71         uint height;       ///< Vehicle cell height.
  72         uint extend_left;  ///< Extend of the cell to the left.
  73         uint extend_right; ///< Extend of the cell to the right.
  74 };
  75
  76 VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type);
  77
  78 /**
  79  * Get WindowClass for vehicle list of given vehicle type
  80  * @param vt vehicle type to check
  81  * @return corresponding window class
  82  * @note works only for company buildable vehicle types
  83  */
  84 static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)
  85 {
  86         switch (vt) {
  87                 default: NOT_REACHED();
  88                 case VEH_TRAIN:    return WC_TRAINS_LIST;
  89                 case VEH_ROAD:     return WC_ROADVEH_LIST;
  90                 case VEH_SHIP:     return WC_SHIPS_LIST;
  91                 case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
  92         }
  93 }
  94
  95 /* Unified window procedure */
  96 void ShowVehicleViewWindow(const Vehicle *v);
  97 bool VehicleClicked(const Vehicle *v);
  98 void StartStopVehicle(const Vehicle *v, bool texteffect);
  99
 100 Vehicle *CheckClickOnVehicle(const struct ViewPort *vp, int x, int y);
 101
 102 void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip);
 103
 104 #endif /* VEHICLE_GUI_H */