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