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/>.
10 /** @file viewport_gui.cpp Extra viewport window. */
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"
21 #include "widgets/viewport_widget.h"
23 #include "table/strings.h"
24 #include "table/sprites.h"
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
),
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),
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
),
48 NWidget(NWID_HORIZONTAL
),
49 NWidget(WWT_PANEL
, COLOUR_GREY
), SetFill(1, 1), SetResize(1, 0), EndContainer(),
50 NWidget(WWT_RESIZEBOX
, COLOUR_GREY
),
54 class ExtraViewportWindow
: public Window
{
56 ExtraViewportWindow (const WindowDesc
*desc
, int window_number
, TileIndex tile
) : Window(desc
)
58 this->InitNested(window_number
);
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
);
65 if (tile
== INVALID_TILE
) {
66 /* No tile? Use center of main viewport. */
67 const Window
*w
= FindWindowById(WC_MAIN_WINDOW
, 0);
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;
73 pt
= RemapCoords(TileX(tile
) * TILE_SIZE
+ TILE_SIZE
/ 2, TileY(tile
) * TILE_SIZE
+ TILE_SIZE
/ 2, TileHeight(tile
));
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
;
82 virtual void SetStringParameters(int widget
) const
86 /* set the number in the title bar */
87 SetDParam(0, this->window_number
+ 1);
92 virtual void OnClick(Point pt
, int widget
, int click_count
)
96 if (this->viewport
->zoom
<= _settings_client
.gui
.zoom_min
) break;
97 DoZoomInOutViewport (this->viewport
, true);
98 this->InvalidateData();
101 case WID_EV_ZOOM_OUT
:
102 if (this->viewport
->zoom
>= _settings_client
.gui
.zoom_max
) break;
103 DoZoomInOutViewport (this->viewport
, false);
104 this->InvalidateData();
107 case WID_EV_MAIN_TO_VIEW
: { // location button (move main view to same spot as this view) 'Paste Location'
108 Window
*w
= FindWindowById(WC_MAIN_WINDOW
, 0);
109 int x
= this->viewport
->scrollpos_x
; // Where is the main looking at
110 int y
= this->viewport
->scrollpos_y
;
112 /* set this view to same location. Based on the center, adjusting for zoom */
113 w
->viewport
->dest_scrollpos_x
= x
- (w
->viewport
->virtual_width
- this->viewport
->virtual_width
) / 2;
114 w
->viewport
->dest_scrollpos_y
= y
- (w
->viewport
->virtual_height
- this->viewport
->virtual_height
) / 2;
115 w
->viewport
->follow_vehicle
= INVALID_VEHICLE
;
119 case WID_EV_VIEW_TO_MAIN
: { // inverse location button (move this view to same spot as main view) 'Copy Location'
120 const Window
*w
= FindWindowById(WC_MAIN_WINDOW
, 0);
121 int x
= w
->viewport
->scrollpos_x
;
122 int y
= w
->viewport
->scrollpos_y
;
124 this->viewport
->dest_scrollpos_x
= x
+ (w
->viewport
->virtual_width
- this->viewport
->virtual_width
) / 2;
125 this->viewport
->dest_scrollpos_y
= y
+ (w
->viewport
->virtual_height
- this->viewport
->virtual_height
) / 2;
131 virtual void OnResize()
133 if (this->viewport
!= NULL
) {
134 NWidgetViewport
*nvp
= this->GetWidget
<NWidgetViewport
>(WID_EV_VIEWPORT
);
135 nvp
->UpdateViewportCoordinates(this);
139 virtual void OnScroll(Point delta
)
141 this->viewport
->scrollpos_x
+= ScaleByZoom(delta
.x
, this->viewport
->zoom
);
142 this->viewport
->scrollpos_y
+= ScaleByZoom(delta
.y
, this->viewport
->zoom
);
143 this->viewport
->dest_scrollpos_x
= this->viewport
->scrollpos_x
;
144 this->viewport
->dest_scrollpos_y
= this->viewport
->scrollpos_y
;
147 virtual void OnMouseWheel(int wheel
)
149 if (_settings_client
.gui
.scrollwheel_scrolling
== 0) {
150 ZoomInOrOutToCursorWindow(wheel
< 0, this);
155 * Some data on this window has become invalid.
156 * @param data Information about the changed data.
157 * @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.
159 virtual void OnInvalidateData(int data
= 0, bool gui_scope
= true)
161 if (!gui_scope
) return;
162 /* Only handle zoom message if intended for us (msg ZOOM_IN/ZOOM_OUT) */
163 HandleZoomMessage(this, this->viewport
, WID_EV_ZOOM_IN
, WID_EV_ZOOM_OUT
);
167 static WindowDesc::Prefs
_extra_view_port_prefs ("extra_viewport");
169 static const WindowDesc
_extra_view_port_desc(
171 WC_EXTRA_VIEW_PORT
, WC_NONE
,
173 _nested_extra_view_port_widgets
, lengthof(_nested_extra_view_port_widgets
),
174 &_extra_view_port_prefs
178 * Show a new Extra Viewport window.
179 * @param tile Tile to center the view on. INVALID_TILE means to use the center of main viewport.
181 void ShowExtraViewPortWindow(TileIndex tile
)
185 /* find next free window number for extra viewport */
186 while (FindWindowById(WC_EXTRA_VIEW_PORT
, i
) != NULL
) i
++;
188 new ExtraViewportWindow(&_extra_view_port_desc
, i
, tile
);
192 * Show a new Extra Viewport window.
193 * 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.
196 void ShowExtraViewPortWindowForTileUnderCursor()
198 /* Use tile under mouse as center for new viewport.
199 * Do this before creating the window, it might appear just below the mouse. */
200 Point pt
= GetTileBelowCursor();
201 ShowExtraViewPortWindow(pt
.x
!= -1 ? TileVirtXY(pt
.x
, pt
.y
) : INVALID_TILE
);