UISprite widget added

Display single sprites

src/client/CMakeLists.txt

@@ -100,6 +100,8 @@ set(client_SOURCES ${client_SOURCES}
     ${CMAKE_CURRENT_LIST_DIR}/uiprogressrect.h
     ${CMAKE_CURRENT_LIST_DIR}/uimapanchorlayout.cpp
     ${CMAKE_CURRENT_LIST_DIR}/uimapanchorlayout.h
+    ${CMAKE_CURRENT_LIST_DIR}/uisprite.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/uisprite.h
 
     # util
     ${CMAKE_CURRENT_LIST_DIR}/position.h

src/client/declarations.h

@@ -98,9 +98,11 @@ class UIMinimap;
 class UIProgressRect;
 class UIMapAnchorLayout;
 class UIPositionAnchor;
+class UISprite;
 
 typedef stdext::shared_object_ptr<UIItem> UIItemPtr;
 typedef stdext::shared_object_ptr<UICreature> UICreaturePtr;
+typedef stdext::shared_object_ptr<UISprite> UISpritePtr;
 typedef stdext::shared_object_ptr<UIMap> UIMapPtr;
 typedef stdext::shared_object_ptr<UIMinimap> UIMinimapPtr;
 typedef stdext::shared_object_ptr<UIProgressRect> UIProgressRectPtr;

src/client/luafunctions.cpp

@@ -47,6 +47,7 @@
 #include "uiminimap.h"
 #include "uimapanchorlayout.h"
 #include "uiprogressrect.h"
+#include "uisprite.h"
 #include "outfit.h"
 
 #include <framework/luaengine/luainterface.h>
@@ -577,6 +578,13 @@ void Client::registerLuaFunctions()
     g_lua.bindClassMemberFunction<UIItem>("isVirtual", &UIItem::isVirtual);
     g_lua.bindClassMemberFunction<UIItem>("isItemVisible", &UIItem::isItemVisible);
 
+    g_lua.registerClass<UISprite, UIWidget>();
+    g_lua.bindClassStaticFunction<UISprite>("create", []{ return UISpritePtr(new UISprite); });
+    g_lua.bindClassMemberFunction<UISprite>("setSpriteId", &UISprite::setSpriteId);
+    g_lua.bindClassMemberFunction<UISprite>("clearSprite", &UISprite::clearSprite);
+    g_lua.bindClassMemberFunction<UISprite>("getSpriteId", &UISprite::getSpriteId);
+    g_lua.bindClassMemberFunction<UISprite>("setSpriteColor", &UISprite::setSpriteColor);
+
     g_lua.registerClass<UICreature, UIWidget>();
     g_lua.bindClassStaticFunction<UICreature>("create", []{ return UICreaturePtr(new UICreature); } );
     g_lua.bindClassMemberFunction<UICreature>("setCreature", &UICreature::setCreature);

src/client/uisprite.cpp

@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2010-2013 OTClient <https://github.com/edubart/otclient>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "uisprite.h"
+#include <framework/otml/otml.h>
+#include <framework/graphics/graphics.h>
+#include <framework/graphics/texturemanager.h>
+#include <client/spritemanager.h>
+
+UISprite::UISprite() :
+    m_spriteId(0),
+    m_spriteColor(Color::white)
+{ }
+
+void UISprite::drawSelf(Fw::DrawPane drawPane)
+{
+    if((drawPane & Fw::ForegroundPane) == 0)
+        return;
+
+    // draw style components in order
+    if(m_backgroundColor.aF() > Fw::MIN_ALPHA) {
+        Rect backgroundDestRect = m_rect;
+        backgroundDestRect.expand(-m_borderWidth.top, -m_borderWidth.right, -m_borderWidth.bottom, -m_borderWidth.left);
+        drawBackground(m_rect);
+    }
+
+    drawImage(m_rect);
+
+    if(m_spriteVisible && m_sprite) {
+        g_painter->setColor(m_spriteColor);
+        g_painter->drawTexturedRect(getPaddingRect(), m_sprite);
+    }
+
+    drawBorder(m_rect);
+    drawIcon(m_rect);
+    drawText(m_rect);
+}
+
+void UISprite::setSpriteId(int id)
+{
+    if(!g_sprites.isLoaded())
+        return;
+
+    m_spriteId = id;
+    if(id == 0)
+        m_sprite = nullptr;
+    else {
+        ImagePtr image = g_sprites.getSpriteImage(id);
+        if(image)
+            m_sprite = new Texture(image);
+        else
+            m_sprite = nullptr;
+    }
+}
+
+void UISprite::onStyleApply(const std::string& styleName, const OTMLNodePtr& styleNode)
+{
+    UIWidget::onStyleApply(styleName, styleNode);
+
+    for(const OTMLNodePtr& node : styleNode->children()) {
+        if(node->tag() == "sprite-id")
+            setSpriteId(node->value<int>());
+        else if(node->tag() == "sprite-visible")
+            setSpriteVisible(node->value<bool>());
+        else if(node->tag() == "sprite-color")
+            setSpriteColor(node->value<Color>());
+    }
+}

src/client/uisprite.h

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2010-2013 OTClient <https://github.com/edubart/otclient>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef UISPRITE_H
+#define UISPRITE_H
+
+#include "declarations.h"
+#include <framework/ui/uiwidget.h>
+
+class UISprite : public UIWidget
+{
+public:
+    UISprite();
+    void drawSelf(Fw::DrawPane drawPane);
+
+    void setSpriteId(int id);
+    int getSpriteId() { return m_spriteId; }
+    void clearSprite() { setSpriteId(0); }
+
+    void setSpriteColor(Color color) { m_spriteColor = color; }
+
+    bool isSpriteVisible() { return m_spriteVisible; }
+    void setSpriteVisible(bool visible) { m_spriteVisible = visible; }
+
+protected:
+    void onStyleApply(const std::string& styleName, const OTMLNodePtr& styleNode);
+
+    TexturePtr m_sprite;
+    uint16 m_spriteId;
+    Color m_spriteColor;
+
+    stdext::boolean<true> m_spriteVisible;
+};
+
+#endif