OpenTTD

waypoint_gui.cpp
Go to the documentation of this file.
1 /* $Id: waypoint_gui.cpp 27030 2014-10-21 19:16:47Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #include "stdafx.h"
13 #include "window_gui.h"
14 #include "gui.h"
15 #include "textbuf_gui.h"
16 #include "vehiclelist.h"
17 #include "vehicle_gui.h"
18 #include "viewport_func.h"
19 #include "strings_func.h"
20 #include "command_func.h"
21 #include "company_func.h"
22 #include "company_base.h"
23 #include "window_func.h"
24 #include "waypoint_base.h"
25
26 #include "widgets/waypoint_widget.h"
27
28 #include "table/strings.h"
29
30 #include "safeguards.h"
31
33 struct WaypointWindow : Window {
34 private:
35 VehicleType vt;
36 Waypoint *wp;
37
42 TileIndex GetCenterTile() const
43 {
44 if (!this->wp->IsInUse()) return this->wp->xy;
45
46 TileArea ta;
47 this->wp->GetTileArea(&ta, this->vt == VEH_TRAIN ? STATION_WAYPOINT : STATION_BUOY);
48 return ta.GetCenterTile();
49 }
50
51 public:
57 WaypointWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
58 {
59 this->wp = Waypoint::Get(window_number);
60 this->vt = (wp->string_id == STR_SV_STNAME_WAYPOINT) ? VEH_TRAIN : VEH_SHIP;
61
62 this->CreateNestedTree();
63 if (this->vt == VEH_TRAIN) {
64 this->GetWidget<NWidgetCore>(WID_W_SHOW_VEHICLES)->SetDataTip(STR_TRAIN, STR_STATION_VIEW_SCHEDULED_TRAINS_TOOLTIP);
65 this->GetWidget<NWidgetCore>(WID_W_CENTER_VIEW)->tool_tip = STR_WAYPOINT_VIEW_CENTER_TOOLTIP;
66 this->GetWidget<NWidgetCore>(WID_W_RENAME)->tool_tip = STR_WAYPOINT_VIEW_CHANGE_WAYPOINT_NAME;
67 }
68 this->FinishInitNested(window_number);
69
70 this->owner = this->wp->owner;
71 this->flags |= WF_DISABLE_VP_SCROLL;
72
73 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
74 nvp->InitializeViewport(this, this->GetCenterTile(), ZOOM_LVL_VIEWPORT);
75
76 this->OnInvalidateData(0);
77 }
78
79 ~WaypointWindow()
80 {
81 DeleteWindowById(GetWindowClassForVehicleType(this->vt), VehicleListIdentifier(VL_STATION_LIST, this->vt, this->owner, this->window_number).Pack(), false);
82 }
83
84 virtual void SetStringParameters(int widget) const
85 {
86 if (widget == WID_W_CAPTION) SetDParam(0, this->wp->index);
87 }
88
89 virtual void OnClick(Point pt, int widget, int click_count)
90 {
91 switch (widget) {
92 case WID_W_CENTER_VIEW: // scroll to location
93 if (_ctrl_pressed) {
94 ShowExtraViewPortWindow(this->GetCenterTile());
95 } else {
96 ScrollMainWindowToTile(this->GetCenterTile());
97 }
98 break;
99
100 case WID_W_RENAME: // rename
101 SetDParam(0, this->wp->index);
102 ShowQueryString(STR_WAYPOINT_NAME, STR_EDIT_WAYPOINT_NAME, MAX_LENGTH_STATION_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
103 break;
104
105 case WID_W_SHOW_VEHICLES: // show list of vehicles having this waypoint in their orders
106 ShowVehicleListWindow(this->wp->owner, this->vt, this->wp->index);
107 break;
108 }
109 }
110
116 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
117 {
118 if (!gui_scope) return;
119 /* You can only change your own waypoints */
120 this->SetWidgetDisabledState(WID_W_RENAME, !this->wp->IsInUse() || (this->wp->owner != _local_company && this->wp->owner != OWNER_NONE));
121 /* Disable the widget for waypoints with no use */
122 this->SetWidgetDisabledState(WID_W_SHOW_VEHICLES, !this->wp->IsInUse());
123
124 ScrollWindowToTile(this->GetCenterTile(), this, true);
125 }
126
127 virtual void OnResize()
128 {
129 if (this->viewport != NULL) {
130 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
131 nvp->UpdateViewportCoordinates(this);
132 this->wp->UpdateVirtCoord();
133
134 ScrollWindowToTile(this->GetCenterTile(), this, true); // Re-center viewport.
135 }
136 }
137
138 virtual void OnQueryTextFinished(char *str)
139 {
140 if (str == NULL) return;
141
142 DoCommandP(0, this->window_number, 0, CMD_RENAME_WAYPOINT | CMD_MSG(STR_ERROR_CAN_T_CHANGE_WAYPOINT_NAME), NULL, str);
143 }
144
145 };
146
148 static const NWidgetPart _nested_waypoint_view_widgets[] = {
149 NWidget(NWID_HORIZONTAL),
150 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
151 NWidget(WWT_CAPTION, COLOUR_GREY, WID_W_CAPTION), SetDataTip(STR_WAYPOINT_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
152 NWidget(WWT_SHADEBOX, COLOUR_GREY),
153 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
154 NWidget(WWT_STICKYBOX, COLOUR_GREY),
155 EndContainer(),
156 NWidget(WWT_PANEL, COLOUR_GREY),
157 NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
158 NWidget(NWID_VIEWPORT, COLOUR_GREY, WID_W_VIEWPORT), SetMinimalSize(256, 88), SetPadding(1, 1, 1, 1), SetResize(1, 1),
159 EndContainer(),
160 EndContainer(),
161 NWidget(NWID_HORIZONTAL),
162 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),
163 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),
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 }
NWID_VIEWPORT
Nested widget containing a viewport.
Definition: widget_type.h:81
strings_func.h
Functions related to OTTD&#39;s strings.
company_base.h
Definition of stuff that is very close to a company, like the company struct itself.
VehicleListIdentifier
The information about a vehicle list.
Definition: vehiclelist.h:31
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:930
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:387
WindowDesc
High level window description.
Definition: window_gui.h:168
vehiclelist.h
Functions and type for generating vehicle lists.
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:305
NWidgetViewport::UpdateViewportCoordinates
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition: widget.cpp:1936
NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
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:1066
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:154
WID_W_CAPTION
Caption of window.
Definition: waypoint_widget.h:17
WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:51
WID_W_VIEWPORT
The viewport on this waypoint.
Definition: waypoint_widget.h:18
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
Waypoint
Representation of a waypoint.
Definition: waypoint_base.h:18
WaypointWindow::SetStringParameters
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: waypoint_gui.cpp:84
textbuf_gui.h
Stuff related to the text buffer GUI.
NWidgetViewport::InitializeViewport
void InitializeViewport(Window *w, uint32 follow_flags, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:1927
WID_W_CENTER_VIEW
Center the main view on this waypoint.
Definition: waypoint_widget.h:19
WaypointWindow::WaypointWindow
WaypointWindow(WindowDesc *desc, WindowNumber window_number)
Construct the window.
Definition: waypoint_gui.cpp:57
NWidgetViewport
Nested widget to display a viewport in a window.
Definition: widget_type.h:575
WID_W_SHOW_VEHICLES
Show the vehicles visiting this waypoint.
Definition: waypoint_widget.h:21
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1804
vehicle_gui.h
Functions related to the vehicle&#39;s GUIs.
WaypointWindow::OnQueryTextFinished
virtual void OnQueryTextFinished(char *str)
The query window opened from this window has closed.
Definition: waypoint_gui.cpp:138
window_gui.h
Functions, definitions and such used only by the GUI.
ShowWaypointWindow
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
Definition: waypoint_gui.cpp:181
_local_company
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
viewport_func.h
Functions related to (drawing on) viewports.
Window
Data structure for an opened window.
Definition: window_gui.h:271
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1820
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:1046
QSF_ENABLE_DEFAULT
enable the &#39;Default&#39; button ("\0" is returned)
Definition: textbuf_gui.h:23
WC_WAYPOINT_VIEW
Waypoint view; Window numbers:
Definition: window_type.h:352
WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:65
WaypointWindow::OnResize
virtual void OnResize()
Called after the window got resized.
Definition: waypoint_gui.cpp:127
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
waypoint_widget.h
Types related to the waypoint widgets.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
OrthogonalTileArea::GetCenterTile
TileIndex GetCenterTile() const
Get the center tile.
Definition: tilearea_type.h:57
QSF_LEN_IN_CHARS
the length of the string is counted in characters
Definition: textbuf_gui.h:24
safeguards.h
A number of safeguards to prevent using unsafe methods.
WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
waypoint_base.h
Base of waypoints.
WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:18
NWidget
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:1114
OWNER_NONE
The tile has no ownership.
Definition: company_type.h:27
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:527
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
WID_W_RENAME
Rename this waypoint.
Definition: waypoint_widget.h:20
ScrollWindowToTile
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2257
CMD_RENAME_WAYPOINT
rename a waypoint
Definition: command_type.h:196
ZOOM_LVL_VIEWPORT
Default zoom level for viewports.
Definition: zoom_type.h:35
VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
ShowExtraViewPortWindow
void ShowExtraViewPortWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:170
BaseStation::owner
OwnerByte owner
The owner of this station.
Definition: base_station_base.h:63
WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
DeleteWindowById
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1137
company_func.h
Functions related to companies.
CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
_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.
WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
WaypointWindow
GUI for accessing waypoints and buoys.
Definition: waypoint_gui.cpp:33
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
_nested_waypoint_view_widgets
static const NWidgetPart _nested_waypoint_view_widgets[]
The widgets of the waypoint view.
Definition: waypoint_gui.cpp:148
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:55
EndContainer
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:999
Waypoint::UpdateVirtCoord
void UpdateVirtCoord()
Update the virtual coords needed to draw the waypoint sign.
Definition: waypoint_cmd.cpp:40
WaypointWindow::GetCenterTile
TileIndex GetCenterTile() const
Get the center tile of the waypoint.
Definition: waypoint_gui.cpp:42
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2268
command_func.h
Functions related to commands.
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:28
GetWindowClassForVehicleType
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:85
WF_DISABLE_VP_SCROLL
Window does not do autoscroll,.
Definition: window_gui.h:241
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
WaypointWindow::OnClick
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: waypoint_gui.cpp:89
MAX_LENGTH_STATION_NAME_CHARS
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:92
WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:66
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
WaypointWindow::OnInvalidateData
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: waypoint_gui.cpp:116
CMD_MSG
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:366
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:695
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
WaypointWindow::wp
Waypoint * wp
Waypoint displayed by the window.
Definition: waypoint_gui.cpp:36
window_func.h
Window functions not directly related to making/drawing windows.
WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
WaypointWindow::vt
VehicleType vt
Vehicle type using the waypoint.
Definition: waypoint_gui.cpp:35
Window::viewport
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:321
gui.h
GUI functions that shouldn&#39;t be here.
SpecializedStation< Waypoint, true >::Get
static Waypoint * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:206
BaseStation::string_id
StringID string_id
Default name (town area) of station.
Definition: base_station_base.h:60
WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:64
VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
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:201