viewport_gui.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#include "stdafx.h"
#include "landscape.h"
#include "window_gui.h"
#include "viewport_func.h"
#include "strings_func.h"
#include "zoom_func.h"
#include "window_func.h"
 
#include "widgets/viewport_widget.h"
 
#include "table/strings.h"
#include "table/sprites.h"
 
#include "safeguards.h"
 
/* Extra Viewport Window Stuff */
static constexpr NWidgetPart _nested_extra_viewport_widgets[] = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY, WID_EV_CAPTION),
    NWidget(WWT_SHADEBOX, COLOUR_GREY),
    NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
    NWidget(WWT_STICKYBOX, COLOUR_GREY),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY),
    NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_EV_VIEWPORT), SetPadding(2, 2, 2, 2), SetResize(1, 1), SetFill(1, 1),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_EV_ZOOM_IN), SetSpriteTip(SPR_IMG_ZOOMIN, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_IN),
    NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_EV_ZOOM_OUT), SetSpriteTip(SPR_IMG_ZOOMOUT, STR_TOOLBAR_TOOLTIP_ZOOM_THE_VIEW_OUT),
    NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize),
      NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_EV_MAIN_TO_VIEW), SetFill(1, 1), SetResize(1, 0),
                    SetStringTip(STR_EXTRA_VIEW_MOVE_MAIN_TO_VIEW, STR_EXTRA_VIEW_MOVE_MAIN_TO_VIEW_TOOLTIP),
      NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_EV_VIEW_TO_MAIN), SetFill(1, 1), SetResize(1, 0),
                    SetStringTip(STR_EXTRA_VIEW_MOVE_VIEW_TO_MAIN, STR_EXTRA_VIEW_MOVE_VIEW_TO_MAIN_TOOLTIP),
    EndContainer(),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
    NWidget(WWT_RESIZEBOX, COLOUR_GREY),
  EndContainer(),
};
 
class ExtraViewportWindow : public Window {
public:
  ExtraViewportWindow(WindowDesc &desc, int window_number, TileIndex tile) : Window(desc)
  {
    this->InitNested(window_number);
 
    NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_EV_VIEWPORT);
    nvp->InitializeViewport(this, tile, ScaleZoomGUI(ZoomLevel::Viewport));
    if (_settings_client.gui.zoom_min == viewport->zoom) this->DisableWidget(WID_EV_ZOOM_IN);
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    switch (widget) {
      case WID_EV_CAPTION:
        /* set the number in the title bar */
        return GetString(STR_EXTRA_VIEWPORT_TITLE, this->window_number + 1);
 
      default:
        return this->Window::GetWidgetString(widget, stringid);
    }
  }
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override {…}
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_EV_ZOOM_IN: DoZoomInOutWindow(ZOOM_IN,  this); break;
      case WID_EV_ZOOM_OUT: DoZoomInOutWindow(ZOOM_OUT, this); break;
 
      case WID_EV_MAIN_TO_VIEW: { // location button (move main view to same spot as this view) 'Paste Location'
        Window *w = GetMainWindow();
        int x = this->viewport->scrollpos_x; // Where is the main looking at
        int y = this->viewport->scrollpos_y;
 
        /* set this view to same location. Based on the center, adjusting for zoom */
        w->viewport->dest_scrollpos_x =  x - (w->viewport->virtual_width -  this->viewport->virtual_width) / 2;
        w->viewport->dest_scrollpos_y =  y - (w->viewport->virtual_height - this->viewport->virtual_height) / 2;
        w->viewport->follow_vehicle   = VehicleID::Invalid();
        break;
      }
 
      case WID_EV_VIEW_TO_MAIN: { // inverse location button (move this view to same spot as main view) 'Copy Location'
        const Window *w = GetMainWindow();
        int x = w->viewport->scrollpos_x;
        int y = w->viewport->scrollpos_y;
 
        this->viewport->dest_scrollpos_x =  x + (w->viewport->virtual_width -  this->viewport->virtual_width) / 2;
        this->viewport->dest_scrollpos_y =  y + (w->viewport->virtual_height - this->viewport->virtual_height) / 2;
        break;
      }
    }
  }
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override {…}
 
  void OnResize() override
  {
    if (this->viewport != nullptr) {
      NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_EV_VIEWPORT);
      nvp->UpdateViewportCoordinates(this);
    }
  }
  void OnResize() override {…}
 
  void OnScroll(Point delta) override
  {
    this->viewport->scrollpos_x += ScaleByZoom(delta.x, this->viewport->zoom);
    this->viewport->scrollpos_y += ScaleByZoom(delta.y, this->viewport->zoom);
    this->viewport->dest_scrollpos_x = this->viewport->scrollpos_x;
    this->viewport->dest_scrollpos_y = this->viewport->scrollpos_y;
  }
  void OnScroll(Point delta) override {…}
 
  bool OnRightClick([[maybe_unused]] Point pt, WidgetID widget) override
  {
    return widget == WID_EV_VIEWPORT;
  }
  bool OnRightClick([[maybe_unused]] Point pt, WidgetID widget) override {…}
 
  void OnMouseWheel(int wheel, WidgetID widget) override
  {
    if (widget != WID_EV_VIEWPORT) return;
    if (_settings_client.gui.scrollwheel_scrolling != SWS_OFF) {
      ZoomInOrOutToCursorWindow(wheel < 0, this);
    }
  }
  void OnMouseWheel(int wheel, WidgetID widget) override {…}
 
  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    if (!gui_scope) return;
    /* Only handle zoom message if intended for us (msg ZOOM_IN/ZOOM_OUT) */
    HandleZoomMessage(this, *this->viewport, WID_EV_ZOOM_IN, WID_EV_ZOOM_OUT);
  }
  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override {…}
};
class ExtraViewportWindow : public Window {…};
 
static WindowDesc _extra_viewport_desc(
  WDP_AUTO, "extra_viewport", 300, 268,
  WC_EXTRA_VIEWPORT, WC_NONE,
  {},
  _nested_extra_viewport_widgets
);
 
void ShowExtraViewportWindow(TileIndex tile)
{
  int i = 0;
 
  /* find next free window number for extra viewport */
  while (FindWindowById(WC_EXTRA_VIEWPORT, i) != nullptr) i++;
 
  new ExtraViewportWindow(_extra_viewport_desc, i, tile);
}
void ShowExtraViewportWindow(TileIndex tile) {…}
 
void ShowExtraViewportWindowForTileUnderCursor()
{
  /* Use tile under mouse as center for new viewport.
   * Do this before creating the window, it might appear just below the mouse. */
  Point pt = GetTileBelowCursor();
  ShowExtraViewportWindow(pt.x != -1 ? TileVirtXY(pt.x, pt.y) : INVALID_TILE);
}
void ShowExtraViewportWindowForTileUnderCursor() {…}