OpenTTD Source  20241120-master-g6d3adc6169
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 constexpr NWidgetPart _nested_extra_viewport_widgets[] = {
28  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
29  NWidget(WWT_CAPTION, COLOUR_GREY, WID_EV_CAPTION), SetDataTip(STR_EXTRA_VIEWPORT_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 
64  void SetStringParameters(WidgetID widget) const override
65  {
66  switch (widget) {
67  case WID_EV_CAPTION:
68  /* set the number in the title bar */
69  SetDParam(0, this->window_number + 1);
70  break;
71  }
72  }
73 
74  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
75  {
76  switch (widget) {
77  case WID_EV_ZOOM_IN: DoZoomInOutWindow(ZOOM_IN, this); break;
78  case WID_EV_ZOOM_OUT: DoZoomInOutWindow(ZOOM_OUT, this); break;
79 
80  case WID_EV_MAIN_TO_VIEW: { // location button (move main view to same spot as this view) 'Paste Location'
81  Window *w = GetMainWindow();
82  int x = this->viewport->scrollpos_x; // Where is the main looking at
83  int y = this->viewport->scrollpos_y;
84 
85  /* set this view to same location. Based on the center, adjusting for zoom */
89  break;
90  }
91 
92  case WID_EV_VIEW_TO_MAIN: { // inverse location button (move this view to same spot as main view) 'Copy Location'
93  const Window *w = GetMainWindow();
94  int x = w->viewport->scrollpos_x;
95  int y = w->viewport->scrollpos_y;
96 
97  this->viewport->dest_scrollpos_x = x + (w->viewport->virtual_width - this->viewport->virtual_width) / 2;
99  break;
100  }
101  }
102  }
103 
104  void OnResize() override
105  {
106  if (this->viewport != nullptr) {
107  NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_EV_VIEWPORT);
108  nvp->UpdateViewportCoordinates(this);
109  }
110  }
111 
112  void OnScroll(Point delta) override
113  {
114  this->viewport->scrollpos_x += ScaleByZoom(delta.x, this->viewport->zoom);
115  this->viewport->scrollpos_y += ScaleByZoom(delta.y, this->viewport->zoom);
118  }
119 
120  bool OnRightClick([[maybe_unused]] Point pt, WidgetID widget) override
121  {
122  return widget == WID_EV_VIEWPORT;
123  }
124 
125  void OnMouseWheel(int wheel) override
126  {
128  ZoomInOrOutToCursorWindow(wheel < 0, this);
129  }
130  }
131 
137  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
138  {
139  if (!gui_scope) return;
140  /* Only handle zoom message if intended for us (msg ZOOM_IN/ZOOM_OUT) */
142  }
143 };
144 
145 static WindowDesc _extra_viewport_desc(
146  WDP_AUTO, "extra_viewport", 300, 268,
148  0,
149  _nested_extra_viewport_widgets
150 );
151 
157 {
158  int i = 0;
159 
160  /* find next free window number for extra viewport */
161  while (FindWindowById(WC_EXTRA_VIEWPORT, i) != nullptr) i++;
162 
163  new ExtraViewportWindow(_extra_viewport_desc, i, tile);
164 }
165 
172 {
173  /* Use tile under mouse as center for new viewport.
174  * Do this before creating the window, it might appear just below the mouse. */
175  Point pt = GetTileBelowCursor();
176  ShowExtraViewportWindow(pt.x != -1 ? TileVirtXY(pt.x, pt.y) : INVALID_TILE);
177 }
void OnInvalidateData([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
Some data on this window has become invalid.
void OnResize() override
Called after the window got resized.
Nested widget to display a viewport in a window.
Definition: widget_type.h:680
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition: widget.cpp:2297
void InitializeViewport(Window *w, std::variant< TileIndex, VehicleID > focus, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:2288
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1181
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1228
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1202
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1309
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1191
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Definition: widget_type.h:1126
Functions related to OTTD's landscape.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
Definition: main_gui.cpp:93
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:404
A number of safeguards to prevent using unsafe methods.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:56
@ SWS_OFF
Scroll wheel has no effect.
This file contains all sprite-related enums and defines.
Definition of base types and functions in a cross-platform compatible way.
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
Functions related to OTTD's strings.
GUISettings gui
settings related to the GUI
ZoomLevel zoom_min
minimum zoom out level
uint8_t scrollwheel_scrolling
scrolling using the scroll wheel?
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:1075
Coordinates of a point in 2D.
int32_t dest_scrollpos_y
Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:257
int32_t scrollpos_y
Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:255
int32_t dest_scrollpos_x
Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewp...
Definition: window_gui.h:256
VehicleID follow_vehicle
VehicleID to follow if following a vehicle, INVALID_VEHICLE otherwise.
Definition: window_gui.h:253
int32_t scrollpos_x
Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
Definition: window_gui.h:254
ZoomLevel zoom
The zoom level of the viewport.
Definition: viewport_type.h:33
int virtual_width
width << zoom
Definition: viewport_type.h:30
int virtual_height
height << zoom
Definition: viewport_type.h:31
High level window description.
Definition: window_gui.h:159
Data structure for an opened window.
Definition: window_gui.h:273
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
Definition: window_gui.h:397
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:318
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1756
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1746
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:302
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:95
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:54
void HandleZoomMessage(Window *w, const Viewport *vp, WidgetID widget_zoom_in, WidgetID widget_zoom_out)
Update the status of the zoom-buttons according to the zoom-level of the viewport.
Definition: viewport.cpp:494
Functions related to (drawing on) viewports.
void ShowExtraViewportWindowForTileUnderCursor()
Show a new Extra Viewport window.
void ShowExtraViewportWindow(TileIndex tile)
Show a new Extra Viewport window.
@ ZOOM_IN
Zoom in (get more detailed view).
Definition: viewport_type.h:77
@ ZOOM_OUT
Zoom out (get helicopter view).
Definition: viewport_type.h:78
Types related to the viewport widgets.
@ WID_EV_MAIN_TO_VIEW
Center the view of this viewport on the main view.
@ WID_EV_VIEW_TO_MAIN
Center the main view on the view of this viewport.
@ WID_EV_CAPTION
Caption of window.
@ WID_EV_ZOOM_OUT
Zoom out.
@ WID_EV_VIEWPORT
The viewport.
@ WID_EV_ZOOM_IN
Zoom in.
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:524
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:112
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:113
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:66
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:64
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:65
@ NWID_VIEWPORT
Nested widget containing a viewport.
Definition: widget_type.h:81
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1098
Window * GetMainWindow()
Get the main window, i.e.
Definition: window.cpp:1127
Window functions not directly related to making/drawing windows.
Functions, definitions and such used only by the GUI.
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:147
int WidgetID
Widget ID.
Definition: window_type.h:18
@ WC_EXTRA_VIEWPORT
Extra viewport; Window numbers:
Definition: window_type.h:642
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:45
Functions related to zooming.
int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_MIN) When shifting right,...
Definition: zoom_func.h:22
ZoomLevel ScaleZoomGUI(ZoomLevel value)
Scale zoom level relative to GUI zoom.
Definition: zoom_func.h:87
@ ZOOM_LVL_VIEWPORT
Default zoom level for viewports.
Definition: zoom_type.h:28