OpenTTD Source: src/engine_gui.h Source File

OpenTTD Source 15.0-beta1

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
20 struct GUIEngineListItem {
21 EngineID engine_id;
22 EngineID variant_id;
23 EngineDisplayFlags flags;
24 uint8_t indent;
25 uint16_t level_mask;
26
27 GUIEngineListItem(EngineID engine_id, EngineID variant_id, EngineDisplayFlags flags, uint8_t indent) : engine_id(engine_id), variant_id(variant_id), flags(flags), indent(indent), level_mask(0) {}
28};
29
30typedef GUIList<GUIEngineListItem, std::nullptr_t, CargoID> GUIEngineList;
31
32 typedef bool EngList_SortTypeFunction(const GUIEngineListItem&, const GUIEngineListItem&);
33void EngList_Sort(GUIEngineList &el, EngList_SortTypeFunction compare);
34void EngList_SortPartial(GUIEngineList &el, EngList_SortTypeFunction compare, size_t begin, size_t num_items);
35
36 StringID GetEngineCategoryName(EngineID engine);
37 StringID GetEngineInfoString(EngineID engine);
38
39void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
40void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
41void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
42void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
43void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type);
44
45extern bool _engine_sort_direction;
46extern uint8_t _engine_sort_last_criteria[];
47extern bool _engine_sort_last_order[];
48extern bool _engine_sort_show_hidden_engines[];
49extern const std::initializer_list<const StringID> _engine_sort_listing[];
50extern EngList_SortTypeFunction * const _engine_sort_functions[][11];
51
52/* Functions in build_vehicle_gui.cpp */
53uint GetEngineListHeight(VehicleType type);
54void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selected, WidgetID button);
55void DrawEngineList(VehicleType type, const Rect &r, const GUIEngineList &eng_list, const Scrollbar &sb, EngineID selected_id, bool show_count, GroupID selected_group);
56void GUIEngineListAddChildren(GUIEngineList &dst, const GUIEngineList &src, EngineID parent = INVALID_ENGINE, uint8_t indent = 0);
57
58#endif /* ENGINE_GUI_H */
GUIList
List template of 'things' T to sort in a GUI.
Definition sortlist_type.h:47
Scrollbar
Scrollbar data structure.
Definition widget_type.h:694
engine_base.h
Base class for engines.
EngineDisplayFlags
EngineDisplayFlags
Flags used client-side in the purchase/autorenew engine list.
Definition engine_base.h:26
_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:100
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
GetEngineListHeight
uint GetEngineListHeight(VehicleType type)
Get the height of a single 'entry' in the engine lists.
Definition build_vehicle_gui.cpp:53
_engine_sort_listing
const std::initializer_list< const StringID > _engine_sort_listing[]
Dropdown menu strings for the vehicle sort criteria.
Definition build_vehicle_gui.cpp:487
_engine_sort_last_criteria
uint8_t _engine_sort_last_criteria[]
Last set sort criteria, for each vehicle type.
Definition build_vehicle_gui.cpp:99
EngList_SortTypeFunction
bool EngList_SortTypeFunction(const GUIEngineListItem &, const GUIEngineListItem &)
argument type for EngList_Sort.
Definition engine_gui.h:32
GUIEngineListAddChildren
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.
Definition build_vehicle_gui.cpp:1130
_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:437
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:1107
GetEngineCategoryName
StringID GetEngineCategoryName(EngineID engine)
Return the category of an engine.
Definition engine_gui.cpp:40
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
_engine_sort_direction
bool _engine_sort_direction
false = descending, true = ascending.
Definition build_vehicle_gui.cpp:98
GetEngineInfoString
StringID GetEngineInfoString(EngineID engine)
Get a multi-line string with some technical data, describing the engine.
Definition engine_gui.cpp:273
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
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:148
_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:101
DrawEngineList
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.
Definition build_vehicle_gui.cpp:1003
engine_type.h
Types related to engines.
INVALID_ENGINE
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition engine_type.h:210
EngineID
uint16_t EngineID
Unique identification number of an engine.
Definition engine_type.h:21
gfx_type.h
Types related to the graphics and/or input devices.
PaletteID
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:19
group_type.h
Types of a group.
GroupID
uint16_t GroupID
Type for all group identifiers.
Definition group_type.h:13
sortlist_type.h
Base types for having sorted lists in GUIs.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:16
GUIEngineListItem
Definition engine_gui.h:20
GUIEngineListItem::flags
EngineDisplayFlags flags
Flags for toggling/drawing (un)folded status and controlling indentation.
Definition engine_gui.h:23
GUIEngineListItem::level_mask
uint16_t level_mask
Mask of level continuations.
Definition engine_gui.h:25
GUIEngineListItem::variant_id
EngineID variant_id
Variant group of the engine.
Definition engine_gui.h:22
GUIEngineListItem::engine_id
EngineID engine_id
Engine to display in build purchase list.
Definition engine_gui.h:21
GUIEngineListItem::indent
uint8_t indent
Display indentation level.
Definition engine_gui.h:24
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition geometry_type.hpp:75
Window
Data structure for an opened window.
Definition window_gui.h:273
vehicle_type.h
Types related to vehicles.
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition vehicle_type.h:78
VehicleType
VehicleType
Available vehicle types.
Definition vehicle_type.h:21
WidgetID
int WidgetID
Widget ID.
Definition window_type.h:18