OpenTTD
viewport_gui.cpp
Go to the documentation of this file.
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 
10 #include "stdafx.h"
11 #include "landscape.h"
12 #include "window_gui.h"
13 #include "viewport_func.h"
14 #include "strings_func.h"
15 #include "zoom_func.h"
16 #include "window_func.h"
17 
19 
20 #include "table/strings.h"
21 #include "table/sprites.h"
22 
23 #include "safeguards.h"
24 
25 /* Extra ViewPort Window Stuff */
26 static const NWidgetPart _nested_extra_view_port_widgets[] = {
28  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
29  NWidget(WWT_CAPTION, COLOUR_GREY, WID_EV_CAPTION), SetDataTip(STR_EXTRA_VIEW_PORT_TITLE, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
30  NWidget(WWT_SHADEBOX, COLOUR_GREY),
31  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
32  NWidget(WWT_STICKYBOX, COLOUR_GREY),
33  EndContainer(),
34  NWidget(WWT_PANEL, COLOUR_GREY),
35  NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_EV_VIEWPORT), SetPadding(2, 2, 2, 2), SetResize(1, 1), SetFill(1, 1),
36  EndContainer(),
38  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_EV_ZOOM_IN), SetDataTip(SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN),
39  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_EV_ZOOM_OUT), SetDataTip(SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT),
41  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_EV_MAIN_TO_VIEW), SetFill(1, 1), SetResize(1, 0),
42  SetDataTip(STR_EXTRA_VIEW_MOVE_MAIN_TO_VIEW, STR_EXTRA_VIEW_MOVE_MAIN_TO_VIEW_TT),
43  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_EV_VIEW_TO_MAIN), SetFill(1, 1), SetResize(1, 0),
44  SetDataTip(STR_EXTRA_VIEW_MOVE_VIEW_TO_MAIN, STR_EXTRA_VIEW_MOVE_VIEW_TO_MAIN_TT),
45  EndContainer(),
46  EndContainer(),
48  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
49  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
50  EndContainer(),
51 };
52 
53 class ExtraViewportWindow : public Window {
54 public:
56  {
57  this->InitNested(window_number);
58 
59  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_EV_VIEWPORT);
62 
63  Point pt;
64  if (tile == INVALID_TILE) {
65  /* No tile? Use center of main viewport. */
66  const Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
67 
68  /* center on same place as main window (zoom is maximum, no adjustment needed) */
69  pt.x = w->viewport->scrollpos_x + w->viewport->virtual_width / 2;
70  pt.y = w->viewport->scrollpos_y + w->viewport->virtual_height / 2;
71  } else {
72  pt = RemapCoords(TileX(tile) * TILE_SIZE + TILE_SIZE / 2, TileY(tile) * TILE_SIZE + TILE_SIZE / 2, TilePixelHeight(tile));
73  }
74 
75  this->viewport->scrollpos_x = pt.x - this->viewport->virtual_width / 2;
76  this->viewport->scrollpos_y = pt.y - this->viewport->virtual_height / 2;
79  }
80 
81  void SetStringParameters(int widget) const override
82  {
83  switch (widget) {
84  case WID_EV_CAPTION:
85  /* set the number in the title bar */
86  SetDParam(0, this->window_number + 1);
87  break;
88  }
89  }
90 
91  void OnClick(Point pt, int widget, int click_count) override
92  {
93  switch (widget) {
94  case WID_EV_ZOOM_IN: DoZoomInOutWindow(ZOOM_IN, this); break;
95  case WID_EV_ZOOM_OUT: DoZoomInOutWindow(ZOOM_OUT, this); break;
96 
97  case WID_EV_MAIN_TO_VIEW: { // location button (move main view to same spot as this view) 'Paste Location'
99  int x = this->viewport->scrollpos_x; // Where is the main looking at
100  int y = this->viewport->scrollpos_y;
101 
102  /* set this view to same location. Based on the center, adjusting for zoom */
106  break;
107  }
108 
109  case WID_EV_VIEW_TO_MAIN: { // inverse location button (move this view to same spot as main view) 'Copy Location'
110  const Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
111  int x = w->viewport->scrollpos_x;
112  int y = w->viewport->scrollpos_y;
113 
114  this->viewport->dest_scrollpos_x = x + (w->viewport->virtual_width - this->viewport->virtual_width) / 2;
116  break;
117  }
118  }
119  }
120 
121  void OnResize() override
122  {
123  if (this->viewport != nullptr) {
124  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_EV_VIEWPORT);
125  nvp->UpdateViewportCoordinates(this);
126  }
127  }
128 
129  void OnScroll(Point delta) override
130  {
131  this->viewport->scrollpos_x += ScaleByZoom(delta.x, this->viewport->zoom);
132  this->viewport->scrollpos_y += ScaleByZoom(delta.y, this->viewport->zoom);
135  }
136 
137  void OnMouseWheel(int wheel) override
138  {
140  ZoomInOrOutToCursorWindow(wheel < 0, this);
141  }
142  }
143 
149  void OnInvalidateData(int data = 0, bool gui_scope = true) override
150  {
151  if (!gui_scope) return;
152  /* Only handle zoom message if intended for us (msg ZOOM_IN/ZOOM_OUT) */
154  }
155 };
156 
157 static WindowDesc _extra_view_port_desc(
158  WDP_AUTO, "extra_viewport", 300, 268,
160  0,
161  _nested_extra_view_port_widgets, lengthof(_nested_extra_view_port_widgets)
162 );
163 
169 {
170  int i = 0;
171 
172  /* find next free window number for extra viewport */
173  while (FindWindowById(WC_EXTRA_VIEW_PORT, i) != nullptr) i++;
174 
175  new ExtraViewportWindow(&_extra_view_port_desc, i, tile);
176 }
177 
184 {
185  /* Use tile under mouse as center for new viewport.
186  * Do this before creating the window, it might appear just below the mouse. */
187  Point pt = GetTileBelowCursor();
188  ShowExtraViewPortWindow(pt.x != -1 ? TileVirtXY(pt.x, pt.y) : INVALID_TILE);
189 }
Nested widget containing a viewport.
Definition: widget_type.h:79
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
Definition: main_gui.cpp:136
Functions related to OTTD&#39;s strings.
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:103
void OnResize() override
Called after the window got resized.
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:928
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1867
High level window description.
Definition: window_gui.h:166
Zoom out (get helicopter view).
Definition: viewport_type.h:82
void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out)
Update the status of the zoom-buttons according to the zoom-level of the viewport.
Definition: viewport.cpp:476
static Point RemapCoords(int x, int y, int z)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap...
Definition: landscape.h:82
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition: widget.cpp:1934
Horizontal container.
Definition: widget_type.h:73
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1130
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
int virtual_height
height << zoom
Definition: viewport_type.h:31
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:22
Center the main view on the view of this viewport.
Close box (at top-left of a window)
Definition: widget_type.h:67
Zoom in (get more detailed view).
Definition: viewport_type.h:81
void OnMouseWheel(int wheel) override
The mouse wheel has been turned.
void InitializeViewport(Window *w, uint32 follow_flags, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:1925
void DisableWidget(byte widget_index)
Sets a widget to disabled.
Definition: window_gui.h:402
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Nested widget to display a viewport in a window.
Definition: widget_type.h:573
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
Functions, definitions and such used only by the GUI.
void OnScroll(Point delta) override
Handle the request for (viewport) scrolling.
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Functions related to (drawing on) viewports.
void ShowExtraViewPortWindow(TileIndex tile)
Show a new Extra Viewport window.
Data structure for an opened window.
Definition: window_gui.h:276
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1044
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1857
Main window; Window numbers:
Definition: window_type.h:44
The viewport.
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:63
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:78
uint8 scrollwheel_scrolling
scrolling using the scroll wheel?
Definition of base types and functions in a cross-platform compatible way.
A number of safeguards to prevent using unsafe methods.
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
Simple depressed panel.
Definition: widget_type.h:48
int32 scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:258
int virtual_width
width << zoom
Definition: viewport_type.h:30
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1112
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
Definition: window_gui.h:257
int32 dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:261
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:194
int32 dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:260
GUISettings gui
settings related to the GUI
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
Default zoom level for viewports.
Definition: zoom_type.h:33
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
Caption of window.
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:997
Functions related to zooming.
Functions related to OTTD&#39;s landscape.
Coordinates of a point in 2D.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:83
Extra viewport; Window numbers:
Definition: window_type.h:624
void ShowExtraViewPortWindowForTileUnderCursor()
Show a new Extra Viewport window.
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
Window functions not directly related to making/drawing windows.
Find a place automatically.
Definition: window_gui.h:154
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:326
ZoomLevel zoom_min
minimum zoom out level
Center the view of this viewport on the main view.
Types related to the viewport widgets.
int32 scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:259
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:427
This file contains all sprite-related enums and defines.
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
static uint TilePixelHeight(TileIndex tile)
Returns the height of a tile in pixels.
Definition: tile_map.h:72
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199