OpenTTD Source: src/vehicle_gui.h Source File

OpenTTD Source 13.2.1

vehicle_gui.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #ifndef VEHICLE_GUI_H
11 #define VEHICLE_GUI_H
12
13 #include "window_type.h"
14 #include "vehicle_type.h"
15 #include "vehicle_gui_base.h"
16 #include "vehiclelist.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
25 enum TrainDetailsWindowTabs {
26 TDW_TAB_CARGO = 0,
27 TDW_TAB_INFO,
28 TDW_TAB_CAPACITY,
29 TDW_TAB_TOTALS,
30 };
31
33 enum VehicleInvalidateWindowData {
34 VIWD_REMOVE_ALL_ORDERS = -1,
35 VIWD_MODIFY_ORDERS = -2,
36 VIWD_CONSIST_CHANGED = -3,
37 VIWD_AUTOREPLACE = -4,
38 };
39
41 struct TestedEngineDetails {
42 Money cost;
43 CargoID cargo;
44 uint capacity;
45 uint16 mail_capacity;
46 CargoArray all_capacities;
47
48 void FillDefaultCapacities(const Engine *e);
49 };
50
51 int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number, TestedEngineDetails &te);
52
53 void DrawTrainImage(const Train *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest = INVALID_VEHICLE);
54 void DrawRoadVehImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip = 0);
55 void DrawShipImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type);
56 void DrawAircraftImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type);
57
58 void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);
59
60 uint ShowRefitOptionsList(int left, int right, int y, EngineID engine);
61 StringID GetCargoSubtypeText(const Vehicle *v);
62
63 void ShowVehicleListWindow(const Vehicle *v);
64 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);
65 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);
66 void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);
67
73 static inline uint GetVehicleHeight(VehicleType type)
74 {
75 return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;
76 }
77
78 int GetSingleVehicleWidth(const Vehicle *v, EngineImageType image_type);
79 int GetVehicleWidth(const Vehicle *v, EngineImageType image_type);
80
82 struct VehicleCellSize {
83 uint height;
84 uint extend_left;
85 uint extend_right;
86 };
87
88 VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type);
89
96 static inline WindowClass GetWindowClassForVehicleType(VehicleType vt)
97 {
98 switch (vt) {
99 default: NOT_REACHED();
100 case VEH_TRAIN: return WC_TRAINS_LIST;
101 case VEH_ROAD: return WC_ROADVEH_LIST;
102 case VEH_SHIP: return WC_SHIPS_LIST;
103 case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
104 }
105 }
106
107 /* Unified window procedure */
108 void ShowVehicleViewWindow(const Vehicle *v);
109 bool VehicleClicked(const Vehicle *v);
110 bool VehicleClicked(VehicleList::const_iterator begin, VehicleList::const_iterator end);
111 bool VehicleClicked(const GUIVehicleGroup &vehgroup);
112 void StartStopVehicle(const Vehicle *v, bool texteffect);
113
114 Vehicle *CheckClickOnVehicle(const struct Viewport *vp, int x, int y);
115
116 void DrawVehicleImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip);
117 void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type);
118
119 #endif /* VEHICLE_GUI_H */
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
StartStopVehicle
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
Definition: vehicle_gui.cpp:2806
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
WC_ROADVEH_LIST
@ WC_ROADVEH_LIST
Road vehicle list; Window numbers:
Definition: window_type.h:307
DrawTrainImage
void DrawTrainImage(const Train *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest=INVALID_VEHICLE)
Draws an image of a whole train.
Definition: train_gui.cpp:94
VehicleCellSize::height
uint height
Vehicle cell height.
Definition: vehicle_gui.h:83
TDW_TAB_INFO
@ TDW_TAB_INFO
Tab with name and value of the vehicles.
Definition: vehicle_gui.h:27
TestedEngineDetails::all_capacities
CargoArray all_capacities
Capacities for all cargoes.
Definition: vehicle_gui.h:46
TestedEngineDetails::mail_capacity
uint16 mail_capacity
Mail capacity if available.
Definition: vehicle_gui.h:45
GetVehicleWidth
int GetVehicleWidth(const Vehicle *v, EngineImageType image_type)
Get the width of a vehicle (including all parts of the consist) in pixels.
Definition: vehicle_gui.cpp:3396
TrainDetailsWindowTabs
TrainDetailsWindowTabs
The tabs in the train details window.
Definition: vehicle_gui.h:25
vehiclelist.h
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:82
window_type.h
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
DrawRoadVehImage
void DrawRoadVehImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip=0)
Draws an image of a road vehicle chain.
Definition: roadveh_gui.cpp:127
TestedEngineDetails::cargo
CargoID cargo
Cargo type.
Definition: vehicle_gui.h:43
VehicleCellSize::extend_right
uint extend_right
Extend of the cell to the right.
Definition: vehicle_gui.h:85
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:86
Engine
Definition: engine_base.h:36
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:224
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
DrawAircraftImage
void DrawAircraftImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type)
Draws an image of an aircraft.
Definition: aircraft_gui.cpp:79
TestedEngineDetails::capacity
uint capacity
Cargo capacity.
Definition: vehicle_gui.h:44
CheckClickOnVehicle
Vehicle * CheckClickOnVehicle(const Viewport *vp, int x, int y)
Find the vehicle close to the clicked coordinates.
Definition: vehicle.cpp:1216
DrawVehicleImage
void DrawVehicleImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip)
Draws an image of a vehicle chain.
Definition: vehicle_gui.cpp:1608
GetVehicleImageCellSize
VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type)
Get the GUI cell size for a vehicle image.
Definition: depot_gui.cpp:162
TDW_TAB_TOTALS
@ TDW_TAB_TOTALS
Tab with sum of total cargo transported.
Definition: vehicle_gui.h:29
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
Viewport
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:22
GetVehicleHeight
static uint GetVehicleHeight(VehicleType type)
Get the height of a single vehicle in the GUIs.
Definition: vehicle_gui.h:73
ShowRefitOptionsList
uint ShowRefitOptionsList(int left, int right, int y, EngineID engine)
Display list of cargo types of the engine, for the purchase information window.
Definition: vehicle_gui.cpp:1251
INVALID_VEHICLE
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
vehicle_gui_base.h
Train
'Train' is either a loco or a wagon.
Definition: train.h:89
WC_SHIPS_LIST
@ WC_SHIPS_LIST
Ships list; Window numbers:
Definition: window_type.h:313
TestedEngineDetails
Extra information about refitted cargo and capacity.
Definition: vehicle_gui.h:41
WindowClass
WindowClass
Window classes.
Definition: window_type.h:37
WC_TRAINS_LIST
@ WC_TRAINS_LIST
Trains list; Window numbers:
Definition: window_type.h:301
GetCargoSubtypeText
StringID GetCargoSubtypeText(const Vehicle *v)
Get the cargo subtype text from NewGRF for the vehicle details window.
Definition: vehicle_gui.cpp:1280
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
DrawShipImage
void DrawShipImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type)
Draws an image of a ship.
Definition: ship_gui.cpp:30
VIWD_CONSIST_CHANGED
@ VIWD_CONSIST_CHANGED
Vehicle composition was changed.
Definition: vehicle_gui.h:36
GetSingleVehicleWidth
int GetSingleVehicleWidth(const Vehicle *v, EngineImageType image_type)
Get the width of a vehicle (part) in pixels.
Definition: vehicle_gui.cpp:3372
GetWindowClassForVehicleType
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:96
SetMouseCursorVehicle
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type)
Set the mouse cursor to look like a vehicle.
Definition: vehicle_gui.cpp:3414
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
vehicle_type.h
GUIVehicleGroup
Definition: vehicle_gui_base.h:28
engine_type.h
TDW_TAB_CAPACITY
@ TDW_TAB_CAPACITY
Tab with cargo capacity of the vehicles.
Definition: vehicle_gui.h:28
VIWD_AUTOREPLACE
@ VIWD_AUTOREPLACE
Autoreplace replaced the vehicle.
Definition: vehicle_gui.h:37
ShowVehicleRefitWindow
void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit=false)
Show the refit window for a vehicle.
Definition: vehicle_gui.cpp:1243
TestedEngineDetails::cost
Money cost
Refit cost.
Definition: vehicle_gui.h:42
VehicleCellSize
Dimensions of a cell in the purchase/depot windows.
Definition: vehicle_gui.h:82
DrawVehiclePurchaseInfo
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.
Definition: build_vehicle_gui.cpp:902
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
VehicleInvalidateWindowData
VehicleInvalidateWindowData
Special values for vehicle-related windows for the data parameter of InvalidateWindowData.
Definition: vehicle_gui.h:33
OverflowSafeInt< int64 >
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
Window
Data structure for an opened window.
Definition: window_gui.h:213
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
VIWD_MODIFY_ORDERS
@ VIWD_MODIFY_ORDERS
Other order modifications.
Definition: vehicle_gui.h:35
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:69
VIWD_REMOVE_ALL_ORDERS
@ VIWD_REMOVE_ALL_ORDERS
Removed / replaced all orders (after deleting / sharing).
Definition: vehicle_gui.h:34
WC_AIRCRAFT_LIST
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
Definition: window_type.h:319
order_type.h
company_type.h
VehicleCellSize::extend_left
uint extend_left
Extend of the cell to the left.
Definition: vehicle_gui.h:84
ShowVehicleViewWindow
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
Definition: vehicle_gui.cpp:3295
VehicleClicked
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Definition: vehicle_gui.cpp:3305
station_type.h
TDW_TAB_CARGO
@ TDW_TAB_CARGO
Tab with cargo carried by the vehicles.
Definition: vehicle_gui.h:26