OpenTTD Source: src/engine_gui.h Source File

OpenTTD Source 14.0-RC3

engine_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 ENGINE_GUI_H
11 #define ENGINE_GUI_H
12
13 #include "engine_type.h"
14 #include "sortlist_type.h"
15 #include "gfx_type.h"
16 #include "vehicle_type.h"
17 #include "engine_base.h"
18
19 struct GUIEngineListItem {
20 EngineID engine_id;
21 EngineID variant_id;
22 EngineDisplayFlags flags;
23 int8_t indent;
24
25 GUIEngineListItem(EngineID engine_id, EngineID variant_id, EngineDisplayFlags flags, int indent) : engine_id(engine_id), variant_id(variant_id), flags(flags), indent(indent) {}
26
27 /* Used when searching list only by engine_id. */
28 bool operator == (const EngineID &other) const { return this->engine_id == other; }
29 };
30
31 typedef GUIList<GUIEngineListItem, std::nullptr_t, CargoID> GUIEngineList;
32
33 typedef bool EngList_SortTypeFunction(const GUIEngineListItem&, const GUIEngineListItem&);
34 void EngList_Sort(GUIEngineList &el, EngList_SortTypeFunction compare);
35 void EngList_SortPartial(GUIEngineList &el, EngList_SortTypeFunction compare, size_t begin, size_t num_items);
36
37 StringID GetEngineCategoryName(EngineID engine);
38 StringID GetEngineInfoString(EngineID engine);
39
40 void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
41 void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
42 void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
43 void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
44 void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
45
46 extern bool _engine_sort_direction;
47 extern byte _engine_sort_last_criteria[];
48 extern bool _engine_sort_last_order[];
49 extern bool _engine_sort_show_hidden_engines[];
50 extern const StringID _engine_sort_listing[][12];
51 extern EngList_SortTypeFunction * const _engine_sort_functions[][11];
52
53 uint GetEngineListHeight(VehicleType type);
54 void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, WidgetID button);
55
56 #endif /* ENGINE_GUI_H */
DrawVehicleEngine
void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw an engine.
Definition: engine_gui.cpp:303
_engine_sort_functions
EngList_SortTypeFunction *const _engine_sort_functions[][11]
Sort functions for the vehicle sort criteria, for each vehicle type.
Definition: build_vehicle_gui.cpp:436
EngList_SortTypeFunction
bool EngList_SortTypeFunction(const GUIEngineListItem &, const GUIEngineListItem &)
argument type for EngList_Sort.
Definition: engine_gui.h:33
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
GUIList< GUIEngineListItem, std::nullptr_t, CargoID >
_engine_sort_last_order
bool _engine_sort_last_order[]
Last set direction of the sort order, for each vehicle type.
Definition: build_vehicle_gui.cpp:99
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
PaletteID
uint32_t PaletteID
The number of the palette.
Definition: gfx_type.h:18
GUIEngineListItem::variant_id
EngineID variant_id
Variant group of the engine.
Definition: engine_gui.h:21
WidgetID
int WidgetID
Widget ID.
Definition: window_type.h:18
_engine_sort_show_hidden_engines
bool _engine_sort_show_hidden_engines[]
Last set 'show hidden engines' setting for each vehicle type.
Definition: build_vehicle_gui.cpp:100
DrawRoadVehEngine
void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw a road vehicle engine.
Definition: roadveh_cmd.cpp:149
_engine_sort_last_criteria
byte _engine_sort_last_criteria[]
Last set sort criteria, for each vehicle type.
Definition: build_vehicle_gui.cpp:98
GetEngineListHeight
uint GetEngineListHeight(VehicleType type)
Get the height of a single 'entry' in the engine lists.
Definition: build_vehicle_gui.cpp:52
GUIEngineListItem::indent
int8_t indent
Display indentation level.
Definition: engine_gui.h:23
_engine_sort_listing
const StringID _engine_sort_listing[][12]
Dropdown menu strings for the vehicle sort criteria.
Definition: build_vehicle_gui.cpp:486
GetEngineInfoString
StringID GetEngineInfoString(EngineID engine)
Get a multi-line string with some technical data, describing the engine.
Definition: engine_gui.cpp:273
sortlist_type.h
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
GUIEngineListItem::engine_id
EngineID engine_id
Engine to display in build purchase list.
Definition: engine_gui.h:20
EngList_Sort
void EngList_Sort(GUIEngineList &el, EngList_SortTypeFunction compare)
Sort all items using quick sort and given 'CompareItems' function.
Definition: engine_gui.cpp:333
vehicle_type.h
engine_type.h
EngineDisplayFlags
EngineDisplayFlags
Flags used client-side in the purchase/autorenew engine list.
Definition: engine_base.h:26
EngList_SortPartial
void EngList_SortPartial(GUIEngineList &el, EngList_SortTypeFunction compare, size_t begin, size_t num_items)
Sort selected range of items (on indices @ <begin, begin+num_items-1>)
Definition: engine_gui.cpp:346
GUIEngineListItem::flags
EngineDisplayFlags flags
Flags for toggling/drawing (un)folded status and controlling indentation.
Definition: engine_gui.h:22
_engine_sort_direction
bool _engine_sort_direction
false = descending, true = ascending.
Definition: build_vehicle_gui.cpp:97
GetEngineCategoryName
StringID GetEngineCategoryName(EngineID engine)
Return the category of an engine.
Definition: engine_gui.cpp:40
engine_base.h
EngineID
uint16_t EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
Window
Data structure for an opened window.
Definition: window_gui.h:267
DisplayVehicleSortDropDown
void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, WidgetID button)
Display the dropdown for the vehicle sort criteria.
Definition: build_vehicle_gui.cpp:1102
gfx_type.h
GUIEngineListItem
Definition: engine_gui.h:19