OpenTTD Source: src/ship_gui.cpp Source File

OpenTTD Source 14.0-beta3

ship_gui.cpp
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 #include "stdafx.h"
11 #include "vehicle_base.h"
12 #include "window_gui.h"
13 #include "gfx_func.h"
14 #include "vehicle_gui.h"
15 #include "strings_func.h"
16 #include "vehicle_func.h"
17 #include "spritecache.h"
18 #include "zoom_func.h"
19
20 #include "table/strings.h"
21
22 #include "safeguards.h"
23
30 void DrawShipImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type)
31 {
32 bool rtl = _current_text_dir == TD_RTL;
33
34 VehicleSpriteSeq seq;
35 v->GetImage(rtl ? DIR_E : DIR_W, image_type, &seq);
36
37 Rect rect;
38 seq.GetBounds(&rect);
39
40 int width = UnScaleGUI(rect.Width());
41 int x_offs = UnScaleGUI(rect.left);
42 int x = rtl ? r.right - width - x_offs : r.left - x_offs;
43 /* This magic -1 offset is related to the sprite_y_offsets in build_vehicle_gui.cpp */
44 int y = ScaleSpriteTrad(-1) + CenterBounds(r.top, r.bottom, 0);
45
46 seq.Draw(x, y, GetVehiclePalette(v), false);
47
48 if (v->index == selection) {
49 x += x_offs;
50 y += UnScaleGUI(rect.top);
51 Rect hr = {x, y, x + width - 1, y + UnScaleGUI(rect.Height()) - 1};
52 DrawFrameRect(hr.Expand(WidgetDimensions::scaled.bevel), COLOUR_WHITE, FR_BORDERONLY);
53 }
54 }
55
62 void DrawShipDetails(const Vehicle *v, const Rect &r)
63 {
64 int y = r.top;
65
66 SetDParam(0, PackEngineNameDParam(v->engine_type, EngineNameContext::VehicleDetails));
67 SetDParam(1, v->build_year);
68 SetDParam(2, v->value);
69 DrawString(r.left, r.right, y, STR_VEHICLE_INFO_BUILT_VALUE);
70 y += GetCharacterHeight(FS_NORMAL);
71
72 SetDParam(0, v->cargo_type);
73 SetDParam(1, v->cargo_cap);
74 SetDParam(4, GetCargoSubtypeText(v));
75 DrawString(r.left, r.right, y, STR_VEHICLE_INFO_CAPACITY);
76 y += GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal;
77
78 StringID str = STR_VEHICLE_DETAILS_CARGO_EMPTY;
79 if (v->cargo.StoredCount() > 0) {
80 SetDParam(0, v->cargo_type);
81 SetDParam(1, v->cargo.StoredCount());
82 SetDParam(2, v->cargo.GetFirstStation());
83 str = STR_VEHICLE_DETAILS_CARGO_FROM;
84 }
85 DrawString(r.left, r.right, y, str);
86 y += GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal;
87
88 /* Draw Transfer credits text */
89 SetDParam(0, v->cargo.GetFeederShare());
90 DrawString(r.left, r.right, y, STR_VEHICLE_INFO_FEEDER_CARGO_VALUE);
91 }
VehicleCargoList::StoredCount
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Definition: cargopacket.h:434
Rect::Height
int Height() const
Get height of Rect.
Definition: geometry_type.hpp:91
vehicle_gui.h
Vehicle::value
Money value
Value of the vehicle.
Definition: vehicle_base.h:271
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
Vehicle::cargo_cap
uint16_t cargo_cap
total capacity
Definition: vehicle_base.h:338
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:234
vehicle_base.h
zoom_func.h
DIR_W
@ DIR_W
West.
Definition: direction_type.h:32
Rect::Expand
Rect Expand(int s) const
Copy and expand Rect by s pixels.
Definition: geometry_type.hpp:153
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:240
VehicleSpriteSeq::Draw
void Draw(int x, int y, PaletteID default_pal, bool force_pal) const
Draw the sprite sequence.
Definition: vehicle.cpp:131
VehicleCargoList::GetFirstStation
StationID GetFirstStation() const
Returns the first station of the first cargo packet in this list.
Definition: cargopacket.h:405
gfx_func.h
Vehicle::GetImage
virtual void GetImage([[maybe_unused]] Direction direction, [[maybe_unused]] EngineImageType image_type, [[maybe_unused]] VehicleSpriteSeq *result) const
Gets the sprite to show for the given direction.
Definition: vehicle_base.h:481
window_gui.h
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:203
DIR_E
@ DIR_E
East.
Definition: direction_type.h:28
PackEngineNameDParam
uint64_t PackEngineNameDParam(EngineID engine_id, EngineNameContext context, uint32_t extra_data=0)
Combine an engine ID and a name context to an engine name dparam.
Definition: engine_type.h:199
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:318
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:131
Vehicle::cargo
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:340
Vehicle::build_year
TimerGameCalendar::Year build_year
Year the vehicle has been built.
Definition: vehicle_base.h:287
safeguards.h
VehicleID
uint32_t VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
CenterBounds
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:166
stdafx.h
DrawShipDetails
void DrawShipDetails(const Vehicle *v, const Rect &r)
Draw the details for the given vehicle at the given position.
Definition: ship_gui.cpp:62
GetCargoSubtypeText
StringID GetCargoSubtypeText(const Vehicle *v)
Get the cargo subtype text from NewGRF for the vehicle details window.
Definition: vehicle_gui.cpp:1325
spritecache.h
vehicle_func.h
strings_func.h
VehicleCargoList::GetFeederShare
Money GetFeederShare() const
Returns total sum of the feeder share for all packets.
Definition: cargopacket.h:414
GetVehiclePalette
PaletteID GetVehiclePalette(const Vehicle *v)
Get the colour map for a vehicle.
Definition: vehicle.cpp:2123
SetDParam
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
WidgetDimensions::vsep_normal
int vsep_normal
Normal vertical spacing.
Definition: window_gui.h:60
ScaleSpriteTrad
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition: zoom_func.h:107
VehicleDetails
@ VehicleDetails
Name is shown in the vehicle details GUI.
Definition: engine_type.h:192
DrawFrameRect
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:281
UnScaleGUI
int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:77
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
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:78
DrawString
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:658
Vehicle::cargo_type
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:336
WidgetDimensions::bevel
RectPadding bevel
Bevel thickness, affected by "scaled bevels" game option.
Definition: window_gui.h:40
Rect::Width
int Width() const
Get width of Rect.
Definition: geometry_type.hpp:85
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:75
VehicleSpriteSeq::GetBounds
void GetBounds(Rect *bounds) const
Determine shared bounds of all sprites.
Definition: vehicle.cpp:103
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:56
FR_BORDERONLY
@ FR_BORDERONLY
Draw border only, no background.
Definition: window_gui.h:27