Files @ r25958:603d75b53498
Branch filter:

Location: cpp/openttd-patchpack/source/src/transparency_gui.cpp - annotation

Patric Stout
Doc: update multiplayer documentation with latest changes (#9552)

Although several places were fixed during the PR making the change,
not all made it in this document.

While at it, removed all kinds of Markdown warnings by an excessive
usage of spacebar in this document.
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r9111:983de9c5a848
r9111:983de9c5a848
r6427:94a91cd8da86
r8107:82461791b7a2
r7849:cfd99cb69695
r8157:cf41aa22cd09
r19891:7fd9bf0868c4
r7849:cfd99cb69695
r18670:f122c356353c
r18670:f122c356353c
r8264:d493cb51fe8a
r8264:d493cb51fe8a
r8264:d493cb51fe8a
r21383:942c32fb8b0e
r21383:942c32fb8b0e
r17624:f2c5f47dceaa
r17624:f2c5f47dceaa
r17624:f2c5f47dceaa
r17624:f2c5f47dceaa
r6427:94a91cd8da86
r9196:80833565de60
r9196:80833565de60
r9196:80833565de60
r20280:ca1fc41725ff
r9196:80833565de60
r20280:ca1fc41725ff
r9196:80833565de60
r6496:bbfde726b81e
r23499:f9bf6ad58697
r9196:80833565de60
r17377:911241be2fa4
r9273:0df9c11598cc
r12523:03c4f2100c71
r8806:1fc0d9e1c2bf
r23499:f9bf6ad58697
r12523:03c4f2100c71
r12523:03c4f2100c71
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r12523:03c4f2100c71
r12523:03c4f2100c71
r12523:03c4f2100c71
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r12523:03c4f2100c71
r13062:680961bd134a
r12523:03c4f2100c71
r18677:53c91eb23957
r12523:03c4f2100c71
r12523:03c4f2100c71
r9196:80833565de60
r9196:80833565de60
r6427:94a91cd8da86
r23499:f9bf6ad58697
r9196:80833565de60
r18677:53c91eb23957
r9196:80833565de60
r9196:80833565de60
r18677:53c91eb23957
r9196:80833565de60
r9196:80833565de60
r9196:80833565de60
r18677:53c91eb23957
r19891:7fd9bf0868c4
r9196:80833565de60
r9196:80833565de60
r18677:53c91eb23957
r12523:03c4f2100c71
r18677:53c91eb23957
r13062:680961bd134a
r15542:f6c6d0f8689e
r12523:03c4f2100c71
r15542:f6c6d0f8689e
r12523:03c4f2100c71
r18677:53c91eb23957
r8806:1fc0d9e1c2bf
r18677:53c91eb23957
r19891:7fd9bf0868c4
r8806:1fc0d9e1c2bf
r9196:80833565de60
r18677:53c91eb23957
r9196:80833565de60
r9196:80833565de60
r18677:53c91eb23957
r6427:94a91cd8da86
r9196:80833565de60
r6427:94a91cd8da86
r6427:94a91cd8da86
r23499:f9bf6ad58697
r13784:714b55955586
r13784:714b55955586
r18677:53c91eb23957
r13784:714b55955586
r13784:714b55955586
r13784:714b55955586
r17476:d3b7a183536d
r17476:d3b7a183536d
r17476:d3b7a183536d
r17476:d3b7a183536d
r17476:d3b7a183536d
r23499:f9bf6ad58697
r12523:03c4f2100c71
r17476:d3b7a183536d
r18677:53c91eb23957
r18677:53c91eb23957
r12523:03c4f2100c71
r12523:03c4f2100c71
r6427:94a91cd8da86
r6427:94a91cd8da86
r11632:2ff0ad7253de
r11632:2ff0ad7253de
r13742:180ad925befc
r13742:180ad925befc
r13742:180ad925befc
r11632:2ff0ad7253de
r11632:2ff0ad7253de
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r18677:53c91eb23957
r13745:49505a0400d8
r11632:2ff0ad7253de
r19944:25a78576fb5e
r18677:53c91eb23957
r11632:2ff0ad7253de
r11632:2ff0ad7253de
r11632:2ff0ad7253de
r20280:ca1fc41725ff
r20283:2a199c78224c
r6427:94a91cd8da86
r13739:747ed1f003e3
r13554:d1964ead02ee
r11368:058349c3a02c
r6427:94a91cd8da86
r17624:f2c5f47dceaa
r17624:f2c5f47dceaa
r17624:f2c5f47dceaa
r11962:0e3a6981e508
r6427:94a91cd8da86
r9196:80833565de60
r6427:94a91cd8da86
/*
 * 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/>.
 */

/** @file transparency_gui.cpp The transparency GUI. */

#include "stdafx.h"
#include "window_gui.h"
#include "transparency.h"
#include "sound_func.h"
#include "settings_type.h"

#include "widgets/transparency_widget.h"

#include "table/sprites.h"
#include "table/strings.h"

#include "safeguards.h"

TransparencyOptionBits _transparency_opt;  ///< The bits that should be transparent.
TransparencyOptionBits _transparency_lock; ///< Prevent these bits from flipping with X.
TransparencyOptionBits _invisibility_opt;  ///< The bits that should be invisible.
byte _display_opt; ///< What do we want to draw/do?

class TransparenciesWindow : public Window
{
public:
	TransparenciesWindow(WindowDesc *desc, int window_number) : Window(desc)
	{
		this->InitNested(window_number);
	}

	void OnPaint() override
	{
		this->OnInvalidateData(0); // Must be sure that the widgets show the transparency variable changes, also when we use shortcuts.
		this->DrawWidgets();
	}

	void DrawWidget(const Rect &r, int widget) const override
	{
		switch (widget) {
			case WID_TT_SIGNS:
			case WID_TT_TREES:
			case WID_TT_HOUSES:
			case WID_TT_INDUSTRIES:
			case WID_TT_BUILDINGS:
			case WID_TT_BRIDGES:
			case WID_TT_STRUCTURES:
			case WID_TT_CATENARY:
			case WID_TT_LOADING: {
				uint i = widget - WID_TT_BEGIN;
				if (HasBit(_transparency_lock, i)) DrawSprite(SPR_LOCK, PAL_NONE, r.left + 1, r.top + 1);
				break;
			}
			case WID_TT_BUTTONS:
				for (uint i = WID_TT_BEGIN; i < WID_TT_END; i++) {
					if (i == WID_TT_LOADING) continue; // Do not draw button for invisible loading indicators.

					const NWidgetBase *wi = this->GetWidget<NWidgetBase>(i);
					DrawFrameRect(wi->pos_x + 1, r.top + 2, wi->pos_x + wi->current_x - 2, r.bottom - 2, COLOUR_PALE_GREEN,
							HasBit(_invisibility_opt, i - WID_TT_BEGIN) ? FR_LOWERED : FR_NONE);
				}
				break;
		}
	}

	void OnClick(Point pt, int widget, int click_count) override
	{
		if (widget >= WID_TT_BEGIN && widget < WID_TT_END) {
			if (_ctrl_pressed) {
				/* toggle the bit of the transparencies lock variable */
				ToggleTransparencyLock((TransparencyOption)(widget - WID_TT_BEGIN));
				this->SetDirty();
			} else {
				/* toggle the bit of the transparencies variable and play a sound */
				ToggleTransparency((TransparencyOption)(widget - WID_TT_BEGIN));
				if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
				MarkWholeScreenDirty();
			}
		} else if (widget == WID_TT_BUTTONS) {
			uint i;
			for (i = WID_TT_BEGIN; i < WID_TT_END; i++) {
				const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
				if (IsInsideBS(pt.x, nwid->pos_x, nwid->current_x)) {
					break;
				}
			}
			if (i == WID_TT_LOADING || i == WID_TT_END) return;

			ToggleInvisibility((TransparencyOption)(i - WID_TT_BEGIN));
			if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);

			/* Redraw whole screen only if transparency is set */
			if (IsTransparencySet((TransparencyOption)(i - WID_TT_BEGIN))) {
				MarkWholeScreenDirty();
			} else {
				this->SetWidgetDirty(WID_TT_BUTTONS);
			}
		}
	}

	Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
	{
		Point pt = GetToolbarAlignedWindowPosition(sm_width);
		pt.y += 2 * (sm_height - this->GetWidget<NWidgetBase>(WID_TT_BUTTONS)->current_y);
		return pt;
	}

	/**
	 * Some data on this window has become invalid.
	 * @param data Information about the changed data.
	 * @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.
	 */
	void OnInvalidateData(int data = 0, bool gui_scope = true) override
	{
		if (!gui_scope) return;
		for (uint i = WID_TT_BEGIN; i < WID_TT_END; i++) {
			this->SetWidgetLoweredState(i, IsTransparencySet((TransparencyOption)(i - WID_TT_BEGIN)));
		}
	}
};

static const NWidgetPart _nested_transparency_widgets[] = {
	NWidget(NWID_HORIZONTAL),
		NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
		NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_TRANSPARENCY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
		NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
	EndContainer(),
	NWidget(NWID_HORIZONTAL),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_SIGNS), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_SIGN, STR_TRANSPARENT_SIGNS_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_TREES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_PLANTTREES, STR_TRANSPARENT_TREES_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_HOUSES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_TOWN, STR_TRANSPARENT_HOUSES_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_INDUSTRIES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_INDUSTRY, STR_TRANSPARENT_INDUSTRIES_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_BUILDINGS), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_COMPANY_LIST, STR_TRANSPARENT_BUILDINGS_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_BRIDGES), SetMinimalSize(43, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BRIDGE, STR_TRANSPARENT_BRIDGES_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_STRUCTURES), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_TRANSMITTER, STR_TRANSPARENT_STRUCTURES_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_CATENARY), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_BUILD_X_ELRAIL, STR_TRANSPARENT_CATENARY_TOOLTIP),
		NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_LOADING), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_TRAINLIST, STR_TRANSPARENT_LOADING_TOOLTIP),
		NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(1, 1), EndContainer(),
	EndContainer(),
	/* Panel with 'invisibility' buttons. */
	NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_TT_BUTTONS), SetMinimalSize(219, 13), SetDataTip(0x0, STR_TRANSPARENT_INVISIBLE_TOOLTIP),
	EndContainer(),
};

static WindowDesc _transparency_desc(
	WDP_MANUAL, "toolbar_transparency", 0, 0,
	WC_TRANSPARENCY_TOOLBAR, WC_NONE,
	0,
	_nested_transparency_widgets, lengthof(_nested_transparency_widgets)
);

/**
 * Show the transparency toolbar.
 */
void ShowTransparencyToolbar()
{
	AllocateWindowDescFront<TransparenciesWindow>(&_transparency_desc, 0);
}