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