src/waypoint_gui.cpp

   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
   8 /** @file waypoint_gui.cpp Handling of waypoints gui. */
   9
  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 #include "waypoint_cmd.h"
  24
  25 #include "widgets/waypoint_widget.h"
  26
  27 #include "table/strings.h"
  28
  29 #include "safeguards.h"
  30 #include "zoom_func.h"
  31
  32 /** GUI for accessing waypoints and buoys. */
  33 struct WaypointWindow : Window {
  34 private:
  35         VehicleType vt; ///< Vehicle type using the waypoint.
  36         Waypoint *wp;   ///< Waypoint displayed by the window.
  37
  38         /**
  39          * Get the center tile of the waypoint.
  40          * @return The center tile if the waypoint exists, otherwise the tile with the waypoint name.
  41          */
  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:
  52         /**
  53          * Construct the window.
  54          * @param desc The description of the window.
  55          * @param window_number The window number, in this case the waypoint's ID.
  56          */
  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(), ScaleZoomGUI(ZOOM_LVL_VIEWPORT));
  75
  76                 this->OnInvalidateData(0);
  77         }
  78
  79         void Close() override
  80         {
  81                 CloseWindowById(GetWindowClassForVehicleType(this->vt), VehicleListIdentifier(VL_STATION_LIST, this->vt, this->owner, this->window_number).Pack(), false);
  82                 this->Window::Close();
  83         }
  84
  85         void SetStringParameters(int widget) const override
  86         {
  87                 if (widget == WID_W_CAPTION) SetDParam(0, this->wp->index);
  88         }
  89
  90         void OnClick(Point pt, int widget, int click_count) override
  91         {
  92                 switch (widget) {
  93                         case WID_W_CENTER_VIEW: // scroll to location
  94                                 if (_ctrl_pressed) {
  95                                         ShowExtraViewportWindow(this->GetCenterTile());
  96                                 } else {
  97                                         ScrollMainWindowToTile(this->GetCenterTile());
  98                                 }
  99                                 break;
 100
 101                         case WID_W_RENAME: // rename
 102                                 SetDParam(0, this->wp->index);
 103                                 ShowQueryString(STR_WAYPOINT_NAME, STR_EDIT_WAYPOINT_NAME, MAX_LENGTH_STATION_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
 104                                 break;
 105
 106                         case WID_W_SHOW_VEHICLES: // show list of vehicles having this waypoint in their orders
 107                                 ShowVehicleListWindow(this->wp->owner, this->vt, this->wp->index);
 108                                 break;
 109                 }
 110         }
 111
 112         /**
 113          * Some data on this window has become invalid.
 114          * @param data Information about the changed data.
 115          * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
 116          */
 117         void OnInvalidateData(int data = 0, bool gui_scope = true) override
 118         {
 119                 if (!gui_scope) return;
 120                 /* You can only change your own waypoints */
 121                 this->SetWidgetDisabledState(WID_W_RENAME, !this->wp->IsInUse() || (this->wp->owner != _local_company && this->wp->owner != OWNER_NONE));
 122                 /* Disable the widget for waypoints with no use */
 123                 this->SetWidgetDisabledState(WID_W_SHOW_VEHICLES, !this->wp->IsInUse());
 124
 125                 ScrollWindowToTile(this->GetCenterTile(), this, true);
 126         }
 127
 128         void OnResize() override
 129         {
 130                 if (this->viewport != nullptr) {
 131                         NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
 132                         nvp->UpdateViewportCoordinates(this);
 133                         this->wp->UpdateVirtCoord();
 134
 135                         ScrollWindowToTile(this->GetCenterTile(), this, true); // Re-center viewport.
 136                 }
 137         }
 138
 139         void OnQueryTextFinished(char *str) override
 140         {
 141                 if (str == nullptr) return;
 142
 143                 Command<CMD_RENAME_WAYPOINT>::Post(STR_ERROR_CAN_T_CHANGE_WAYPOINT_NAME, this->window_number, str);
 144         }
 145
 146 };
 147
 148 /** The widgets of the waypoint view. */
 149 static const NWidgetPart _nested_waypoint_view_widgets[] = {
 150         NWidget(NWID_HORIZONTAL),
 151                 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
 152                 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_W_RENAME), SetMinimalSize(12, 14), SetDataTip(SPR_RENAME, STR_BUOY_VIEW_CHANGE_BUOY_NAME),
 153                 NWidget(WWT_CAPTION, COLOUR_GREY, WID_W_CAPTION), SetDataTip(STR_WAYPOINT_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 154                 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_W_CENTER_VIEW), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_BUOY_VIEW_CENTER_TOOLTIP),
 155                 NWidget(WWT_SHADEBOX, COLOUR_GREY),
 156                 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
 157                 NWidget(WWT_STICKYBOX, COLOUR_GREY),
 158         EndContainer(),
 159         NWidget(WWT_PANEL, COLOUR_GREY),
 160                 NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
 161                         NWidget(NWID_VIEWPORT, COLOUR_GREY, WID_W_VIEWPORT), SetMinimalSize(256, 88), SetResize(1, 1),
 162                 EndContainer(),
 163         EndContainer(),
 164         NWidget(NWID_HORIZONTAL),
 165                 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
 166                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_W_SHOW_VEHICLES), SetMinimalSize(15, 12), SetDataTip(STR_SHIP, STR_STATION_VIEW_SCHEDULED_SHIPS_TOOLTIP),
 167                 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
 168         EndContainer(),
 169 };
 170
 171 /** The description of the waypoint view. */
 172 static WindowDesc _waypoint_view_desc(
 173         WDP_AUTO, "view_waypoint", 260, 118,
 174         WC_WAYPOINT_VIEW, WC_NONE,
 175         0,
 176         _nested_waypoint_view_widgets, lengthof(_nested_waypoint_view_widgets)
 177 );
 178
 179 /**
 180  * Show the window for the given waypoint.
 181  * @param wp The waypoint to show the window for.
 182  */
 183 void ShowWaypointWindow(const Waypoint *wp)
 184 {
 185         AllocateWindowDescFront<WaypointWindow>(&_waypoint_view_desc, wp->index);
 186 }