OpenTTD
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 
25 
26 #include "table/strings.h"
27 
28 #include "safeguards.h"
29 
32 private:
35 
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:
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);
73 
74  this->OnInvalidateData(0);
75  }
76 
78  {
79  DeleteWindowById(GetWindowClassForVehicleType(this->vt), VehicleListIdentifier(VL_STATION_LIST, this->vt, this->owner, this->window_number).Pack(), false);
80  }
81 
82  void SetStringParameters(int widget) const override
83  {
84  if (widget == WID_W_CAPTION) SetDParam(0, this->wp->index);
85  }
86 
87  void OnClick(Point pt, int widget, int click_count) override
88  {
89  switch (widget) {
90  case WID_W_CENTER_VIEW: // scroll to location
91  if (_ctrl_pressed) {
93  } else {
95  }
96  break;
97 
98  case WID_W_RENAME: // rename
99  SetDParam(0, this->wp->index);
100  ShowQueryString(STR_WAYPOINT_NAME, STR_EDIT_WAYPOINT_NAME, MAX_LENGTH_STATION_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
101  break;
102 
103  case WID_W_SHOW_VEHICLES: // show list of vehicles having this waypoint in their orders
104  ShowVehicleListWindow(this->wp->owner, this->vt, this->wp->index);
105  break;
106  }
107  }
108 
114  void OnInvalidateData(int data = 0, bool gui_scope = true) override
115  {
116  if (!gui_scope) return;
117  /* You can only change your own waypoints */
118  this->SetWidgetDisabledState(WID_W_RENAME, !this->wp->IsInUse() || (this->wp->owner != _local_company && this->wp->owner != OWNER_NONE));
119  /* Disable the widget for waypoints with no use */
121 
122  ScrollWindowToTile(this->GetCenterTile(), this, true);
123  }
124 
125  void OnResize() override
126  {
127  if (this->viewport != nullptr) {
128  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
129  nvp->UpdateViewportCoordinates(this);
130  this->wp->UpdateVirtCoord();
131 
132  ScrollWindowToTile(this->GetCenterTile(), this, true); // Re-center viewport.
133  }
134  }
135 
136  void OnQueryTextFinished(char *str) override
137  {
138  if (str == nullptr) return;
139 
140  DoCommandP(0, this->window_number, 0, CMD_RENAME_WAYPOINT | CMD_MSG(STR_ERROR_CAN_T_CHANGE_WAYPOINT_NAME), nullptr, str);
141  }
142 
143 };
144 
148  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
149  NWidget(WWT_CAPTION, COLOUR_GREY, WID_W_CAPTION), SetDataTip(STR_WAYPOINT_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
150  NWidget(WWT_SHADEBOX, COLOUR_GREY),
151  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
152  NWidget(WWT_STICKYBOX, COLOUR_GREY),
153  EndContainer(),
154  NWidget(WWT_PANEL, COLOUR_GREY),
155  NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
156  NWidget(NWID_VIEWPORT, COLOUR_GREY, WID_W_VIEWPORT), SetMinimalSize(256, 88), SetPadding(1, 1, 1, 1), SetResize(1, 1),
157  EndContainer(),
158  EndContainer(),
160  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_W_CENTER_VIEW), SetMinimalSize(100, 12), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_BUTTON_LOCATION, STR_BUOY_VIEW_CENTER_TOOLTIP),
161  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_W_RENAME), SetMinimalSize(100, 12), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_BUTTON_RENAME, STR_BUOY_VIEW_CHANGE_BUOY_NAME),
162  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_W_SHOW_VEHICLES), SetMinimalSize(15, 12), SetDataTip(STR_SHIP, STR_STATION_VIEW_SCHEDULED_SHIPS_TOOLTIP),
163  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
164  EndContainer(),
165 };
166 
169  WDP_AUTO, "view_waypoint", 260, 118,
171  0,
172  _nested_waypoint_view_widgets, lengthof(_nested_waypoint_view_widgets)
173 );
174 
180 {
181  AllocateWindowDescFront<WaypointWindow>(&_waypoint_view_desc, wp->index);
182 }
Nested widget containing a viewport.
Definition: widget_type.h:79
Functions related to OTTD&#39;s strings.
Definition of stuff that is very close to a company, like the company struct itself.
void UpdateVirtCoord() override
Update the virtual coords needed to draw the waypoint sign.
The information about a vehicle list.
Definition: vehiclelist.h:29
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:928
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:392
High level window description.
Definition: window_gui.h:166
Functions and type for generating vehicle lists.
WindowFlags flags
Window flags.
Definition: window_gui.h:310
Train vehicle type.
Definition: vehicle_type.h:24
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition: widget.cpp:1934
Horizontal container.
Definition: widget_type.h:73
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
Ship vehicle type.
Definition: vehicle_type.h:26
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
Caption of window.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:49
The viewport on this waypoint.
Tindex index
Index of this pool item.
Definition: pool_type.hpp:189
Close box (at top-left of a window)
Definition: widget_type.h:67
Representation of a waypoint.
Definition: waypoint_base.h:16
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnResize() override
Called after the window got resized.
Stuff related to the text buffer GUI.
void InitializeViewport(Window *w, uint32 follow_flags, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:1925
Center the main view on this waypoint.
WaypointWindow(WindowDesc *desc, WindowNumber window_number)
Construct the window.
Nested widget to display a viewport in a window.
Definition: widget_type.h:573
Show the vehicles visiting this waypoint.
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1828
Functions related to the vehicle&#39;s GUIs.
Functions, definitions and such used only by the GUI.
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Functions related to (drawing on) viewports.
Data structure for an opened window.
Definition: window_gui.h:276
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1844
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:1044
enable the &#39;Default&#39; button ("\0" is returned)
Definition: textbuf_gui.h:21
The tile has no ownership.
Definition: company_type.h:25
Waypoint view; Window numbers:
Definition: window_type.h:350
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:63
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:945
Types related to the waypoint widgets.
Definition of base types and functions in a cross-platform compatible way.
TileIndex GetCenterTile() const
Get the center tile.
Definition: tilearea_type.h:57
the length of the string is counted in characters
Definition: textbuf_gui.h:22
A number of safeguards to prevent using unsafe methods.
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
Base of waypoints.
Simple depressed panel.
Definition: widget_type.h:48
Represents the covered area of e.g.
Definition: tilearea_type.h:16
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1112
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:532
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
Rename this waypoint.
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2385
rename a waypoint
Definition: command_type.h:194
void ShowExtraViewPortWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1162
Functions related to companies.
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
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.
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
GUI for accessing waypoints and buoys.
Default zoom level for viewports.
Definition: zoom_type.h:33
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
static const NWidgetPart _nested_waypoint_view_widgets[]
The widgets of the waypoint view.
TileIndex xy
Base tile of the station.
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:997
TileIndex GetCenterTile() const
Get the center tile of the waypoint.
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2396
Functions related to commands.
Coordinates of a point in 2D.
Owner owner
The owner of this station.
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:91
Window does not do autoscroll,.
Definition: window_gui.h:239
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable...
Definition: window_gui.h:324
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including &#39;\0&#39;.
Definition: station_type.h:87
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:368
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:705
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
Waypoint * wp
Waypoint displayed by the window.
Window functions not directly related to making/drawing windows.
Find a place automatically.
Definition: window_gui.h:154
VehicleType vt
Vehicle type using the waypoint.
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:326
GUI functions that shouldn&#39;t be here.
static Waypoint * Get(size_t index)
Gets station with given index.
StringID string_id
Default name (town area) of station.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:44
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
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:199