Introduce progress/loader window

resources/g2/sprites.json

@@ -311,6 +311,39 @@
     {
         "path": "icons/colour_invisible_pressed.png"
     },
+    {
+        "path": "loader/loader_hybrid_supports.png",
+        "y": 10
+    },
+    {
+        "path": "loader/loader_hybrid_track.png",
+        "y": 15
+    },
+    {
+        "path": "loader/loader_hybrid_vehicle.png"
+    },
+    {
+        "path": "loader/loader_steel_supports.png",
+        "y": 27
+    },
+    {
+        "path": "loader/loader_steel_track.png",
+        "y": 16
+    },
+    {
+        "path": "loader/loader_steel_vehicle.png"
+    },
+    {
+        "path": "loader/loader_wooden_supports.png",
+        "y": 3
+    },
+    {
+        "path": "loader/loader_wooden_track.png",
+        "y": 3
+    },
+    {
+        "path": "loader/loader_wooden_vehicle.png"
+    },
     {
         "path": "palette_map/palette_map_dark_olive_dark.png",
         "palette": "keep",
@@ -24912,12 +24945,12 @@
         "palette": "keep"
     },
     {
-    	"path": "icons/medium-curve-left.png",
+        "path": "icons/medium-curve-left.png",
         "x": 2,
         "y": 6
     },
     {
-    	"path": "icons/medium-curve-right.png",
+        "path": "icons/medium-curve-right.png",
         "x": 1,
         "y": 6
     }

src/openrct2-ui/WindowManager.cpp

@@ -269,6 +269,11 @@ public:
 
                 return nullptr;
             }
+            case WindowClass::ProgressWindow:
+            {
+                std::string message = intent->GetStringExtra(INTENT_EXTRA_MESSAGE);
+                return ProgressWindowOpen(message);
+            }
             case WindowClass::Ride:
             {
                 const auto rideId = RideId::FromUnderlying(intent->GetSIntExtra(INTENT_EXTRA_RIDE_ID));

src/openrct2-ui/libopenrct2ui.vcxproj

@@ -193,6 +193,7 @@
     <ClCompile Include="windows\Park.cpp" />
     <ClCompile Include="windows\PatrolArea.cpp" />
     <ClCompile Include="windows\Player.cpp" />
+    <ClCompile Include="windows\ProgressWindow.cpp" />
     <ClCompile Include="windows\RefurbishRidePrompt.cpp" />
     <ClCompile Include="windows\Research.cpp" />
     <ClCompile Include="windows\Ride.cpp" />

src/openrct2-ui/windows/ProgressWindow.cpp

@@ -0,0 +1,192 @@
+/*****************************************************************************
+ * Copyright (c) 2014-2024 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 <array>
+#include <openrct2-ui/interface/Widget.h>
+#include <openrct2-ui/windows/Window.h>
+#include <openrct2/drawing/Drawing.h>
+#include <openrct2/drawing/Text.h>
+#include <openrct2/localisation/Localisation.h>
+#include <openrct2/sprites.h>
+#include <sstream>
+
+namespace OpenRCT2::Ui::Windows
+{
+    enum ProgressWindowWidgetIdx
+    {
+        WIDX_BACKGROUND,
+        WIDX_TITLE,
+        WIDX_CLOSE,
+    };
+
+    static constexpr int32_t kWindowWidth = 400;
+    static constexpr int32_t kWindowHeight = 90;
+
+    // clang-format off
+    static Widget kProgressWindowWidgets[] = {
+        MakeWidget({                0, 0}, {    kWindowWidth, kWindowHeight}, WindowWidgetType::Frame,    WindowColour::Primary                                     ), // panel / background
+        MakeWidget({                1, 1}, {kWindowWidth - 3,            14}, WindowWidgetType::Caption,  WindowColour::Primary, STR_STRINGID,  STR_WINDOW_TITLE_TIP), // title bar
+        MakeWidget({kWindowWidth - 12, 2}, {              11,            12}, WindowWidgetType::CloseBox, WindowColour::Primary, STR_CLOSE_X,   STR_CLOSE_WINDOW_TIP), // close x button
+        kWidgetsEnd,
+    };
+
+    struct LoaderVehicleStyle
+    {
+        ImageId supports;
+        ImageId track;
+        ImageId vehicle;
+    };
+
+    static std::array<LoaderVehicleStyle, 3> kVehicleStyles = { {
+        {
+            ImageId{SPR_G2_LOADER_HYBRID_SUPPORTS, COLOUR_LIGHT_ORANGE, COLOUR_DARK_BROWN },
+            ImageId{SPR_G2_LOADER_HYBRID_TRACK, COLOUR_LIGHT_ORANGE, COLOUR_LIGHT_ORANGE },
+            ImageId{SPR_G2_LOADER_HYBRID_VEHICLE, COLOUR_OLIVE_GREEN, COLOUR_OLIVE_GREEN, COLOUR_BRIGHT_RED }
+        },
+        {
+            ImageId{SPR_G2_LOADER_STEEL_SUPPORTS, COLOUR_LIGHT_BROWN, COLOUR_BLACK },
+            ImageId{SPR_G2_LOADER_STEEL_TRACK, COLOUR_LIGHT_BROWN, COLOUR_LIGHT_BROWN },
+            ImageId{SPR_G2_LOADER_STEEL_VEHICLE, COLOUR_LIGHT_BLUE, COLOUR_WHITE, COLOUR_LIGHT_BLUE }
+        },
+        {
+            ImageId{SPR_G2_LOADER_WOODEN_SUPPORTS, COLOUR_BLACK, COLOUR_WHITE },
+            ImageId{SPR_G2_LOADER_WOODEN_TRACK, COLOUR_BORDEAUX_RED, COLOUR_BLACK },
+            ImageId{SPR_G2_LOADER_WOODEN_VEHICLE, COLOUR_BRIGHT_RED, COLOUR_BRIGHT_RED, COLOUR_SATURATED_BROWN}
+        },
+    } };
+
+    static uint8_t nextStyle = 0;
+
+    // clang-format on
+    class ProgressWindow final : public Window
+    {
+    private:
+        std::string _captionTemplate;
+        std::string _currentCaption;
+        uint8_t style;
+
+    public:
+        void OnOpen() override
+        {
+            widgets = kProgressWindowWidgets;
+            WindowInitScrollWidgets(*this);
+
+            widgets[WIDX_CLOSE].type = WindowWidgetType::Empty;
+
+            frame_no = 0;
+            min_width = kWindowWidth;
+            min_height = kWindowHeight;
+            max_width = min_width;
+            max_height = min_height;
+
+            style = nextStyle++ % std::size(kVehicleStyles);
+        }
+
+        void OnUpdate() override
+        {
+            frame_no += 3;
+            if (frame_no > width)
+            {
+                frame_no = 0;
+                style++;
+                if (style >= 3)
+                    style = 0;
+            }
+
+            InvalidateWidget(WIDX_BACKGROUND);
+        }
+
+        void OnPrepareDraw() override
+        {
+            ResizeFrame();
+        }
+
+        void PrepareCaption()
+        {
+            std::stringstream caption;
+            caption << _captionTemplate;
+            caption << " (" << frame_no << " / " << width << ")";
+
+            _currentCaption = caption.str();
+
+            // Set window title
+            auto ft = Formatter::Common();
+            ft.Add<StringId>(STR_STRING);
+            ft.Add<const char*>(_currentCaption.c_str());
+        }
+
+        void OnDraw(DrawPixelInfo& dpi) override
+        {
+            PrepareCaption();
+            WindowDrawWidgets(*this, dpi);
+
+            auto& widget = widgets[WIDX_TITLE];
+            auto screenCoords = windowPos + ScreenCoordsXY{ widget.left, widget.bottom + 1 };
+
+            DrawPixelInfo clipDPI;
+            if (!ClipDrawPixelInfo(clipDPI, dpi, screenCoords, width - 3, height - widget.bottom - 3))
+                return;
+
+            auto& variant = kVehicleStyles[style];
+
+            // Draw supports sprite -- twice, to fill the window
+            auto trackCoords = ScreenCoordsXY{ widget.left, widget.bottom + 1 };
+            GfxDrawSprite(clipDPI, variant.supports, trackCoords);
+            GfxDrawSprite(clipDPI, variant.supports, trackCoords + ScreenCoordsXY(256, 0));
+
+            // Draw track sprite -- twice, to fill the window
+            GfxDrawSprite(clipDPI, variant.track, trackCoords);
+            GfxDrawSprite(clipDPI, variant.track, trackCoords + ScreenCoordsXY(256, 0));
+
+            if (_totalCount == 0)
+                return;
+
+            // Draw vehicle to indicate progress
+            auto* vehicle = GfxGetG1Element(variant.vehicle);
+            auto position = (-vehicle->width + 2) + (frame_no % width);
+            GfxDrawSprite(clipDPI, variant.vehicle, ScreenCoordsXY(position, widget.bottom + 1));
+        }
+
+        void SetCaptionTemplate(const std::string& text)
+        {
+            _captionTemplate = text;
+            Invalidate();
+        }
+    };
+
+    WindowBase* ProgressWindowOpen(const std::string& text)
+    {
+        ProgressWindow* window;
+        if ((window = static_cast<ProgressWindow*>(WindowFindByClass(WindowClass::ProgressWindow))) != nullptr)
+        {
+            WindowBringToFront(*window);
+        }
+        else
+        {
+            window = WindowCreate<ProgressWindow>(
+                WindowClass::ProgressWindow, kWindowWidth, kWindowHeight,
+                WF_10 | WF_TRANSPARENT | WF_CENTRE_SCREEN | WF_STICK_TO_FRONT);
+        }
+
+        window->SetCaptionTemplate(text);
+        return window;
+    }
+
+    // force close
+    void ProgressWindowClose()
+    {
+        auto window = WindowFindByClass(WindowClass::ProgressWindow);
+        if (window == nullptr)
+        {
+            return;
+        }
+        auto progressWindow = static_cast<ProgressWindow*>(window);
+        progressWindow->Close();
+    }
+} // namespace OpenRCT2::Ui::Windows

src/openrct2-ui/windows/Window.h

@@ -167,6 +167,9 @@ namespace OpenRCT2::Ui::Windows
     WindowBase* NetworkStatusOpenPassword();
     void WindowNetworkStatusClose();
 
+    WindowBase* ProgressWindowOpen(const std::string& text);
+    void ProgressWindowClose();
+
     void WindowTextInputKey(WindowBase* w, uint32_t keycode);
     void WindowTextInputOpen(
         WindowBase* call_w, WidgetIndex call_widget, StringId title, StringId description, const Formatter& descriptionArgs,

src/openrct2/interface/WindowClasses.h

@@ -88,6 +88,7 @@ enum class WindowClass : uint8_t
     Transparency = 134,
     AssetPacks = 135,
     ResetShortcutKeysPrompt = 136,
+    ProgressWindow = 137,
 
     // Only used for colour schemes
     Staff = 220,

src/openrct2/scenes/title/TitleScene.cpp

@@ -29,6 +29,7 @@
 #include "../../scenario/ScenarioRepository.h"
 #include "../../ui/UiContext.h"
 #include "../../util/Util.h"
+#include "../../windows/Intent.h"
 #include "TitleSequence.h"
 #include "TitleSequenceManager.h"
 #include "TitleSequencePlayer.h"
@@ -205,6 +206,11 @@ void TitleScene::CreateWindows()
     ContextOpenWindow(WindowClass::TitleOptions);
     ContextOpenWindow(WindowClass::TitleLogo);
     WindowResizeGui(ContextGetWidth(), ContextGetHeight());
+
+    auto intent = Intent(WindowClass::ProgressWindow);
+    intent.PutExtra(INTENT_EXTRA_MESSAGE, "Important stuff is loading");
+    ContextOpenIntent(&intent);
+
     _hideVersionInfo = false;
 }
 

src/openrct2/sprites.h

@@ -976,6 +976,18 @@ enum
     SPR_G2_ICON_PALETTE_INVISIBLE,
     SPR_G2_ICON_PALETTE_INVISIBLE_PRESSED,
 
+    // G2 Loading progress
+
+    SPR_G2_LOADER_HYBRID_SUPPORTS,
+    SPR_G2_LOADER_HYBRID_TRACK,
+    SPR_G2_LOADER_HYBRID_VEHICLE,
+    SPR_G2_LOADER_STEEL_SUPPORTS,
+    SPR_G2_LOADER_STEEL_TRACK,
+    SPR_G2_LOADER_STEEL_VEHICLE,
+    SPR_G2_LOADER_WOODEN_SUPPORTS,
+    SPR_G2_LOADER_WOODEN_TRACK,
+    SPR_G2_LOADER_WOODEN_VEHICLE,
+
     // G2 Palette maps
 
     SPR_G2_PALETTE_BEGIN,