vehicle_gui.h

Go to the documentation of this file.
00001 /* $Id: vehicle_gui.h 24839 2012-12-23 01:00:25Z michi_cc $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifndef VEHICLE_GUI_H
00013 #define VEHICLE_GUI_H
00014 
00015 #include "window_type.h"
00016 #include "vehicle_type.h"
00017 #include "order_type.h"
00018 #include "station_type.h"
00019 #include "engine_type.h"
00020 #include "company_type.h"
00021 
00022 void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit = false);
00023 
00025 enum TrainDetailsWindowTabs {
00026   TDW_TAB_CARGO = 0, 
00027   TDW_TAB_INFO,      
00028   TDW_TAB_CAPACITY,  
00029   TDW_TAB_TOTALS,    
00030 };
00031 
00033 enum VehicleInvalidateWindowData {
00034   VIWD_REMOVE_ALL_ORDERS = -1, 
00035   VIWD_MODIFY_ORDERS     = -2, 
00036   VIWD_CONSIST_CHANGED   = -3, 
00037   VIWD_AUTOREPLACE       = -4, 
00038 };
00039 
00040 int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number);
00041 
00042 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest = INVALID_VEHICLE);
00043 void DrawRoadVehImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip = 0);
00044 void DrawShipImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
00045 void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
00046 
00047 void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);
00048 
00049 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine);
00050 StringID GetCargoSubtypeText(const Vehicle *v);
00051 
00052 void ShowVehicleListWindow(const Vehicle *v);
00053 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);
00054 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);
00055 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);
00056 
00062 static inline uint GetVehicleHeight(VehicleType type)
00063 {
00064   return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;
00065 }
00066 
00067 int GetVehicleWidth(Vehicle *v, EngineImageType image_type);
00068 
00070 struct VehicleCellSize {
00071   uint height;       
00072   uint extend_left;  
00073   uint extend_right; 
00074 };
00075 
00076 VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type);
00077 
00084 static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)
00085 {
00086   switch (vt) {
00087     default: NOT_REACHED();
00088     case VEH_TRAIN:    return WC_TRAINS_LIST;
00089     case VEH_ROAD:     return WC_ROADVEH_LIST;
00090     case VEH_SHIP:     return WC_SHIPS_LIST;
00091     case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
00092   }
00093 }
00094 
00095 /* Unified window procedure */
00096 void ShowVehicleViewWindow(const Vehicle *v);
00097 bool VehicleClicked(const Vehicle *v);
00098 void StartStopVehicle(const Vehicle *v, bool texteffect);
00099 
00100 Vehicle *CheckClickOnVehicle(const struct ViewPort *vp, int x, int y);
00101 
00102 void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip);
00103 
00104 #endif /* VEHICLE_GUI_H */