ui_node_radiobutton.cpp

Go to the documentation of this file.

/*
Copyright (C) 2002-2023 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_sprite.h"
#include "../ui_parse.h"
#include "../ui_behaviour.h"
#include "../ui_input.h"
#include "../ui_render.h"
#include "../ui_lua.h"

#include "ui_node_radiobutton.h"
#include "ui_node_abstractnode.h"

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

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

#define EPSILON 0.001f

#define UI_4STATUS_TEX_HEIGHT 64

static bool UI_RadioButtonNodeIsSelected (uiNode_t* node)
{
    if (EXTRADATA(node).string == nullptr) {
        const float current = UI_GetReferenceFloat(node, EXTRADATA(node).cvar);
        return current > EXTRADATA(node).value - EPSILON && current < EXTRADATA(node).value + EPSILON;
    } else {
        const char* current = UI_GetReferenceString(node, EXTRADATA(node).cvar);
        return Q_streq(current, EXTRADATA(node).string);
    }
}

void uiRadioButtonNode::draw (uiNode_t* node)
{
    vec2_t pos;
    uiSpriteStatus_t iconStatus;
    const bool disabled = node->disabled || node->parent->disabled;
    int texY;
    const char* image;
    const bool isSelected = UI_RadioButtonNodeIsSelected(node);

    if (disabled) {
        iconStatus = SPRITE_STATUS_DISABLED;
        texY = UI_4STATUS_TEX_HEIGHT * 2;
    } else if (isSelected) {
        iconStatus = SPRITE_STATUS_CLICKED;
        texY = UI_4STATUS_TEX_HEIGHT * 3;
    } else if (node->state) {
        iconStatus = SPRITE_STATUS_HOVER;
        texY = UI_4STATUS_TEX_HEIGHT;
    } else {
        iconStatus = SPRITE_STATUS_NORMAL;
        texY = 0;
    }

    UI_GetNodeAbsPos(node, pos);

    image = UI_GetReferenceString(node, node->image);
    if (image) {
        const int texX = 0;
        UI_DrawNormImageByName(false, pos[0], pos[1], node->box.size[0], node->box.size[1],
            texX + node->box.size[0], texY + node->box.size[1], texX, texY, image);
    }

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

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

void uiRadioButtonNode::onActivate (uiNode_t* node)
{
    /* no cvar given? */
    if (!EXTRADATA(node).cvar || !*(char*)(EXTRADATA(node).cvar)) {
        return;
    }

    /* its not a cvar! */
    char const* const cvarName = Q_strstart((char const*)(EXTRADATA(node).cvar), "*cvar:");
    if (!cvarName)
        return;

    UI_GetReferenceFloat(node, EXTRADATA(node).cvar);
    /* Is we click on the already selected button, we can continue */
    if (UI_RadioButtonNodeIsSelected(node))
        return;

    if (EXTRADATA(node).string == nullptr) {
        Cvar_SetValue(cvarName, EXTRADATA(node).value);
    } else {
        Cvar_Set(cvarName, "%s", EXTRADATA(node).string);
    }
    if (node->onChange) {
        UI_ExecuteEventActions(node, node->onChange);
    }
    if (node->lua_onChange != LUA_NOREF) {
        UI_ExecuteLuaEventScript(node, node->lua_onChange);
    }
}

void uiRadioButtonNode::onLeftClick (uiNode_t* node, int x, int y)
{
    if (node->onClick) {
        UI_ExecuteEventActions(node, node->onClick);
    }
    if (node->lua_onClick != LUA_NOREF) {
        UI_ExecuteLuaEventScript_XY(node, node->lua_onClick, x, y);
    }

    onActivate(node);
}


const char* UI_RadioButton_GetCvar (uiNode_t* node) {
    return EXTRADATA(node).cvar;
}

void UI_RadioButton_SetCvar (uiNode_t* node, const char* name) {
    cvar_t* var = Cvar_Get(name);
    EXTRADATA(node).cvar = var->name;
}

void UI_RadioButton_SetValue (uiNode_t* node, const char* value) {

    /* This is a special case: we have a situation where the node already has a value reference
       (either being float or cvar). We now want to replace this value reference by a new cvar. So we first
       need to free the existing reference, then create new cvar reference (just a string starting with
       '*cvar' and store it. */
    Mem_Free(*(void**)(EXTRADATA(node).string));
    *(void**)EXTRADATA(node).string= Mem_StrDup(value);
    uiRadioButtonNode* b=static_cast<uiRadioButtonNode*>(node->behaviour->manager.get());
    b->onActivate(node);
}

void UI_RadioButton_SetValue (uiNode_t* node, float value) {
    EXTRADATA(node).value = value;
    uiRadioButtonNode* b=static_cast<uiRadioButtonNode*>(node->behaviour->manager.get());
    b->onActivate(node);
}

void UI_RadioButton_SetBackgroundByName (uiNode_t* node, const char* name) {
    uiSprite_t* sprite = UI_GetSpriteByName(name);
    EXTRADATA(node).background = sprite;
}

void UI_RadioButton_SetIconByName (uiNode_t* node, const char* name) {
    uiSprite_t* sprite = UI_GetSpriteByName(name);
    EXTRADATA(node).icon = sprite;}

void UI_RegisterRadioButtonNode (uiBehaviour_t* behaviour)
{
    behaviour->name = "radiobutton";
    behaviour->manager = UINodePtr(new uiRadioButtonNode());
    behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
    behaviour->lua_SWIG_typeinfo = UI_SWIG_TypeQuery("uiRadioButtonNode_t *");

    /* Numerical value defining the radiobutton. Cvar is updated with this value when the radio button is selected. */
    UI_RegisterExtradataNodeProperty(behaviour, "value", V_FLOAT, EXTRADATA_TYPE, value);
    /* String Value defining the radiobutton. Cvar is updated with this value when the radio button is selected. */
    UI_RegisterExtradataNodeProperty(behaviour, "stringValue", V_CVAR_OR_STRING, EXTRADATA_TYPE, string);

    /* Cvar name shared with the radio button group to identify when a radio button is selected. */
    UI_RegisterExtradataNodeProperty(behaviour, "cvar", V_UI_CVAR, EXTRADATA_TYPE, cvar);
    /* 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);
}