Add 9-slice background support to button formspec elements (#9290)

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 1857ce541e063b0767fdb11c87340b70ff2a9705..a4af821c32175c2560bc835940000ff20d1d3899 100644 (file)
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2573,6 +2573,8 @@ Some types may inherit styles from parent types.
     * bgcolor_pressed - color when pressed. Defaults to a darker bgcolor when not provided.
     * bgimg - standard background image. Defaults to none.
     * bgimg_hovered - background image when hovered. Defaults to bgimg when not provided.
+    * bgimg_middle - Makes the bgimg textures render in 9-sliced mode and defines the middle rect.
+                     See background9[] documentation for more details
     * bgimg_pressed - background image when pressed. Defaults to bgimg when not provided.
     * border - boolean, draw border. Set to false to hide the bevelled button pane. Default true.
     * noclip - boolean, set to true to allow the element to exceed formspec bounds.

diff --git a/games/minimal/mods/test/formspec.lua b/games/minimal/mods/test/formspec.lua
index bac82c965fcb6fa8ae6d6c5c41133b27ead582fc..67aad3b204ec3b7cb3a17b47883090992241a44f 100644 (file)
--- a/games/minimal/mods/test/formspec.lua
+++ b/games/minimal/mods/test/formspec.lua
@@ -78,6 +78,9 @@ local style_fs = [[
        style[one_btn15;border=false;bgimg=test_bg.png;bgimg_hovered=test_bg_hovered.png;bgimg_pressed=test_bg_pressed.png]\r
        item_image_button[1.25,9.6;1,1;default:sword_steel;one_btn15;Bg]\r
 \r
+       style[one_btn16;border=false;bgimg=test_bg_9slice.png;bgimg_hovered=test_bg_9slice_hovered.png;bgimg_pressed=test_bg_9slice_pressed.png;bgimg_middle=4,6]\r
+       button[2.5,9.6;2,1;one_btn16;9-Slice Bg]\r
+\r
 \r
 \r
        container[2.75,0]\r

diff --git a/games/minimal/mods/test/textures/test_bg_9slice.png b/games/minimal/mods/test/textures/test_bg_9slice.png
new file mode 100644 (file)
index 0000000..f9fe687
Binary files /dev/null and b/games/minimal/mods/test/textures/test_bg_9slice.png differ

diff --git a/games/minimal/mods/test/textures/test_bg_9slice_hovered.png b/games/minimal/mods/test/textures/test_bg_9slice_hovered.png
new file mode 100644 (file)
index 0000000..e614a5e
Binary files /dev/null and b/games/minimal/mods/test/textures/test_bg_9slice_hovered.png differ

diff --git a/games/minimal/mods/test/textures/test_bg_9slice_pressed.png b/games/minimal/mods/test/textures/test_bg_9slice_pressed.png
new file mode 100644 (file)
index 0000000..125c774
Binary files /dev/null and b/games/minimal/mods/test/textures/test_bg_9slice_pressed.png differ

diff --git a/src/gui/StyleSpec.h b/src/gui/StyleSpec.h
index 5c9e20a1123849e7af14d3480ac6c879da186ff9..999c1d2379d6b196de6643dd3d8317cb7e6a00b2 100644 (file)
--- a/src/gui/StyleSpec.h
+++ b/src/gui/StyleSpec.h
@@ -37,6 +37,7 @@ public:
                BORDER,
                BGIMG,
                BGIMG_HOVERED,
+               BGIMG_MIDDLE,
                BGIMG_PRESSED,
                FGIMG,
                FGIMG_HOVERED,
@@ -69,6 +70,8 @@ public:
                        return BGIMG;
                } else if (name == "bgimg_hovered") {
                        return BGIMG_HOVERED;
+               } else if (name == "bgimg_middle") {
+                       return BGIMG_MIDDLE;
                } else if (name == "bgimg_pressed") {
                        return BGIMG_PRESSED;
                } else if (name == "fgimg") {
@@ -117,6 +120,29 @@ public:
                return color;
        }
 
+       irr::core::rect<s32> getRect(Property prop, irr::core::rect<s32> def) const
+       {
+               const auto &val = properties[prop];
+               if (val.empty())
+                       return def;
+
+               irr::core::rect<s32> rect;
+               if (!parseRect(val, &rect))
+                       return def;
+
+               return rect;
+       }
+
+       irr::core::rect<s32> getRect(Property prop) const
+       {
+               const auto &val = properties[prop];
+               FATAL_ERROR_IF(val.empty(), "Unexpected missing property");
+
+               irr::core::rect<s32> rect;
+               parseRect(val, &rect);
+               return rect;
+       }
+
        video::ITexture *getTexture(Property prop, ISimpleTextureSource *tsrc,
                        video::ITexture *def) const
        {
@@ -175,4 +201,36 @@ public:
                newspec |= other;
                return newspec;
        }
+
+private:
+       bool parseRect(const std::string &value, irr::core::rect<s32> *parsed_rect) const
+       {
+               irr::core::rect<s32> rect;
+               std::vector<std::string> v_rect = split(value, ',');
+
+               if (v_rect.size() == 1) {
+                       s32 x = stoi(v_rect[0]);
+                       rect.UpperLeftCorner = irr::core::vector2di(x, x);
+                       rect.LowerRightCorner = irr::core::vector2di(-x, -x);
+               } else if (v_rect.size() == 2) {
+                       s32 x = stoi(v_rect[0]);
+                       s32 y = stoi(v_rect[1]);
+                       rect.UpperLeftCorner = irr::core::vector2di(x, y);
+                       rect.LowerRightCorner = irr::core::vector2di(-x, -y);
+                       // `-x` is interpreted as `w - x`
+               } else if (v_rect.size() == 4) {
+                       rect.UpperLeftCorner = irr::core::vector2di(
+                                       stoi(v_rect[0]), stoi(v_rect[1]));
+                       rect.LowerRightCorner = irr::core::vector2di(
+                                       stoi(v_rect[2]), stoi(v_rect[3]));
+               } else {
+                       warningstream << "Invalid rectangle string format: \"" << value
+                                       << "\"" << std::endl;
+                       return false;
+               }
+
+               *parsed_rect = rect;
+
+               return true;
+       }
 };

diff --git a/src/gui/guiButton.cpp b/src/gui/guiButton.cpp
index f7a0af2d99477e9d8d1c78fcbb38038a50129c11..4c16ee2376a79a189b81b3e9aa8571c666c8dcd6 100644 (file)
--- a/src/gui/guiButton.cpp
+++ b/src/gui/guiButton.cpp
@@ -307,10 +307,25 @@ void GUIButton::draw()
                        }\r
                }\r
 \r
-               driver->draw2DImage(ButtonImages[(u32)imageState].Texture,\r
-                               ScaleImage? AbsoluteRect : core::rect<s32>(pos, sourceRect.getSize()),\r
-                               sourceRect, &AbsoluteClippingRect,\r
-                               0, UseAlphaChannel);\r
+               // PATCH\r
+               video::ITexture* texture = ButtonImages[(u32)imageState].Texture;\r
+               if (BgMiddle.getArea() == 0) {\r
+                       driver->draw2DImage(texture,\r
+                                       ScaleImage? AbsoluteRect : core::rect<s32>(pos, sourceRect.getSize()),\r
+                                       sourceRect, &AbsoluteClippingRect,\r
+                                       0, UseAlphaChannel);\r
+               } else {\r
+                       core::rect<s32> middle = BgMiddle;\r
+                       // `-x` is interpreted as `w - x`\r
+                       if (middle.LowerRightCorner.X < 0)\r
+                               middle.LowerRightCorner.X += texture->getOriginalSize().Width;\r
+                       if (middle.LowerRightCorner.Y < 0)\r
+                               middle.LowerRightCorner.Y += texture->getOriginalSize().Height;\r
+                       draw2DImage9Slice(driver, texture,\r
+                                       ScaleImage ? AbsoluteRect : core::rect<s32>(pos, sourceRect.getSize()),\r
+                                       middle, &AbsoluteClippingRect);\r
+               }\r
+               // END PATCH\r
        }\r
 \r
        if (SpriteBank)\r
@@ -804,5 +819,6 @@ void GUIButton::setFromStyle(const StyleSpec& style, ISimpleTextureSource *tsrc)
                                        Environment->getVideoDriver(), pressed_texture, geom.X, geom.Y));\r
                setScaleImage(true);\r
        }\r
+       BgMiddle = style.getRect(StyleSpec::BGIMG_MIDDLE, BgMiddle);\r
 }\r
 // END PATCH\r

diff --git a/src/gui/guiButton.h b/src/gui/guiButton.h
index 37b278d25aca18830264a91e701819dacdd7cefd..3d1f98c32bed77fc8648995b087932f166b4df8a 100644 (file)
--- a/src/gui/guiButton.h
+++ b/src/gui/guiButton.h
@@ -330,5 +330,7 @@ private:
        video::SColor PressedColors[4];\r
 \r
        gui::IGUIStaticText *StaticText;\r
+\r
+       core::rect<s32> BgMiddle;\r
        // END PATCH\r
 };\r

diff --git a/util/travis/clang-format-whitelist.txt b/util/travis/clang-format-whitelist.txt
index f15b37cf5e3b28e91d3fc08a147016c884338ed1..b945a6db3a39b965f8c1364f75221927a257a5cd 100644 (file)
--- a/util/travis/clang-format-whitelist.txt
+++ b/util/travis/clang-format-whitelist.txt
@@ -196,6 +196,7 @@ src/gui/mainmenumanager.h
 src/gui/modalMenu.h
 src/guiscalingfilter.cpp
 src/guiscalingfilter.h
+src/gui/StyleSpec.h
 src/gui/touchscreengui.cpp
 src/httpfetch.cpp
 src/hud.cpp