src/viewport_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 viewport_gui.cpp Extra viewport window. */
  11
  12 #include "stdafx.h"
  13 #include "landscape.h"
  14 #include "window_gui.h"
  15 #include "viewport_func.h"
  16 #include "strings_func.h"
  17 #include "tunnelbridge.h"
  18 #include "tilehighlight_func.h"
  19 #include "zoom_func.h"
  20 #include "window_func.h"
  21 #include "gfx_func.h"
  22 #include "industry.h"
  23 #include "town_map.h"
  24
  25 #include "widgets/viewport_widget.h"
  26
  27 #include "table/strings.h"
  28 #include "table/sprites.h"
  29
  30 #include "safeguards.h"
  31
  32 /* Extra ViewPort Window Stuff */
  33 static const NWidgetPart _nested_extra_view_port_widgets[] = {
  34         NWidget(NWID_HORIZONTAL),
  35                 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
  36                 NWidget(WWT_CAPTION, COLOUR_GREY, WID_EV_CAPTION), SetDataTip(STR_EXTRA_VIEW_PORT_TITLE, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
  37                 NWidget(WWT_SHADEBOX, COLOUR_GREY),
  38                 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
  39                 NWidget(WWT_STICKYBOX, COLOUR_GREY),
  40         EndContainer(),
  41         NWidget(WWT_PANEL, COLOUR_GREY),
  42                 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_EV_VIEWPORT), SetPadding(2, 2, 2, 2), SetResize(1, 1), SetFill(1, 1),
  43         EndContainer(),
  44         NWidget(NWID_HORIZONTAL),
  45                 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_EV_ZOOM_IN), SetDataTip(SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN),
  46                 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_EV_ZOOM_OUT), SetDataTip(SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT),
  47                 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
  48                         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_EV_MAIN_TO_VIEW), SetFill(1, 1), SetResize(1, 0),
  49                                                                                 SetDataTip(STR_EXTRA_VIEW_MOVE_MAIN_TO_VIEW, STR_EXTRA_VIEW_MOVE_MAIN_TO_VIEW_TT),
  50                         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_EV_VIEW_TO_MAIN), SetFill(1, 1), SetResize(1, 0),
  51                                                                                 SetDataTip(STR_EXTRA_VIEW_MOVE_VIEW_TO_MAIN, STR_EXTRA_VIEW_MOVE_VIEW_TO_MAIN_TT),
  52                 EndContainer(),
  53         EndContainer(),
  54         NWidget(NWID_HORIZONTAL),
  55                 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
  56                 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
  57         EndContainer(),
  58 };
  59
  60 class ExtraViewportWindow : public Window {
  61 public:
  62         ExtraViewportWindow(WindowDesc *desc, int window_number, TileIndex tile) : Window(desc)
  63         {
  64                 this->InitNested(window_number);
  65
  66                 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_EV_VIEWPORT);
  67                 nvp->InitializeViewport(this, 0, ZOOM_LVL_VIEWPORT);
  68                 if (_settings_client.gui.zoom_min == ZOOM_LVL_VIEWPORT) this->DisableWidget(WID_EV_ZOOM_IN);
  69
  70                 Point pt;
  71                 if (tile == INVALID_TILE) {
  72                         /* No tile? Use center of main viewport. */
  73                         const Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
  74
  75                         /* center on same place as main window (zoom is maximum, no adjustment needed) */
  76                         pt.x = w->viewport->scrollpos_x + w->viewport->virtual_width / 2;
  77                         pt.y = w->viewport->scrollpos_y + w->viewport->virtual_height / 2;
  78                 } else {
  79                         pt = RemapCoords(TileX(tile) * TILE_SIZE + TILE_SIZE / 2, TileY(tile) * TILE_SIZE + TILE_SIZE / 2, TilePixelHeight(tile));
  80                 }
  81
  82                 this->viewport->scrollpos_x = pt.x - this->viewport->virtual_width / 2;
  83                 this->viewport->scrollpos_y = pt.y - this->viewport->virtual_height / 2;
  84                 this->viewport->dest_scrollpos_x = this->viewport->scrollpos_x;
  85                 this->viewport->dest_scrollpos_y = this->viewport->scrollpos_y;
  86                 this->viewport->map_type = (ViewportMapType) _settings_client.gui.default_viewport_map_mode;
  87         }
  88
  89         virtual void SetStringParameters(int widget) const
  90         {
  91                 switch (widget) {
  92                         case WID_EV_CAPTION:
  93                                 /* set the number in the title bar */
  94                                 SetDParam(0, this->window_number + 1);
  95                                 break;
  96                 }
  97         }
  98
  99         virtual void OnClick(Point pt, int widget, int click_count)
 100         {
 101                 switch (widget) {
 102                         case WID_EV_ZOOM_IN: DoZoomInOutWindow(ZOOM_IN,  this); break;
 103                         case WID_EV_ZOOM_OUT: DoZoomInOutWindow(ZOOM_OUT, this); break;
 104
 105                         case WID_EV_MAIN_TO_VIEW: { // location button (move main view to same spot as this view) 'Paste Location'
 106                                 Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
 107                                 int x = this->viewport->scrollpos_x; // Where is the main looking at
 108                                 int y = this->viewport->scrollpos_y;
 109
 110                                 /* set this view to same location. Based on the center, adjusting for zoom */
 111                                 w->viewport->dest_scrollpos_x =  x - (w->viewport->virtual_width -  this->viewport->virtual_width) / 2;
 112                                 w->viewport->dest_scrollpos_y =  y - (w->viewport->virtual_height - this->viewport->virtual_height) / 2;
 113                                 w->viewport->follow_vehicle   = INVALID_VEHICLE;
 114                                 break;
 115                         }
 116
 117                         case WID_EV_VIEW_TO_MAIN: { // inverse location button (move this view to same spot as main view) 'Copy Location'
 118                                 const Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
 119                                 int x = w->viewport->scrollpos_x;
 120                                 int y = w->viewport->scrollpos_y;
 121
 122                                 this->viewport->dest_scrollpos_x =  x + (w->viewport->virtual_width -  this->viewport->virtual_width) / 2;
 123                                 this->viewport->dest_scrollpos_y =  y + (w->viewport->virtual_height - this->viewport->virtual_height) / 2;
 124                                 break;
 125                         }
 126                 }
 127         }
 128
 129         virtual void OnResize()
 130         {
 131                 if (this->viewport != NULL) {
 132                         NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_EV_VIEWPORT);
 133                         nvp->UpdateViewportCoordinates(this);
 134                 }
 135         }
 136
 137         virtual void OnScroll(Point delta)
 138         {
 139                 this->viewport->scrollpos_x += ScaleByZoom(delta.x, this->viewport->zoom);
 140                 this->viewport->scrollpos_y += ScaleByZoom(delta.y, this->viewport->zoom);
 141                 this->viewport->dest_scrollpos_x = this->viewport->scrollpos_x;
 142                 this->viewport->dest_scrollpos_y = this->viewport->scrollpos_y;
 143         }
 144
 145         virtual void OnMouseWheel(int wheel)
 146         {
 147                 if (_ctrl_pressed) {
 148                         /* Cycle through the drawing modes */
 149                         this->viewport->map_type = ChangeRenderMode(this->viewport, wheel < 0);
 150                         this->SetDirty();
 151                 } else if (_settings_client.gui.scrollwheel_scrolling == 0) {
 152                         ZoomInOrOutToCursorWindow(wheel < 0, this);
 153                 }
 154         }
 155
 156         /**
 157          * Some data on this window has become invalid.
 158          * @param data Information about the changed data.
 159          * @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.
 160          */
 161         virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
 162         {
 163                 if (!gui_scope) return;
 164                 /* Only handle zoom message if intended for us (msg ZOOM_IN/ZOOM_OUT) */
 165                 HandleZoomMessage(this, this->viewport, WID_EV_ZOOM_IN, WID_EV_ZOOM_OUT);
 166         }
 167 };
 168
 169 static WindowDesc _extra_view_port_desc(
 170         WDP_AUTO, "extra_viewport", 300, 268,
 171         WC_EXTRA_VIEW_PORT, WC_NONE,
 172         0,
 173         _nested_extra_view_port_widgets, lengthof(_nested_extra_view_port_widgets)
 174 );
 175
 176 /**
 177  * Show a new Extra Viewport window.
 178  * @param tile Tile to center the view on. INVALID_TILE means to use the center of main viewport.
 179  */
 180 void ShowExtraViewPortWindow(TileIndex tile)
 181 {
 182         int i = 0;
 183
 184         /* find next free window number for extra viewport */
 185         while (FindWindowById(WC_EXTRA_VIEW_PORT, i) != NULL) i++;
 186
 187         new ExtraViewportWindow(&_extra_view_port_desc, i, tile);
 188 }
 189
 190 /**
 191  * Show a new Extra Viewport window.
 192  * When building a tunnel, the tunnel end-tile is used as center for new viewport.
 193  * Otherwise center it on the tile under the cursor, if the cursor is inside a viewport.
 194  * If that fails, center it on main viewport center.
 195  */
 196 void ShowExtraViewPortWindowForTileUnderCursor()
 197 {
 198         if (_build_tunnel_endtile != 0 && _thd.place_mode & HT_TUNNEL) {
 199                 ShowExtraViewPortWindow(_build_tunnel_endtile);
 200                 return;
 201         }
 202
 203         /* Use tile under mouse as center for new viewport.
 204          * Do this before creating the window, it might appear just below the mouse. */
 205         Point pt = GetTileBelowCursor();
 206         ShowExtraViewPortWindow(pt.x != -1 ? TileVirtXY(pt.x, pt.y) : INVALID_TILE);
 207 }