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 #include "gfx_func.h"
  26
  27 #include "widgets/waypoint_widget.h"
  28
  29 #include "table/strings.h"
  30
  31 /** GUI for accessing waypoints and buoys. */
  32 struct WaypointWindow : Window {
  33 private:
  34         VehicleType vt; ///< Vehicle type using the waypoint.
  35         Waypoint *wp;   ///< Waypoint displayed by the window.
  36
  37         /**
  38          * Get the center tile of the waypoint.
  39          * @return The center tile if the waypoint exists, otherwise the tile with the waypoint name.
  40          */
  41         TileIndex GetCenterTile() const
  42         {
  43                 if (!this->wp->IsInUse()) return this->wp->xy;
  44
  45                 TileArea ta;
  46                 this->wp->GetTileArea(&ta, this->vt == VEH_TRAIN ? STATION_WAYPOINT : STATION_BUOY);
  47                 return ta.GetCenterTile();
  48         }
  49
  50 public:
  51         /**
  52          * Construct the window.
  53          * @param desc The description of the window.
  54          * @param window_number The window number, in this case the waypoint's ID.
  55          */
  56         WaypointWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
  57         {
  58                 this->wp = Waypoint::Get(window_number);
  59                 this->vt = (wp->string_id == STR_SV_STNAME_WAYPOINT) ? VEH_TRAIN : VEH_SHIP;
  60
  61                 this->CreateNestedTree();
  62                 if (this->vt == VEH_TRAIN) {
  63                         this->GetWidget<NWidgetCore>(WID_W_SHOW_VEHICLES)->SetDataTip(STR_TRAIN, STR_STATION_VIEW_SCHEDULED_TRAINS_TOOLTIP);
  64                         this->GetWidget<NWidgetCore>(WID_W_CENTER_VIEW)->tool_tip = STR_WAYPOINT_VIEW_CENTER_TOOLTIP;
  65                         this->GetWidget<NWidgetCore>(WID_W_RENAME)->tool_tip = STR_WAYPOINT_VIEW_CHANGE_WAYPOINT_NAME;
  66                 }
  67                 this->FinishInitNested(window_number);
  68
  69                 if (this->wp->owner != OWNER_NONE) this->owner = this->wp->owner;
  70                 this->flags |= WF_DISABLE_VP_SCROLL;
  71
  72                 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
  73                 nvp->InitializeViewport(this, this->GetCenterTile(), ZOOM_LVL_VIEWPORT);
  74
  75                 this->OnInvalidateData(0);
  76         }
  77
  78         ~WaypointWindow()
  79         {
  80                 Owner owner = this->owner;
  81
  82                 /* Buoys have no owner and can be used by everyone. Show only 'our' vehicles */
  83                 if (!Company::IsValidID(owner)) owner = _local_company;
  84
  85                 /* Well, spectators otoh */
  86                 if (Company::IsValidID(owner)) DeleteWindowById(GetWindowClassForVehicleType(this->vt), VehicleListIdentifier(VL_STATION_LIST, this->vt, owner, this->window_number).Pack(), false);
  87         }
  88
  89         virtual void SetStringParameters(int widget) const
  90         {
  91                 if (widget == WID_W_CAPTION) SetDParam(0, this->wp->index);
  92         }
  93
  94         virtual void OnClick(Point pt, int widget, int click_count)
  95         {
  96                 switch (widget) {
  97                         case WID_W_CENTER_VIEW: // scroll to location
  98                                 if (_ctrl_pressed) {
  99                                         ShowExtraViewPortWindow(this->GetCenterTile());
 100                                 } else {
 101                                         ScrollMainWindowToTile(this->GetCenterTile());
 102                                 }
 103                                 break;
 104
 105                         case WID_W_RENAME: // rename
 106                                 SetDParam(0, this->wp->index);
 107                                 ShowQueryString(STR_WAYPOINT_NAME, STR_EDIT_WAYPOINT_NAME, MAX_LENGTH_STATION_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
 108                                 break;
 109
 110                         case WID_W_SHOW_VEHICLES: // show list of vehicles having this waypoint in their orders
 111                                 ShowVehicleListWindow(this->wp->owner, this->vt, this->wp->index);
 112                                 break;
 113                 }
 114         }
 115
 116         /**
 117          * Some data on this window has become invalid.
 118          * @param data Information about the changed data.
 119          * @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.
 120          */
 121         virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
 122         {
 123                 if (!gui_scope) return;
 124                 /* You can only change your own waypoints */
 125                 this->SetWidgetDisabledState(WID_W_RENAME, !this->wp->IsInUse() || (this->wp->owner != _local_company && this->wp->owner != OWNER_NONE));
 126                 /* Disable the widget for waypoints with no use */
 127                 this->SetWidgetDisabledState(WID_W_SHOW_VEHICLES, !this->wp->IsInUse());
 128
 129                 ScrollWindowToTile(this->GetCenterTile(), this, true);
 130         }
 131
 132         virtual void OnResize()
 133         {
 134                 if (this->viewport != NULL) {
 135                         NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_W_VIEWPORT);
 136                         nvp->UpdateViewportCoordinates(this);
 137                         this->wp->UpdateVirtCoord();
 138
 139                         ScrollWindowToTile(this->GetCenterTile(), this, true); // Re-center viewport.
 140                 }
 141         }
 142
 143         virtual void OnQueryTextFinished(char *str)
 144         {
 145                 if (str == NULL) return;
 146
 147                 DoCommandP(0, this->window_number, 0, CMD_RENAME_WAYPOINT | CMD_MSG(STR_ERROR_CAN_T_CHANGE_WAYPOINT_NAME), NULL, str);
 148         }
 149
 150 };
 151
 152 /** The widgets of the waypoint view. */
 153 static const NWidgetPart _nested_waypoint_view_widgets[] = {
 154         NWidget(NWID_HORIZONTAL),
 155                 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
 156                 NWidget(WWT_CAPTION, COLOUR_GREY, WID_W_CAPTION), SetDataTip(STR_WAYPOINT_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 157                 NWidget(WWT_SHADEBOX, COLOUR_GREY),
 158                 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
 159                 NWidget(WWT_STICKYBOX, COLOUR_GREY),
 160         EndContainer(),
 161         NWidget(WWT_PANEL, COLOUR_GREY),
 162                 NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
 163                         NWidget(NWID_VIEWPORT, COLOUR_GREY, WID_W_VIEWPORT), SetMinimalSize(256, 88), SetPadding(1, 1, 1, 1), SetResize(1, 1),
 164                 EndContainer(),
 165         EndContainer(),
 166         NWidget(NWID_HORIZONTAL),
 167                 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),
 168                 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),
 169                 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_W_SHOW_VEHICLES), SetMinimalSize(15, 12), SetDataTip(STR_SHIP, STR_STATION_VIEW_SCHEDULED_SHIPS_TOOLTIP),
 170                 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
 171         EndContainer(),
 172 };
 173
 174 /** The description of the waypoint view. */
 175 static WindowDesc _waypoint_view_desc(
 176         WDP_AUTO, "view_waypoint", 260, 118,
 177         WC_WAYPOINT_VIEW, WC_NONE,
 178         0,
 179         _nested_waypoint_view_widgets, lengthof(_nested_waypoint_view_widgets)
 180 );
 181
 182 /**
 183  * Show the window for the given waypoint.
 184  * @param wp The waypoint to show the window for.
 185  */
 186 void ShowWaypointWindow(const Waypoint *wp)
 187 {
 188         AllocateWindowDescFront<WaypointWindow>(&_waypoint_view_desc, wp->index);
 189 }