src/waypoint_gui.cpp

   1 /* $Id$ */
   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
  10 /** @file waypoint_gui.cpp Handling of waypoints gui. */
  11
  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 /** GUI for accessing waypoints and buoys. */
  31 struct WaypointWindow : Window {
  32 private:
  33         VehicleType vt; ///< Vehicle type using the waypoint.
  34         Waypoint *wp;   ///< Waypoint displayed by the window.
  35
  36         /**
  37          * Get the center tile of the waypoint.
  38          * @return The center tile if the waypoint exists, otherwise the tile with the waypoint name.
  39          */
  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:
  50         /**
  51          * Construct the window.
  52          * @param desc The description of the window.
  53          * @param window_number The window number, in this case the waypoint's ID.
  54          */
  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                 if (this->wp->owner != OWNER_NONE) 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         ~WaypointWindow()
  78         {
  79                 Owner owner = this->owner;
  80
  81                 /* Buoys have no owner and can be used by everyone. Show only 'our' vehicles */
  82                 if (!Company::IsValidID(owner)) owner = _local_company;
  83
  84                 /* Well, spectators otoh */
  85                 if (Company::IsValidID(owner)) DeleteWindowById(GetWindowClassForVehicleType(this->vt), VehicleListIdentifier(VL_STATION_LIST, this->vt, owner, this->window_number).Pack(), false);
  86         }
  87
  88         virtual void SetStringParameters(int widget) const
  89         {
  90                 if (widget == WID_W_CAPTION) SetDParam(0, this->wp->index);
  91         }
  92
  93         virtual void OnClick(Point pt, int widget, int click_count)
  94         {
  95                 switch (widget) {
  96                         case WID_W_CENTER_VIEW: // scroll to location
  97                                 if (_ctrl_pressed) {
  98                                         ShowExtraViewPortWindow(this->GetCenterTile());
  99                                 } else {
 100                                         ScrollMainWindowToTile(this->GetCenterTile());
 101                                 }
 102                                 break;
 103
 104                         case WID_W_RENAME: // rename
 105                                 SetDParam(0, this->wp->index);
 106                                 ShowQueryString(STR_WAYPOINT_NAME, STR_EDIT_WAYPOINT_NAME, MAX_LENGTH_STATION_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
 107                                 break;
 108
 109                         case WID_W_SHOW_VEHICLES: // show list of vehicles having this waypoint in their orders
 110                                 ShowVehicleListWindow(this->wp->owner, this->vt, this->wp->index);
 111                                 break;
 112                 }
 113         }
 114
 115         /**
 116          * Some data on this window has become invalid.
 117          * @param data Information about the changed data.
 118          * @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.
 119          */
 120         virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
 121         {
 122                 if (!gui_scope) return;
 123                 /* You can only change your own waypoints */
 124                 this->SetWidgetDisabledState(WID_W_RENAME, !this->wp->IsInUse() || (this->wp->owner != _local_company && this->wp->owner != OWNER_NONE));
 125                 /* Disable the widget for waypoints with no use */
 126                 this->SetWidgetDisabledState(WID_W_SHOW_VEHICLES, !this->wp->IsInUse());
 127
 128                 ScrollWindowToTile(this->GetCenterTile(), this, true);
 129         }
 130
 131         virtual void OnResize()
 132         {
 133                 if (this->viewport != NULL) {
 134                         NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
 135                         nvp->UpdateViewportCoordinates(this);
 136                         this->wp->UpdateVirtCoord();
 137
 138                         ScrollWindowToTile(this->GetCenterTile(), this, true); // Re-center viewport.
 139                 }
 140         }
 141
 142         virtual void OnQueryTextFinished(char *str)
 143         {
 144                 if (str == NULL) return;
 145
 146                 DoCommandP(0, this->window_number, 0, CMD_RENAME_WAYPOINT | CMD_MSG(STR_ERROR_CAN_T_CHANGE_WAYPOINT_NAME), NULL, str);
 147         }
 148
 149 };
 150
 151 /** The widgets of the waypoint view. */
 152 static const NWidgetPart _nested_waypoint_view_widgets[] = {
 153         NWidget(NWID_HORIZONTAL),
 154                 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
 155                 NWidget(WWT_CAPTION, COLOUR_GREY, WID_W_CAPTION), SetDataTip(STR_WAYPOINT_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 156                 NWidget(WWT_SHADEBOX, 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), SetPadding(1, 1, 1, 1), SetResize(1, 1),
 162                 EndContainer(),
 163         EndContainer(),
 164         NWidget(NWID_HORIZONTAL),
 165                 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),
 166                 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),
 167                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_W_SHOW_VEHICLES), SetMinimalSize(15, 12), SetDataTip(STR_SHIP, STR_STATION_VIEW_SCHEDULED_SHIPS_TOOLTIP),
 168                 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
 169         EndContainer(),
 170 };
 171
 172 /** The description of the waypoint view. */
 173 static WindowDesc _waypoint_view_desc(
 174         WDP_AUTO, 260, 118,
 175         WC_WAYPOINT_VIEW, WC_NONE,
 176         0,
 177         _nested_waypoint_view_widgets, lengthof(_nested_waypoint_view_widgets)
 178 );
 179
 180 /**
 181  * Show the window for the given waypoint.
 182  * @param wp The waypoint to show the window for.
 183  */
 184 void ShowWaypointWindow(const Waypoint *wp)
 185 {
 186         AllocateWindowDescFront<WaypointWindow>(&_waypoint_view_desc, wp->index);
 187 }