src/transparency_gui.cpp

   1 /* $Id$ */
   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
  10 /** @file transparency_gui.cpp The transparency GUI. */
  11
  12 #include "stdafx.h"
  13 #include "window_gui.h"
  14 #include "transparency.h"
  15 #include "sound_func.h"
  16 #include "settings_type.h"
  17
  18 #include "widgets/transparency_widget.h"
  19
  20 #include "table/sprites.h"
  21 #include "table/strings.h"
  22
  23 #include "safeguards.h"
  24
  25 TransparencyOptionBits _transparency_opt;  ///< The bits that should be transparent.
  26 TransparencyOptionBits _transparency_lock; ///< Prevent these bits from flipping with X.
  27 TransparencyOptionBits _invisibility_opt;  ///< The bits that should be invisible.
  28 byte _display_opt; ///< What do we want to draw/do?
  29
  30 class TransparenciesWindow : public Window
  31 {
  32 public:
  33         TransparenciesWindow(WindowDesc *desc, int window_number) : Window(desc)
  34         {
  35                 this->InitNested(window_number);
  36         }
  37
  38         virtual void OnPaint()
  39         {
  40                 this->OnInvalidateData(0); // Must be sure that the widgets show the transparency variable changes, also when we use shortcuts.
  41                 this->DrawWidgets();
  42         }
  43
  44         virtual void DrawWidget(const Rect &r, int widget) const
  45         {
  46                 switch (widget) {
  47                         case WID_TT_SIGNS:
  48                         case WID_TT_TREES:
  49                         case WID_TT_HOUSES:
  50                         case WID_TT_INDUSTRIES:
  51                         case WID_TT_BUILDINGS:
  52                         case WID_TT_BRIDGES:
  53                         case WID_TT_STRUCTURES:
  54                         case WID_TT_CATENARY:
  55                         case WID_TT_LOADING: {
  56                                 uint i = widget - WID_TT_BEGIN;
  57                                 if (HasBit(_transparency_lock, i)) DrawSprite(SPR_LOCK, PAL_NONE, r.left + 1, r.top + 1);
  58                                 break;
  59                         }
  60                         case WID_TT_BUTTONS:
  61                                 for (uint i = WID_TT_BEGIN; i < WID_TT_END; i++) {
  62                                         if (i == WID_TT_LOADING) continue; // Do not draw button for invisible loading indicators.
  63
  64                                         const NWidgetBase *wi = this->GetWidget<NWidgetBase>(i);
  65                                         DrawFrameRect(wi->pos_x + 1, r.top + 2, wi->pos_x + wi->current_x - 2, r.bottom - 2, COLOUR_PALE_GREEN,
  66                                                         HasBit(_invisibility_opt, i - WID_TT_BEGIN) ? FR_LOWERED : FR_NONE);
  67                                 }
  68                                 break;
  69                 }
  70         }
  71
  72         virtual void OnClick(Point pt, int widget, int click_count)
  73         {
  74                 if (widget >= WID_TT_BEGIN && widget < WID_TT_END) {
  75                         if (_ctrl_pressed) {
  76                                 /* toggle the bit of the transparencies lock variable */
  77                                 ToggleTransparencyLock((TransparencyOption)(widget - WID_TT_BEGIN));
  78                                 this->SetDirty();
  79                         } else {
  80                                 /* toggle the bit of the transparencies variable and play a sound */
  81                                 ToggleTransparency((TransparencyOption)(widget - WID_TT_BEGIN));
  82                                 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
  83                                 MarkWholeScreenDirty();
  84                         }
  85                 } else if (widget == WID_TT_BUTTONS) {
  86                         uint i;
  87                         for (i = WID_TT_BEGIN; i < WID_TT_END; i++) {
  88                                 const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
  89                                 if (IsInsideBS(pt.x, nwid->pos_x, nwid->current_x)) {
  90                                         break;
  91                                 }
  92                         }
  93                         if (i == WID_TT_LOADING || i == WID_TT_END) return;
  94
  95                         ToggleInvisibility((TransparencyOption)(i - WID_TT_BEGIN));
  96                         if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
  97
  98                         /* Redraw whole screen only if transparency is set */
  99                         if (IsTransparencySet((TransparencyOption)(i - WID_TT_BEGIN))) {
 100                                 MarkWholeScreenDirty();
 101                         } else {
 102                                 this->SetWidgetDirty(WID_TT_BUTTONS);
 103                         }
 104                 }
 105         }
 106
 107         virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
 108         {
 109                 Point pt = GetToolbarAlignedWindowPosition(sm_width);
 110                 pt.y += 2 * (sm_height - this->GetWidget<NWidgetBase>(WID_TT_BUTTONS)->current_y);
 111                 return pt;
 112         }
 113
 114         /**
 115          * Some data on this window has become invalid.
 116          * @param data Information about the changed data.
 117          * @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.
 118          */
 119         virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
 120         {
 121                 if (!gui_scope) return;
 122                 for (uint i = WID_TT_BEGIN; i < WID_TT_END; i++) {
 123                         this->SetWidgetLoweredState(i, IsTransparencySet((TransparencyOption)(i - WID_TT_BEGIN)));
 124                 }
 125         }
 126 };
 127
 128 static const NWidgetPart _nested_transparency_widgets[] = {
 129         NWidget(NWID_HORIZONTAL),
 130                 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
 131                 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_TRANSPARENCY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 132                 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
 133         EndContainer(),
 134         NWidget(NWID_HORIZONTAL),
 135                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_SIGNS), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_SIGN, STR_TRANSPARENT_SIGNS_TOOLTIP),
 136                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_TREES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_PLANTTREES, STR_TRANSPARENT_TREES_TOOLTIP),
 137                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_HOUSES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_TOWN, STR_TRANSPARENT_HOUSES_TOOLTIP),
 138                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_INDUSTRIES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_INDUSTRY, STR_TRANSPARENT_INDUSTRIES_TOOLTIP),
 139                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_BUILDINGS), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_COMPANY_LIST, STR_TRANSPARENT_BUILDINGS_TOOLTIP),
 140                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_BRIDGES), SetMinimalSize(43, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BRIDGE, STR_TRANSPARENT_BRIDGES_TOOLTIP),
 141                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_STRUCTURES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_TRANSMITTER, STR_TRANSPARENT_STRUCTURES_TOOLTIP),
 142                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_CATENARY), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_BUILD_X_ELRAIL, STR_TRANSPARENT_CATENARY_TOOLTIP),
 143                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_LOADING), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_TRAINLIST, STR_TRANSPARENT_LOADING_TOOLTIP),
 144                 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(1, 1), EndContainer(),
 145         EndContainer(),
 146         /* Panel with 'invisibility' buttons. */
 147         NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_TT_BUTTONS), SetMinimalSize(219, 13), SetDataTip(0x0, STR_TRANSPARENT_INVISIBLE_TOOLTIP),
 148         EndContainer(),
 149 };
 150
 151 static WindowDesc _transparency_desc(
 152         WDP_MANUAL, "toolbar_transparency", 0, 0,
 153         WC_TRANSPARENCY_TOOLBAR, WC_NONE,
 154         0,
 155         _nested_transparency_widgets, lengthof(_nested_transparency_widgets)
 156 );
 157
 158 /**
 159  * Show the transparency toolbar.
 160  */
 161 void ShowTransparencyToolbar()
 162 {
 163         AllocateWindowDescFront<TransparenciesWindow>(&_transparency_desc, 0);
 164 }