OpenTTD

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