OpenTTD Source  20241108-master-g80f628063a
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 "group_type.h"
15 #include "sortlist_type.h"
16 #include "gfx_type.h"
17 #include "vehicle_type.h"
18 #include "engine_base.h"
19 
24  uint8_t indent;
25  uint16_t level_mask;
26 
28 
29  /* Used when searching list only by engine_id. */
30  bool operator == (const EngineID &other) const { return this->engine_id == other; }
31 };
32 
34 
37 void EngList_SortPartial(GUIEngineList &el, EngList_SortTypeFunction compare, size_t begin, size_t num_items);
38 
41 
42 void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
43 void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
44 void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
45 void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
46 void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
47 
48 extern bool _engine_sort_direction;
49 extern uint8_t _engine_sort_last_criteria[];
50 extern bool _engine_sort_last_order[];
52 extern const std::initializer_list<const StringID> _engine_sort_listing[];
54 
55 /* Functions in build_vehicle_gui.cpp */
57 void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, WidgetID button);
58 void DrawEngineList(VehicleType type, const Rect &r, const GUIEngineList &eng_list, const Scrollbar &sb, EngineID selected_id, bool show_count, GroupID selected_group);
59 void GUIEngineListAddChildren(GUIEngineList &dst, const GUIEngineList &src, EngineID parent = INVALID_ENGINE, uint8_t indent = 0);
60 
61 #endif /* ENGINE_GUI_H */
Scrollbar data structure.
Definition: widget_type.h:694
Base class for engines.
EngineDisplayFlags
Flags used client-side in the purchase/autorenew engine list.
Definition: engine_base.h:26
bool _engine_sort_last_order[]
Last set direction of the sort order, for each vehicle type.
void EngList_Sort(GUIEngineList &el, EngList_SortTypeFunction compare)
Sort all items using quick sort and given 'CompareItems' function.
Definition: engine_gui.cpp:333
uint GetEngineListHeight(VehicleType type)
Get the height of a single 'entry' in the engine lists.
const std::initializer_list< const StringID > _engine_sort_listing[]
Dropdown menu strings for the vehicle sort criteria.
uint8_t _engine_sort_last_criteria[]
Last set sort criteria, for each vehicle type.
bool EngList_SortTypeFunction(const GUIEngineListItem &, const GUIEngineListItem &)
argument type for EngList_Sort.
Definition: engine_gui.h:35
void GUIEngineListAddChildren(GUIEngineList &dst, const GUIEngineList &src, EngineID parent=INVALID_ENGINE, uint8_t indent=0)
Add children to GUI engine list to build a hierarchical tree.
EngList_SortTypeFunction *const _engine_sort_functions[][11]
Sort functions for the vehicle sort criteria, for each vehicle type.
void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, WidgetID button)
Display the dropdown for the vehicle sort criteria.
StringID GetEngineCategoryName(EngineID engine)
Return the category of an engine.
Definition: engine_gui.cpp:40
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
bool _engine_sort_direction
false = descending, true = ascending.
StringID GetEngineInfoString(EngineID engine)
Get a multi-line string with some technical data, describing the engine.
Definition: engine_gui.cpp:273
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
void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw a road vehicle engine.
bool _engine_sort_show_hidden_engines[]
Last set 'show hidden engines' setting for each vehicle type.
void DrawEngineList(VehicleType type, const Rect &r, const GUIEngineList &eng_list, const Scrollbar &sb, EngineID selected_id, bool show_count, GroupID selected_group)
Engine drawing loop.
Types related to engines.
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition: engine_type.h:206
uint16_t EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
Types related to the graphics and/or input devices.
uint32_t PaletteID
The number of the palette.
Definition: gfx_type.h:19
Types of a group.
uint16_t GroupID
Type for all group identifiers.
Definition: group_type.h:13
Base types for having sorted lists in GUIs.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
EngineDisplayFlags flags
Flags for toggling/drawing (un)folded status and controlling indentation.
Definition: engine_gui.h:23
uint16_t level_mask
Mask of level continuations.
Definition: engine_gui.h:25
EngineID variant_id
Variant group of the engine.
Definition: engine_gui.h:22
EngineID engine_id
Engine to display in build purchase list.
Definition: engine_gui.h:21
uint8_t indent
Display indentation level.
Definition: engine_gui.h:24
Specification of a rectangle with absolute coordinates of all edges.
Data structure for an opened window.
Definition: window_gui.h:273
Types related to vehicles.
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:78
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
int WidgetID
Widget ID.
Definition: window_type.h:18