OpenTTD Source: src/vehicle_gui_base.h Source File

OpenTTD Source 14.1

vehicle_gui_base.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_BASE_H
11 #define VEHICLE_GUI_BASE_H
12
13 #include "cargo_type.h"
14 #include "timer/timer_game_calendar.h"
15 #include "economy_type.h"
16 #include "sortlist_type.h"
17 #include "vehicle_base.h"
18 #include "vehiclelist.h"
19 #include "window_gui.h"
20 #include "widgets/dropdown_type.h"
21
22 typedef GUIList<const Vehicle*, std::nullptr_t, CargoID> GUIVehicleList;
23
24 struct GUIVehicleGroup {
25 VehicleList::const_iterator vehicles_begin;
26 VehicleList::const_iterator vehicles_end;
27
28 GUIVehicleGroup(VehicleList::const_iterator vehicles_begin, VehicleList::const_iterator vehicles_end)
29 : vehicles_begin(vehicles_begin), vehicles_end(vehicles_end) {}
30
31 std::ptrdiff_t NumVehicles() const
32 {
33 return std::distance(this->vehicles_begin, this->vehicles_end);
34 }
35
36 const Vehicle *GetSingleVehicle() const
37 {
38 assert(this->NumVehicles() == 1);
39 return this->vehicles_begin[0];
40 }
41
42 Money GetDisplayProfitThisYear() const
43 {
44 return std::accumulate(this->vehicles_begin, this->vehicles_end, (Money)0, [](Money acc, const Vehicle *v) {
45 return acc + v->GetDisplayProfitThisYear();
46 });
47 }
48
49 Money GetDisplayProfitLastYear() const
50 {
51 return std::accumulate(this->vehicles_begin, this->vehicles_end, (Money)0, [](Money acc, const Vehicle *v) {
52 return acc + v->GetDisplayProfitLastYear();
53 });
54 }
55
56 TimerGameEconomy::Date GetOldestVehicleAge() const
57 {
58 const Vehicle *oldest = *std::max_element(this->vehicles_begin, this->vehicles_end, [](const Vehicle *v_a, const Vehicle *v_b) {
59 return v_a->economy_age < v_b->economy_age;
60 });
61 return oldest->economy_age;
62 }
63 };
64
65 typedef GUIList<GUIVehicleGroup, std::nullptr_t, CargoID> GUIVehicleGroupList;
66
67 struct BaseVehicleListWindow : public Window {
68
69 enum GroupBy : byte {
70 GB_NONE,
71 GB_SHARED_ORDERS,
72
73 GB_END,
74 };
75
76 GroupBy grouping;
77 VehicleList vehicles;
78 GUIVehicleGroupList vehgroups;
79 Listing *sorting;
80 byte unitnumber_digits;
81 Scrollbar *vscroll;
82 VehicleListIdentifier vli;
83 VehicleID vehicle_sel;
84 CargoID cargo_filter_criteria;
85 uint order_arrow_width;
86 CargoTypes used_cargoes;
87
88 typedef GUIVehicleGroupList::SortFunction VehicleGroupSortFunction;
89 typedef GUIVehicleList::SortFunction VehicleIndividualSortFunction;
90
91 enum ActionDropdownItem {
92 ADI_REPLACE,
93 ADI_SERVICE,
94 ADI_DEPOT,
95 ADI_ADD_SHARED,
96 ADI_REMOVE_ALL,
97 ADI_CREATE_GROUP,
98 };
99
100 static const StringID vehicle_depot_name[];
101 static const StringID vehicle_group_by_names[];
102 static const StringID vehicle_group_none_sorter_names_calendar[];
103 static const StringID vehicle_group_none_sorter_names_wallclock[];
104 static const StringID vehicle_group_shared_orders_sorter_names_calendar[];
105 static const StringID vehicle_group_shared_orders_sorter_names_wallclock[];
106 static VehicleGroupSortFunction * const vehicle_group_none_sorter_funcs[];
107 static VehicleGroupSortFunction * const vehicle_group_shared_orders_sorter_funcs[];
108
109 BaseVehicleListWindow(WindowDesc *desc, WindowNumber wno);
110
111 void OnInit() override;
112
113 void UpdateSortingFromGrouping();
114
115 void DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const;
116 void UpdateVehicleGroupBy(GroupBy group_by);
117 void SortVehicleList();
118 void BuildVehicleList();
119 void SetCargoFilter(byte index);
120 void SetCargoFilterArray();
121 void FilterVehicleList();
122 StringID GetCargoFilterLabel(CargoID cid) const;
123 DropDownList BuildCargoDropDownList(bool full) const;
124 Dimension GetActionDropdownSize(bool show_autoreplace, bool show_group, bool show_create);
125 DropDownList BuildActionDropdownList(bool show_autoreplace, bool show_group, bool show_create);
126
127 const StringID *GetVehicleSorterNames();
128
129 VehicleGroupSortFunction * const *GetVehicleSorterFuncs()
130 {
131 switch (this->grouping) {
132 case GB_NONE:
133 return vehicle_group_none_sorter_funcs;
134 case GB_SHARED_ORDERS:
135 return vehicle_group_shared_orders_sorter_funcs;
136 default:
137 NOT_REACHED();
138 }
139 }
140 };
141
142 uint GetVehicleListHeight(VehicleType type, uint divisor = 1);
143
144 struct Sorting {
145 Listing aircraft;
146 Listing roadveh;
147 Listing ship;
148 Listing train;
149 };
150
151 extern BaseVehicleListWindow::GroupBy _grouping[VLT_END][VEH_COMPANY_END];
152 extern Sorting _sorting[BaseVehicleListWindow::GB_END];
153
154 #endif /* VEHICLE_GUI_BASE_H */
BaseVehicleListWindow::SetCargoFilter
void SetCargoFilter(byte index)
Set cargo filter for the vehicle group list.
Definition: vehicle_gui.cpp:344
VehicleList
std::vector< const Vehicle * > VehicleList
A list of vehicles.
Definition: vehiclelist.h:54
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:30
BaseVehicleListWindow::BuildActionDropdownList
DropDownList BuildActionDropdownList(bool show_autoreplace, bool show_group, bool show_create)
Display the Action dropdown window.
Definition: vehicle_gui.cpp:453
BaseVehicleListWindow::grouping
GroupBy grouping
How we want to group the list.
Definition: vehicle_gui_base.h:76
VehicleListIdentifier
The information about a vehicle list.
Definition: vehiclelist.h:28
timer_game_calendar.h
BaseVehicleListWindow::order_arrow_width
uint order_arrow_width
Width of the arrow in the small order list.
Definition: vehicle_gui_base.h:85
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
GUIList
List template of 'things' T to sort in a GUI.
Definition: sortlist_type.h:47
vehiclelist.h
DropDownList
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
Definition: dropdown_type.h:210
GetVehicleListHeight
uint GetVehicleListHeight(VehicleType type, uint divisor=1)
Get the height of a vehicle in the vehicle list GUIs.
Definition: vehicle_gui.cpp:1670
BaseVehicleListWindow::sorting
Listing * sorting
Pointer to the vehicle type related sorting.
Definition: vehicle_gui_base.h:79
vehicle_base.h
GUIVehicleGroup::vehicles_begin
VehicleList::const_iterator vehicles_begin
Pointer to beginning element of this vehicle group.
Definition: vehicle_gui_base.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:240
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:680
BaseVehicleListWindow::SetCargoFilterArray
void SetCargoFilterArray()
Populate the filter list and set the cargo filter criteria.
Definition: vehicle_gui.cpp:358
BaseVehicleListWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: vehicle_gui.cpp:404
WindowDesc
High level window description.
Definition: window_gui.h:153
BaseVehicleListWindow::FilterVehicleList
void FilterVehicleList()
Filter the engine list against the currently selected cargo filter.
Definition: vehicle_gui.cpp:368
window_gui.h
BaseVehicleListWindow::vli
VehicleListIdentifier vli
Identifier of the vehicle list we want to currently show.
Definition: vehicle_gui_base.h:82
Vehicle::GetDisplayProfitThisYear
Money GetDisplayProfitThisYear() const
Gets the profit vehicle had this year.
Definition: vehicle_base.h:613
Listing
Data structure describing how to show the list (what sort direction and criteria).
Definition: sortlist_type.h:30
WindowNumber
int32_t WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:732
VEH_COMPANY_END
@ VEH_COMPANY_END
Last company-ownable type.
Definition: vehicle_type.h:29
BaseVehicleListWindow
Definition: vehicle_gui_base.h:67
GUIList< GUIVehicleGroup, std::nullptr_t, CargoID >::SortFunction
std::conditional_t< std::is_same_v< std::nullptr_t, std::nullptr_t >, bool(const GUIVehicleGroup &, const GUIVehicleGroup &), bool(const GUIVehicleGroup &, const GUIVehicleGroup &, const std::nullptr_t)> SortFunction
Signature of sort function.
Definition: sortlist_type.h:49
cargo_type.h
dropdown_type.h
BaseVehicleListWindow::BuildCargoDropDownList
DropDownList BuildCargoDropDownList(bool full) const
Build drop down list for cargo filter selection.
Definition: vehicle_gui.cpp:425
sortlist_type.h
VehicleID
uint32_t VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
BaseVehicleListWindow::GetActionDropdownSize
Dimension GetActionDropdownSize(bool show_autoreplace, bool show_group, bool show_create)
Compute the size for the Action dropdown.
Definition: vehicle_gui.cpp:386
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
BaseVehicleListWindow::cargo_filter_criteria
CargoID cargo_filter_criteria
Selected cargo filter index.
Definition: vehicle_gui_base.h:84
BaseVehicleListWindow::DrawVehicleListItems
void DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const
Draw all the vehicle list items.
Definition: vehicle_gui.cpp:1701
Sorting
Definition: vehicle_gui_base.h:144
GUIVehicleGroup
Definition: vehicle_gui_base.h:24
BaseVehicleListWindow::vehgroups
GUIVehicleGroupList vehgroups
List of (groups of) vehicles. This stores iterators of vehicles, and should be rebuilt if vehicles is...
Definition: vehicle_gui_base.h:78
Vehicle::economy_age
TimerGameEconomy::Date economy_age
Age in economy days.
Definition: vehicle_base.h:289
BaseVehicleListWindow::vehicle_sel
VehicleID vehicle_sel
Selected vehicle.
Definition: vehicle_gui_base.h:83
BaseVehicleListWindow::vehicles
VehicleList vehicles
List of vehicles. This is the buffer for vehgroups to point into; if this is structurally modified,...
Definition: vehicle_gui_base.h:77
OverflowSafeInt< int64_t >
BaseVehicleListWindow::unitnumber_digits
byte unitnumber_digits
The number of digits of the highest unit number.
Definition: vehicle_gui_base.h:80
Window
Data structure for an opened window.
Definition: window_gui.h:267
economy_type.h
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:75
Vehicle::GetDisplayProfitLastYear
Money GetDisplayProfitLastYear() const
Gets the profit vehicle had last year.
Definition: vehicle_base.h:619
GUIVehicleGroup::vehicles_end
VehicleList::const_iterator vehicles_end
Pointer to past-the-end element of this vehicle group.
Definition: vehicle_gui_base.h:26