mirrors/OpenRCT2
1
0
Fork 0
mirror of https://github.com/OpenRCT2/OpenRCT2 synced 2026-01-21 05:53:02 +01:00
Code Issues Releases Wiki Activity

Close #13748: Refactor About window to class (#16297)

Browse Source
This commit is contained in:
Vinícius Hashimoto
2021-12-27 18:44:06 -03:00
committed by GitHub
parent f65e12fc78
commit 4155bf9ce0
2 changed files with 170 additions and 221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

390
src/openrct2-ui/windows/About.cpp
View File

@@ -1,12 +1,11 @@
/*****************************************************************************
* Copyright (c) 2014-2020 OpenRCT2 developers
* Copyright (c) 2014-2021 OpenRCT2 developers
*
* For a complete list of all authors, please refer to contributors.md
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
*
* OpenRCT2 is licensed under the GNU General Public License version 3.
*****************************************************************************/
#include <SDL_clipboard.h>
#include <openrct2-ui/interface/Widget.h>
#include <openrct2-ui/windows/Window.h>
@@ -19,6 +18,8 @@
#include <openrct2/sprites.h>
#include <openrct2/ui/UiContext.h>
using namespace OpenRCT2;
static constexpr const int32_t WW = 400;
static constexpr const int32_t WH = 352;
static constexpr const rct_string_id WINDOW_TITLE = STR_ABOUT;
@@ -59,7 +60,7 @@ enum WindowAboutWidgetIdx {
MakeRemapWidget({ 3, 17}, {91, TABHEIGHT - 16}, WindowWidgetType::Tab, WindowColour::Secondary, SPR_TAB_LARGE), /* about OpenRCT2 button */ \
MakeRemapWidget({94, 17}, {91, TABHEIGHT - 16}, WindowWidgetType::Tab, WindowColour::Secondary, SPR_TAB_LARGE) /* about RCT2 button */
static rct_widget window_about_openrct2_widgets[] = {
static rct_widget _windowAboutOpenRCT2Widgets[] = {
WIDGETS_MAIN,
MakeWidget({10, 60}, {WW - 20, 20}, WindowWidgetType::LabelCentred, WindowColour::Secondary, STR_ABOUT_OPENRCT2_DESCRIPTION), // Introduction
MakeWidget({30, 90}, {128, 128}, WindowWidgetType::Placeholder, WindowColour::Secondary, STR_NONE), // OpenRCT2 Logo
@@ -73,52 +74,178 @@ static rct_widget window_about_openrct2_widgets[] = {
WIDGETS_END,
};
static rct_widget window_about_rct2_widgets[] = {
static rct_widget _windowAboutRCT2Widgets[] = {
WIDGETS_MAIN,
WIDGETS_END,
};
static rct_widget *window_about_page_widgets[] = {
window_about_openrct2_widgets,
window_about_rct2_widgets,
static rct_widget *_windowAboutPageWidgets[] = {
_windowAboutOpenRCT2Widgets,
_windowAboutRCT2Widgets,
};
#define DEFAULT_ENABLED_WIDGETS \
(1ULL << WIDX_CLOSE) | (1ULL << WIDX_TAB_ABOUT_OPENRCT2) | (1ULL << WIDX_TAB_ABOUT_RCT2)
static uint64_t window_about_page_enabled_widgets[] = {
DEFAULT_ENABLED_WIDGETS | (1ULL << WIDX_COPY_BUILD_INFO) | (1ULL << WIDX_CHANGELOG) | (1ULL << WIDX_JOIN_DISCORD),
DEFAULT_ENABLED_WIDGETS,
};
static void WindowAboutOpenRCT2Mouseup(rct_window *w, rct_widgetindex widgetIndex);
static void WindowAboutOpenRCT2Paint(rct_window *w, rct_drawpixelinfo *dpi);
static void WindowAboutOpenRCT2Invalidate(rct_window *w);
static void WindowAboutRCT2Mouseup(rct_window *w, rct_widgetindex widgetIndex);
static void WindowAboutRCT2Paint(rct_window *w, rct_drawpixelinfo *dpi);
static void WindowAboutOpenRCT2CommonPaint(rct_window *w, rct_drawpixelinfo *dpi);
static rct_window_event_list window_about_openrct2_events([](auto& events)
{
events.mouse_up = &WindowAboutOpenRCT2Mouseup;
events.invalidate = &WindowAboutOpenRCT2Invalidate;
events.paint = &WindowAboutOpenRCT2Paint;
});
static rct_window_event_list window_about_rct2_events([](auto& events)
{
events.mouse_up = &WindowAboutRCT2Mouseup;
events.paint = &WindowAboutRCT2Paint;
});
static rct_window_event_list *window_about_page_events[] = {
&window_about_openrct2_events,
&window_about_rct2_events,
};
// clang-format on
static void WindowAboutSetPage(rct_window* w, int32_t page);
class AboutWindow final : public Window
{
public:
void OnOpen() override
{
widgets = _windowAboutOpenRCT2Widgets;
enabled_widgets = (1ULL << WIDX_CLOSE) | (1ULL << WIDX_TAB_ABOUT_OPENRCT2) | (1ULL << WIDX_TAB_ABOUT_RCT2)
| (1ULL << WIDX_COPY_BUILD_INFO) | (1ULL << WIDX_CHANGELOG) | (1ULL << WIDX_JOIN_DISCORD);
WindowInitScrollWidgets(this);
SetPage(WINDOW_ABOUT_PAGE_OPENRCT2);
}
void OnMouseUp(rct_widgetindex widgetIndex) override
{
switch (widgetIndex)
{
case WIDX_CLOSE:
Close();
break;
case WIDX_TAB_ABOUT_OPENRCT2:
case WIDX_TAB_ABOUT_RCT2:
SetPage(widgetIndex - WIDX_TAB_ABOUT_OPENRCT2);
break;
case WIDX_JOIN_DISCORD:
OpenRCT2::GetContext()->GetUiContext()->OpenURL("https://discord.gg/ZXZd8D8");
break;
case WIDX_CHANGELOG:
context_open_window(WC_CHANGELOG);
break;
case WIDX_NEW_VERSION:
context_open_window_view(WV_NEW_VERSION_INFO);
break;
case WIDX_COPY_BUILD_INFO:
SDL_SetClipboardText(gVersionInfoFull);
break;
}
}
void OnDraw(rct_drawpixelinfo& dpi) override
{
DrawWidgets(dpi);
const auto& aboutOpenRCT2 = widgets[WIDX_TAB_ABOUT_OPENRCT2];
const auto& aboutRCT2 = widgets[WIDX_TAB_ABOUT_RCT2];
int32_t y = windowPos.y + aboutOpenRCT2.midY() - 3;
ScreenCoordsXY aboutOpenRCT2Coords(windowPos.x + aboutOpenRCT2.left + 45, y);
ScreenCoordsXY aboutRCT2Coords(windowPos.x + aboutRCT2.left + 45, y);
// Draw tab names
{
auto ft = Formatter();
ft.Add<rct_string_id>(STR_TITLE_SEQUENCE_OPENRCT2);
DrawTextWrapped(
&dpi, aboutOpenRCT2Coords, 87, STR_WINDOW_COLOUR_2_STRINGID, ft, { COLOUR_AQUAMARINE, TextAlignment::CENTRE });
}
{
auto ft = Formatter();
ft.Add<rct_string_id>(STR_TITLE_SEQUENCE_RCT2);
DrawTextWrapped(
&dpi, aboutRCT2Coords, 87, STR_WINDOW_COLOUR_2_STRINGID, ft, { COLOUR_AQUAMARINE, TextAlignment::CENTRE });
}
if (page == WINDOW_ABOUT_PAGE_OPENRCT2)
{
DrawOpenRCT2Info(dpi);
}
else if (page == WINDOW_ABOUT_PAGE_RCT2)
{
DrawRCT2Info(dpi);
}
}
private:
/**
* @brief Set which tab to show
*/
void SetPage(int32_t p)
{
page = p;
frame_no = 0;
pressed_widgets = 0;
widgets = _windowAboutPageWidgets[p];
enabled_widgets = (1ULL << WIDX_CLOSE) | (1ULL << WIDX_TAB_ABOUT_OPENRCT2) | (1ULL << WIDX_TAB_ABOUT_RCT2)
| (1ULL << WIDX_COPY_BUILD_INFO) | (1ULL << WIDX_CHANGELOG) | (1ULL << WIDX_JOIN_DISCORD);
pressed_widgets |= (p == WINDOW_ABOUT_PAGE_RCT2) ? (1ULL << WIDX_TAB_ABOUT_RCT2) : (1ULL << WIDX_TAB_ABOUT_OPENRCT2);
WindowInitScrollWidgets(this);
Invalidate();
}
/**
* @brief Draw OpenRCT2 info on open tab
*/
void DrawOpenRCT2Info(rct_drawpixelinfo& dpi)
{
// Draw logo on placeholder widget
ScreenCoordsXY logoCoords = windowPos
+ ScreenCoordsXY(widgets[WIDX_OPENRCT2_LOGO].left, widgets[WIDX_OPENRCT2_LOGO].top);
gfx_draw_sprite(&dpi, ImageId(SPR_G2_LOGO), logoCoords);
// Version info
utf8 buffer[256];
utf8* ch = buffer;
openrct2_write_full_version_info(ch, sizeof(buffer) - (ch - buffer));
auto ft = Formatter();
ft.Add<const char*>(buffer);
auto const& versionPlaceholder = widgets[WIDX_VERSION];
auto versionPlaceHolderWidth = versionPlaceholder.right - versionPlaceholder.left;
auto centreX = versionPlaceholder.left + versionPlaceHolderWidth / 2;
auto centreY = (versionPlaceholder.top + versionPlaceholder.bottom - font_get_line_height(FontSpriteBase::MEDIUM)) / 2;
auto centrePos = windowPos + ScreenCoordsXY(centreX, centreY);
DrawTextWrapped(&dpi, centrePos, versionPlaceHolderWidth, STR_STRING, ft, { colours[1], TextAlignment::CENTRE });
// Shows the update available button
if (OpenRCT2::GetContext()->HasNewVersionInfo())
{
enabled_widgets |= (1ULL << WIDX_NEW_VERSION);
widgets[WIDX_NEW_VERSION].type = WindowWidgetType::Button;
_windowAboutOpenRCT2Widgets[WIDX_NEW_VERSION].type = WindowWidgetType::Button;
}
}
/**
* @brief Draw RCT2 info on open tab
*/
void DrawRCT2Info(rct_drawpixelinfo& dpi)
{
int32_t yPage = windowPos.y + widgets[WIDX_PAGE_BACKGROUND].top + 5;
auto screenCoords = ScreenCoordsXY{ windowPos.x + 200, yPage + 5 };
int32_t lineHeight = font_get_line_height(FontSpriteBase::MEDIUM);
// Credits
DrawTextBasic(&dpi, screenCoords, STR_COPYRIGHT_CS, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight + 74;
DrawTextBasic(&dpi, screenCoords, STR_DESIGNED_AND_PROGRAMMED_BY_CS, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(&dpi, screenCoords, STR_GRAPHICS_BY_SF, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(&dpi, screenCoords, STR_SOUND_AND_MUSIC_BY_AB, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(&dpi, screenCoords, STR_ADDITIONAL_SOUNDS_RECORDED_BY_DE, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight + 3;
DrawTextBasic(&dpi, screenCoords, STR_REPRESENTATION_BY_JL, {}, { TextAlignment::CENTRE });
screenCoords.y += 2 * lineHeight + 5;
DrawTextBasic(&dpi, screenCoords, STR_THANKS_TO, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(&dpi, screenCoords, STR_THANKS_TO_PEOPLE, {}, { TextAlignment::CENTRE });
screenCoords.y += 2 * lineHeight + 5;
DrawTextBasic(&dpi, screenCoords, STR_LICENSED_TO_INFOGRAMES_INTERACTIVE_INC, {}, { TextAlignment::CENTRE });
// Images
gfx_draw_sprite(&dpi, ImageId(SPR_CREDITS_CHRIS_SAWYER_SMALL), { windowPos.x + 92, yPage + 24 });
// Licence
}
};
/**
*
@@ -126,184 +253,5 @@ static void WindowAboutSetPage(rct_window* w, int32_t page);
*/
rct_window* WindowAboutOpen()
{
rct_window* window;
// Check if window is already open
window = window_bring_to_front_by_class(WC_ABOUT);
if (window != nullptr)
return window;
window = WindowCreateCentred(WW, WH, window_about_page_events[WINDOW_ABOUT_PAGE_OPENRCT2], WC_ABOUT, 0);
WindowAboutSetPage(window, WINDOW_ABOUT_PAGE_OPENRCT2);
WindowInitScrollWidgets(window);
return window;
}
#pragma region OpenRCT2
static void WindowAboutOpenRCT2Mouseup(rct_window* w, rct_widgetindex widgetIndex)
{
switch (widgetIndex)
{
case WIDX_CLOSE:
window_close(w);
break;
case WIDX_TAB_ABOUT_OPENRCT2:
case WIDX_TAB_ABOUT_RCT2:
WindowAboutSetPage(w, widgetIndex - WIDX_TAB_ABOUT_OPENRCT2);
break;
case WIDX_JOIN_DISCORD:
OpenRCT2::GetContext()->GetUiContext()->OpenURL("https://discord.gg/ZXZd8D8");
break;
case WIDX_CHANGELOG:
context_open_window(WC_CHANGELOG);
break;
case WIDX_NEW_VERSION:
context_open_window_view(WV_NEW_VERSION_INFO);
break;
case WIDX_COPY_BUILD_INFO:
SDL_SetClipboardText(gVersionInfoFull);
break;
}
}
static void WindowAboutOpenRCT2CommonPaint(rct_window* w, rct_drawpixelinfo* dpi)
{
WindowDrawWidgets(w, dpi);
const auto& aboutOpenRCT2 = w->widgets[WIDX_TAB_ABOUT_OPENRCT2];
const auto& aboutRCT2 = w->widgets[WIDX_TAB_ABOUT_RCT2];
int32_t y = w->windowPos.y + aboutOpenRCT2.midY() - 3;
ScreenCoordsXY aboutOpenRCT2Coords(w->windowPos.x + aboutOpenRCT2.left + 45, y);
ScreenCoordsXY aboutRCT2Coords(w->windowPos.x + aboutRCT2.left + 45, y);
// Draw tab names
{
auto ft = Formatter();
ft.Add<rct_string_id>(STR_TITLE_SEQUENCE_OPENRCT2);
DrawTextWrapped(
dpi, aboutOpenRCT2Coords, 87, STR_WINDOW_COLOUR_2_STRINGID, ft, { COLOUR_AQUAMARINE, TextAlignment::CENTRE });
}
{
auto ft = Formatter();
ft.Add<rct_string_id>(STR_TITLE_SEQUENCE_RCT2);
DrawTextWrapped(
dpi, aboutRCT2Coords, 87, STR_WINDOW_COLOUR_2_STRINGID, ft, { COLOUR_AQUAMARINE, TextAlignment::CENTRE });
}
}
static void WindowAboutOpenRCT2Paint(rct_window* w, rct_drawpixelinfo* dpi)
{
WindowAboutOpenRCT2CommonPaint(w, dpi);
// Draw logo on placeholder widget
ScreenCoordsXY logoCoords = w->windowPos
+ ScreenCoordsXY(w->widgets[WIDX_OPENRCT2_LOGO].left, w->widgets[WIDX_OPENRCT2_LOGO].top);
gfx_draw_sprite(dpi, ImageId(SPR_G2_LOGO), logoCoords);
// Version info
utf8 buffer[256];
utf8* ch = buffer;
openrct2_write_full_version_info(ch, sizeof(buffer) - (ch - buffer));
auto ft = Formatter();
ft.Add<const char*>(buffer);
auto const& versionPlaceholder = w->widgets[WIDX_VERSION];
auto width = versionPlaceholder.right - versionPlaceholder.left;
auto centreX = versionPlaceholder.left + width / 2;
auto centreY = (versionPlaceholder.top + versionPlaceholder.bottom - font_get_line_height(FontSpriteBase::MEDIUM)) / 2;
auto centrePos = w->windowPos + ScreenCoordsXY(centreX, centreY);
DrawTextWrapped(dpi, centrePos, width, STR_STRING, ft, { w->colours[1], TextAlignment::CENTRE });
}
static void WindowAboutOpenRCT2Invalidate(rct_window* w)
{
if (w->page == WINDOW_ABOUT_PAGE_OPENRCT2 && OpenRCT2::GetContext()->HasNewVersionInfo())
{
w->enabled_widgets |= (1ULL << WIDX_NEW_VERSION);
w->widgets[WIDX_NEW_VERSION].type = WindowWidgetType::Button;
window_about_openrct2_widgets[WIDX_NEW_VERSION].type = WindowWidgetType::Button;
}
}
#pragma endregion OpenRCT2
#pragma region RCT2
/**
*
* rct2: 0x0066D4D5
*/
static void WindowAboutRCT2Mouseup(rct_window* w, rct_widgetindex widgetIndex)
{
switch (widgetIndex)
{
case WIDX_CLOSE:
window_close(w);
break;
case WIDX_TAB_ABOUT_OPENRCT2:
case WIDX_TAB_ABOUT_RCT2:
WindowAboutSetPage(w, widgetIndex - WIDX_TAB_ABOUT_OPENRCT2);
break;
}
}
/**
*
* rct2: 0x0066D321
*/
static void WindowAboutRCT2Paint(rct_window* w, rct_drawpixelinfo* dpi)
{
WindowAboutOpenRCT2CommonPaint(w, dpi);
int32_t yPage = w->windowPos.y + w->widgets[WIDX_PAGE_BACKGROUND].top + 5;
auto screenCoords = ScreenCoordsXY{ w->windowPos.x + 200, yPage + 5 };
int32_t lineHeight = font_get_line_height(FontSpriteBase::MEDIUM);
// Credits
DrawTextBasic(dpi, screenCoords, STR_COPYRIGHT_CS, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight + 74;
DrawTextBasic(dpi, screenCoords, STR_DESIGNED_AND_PROGRAMMED_BY_CS, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(dpi, screenCoords, STR_GRAPHICS_BY_SF, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(dpi, screenCoords, STR_SOUND_AND_MUSIC_BY_AB, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(dpi, screenCoords, STR_ADDITIONAL_SOUNDS_RECORDED_BY_DE, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight + 3;
DrawTextBasic(dpi, screenCoords, STR_REPRESENTATION_BY_JL, {}, { TextAlignment::CENTRE });
screenCoords.y += 2 * lineHeight + 5;
DrawTextBasic(dpi, screenCoords, STR_THANKS_TO, {}, { TextAlignment::CENTRE });
screenCoords.y += lineHeight;
DrawTextBasic(dpi, screenCoords, STR_THANKS_TO_PEOPLE, {}, { TextAlignment::CENTRE });
screenCoords.y += 2 * lineHeight + 5;
DrawTextBasic(dpi, screenCoords, STR_LICENSED_TO_INFOGRAMES_INTERACTIVE_INC, {}, { TextAlignment::CENTRE });
// Images
gfx_draw_sprite(dpi, ImageId(SPR_CREDITS_CHRIS_SAWYER_SMALL), { w->windowPos.x + 92, yPage + 24 });
// Licence
}
#pragma endregion RCT2
static void WindowAboutSetPage(rct_window* w, int32_t page)
{
w->page = page;
w->frame_no = 0;
w->pressed_widgets = 0;
w->widgets = window_about_page_widgets[page];
w->enabled_widgets = window_about_page_enabled_widgets[page];
w->event_handlers = window_about_page_events[page];
w->pressed_widgets |= (page == WINDOW_ABOUT_PAGE_RCT2) ? (1ULL << WIDX_TAB_ABOUT_RCT2) : (1ULL << WIDX_TAB_ABOUT_OPENRCT2);
WindowInitScrollWidgets(w);
w->Invalidate();
return WindowFocusOrCreate<AboutWindow>(WC_ABOUT, WW, WH, WF_CENTRE_SCREEN);
}