OpenTTD
vehicle_gui.h
Go to the documentation of this file.
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 
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 
30 };
31 
38 };
39 
44  uint16 capacity;
45  uint16 mail_capacity;
46 };
47 
48 int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number, TestedEngineDetails &te);
49 
50 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest = INVALID_VEHICLE);
51 void DrawRoadVehImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip = 0);
52 void DrawShipImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
53 void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type);
54 
55 void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);
56 
57 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine);
59 
60 void ShowVehicleListWindow(const Vehicle *v);
61 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);
62 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);
63 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);
64 
70 static inline uint GetVehicleHeight(VehicleType type)
71 {
72  return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;
73 }
74 
75 int GetSingleVehicleWidth(const Vehicle *v, EngineImageType image_type);
76 int GetVehicleWidth(const Vehicle *v, EngineImageType image_type);
77 
80  uint height;
81  uint extend_left;
82  uint extend_right;
83 };
84 
86 
94 {
95  switch (vt) {
96  default: NOT_REACHED();
97  case VEH_TRAIN: return WC_TRAINS_LIST;
98  case VEH_ROAD: return WC_ROADVEH_LIST;
99  case VEH_SHIP: return WC_SHIPS_LIST;
100  case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
101  }
102 }
103 
104 /* Unified window procedure */
105 void ShowVehicleViewWindow(const Vehicle *v);
106 bool VehicleClicked(const Vehicle *v);
107 void StartStopVehicle(const Vehicle *v, bool texteffect);
108 
109 Vehicle *CheckClickOnVehicle(const struct ViewPort *vp, int x, int y);
110 
111 void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip);
112 void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type);
113 
114 #endif /* VEHICLE_GUI_H */
Owner
Enum for all companies/owners.
Definition: company_type.h:20
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
Types related to orders.
Train vehicle type.
Definition: vehicle_type.h:26
Vehicle composition was changed.
Definition: vehicle_gui.h:36
Types related to windows.
uint16 capacity
Cargo capacity.
Definition: vehicle_gui.h:44
Other order modifications.
Definition: vehicle_gui.h:35
uint ShowRefitOptionsList(int left, int right, int y, EngineID engine)
Display list of cargo types of the engine, for the purchase information window.
Ship vehicle type.
Definition: vehicle_type.h:28
Types related to engines.
Tab with cargo capacity of the vehicles.
Definition: vehicle_gui.h:28
VehicleType
Available vehicle types.
Definition: vehicle_type.h:23
uint extend_right
Extend of the cell to the right.
Definition: vehicle_gui.h:82
Vehicle data structure.
Definition: vehicle_base.h:212
uint height
Vehicle cell height.
Definition: vehicle_gui.h:80
WindowClass
Window classes.
Definition: window_type.h:39
StringID GetCargoSubtypeText(const Vehicle *v)
Get the cargo subtype text from NewGRF for the vehicle details window.
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:57
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type)
Set the mouse cursor to look like a vehicle.
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:87
uint16 mail_capacity
Mail capacity if available.
Definition: vehicle_gui.h:45
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
Data structure for an opened window.
Definition: window_gui.h:278
Autoreplace replaced the vehicle.
Definition: vehicle_gui.h:37
Types related to stations.
void DrawVehicleImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip)
Draws an image of a vehicle chain.
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Extra information about refitted cargo and capacity.
Definition: vehicle_gui.h:41
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
int GetVehicleWidth(const Vehicle *v, EngineImageType image_type)
Get the width of a vehicle (including all parts of the consist) in pixels.
Removed / replaced all orders (after deleting / sharing).
Definition: vehicle_gui.h:34
VehicleInvalidateWindowData
Special values for vehicle-related windows for the data parameter of InvalidateWindowData.
Definition: vehicle_gui.h:33
void DrawAircraftImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type)
Draws an image of an aircraft.
Road vehicle list; Window numbers:
Definition: window_type.h:309
void DrawRoadVehImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip=0)
Draws an image of a road vehicle chain.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
Tab with cargo carried by the vehicles.
Definition: vehicle_gui.h:26
void DrawShipImage(const Vehicle *v, int left, int right, int y, VehicleID selection, EngineImageType image_type)
Draws an image of a ship.
Definition: ship_gui.cpp:34
&#39;Train&#39; is either a loco or a wagon.
Definition: train.h:87
TrainDetailsWindowTabs
The tabs in the train details window.
Definition: vehicle_gui.h:25
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:24
void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit=false)
Show the refit window for a vehicle.
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:23
Ships list; Window numbers:
Definition: window_type.h:315
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
Tab with sum of total cargo transported.
Definition: vehicle_gui.h:29
Types related to vehicles.
Trains list; Window numbers:
Definition: window_type.h:303
Dimensions of a cell in the purchase/depot windows.
Definition: vehicle_gui.h:79
VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type)
Get the GUI cell size for a vehicle image.
Definition: depot_gui.cpp:160
Vehicle * CheckClickOnVehicle(const ViewPort *vp, int x, int y)
Find the vehicle close to the clicked coordinates.
Definition: vehicle.cpp:1170
static uint GetVehicleHeight(VehicleType type)
Get the height of a single vehicle in the GUIs.
Definition: vehicle_gui.h:70
Aircraft list; Window numbers:
Definition: window_type.h:321
void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest=INVALID_VEHICLE)
Draws an image of a whole train.
Definition: train_gui.cpp:95
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:93
Types related to companies.
Aircraft vehicle type.
Definition: vehicle_type.h:29
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:17
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
uint extend_left
Extend of the cell to the left.
Definition: vehicle_gui.h:81
int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number, TestedEngineDetails &te)
Draw the purchase info details of a vehicle at a given location.
Money cost
Refit cost.
Definition: vehicle_gui.h:42
int GetSingleVehicleWidth(const Vehicle *v, EngineImageType image_type)
Get the width of a vehicle (part) in pixels.
CargoID cargo
Cargo type.
Definition: vehicle_gui.h:43
Road vehicle type.
Definition: vehicle_type.h:27
Tab with name and value of the vehicles.
Definition: vehicle_gui.h:27