vehicle_gui.h

Go to the documentation of this file.
00001 /* $Id: vehicle_gui.h 23528 2011-12-15 22:22:55Z truebrain $ */
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 #include "widgets/vehicle_widget.h"
00022 
00023 void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit = false);
00024 
00026 enum TrainDetailsWindowTabs {
00027   TDW_TAB_CARGO = 0, 
00028   TDW_TAB_INFO,      
00029   TDW_TAB_CAPACITY,  
00030   TDW_TAB_TOTALS,    
00031 };
00032 
00033 int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number);
00034 
00035 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest = INVALID_VEHICLE);
00036 void DrawRoadVehImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip = 0);
00037 void DrawShipImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
00038 void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
00039 
00040 void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);
00041 
00042 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine);
00043 StringID GetCargoSubtypeText(const Vehicle *v);
00044 
00045 void ShowVehicleListWindow(const Vehicle *v);
00046 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);
00047 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);
00048 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);
00049 
00055 static inline uint GetVehicleHeight(VehicleType type)
00056 {
00057   return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;
00058 }
00059 
00060 int GetVehicleWidth(Vehicle *v, EngineImageType image_type);
00061 
00068 static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)
00069 {
00070   switch (vt) {
00071     default: NOT_REACHED();
00072     case VEH_TRAIN:    return WC_TRAINS_LIST;
00073     case VEH_ROAD:     return WC_ROADVEH_LIST;
00074     case VEH_SHIP:     return WC_SHIPS_LIST;
00075     case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
00076   }
00077 }
00078 
00079 /* Unified window procedure */
00080 void ShowVehicleViewWindow(const Vehicle *v);
00081 bool VehicleClicked(const Vehicle *v);
00082 void StartStopVehicle(const Vehicle *v, bool texteffect);
00083 
00084 Vehicle *CheckClickOnVehicle(const struct ViewPort *vp, int x, int y);
00085 
00086 void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip);
00087 
00088 #endif /* VEHICLE_GUI_H */