OpenTTD Source: src/waypoint_gui.cpp Source File

OpenTTD Source 12.2

waypoint_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 "window_gui.h"
12 #include "gui.h"
13 #include "textbuf_gui.h"
14 #include "vehiclelist.h"
15 #include "vehicle_gui.h"
16 #include "viewport_func.h"
17 #include "strings_func.h"
18 #include "command_func.h"
19 #include "company_func.h"
20 #include "company_base.h"
21 #include "window_func.h"
22 #include "waypoint_base.h"
23
24 #include "widgets/waypoint_widget.h"
25
26 #include "table/strings.h"
27
28 #include "safeguards.h"
29
31 struct WaypointWindow : Window {
32 private:
33 VehicleType vt;
34 Waypoint *wp;
35
40 TileIndex GetCenterTile() const
41 {
42 if (!this->wp->IsInUse()) return this->wp->xy;
43
44 TileArea ta;
45 this->wp->GetTileArea(&ta, this->vt == VEH_TRAIN ? STATION_WAYPOINT : STATION_BUOY);
46 return ta.GetCenterTile();
47 }
48
49 public:
55 WaypointWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
56 {
57 this->wp = Waypoint::Get(window_number);
58 this->vt = (wp->string_id == STR_SV_STNAME_WAYPOINT) ? VEH_TRAIN : VEH_SHIP;
59
60 this->CreateNestedTree();
61 if (this->vt == VEH_TRAIN) {
62 this->GetWidget<NWidgetCore>(WID_W_SHOW_VEHICLES)->SetDataTip(STR_TRAIN, STR_STATION_VIEW_SCHEDULED_TRAINS_TOOLTIP);
63 this->GetWidget<NWidgetCore>(WID_W_CENTER_VIEW)->tool_tip = STR_WAYPOINT_VIEW_CENTER_TOOLTIP;
64 this->GetWidget<NWidgetCore>(WID_W_RENAME)->tool_tip = STR_WAYPOINT_VIEW_CHANGE_WAYPOINT_NAME;
65 }
66 this->FinishInitNested(window_number);
67
68 this->owner = this->wp->owner;
69 this->flags |= WF_DISABLE_VP_SCROLL;
70
71 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
72 nvp->InitializeViewport(this, this->GetCenterTile(), ZOOM_LVL_VIEWPORT);
73
74 this->OnInvalidateData(0);
75 }
76
77 void Close() override
78 {
79 CloseWindowById(GetWindowClassForVehicleType(this->vt), VehicleListIdentifier(VL_STATION_LIST, this->vt, this->owner, this->window_number).Pack(), false);
80 this->Window::Close();
81 }
82
83 void SetStringParameters(int widget) const override
84 {
85 if (widget == WID_W_CAPTION) SetDParam(0, this->wp->index);
86 }
87
88 void OnClick(Point pt, int widget, int click_count) override
89 {
90 switch (widget) {
91 case WID_W_CENTER_VIEW: // scroll to location
92 if (_ctrl_pressed) {
93 ShowExtraViewportWindow(this->GetCenterTile());
94 } else {
95 ScrollMainWindowToTile(this->GetCenterTile());
96 }
97 break;
98
99 case WID_W_RENAME: // rename
100 SetDParam(0, this->wp->index);
101 ShowQueryString(STR_WAYPOINT_NAME, STR_EDIT_WAYPOINT_NAME, MAX_LENGTH_STATION_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
102 break;
103
104 case WID_W_SHOW_VEHICLES: // show list of vehicles having this waypoint in their orders
105 ShowVehicleListWindow(this->wp->owner, this->vt, this->wp->index);
106 break;
107 }
108 }
109
115 void OnInvalidateData(int data = 0, bool gui_scope = true) override
116 {
117 if (!gui_scope) return;
118 /* You can only change your own waypoints */
119 this->SetWidgetDisabledState(WID_W_RENAME, !this->wp->IsInUse() || (this->wp->owner != _local_company && this->wp->owner != OWNER_NONE));
120 /* Disable the widget for waypoints with no use */
121 this->SetWidgetDisabledState(WID_W_SHOW_VEHICLES, !this->wp->IsInUse());
122
123 ScrollWindowToTile(this->GetCenterTile(), this, true);
124 }
125
126 void OnResize() override
127 {
128 if (this->viewport != nullptr) {
129 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
130 nvp->UpdateViewportCoordinates(this);
131 this->wp->UpdateVirtCoord();
132
133 ScrollWindowToTile(this->GetCenterTile(), this, true); // Re-center viewport.
134 }
135 }
136
137 void OnQueryTextFinished(char *str) override
138 {
139 if (str == nullptr) return;
140
141 DoCommandP(0, this->window_number, 0, CMD_RENAME_WAYPOINT | CMD_MSG(STR_ERROR_CAN_T_CHANGE_WAYPOINT_NAME), nullptr, str);
142 }
143
144 };
145
147 static const NWidgetPart _nested_waypoint_view_widgets[] = {
148 NWidget(NWID_HORIZONTAL),
149 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
150 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_W_RENAME), SetMinimalSize(12, 14), SetDataTip(SPR_RENAME, STR_BUOY_VIEW_CHANGE_BUOY_NAME),
151 NWidget(WWT_CAPTION, COLOUR_GREY, WID_W_CAPTION), SetDataTip(STR_WAYPOINT_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
152 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_W_CENTER_VIEW), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_BUOY_VIEW_CENTER_TOOLTIP),
153 NWidget(WWT_SHADEBOX, COLOUR_GREY),
154 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
155 NWidget(WWT_STICKYBOX, COLOUR_GREY),
156 EndContainer(),
157 NWidget(WWT_PANEL, COLOUR_GREY),
158 NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
159 NWidget(NWID_VIEWPORT, COLOUR_GREY, WID_W_VIEWPORT), SetMinimalSize(256, 88), SetResize(1, 1),
160 EndContainer(),
161 EndContainer(),
162 NWidget(NWID_HORIZONTAL),
163 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
164 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_W_SHOW_VEHICLES), SetMinimalSize(15, 12), SetDataTip(STR_SHIP, STR_STATION_VIEW_SCHEDULED_SHIPS_TOOLTIP),
165 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
166 EndContainer(),
167 };
168
170 static WindowDesc _waypoint_view_desc(
171 WDP_AUTO, "view_waypoint", 260, 118,
172 WC_WAYPOINT_VIEW, WC_NONE,
173 0,
174 _nested_waypoint_view_widgets, lengthof(_nested_waypoint_view_widgets)
175 );
176
181 void ShowWaypointWindow(const Waypoint *wp)
182 {
183 AllocateWindowDescFront<WaypointWindow>(&_waypoint_view_desc, wp->index);
184 }
waypoint_widget.h
WaypointWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: waypoint_gui.cpp:88
WID_W_RENAME
@ WID_W_RENAME
Rename this waypoint.
Definition: waypoint_widget.h:18
CMD_MSG
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:372
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2445
vehicle_gui.h
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:168
command_func.h
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1139
VehicleListIdentifier
The information about a vehicle list.
Definition: vehiclelist.h:29
company_base.h
NWidgetViewport
Nested widget to display a viewport in a window.
Definition: widget_type.h:615
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
WF_DISABLE_VP_SCROLL
@ WF_DISABLE_VP_SCROLL
Window does not do autoscroll,.
Definition: window_gui.h:241
Window::viewport
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:321
_nested_waypoint_view_widgets
static const NWidgetPart _nested_waypoint_view_widgets[]
The widgets of the waypoint view.
Definition: waypoint_gui.cpp:147
vehiclelist.h
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1760
WaypointWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: waypoint_gui.cpp:126
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
Waypoint
Representation of a waypoint.
Definition: waypoint_base.h:16
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:993
SpecializedStation< Waypoint, true >::Get
static Waypoint * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:219
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:319
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
WaypointWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: waypoint_gui.cpp:137
Waypoint::GetTileArea
void GetTileArea(TileArea *ta, StationType type) const override
Get the tile area for a given station type.
Definition: waypoint.cpp:34
BaseStation::owner
Owner owner
The owner of this station.
Definition: base_station_base.h:62
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
textbuf_gui.h
WaypointWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: waypoint_gui.cpp:83
BaseStation::string_id
StringID string_id
Default name (town area) of station.
Definition: base_station_base.h:58
QSF_LEN_IN_CHARS
@ QSF_LEN_IN_CHARS
the length of the string is counted in characters
Definition: textbuf_gui.h:22
WindowDesc
High level window description.
Definition: window_gui.h:168
Waypoint::UpdateVirtCoord
void UpdateVirtCoord() override
Update the virtual coords needed to draw the waypoint sign.
Definition: waypoint_cmd.cpp:39
window_gui.h
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
NWidgetViewport::UpdateViewportCoordinates
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition: widget.cpp:2076
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
NWID_VIEWPORT
@ NWID_VIEWPORT
Nested widget containing a viewport.
Definition: widget_type.h:79
WaypointWindow::WaypointWindow
WaypointWindow(WindowDesc *desc, WindowNumber window_number)
Construct the window.
Definition: waypoint_gui.cpp:55
ScrollWindowToTile
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2434
ShowWaypointWindow
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
Definition: waypoint_gui.cpp:181
CMD_RENAME_WAYPOINT
@ CMD_RENAME_WAYPOINT
rename a waypoint
Definition: command_type.h:194
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
WaypointWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: waypoint_gui.cpp:77
_waypoint_view_desc
static WindowDesc _waypoint_view_desc(WDP_AUTO, "view_waypoint", 260, 118, WC_WAYPOINT_VIEW, WC_NONE, 0, _nested_waypoint_view_widgets, lengthof(_nested_waypoint_view_widgets))
The description of the waypoint view.
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:18
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:386
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
safeguards.h
ShowQueryString
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1119
WC_WAYPOINT_VIEW
@ WC_WAYPOINT_VIEW
Waypoint view; Window numbers:
Definition: window_type.h:349
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:305
WID_W_CENTER_VIEW
@ WID_W_CENTER_VIEW
Center the main view on this waypoint.
Definition: waypoint_widget.h:17
WaypointWindow::wp
Waypoint * wp
Waypoint displayed by the window.
Definition: waypoint_gui.cpp:34
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
WID_W_SHOW_VEHICLES
@ WID_W_SHOW_VEHICLES
Show the vehicles visiting this waypoint.
Definition: waypoint_widget.h:19
stdafx.h
ZOOM_LVL_VIEWPORT
@ ZOOM_LVL_VIEWPORT
Default zoom level for viewports.
Definition: zoom_type.h:35
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
WaypointWindow::GetCenterTile
TileIndex GetCenterTile() const
Get the center tile of the waypoint.
Definition: waypoint_gui.cpp:40
CS_ALPHANUMERAL
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
viewport_func.h
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
OrthogonalTileArea::GetCenterTile
TileIndex GetCenterTile() const
Get the center tile.
Definition: tilearea_type.h:59
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
MAX_LENGTH_STATION_NAME_CHARS
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including '\0'.
Definition: station_type.h:87
GetWindowClassForVehicleType
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:91
WaypointWindow::vt
VehicleType vt
Vehicle type using the waypoint.
Definition: waypoint_gui.cpp:33
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1092
strings_func.h
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
NWidgetViewport::InitializeViewport
void InitializeViewport(Window *w, uint32 follow_flags, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:2067
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
waypoint_base.h
WID_W_CAPTION
@ WID_W_CAPTION
Caption of window.
Definition: waypoint_widget.h:15
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1776
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:53
company_func.h
WWT_INSET
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:49
window_func.h
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
gui.h
WaypointWindow
GUI for accessing waypoints and buoys.
Definition: waypoint_gui.cpp:31
BaseStation::IsInUse
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
Definition: base_station_base.h:166
Window
Data structure for an opened window.
Definition: window_gui.h:279
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
WaypointWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: waypoint_gui.cpp:115
QSF_ENABLE_DEFAULT
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
Definition: textbuf_gui.h:21
WID_W_VIEWPORT
@ WID_W_VIEWPORT
The viewport on this waypoint.
Definition: waypoint_widget.h:16
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1092