ui_node_button.cpp

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

This program 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; either version 2
of the License, or (at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#include "../ui_main.h"
#include "../ui_actions.h"
#include "../ui_parse.h"
#include "../ui_behaviour.h"
#include "../ui_font.h"
#include "../ui_render.h"
#include "../ui_sound.h"
#include "../ui_sprite.h"
#include "ui_node_button.h"
#include "ui_node_abstractnode.h"
#include "ui_node_panel.h"

#include "../../../common/scripts_lua.h"

#define EXTRADATA_TYPE buttonExtraData_t
#define EXTRADATA(node) UI_EXTRADATA(node, EXTRADATA_TYPE)
#define EXTRADATACONST(node) UI_EXTRADATACONST(node, EXTRADATA_TYPE)

#include "../../client.h"

void uiButtonNode::draw (uiNode_t* node)
{
    const float* textColor;
    vec2_t pos;
    uiSpriteStatus_t iconStatus = SPRITE_STATUS_NORMAL;
    const char* font = UI_GetFontFromNode(node);

    if (node->flash)
        UI_EnableFlashing(node->flashColor, node->flashSpeed);

    if (node->disabled) {
        textColor = node->disabledColor;
        iconStatus = SPRITE_STATUS_DISABLED;
    } else if (node->state) {
        textColor = node->selectedColor;
        iconStatus = SPRITE_STATUS_HOVER;
    } else {
        textColor = node->color;
    }

    UI_GetNodeAbsPos(node, pos);

    if (EXTRADATA(node).background) {
        UI_DrawSpriteInBox(false, EXTRADATA(node).background, iconStatus, pos[0], pos[1], node->box.size[0], node->box.size[1]);
    }

    /* compute node box with padding */
    uiBox_t inside;
    inside.set(pos, node->box.size);
    inside.expand(-node->padding);
    uiBox_t content;
    content.clear();

    const bool hasIcon = EXTRADATA(node).icon != nullptr;
    const char* text = UI_GetReferenceString(node, node->text);
    const bool hasText = text != nullptr && *text != '\0';
    if (hasText) {
        text = _(text);
    }

    vec2_t iconPos;
    Vector2Clear(iconPos);
    if (hasIcon) {
        content.size[0] += EXTRADATA(node).icon->size[0];
        content.size[1] += EXTRADATA(node).icon->size[1];
    }

    vec2_t textPos;
    Vector2Clear(textPos);
    int textWidth;
    if (hasText) {
        textPos[0] = content.size[0];
        const int availableTextWidth = inside.size[0] - content.size[0];
        int height;
        R_FontTextSize(font, text, availableTextWidth, LONGLINES_PRETTYCHOP, &textWidth, &height, nullptr, nullptr);
        content.size[0] += textWidth;
        if (height > content.size[1]) {
            content.size[1] = height;
            iconPos[1] = (height - content.size[1]) * 0.5;
        } else {
            textPos[1] = (content.size[1] - height) * 0.5;
        }
    }

    inside.alignBox(content, (align_t)node->contentAlign);

    /* display the icon at the left */
    if (hasIcon) {
        iconPos[0] += content.pos[0];
        iconPos[1] += content.pos[1];
        UI_DrawSpriteInBox(EXTRADATA(node).flipIcon, EXTRADATA(node).icon, iconStatus,
                iconPos[0], iconPos[1], EXTRADATA(node).icon->size[0], EXTRADATA(node).icon->size[1]);
    }

    if (hasText) {
        textPos[0] += content.pos[0];
        textPos[1] += content.pos[1];
        R_Color(textColor);
        /* @todo here IMO we should not use contentalign. need to check other toolkits to check layout */
        UI_DrawStringInBox(font, (align_t) node->contentAlign,
            textPos[0], content.pos[1], textWidth, content.size[1],
            text);
        R_Color(nullptr);
    }

    if (node->flash)
        UI_DisableFlashing();
}

void uiButtonNode::onLoading (uiNode_t* node)
{
    node->padding = 8;
    node->contentAlign = ALIGN_CC;
    node->flashSpeed = 1.0;
    Vector4Set(node->selectedColor, 1, 1, 1, 1);
    Vector4Set(node->disabledColor, 0.5, 0.5, 0.5, 1.0);
    Vector4Set(node->color, 1, 1, 1, 1);
    Vector4Set(node->flashColor, 1, 1, 1, 0);
}

void uiButtonNode::onLoaded (uiNode_t* node)
{
    /* auto calc the size if none was given via script files */
    if (node->box.size[1] == 0) {
        const char* font = UI_GetFontFromNode(node);
        node->box.size[1] = (UI_FontGetHeight(font) / 2) + (node->padding * 2);
    }
}

void UI_Button_SetBackgroundByName(uiNode_t* node, const char* name) {
    uiSprite_t* sprite = UI_GetSpriteByName(name);
    UI_EXTRADATA(node, buttonExtraData_t).background = sprite;
}

void UI_Button_SetIconByName(uiNode_t* node, const char* name) {
    uiSprite_t* sprite = UI_GetSpriteByName(name);
    UI_EXTRADATA(node, buttonExtraData_t).icon = sprite;
}

void UI_RegisterButtonNode (uiBehaviour_t* behaviour)
{
    behaviour->name = "button";
    behaviour->manager = UINodePtr(new uiButtonNode());
    behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
    behaviour->lua_SWIG_typeinfo = UI_SWIG_TypeQuery("uiButtonNode_t *");

    /* Icon used to display the node
     */
    UI_RegisterExtradataNodeProperty(behaviour, "icon", V_UI_SPRITEREF, EXTRADATA_TYPE, icon);
    UI_RegisterExtradataNodeProperty(behaviour, "flipicon", V_BOOL, EXTRADATA_TYPE, flipIcon);

    /* Sprite used to display the background */
    UI_RegisterExtradataNodeProperty(behaviour, "background", V_UI_SPRITEREF, EXTRADATA_TYPE, background);
}