OpenTTD

transparency_gui.cpp
Go to the documentation of this file.
1 /* $Id: transparency_gui.cpp 26482 2014-04-23 20:13:33Z rubidium $ */
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 "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;
26 TransparencyOptionBits _transparency_lock;
27 TransparencyOptionBits _invisibility_opt;
28 byte _display_opt;
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
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
161 void ShowTransparencyToolbar()
162 {
163 AllocateWindowDescFront<TransparenciesWindow>(&_transparency_desc, 0);
164 }
WID_TT_END
End of toggle buttons.
Definition: transparency_widget.h:28
TransparenciesWindow::OnInitialPosition
virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
Compute the initial position of the window.
Definition: transparency_gui.cpp:107
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1843
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:448
WID_TT_SIGNS
Signs background transparency toggle button.
Definition: transparency_widget.h:19
WindowDesc
High level window description.
Definition: window_gui.h:168
WID_TT_BRIDGES
Bridges transparency toggle button.
Definition: transparency_widget.h:24
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:604
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:577
NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
_transparency_opt
TransparencyOptionBits _transparency_opt
The bits that should be transparent.
Definition: transparency_gui.cpp:25
WID_TT_INDUSTRIES
industries transparency toggle button.
Definition: transparency_widget.h:22
IsInsideBS
static bool IsInsideBS(const T x, const uint base, const uint size)
Checks if a value is between a window started at some base point.
Definition: math_func.hpp:250
TransparenciesWindow::OnPaint
virtual void OnPaint()
The window must be repainted.
Definition: transparency_gui.cpp:38
WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
_invisibility_opt
TransparencyOptionBits _invisibility_opt
The bits that should be invisible.
Definition: transparency_gui.cpp:27
transparency_widget.h
Types related to the transparency widgets.
window_gui.h
Functions, definitions and such used only by the GUI.
DrawFrameRect
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:177
WID_TT_STRUCTURES
Object structure transparency toggle button.
Definition: transparency_widget.h:25
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
Window
Data structure for an opened window.
Definition: window_gui.h:271
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1833
TransparenciesWindow::OnInvalidateData
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: transparency_gui.cpp:119
WC_TRANSPARENCY_TOOLBAR
Transparency toolbar; Window numbers:
Definition: window_type.h:87
ToggleInvisibility
static void ToggleInvisibility(TransparencyOption to)
Toggle the invisibility option bit.
Definition: transparency.h:81
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:564
GetToolbarAlignedWindowPosition
Point GetToolbarAlignedWindowPosition(int window_width)
Computer the position of the top-left corner of a window to be opened right under the toolbar...
Definition: window.cpp:1708
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
_display_opt
byte _display_opt
What do we want to draw/do?
Definition: transparency_gui.cpp:28
settings_type.h
Types related to global configuration settings.
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
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.
WID_TT_BUILDINGS
Company buildings and structures transparency toggle button.
Definition: transparency_widget.h:23
WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
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
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:126
WID_TT_LOADING
Loading indicators transparency toggle button.
Definition: transparency_widget.h:27
ToggleTransparency
static void ToggleTransparency(TransparencyOption to)
Toggle the transparency option bit.
Definition: transparency.h:71
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
NWidgetBase::pos_x
uint pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:177
ToggleTransparencyLock
static void ToggleTransparencyLock(TransparencyOption to)
Toggle the transparency lock bit.
Definition: transparency.h:109
sound_func.h
Functions related to sound.
TransparenciesWindow::DrawWidget
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: transparency_gui.cpp:44
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:959
WID_TT_CATENARY
Catenary transparency toggle button.
Definition: transparency_widget.h:26
WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
FR_LOWERED
If set the frame is lowered and the background colour brighter (ie. buttons when pressed) ...
Definition: window_gui.h:31
TransparenciesWindow::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: transparency_gui.cpp:72
transparency.h
Functions related to transparency.
TransparencyOptionBits
uint TransparencyOptionBits
transparency option bits
Definition: transparency.h:38
WID_TT_TREES
Trees transparency toggle button.
Definition: transparency_widget.h:20
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
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:174
TransparenciesWindow
Definition: transparency_gui.cpp:30
WID_TT_HOUSES
Houses transparency toggle button.
Definition: transparency_widget.h:21
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
WID_TT_BEGIN
First toggle button.
Definition: transparency_widget.h:18
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:105
WID_TT_BUTTONS
Panel with &#39;invisibility&#39; buttons.
Definition: transparency_widget.h:31
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:40
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
WWT_IMGBTN
(Toggle) Button with image
Definition: widget_type.h:52
WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:155
SoundSettings::click_beep
bool click_beep
Beep on a random selection of buttons.
Definition: settings_type.h:178
ShowTransparencyToolbar
void ShowTransparencyToolbar()
Show the transparency toolbar.
Definition: transparency_gui.cpp:161
sprites.h
This file contains all sprite-related enums and defines.
IsTransparencySet
static bool IsTransparencySet(TransparencyOption to)
Check if the transparency option bit is set and if we aren&#39;t in the game menu (there&#39;s never transpar...
Definition: transparency.h:50
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:833
TransparencyOption
TransparencyOption
Transparency option bits: which position in _transparency_opt stands for which transparency.
Definition: transparency.h:24
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1461
_transparency_lock
TransparencyOptionBits _transparency_lock
Prevent these bits from flipping with X.
Definition: transparency_gui.cpp:26