vehicle_gui.h

Go to the documentation of this file.
00001 /* $Id$ */
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 <list>
00022 
00023 void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent);
00024 
00026 enum VehicleViewWindowWidgets {
00027   VVW_WIDGET_CAPTION,
00028   VVW_WIDGET_VIEWPORT,           
00029   VVW_WIDGET_START_STOP_VEH,
00030   VVW_WIDGET_CENTER_MAIN_VIEH,
00031   VVW_WIDGET_GOTO_DEPOT,
00032   VVW_WIDGET_REFIT_VEH,
00033   VVW_WIDGET_SHOW_ORDERS,
00034   VVW_WIDGET_SHOW_DETAILS,
00035   VVW_WIDGET_CLONE_VEH,
00036   VVW_WIDGET_SELECT_DEPOT_CLONE, 
00037   VVW_WIDGET_SELECT_REFIT_TURN,  
00038   VVW_WIDGET_TURN_AROUND,
00039   VVW_WIDGET_FORCE_PROCEED,
00040 };
00041 
00043 enum TrainDetailsWindowTabs {
00044   TDW_TAB_CARGO = 0, 
00045   TDW_TAB_INFO,      
00046   TDW_TAB_CAPACITY,  
00047   TDW_TAB_TOTALS,    
00048 };
00049 
00051 struct CargoDestSummaryData {
00052   SourceID dest;     
00053   SourceType type;   
00054   uint count;        
00055 
00056   CargoDestSummaryData(SourceID dest, SourceType type, uint count)
00057     : dest(dest), type(type), count(count)
00058   { }
00059 };
00060 
00062 typedef std::list<CargoDestSummaryData> CargoDestSummary;
00063 
00064 void AddVehicleCargoDestSummary(const Vehicle *v, CargoDestSummary *sum);
00065 
00066 int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number);
00067 
00068 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, int skip, VehicleID drag_dest = INVALID_VEHICLE);
00069 void DrawRoadVehImage(const Vehicle *v, int left, int right, int y, VehicleID selection, int skip = 0);
00070 void DrawShipImage(const Vehicle *v, int left, int right, int y, VehicleID selection);
00071 void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID selection);
00072 
00073 void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);
00074 
00075 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine);
00076 StringID GetCargoSubtypeText(const Vehicle *v);
00077 
00078 void ShowVehicleListWindow(const Vehicle *v);
00079 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);
00080 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);
00081 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);
00082 
00088 static inline uint GetVehicleHeight(VehicleType type)
00089 {
00090   return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;
00091 }
00092 
00093 int GetVehicleWidth(Vehicle *v);
00094 
00101 static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)
00102 {
00103   switch (vt) {
00104     default: NOT_REACHED();
00105     case VEH_TRAIN:    return WC_TRAINS_LIST;
00106     case VEH_ROAD:     return WC_ROADVEH_LIST;
00107     case VEH_SHIP:     return WC_SHIPS_LIST;
00108     case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
00109   }
00110 }
00111 
00112 /* Unified window procedure */
00113 void ShowVehicleViewWindow(const Vehicle *v);
00114 bool VehicleClicked(const Vehicle *v);
00115 void StartStopVehicle(const Vehicle *v, bool texteffect);
00116 
00117 Vehicle *CheckClickOnVehicle(const struct ViewPort *vp, int x, int y);
00118 
00119 void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, int skip);
00120 
00121 #endif /* VEHICLE_GUI_H */

Generated on Sun May 8 07:30:22 2011 for OpenTTD by  doxygen 1.6.1