stk-code_catmod/src/guiengine/widgets/icon_button_widget.cpp
2019-09-21 11:25:13 +08:00

448 lines
15 KiB
C++

// SuperTuxKart - a fun racing game with go-kart
// Copyright (C) 2009-2015 Marianne Gagnon
//
// 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 3
// 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 "guiengine/widgets/icon_button_widget.hpp"
#include "graphics/central_settings.hpp"
#include "graphics/irr_driver.hpp"
#include "graphics/stk_tex_manager.hpp"
#include "graphics/stk_texture.hpp"
#include "guiengine/engine.hpp"
#include "guiengine/scalable_font.hpp"
#include "io/file_manager.hpp"
#include "utils/log.hpp"
#include "utils/string_utils.hpp"
#include <iostream>
#include <IGUIElement.h>
#include <IGUIEnvironment.h>
#include <IGUIButton.h>
#include <IGUIStaticText.h>
#include <algorithm>
using namespace GUIEngine;
using namespace irr::video;
using namespace irr::core;
using namespace irr::gui;
// -----------------------------------------------------------------------------
IconButtonWidget::IconButtonWidget(ScaleMode scale_mode, const bool tab_stop,
const bool focusable, IconPathType pathType) : Widget(WTYPE_ICON_BUTTON)
{
m_label = NULL;
m_font = NULL;
m_texture = NULL;
m_deactivated_texture = NULL;
m_highlight_texture = NULL;
m_custom_aspect_ratio = 1.0f;
m_texture_w = 0;
m_texture_h = 0;
m_tab_stop = tab_stop;
m_focusable = focusable;
m_scale_mode = scale_mode;
m_icon_path_type = pathType;
}
// -----------------------------------------------------------------------------
void IconButtonWidget::add()
{
// ---- Icon
if (m_texture == NULL)
{
// Avoid warning about missing texture in case of e.g.
// screenshot widget
if (m_properties[PROP_ICON] != "")
{
if (m_icon_path_type == ICON_PATH_TYPE_ABSOLUTE)
{
setTexture(irr_driver->getTexture(m_properties[PROP_ICON]));
}
else if (m_icon_path_type == ICON_PATH_TYPE_RELATIVE)
{
std::string file =
GUIEngine::getSkin()->getThemedIcon(m_properties[PROP_ICON]);
setTexture(irr_driver->getTexture(file));
}
}
}
if (m_texture == NULL)
{
if (m_properties[PROP_ICON].size() > 0)
{
Log::error("icon_button",
"add() : error, cannot find texture '%s' in iconbutton '%s'.",
m_properties[PROP_ICON].c_str(), m_properties[PROP_ID].c_str());
}
std::string file = file_manager->getAsset(FileManager::GUI_ICON,"main_help.png");
setTexture(irr_driver->getTexture(file));
if(!m_texture)
Log::fatal("IconButtonWidget",
"Can't find fallback texture 'gui/icons/main_help.png, aborting.");
}
if (m_properties[PROP_FOCUS_ICON].size() > 0)
{
if (m_icon_path_type == ICON_PATH_TYPE_ABSOLUTE)
{
m_highlight_texture =
irr_driver->getTexture(m_properties[PROP_FOCUS_ICON]);
}
else if (m_icon_path_type == ICON_PATH_TYPE_RELATIVE)
{
m_highlight_texture =
irr_driver->getTexture(
GUIEngine::getSkin()->getThemedIcon(m_properties[PROP_FOCUS_ICON]));
}
}
// irrlicht widgets don't support scaling while keeping aspect ratio
// so, happily, let's implement it ourselves
float useAspectRatio = -1.0f;
if (m_properties[PROP_CUSTOM_RATIO] != "")
{
StringUtils::fromString(m_properties[PROP_CUSTOM_RATIO],
m_custom_aspect_ratio);
m_scale_mode = SCALE_MODE_KEEP_CUSTOM_ASPECT_RATIO;
}
if (m_scale_mode == SCALE_MODE_KEEP_TEXTURE_ASPECT_RATIO ||
m_scale_mode == SCALE_MODE_LIST_WIDGET)
{
assert(m_texture->getOriginalSize().Height > 0);
useAspectRatio = (float)m_texture->getOriginalSize().Width /
(float)m_texture->getOriginalSize().Height;
}
else if (m_scale_mode == SCALE_MODE_KEEP_CUSTOM_ASPECT_RATIO)
{
useAspectRatio = m_custom_aspect_ratio;
}
int suggested_h = m_h;
int suggested_w = (int)((useAspectRatio < 0 ? m_w : useAspectRatio * suggested_h));
if (suggested_w > m_w)
{
const float needed_scale_factor = (float)m_w / (float)suggested_w;
suggested_w = (int)(suggested_w*needed_scale_factor);
suggested_h = (int)(suggested_h*needed_scale_factor);
}
const int x_from = m_x + (m_w - suggested_w)/2; // center horizontally
const int y_from = m_y + (m_h - suggested_h)/2; // center vertically
rect<s32> widget_size = rect<s32>(x_from,
y_from,
x_from + suggested_w,
y_from + suggested_h);
if (m_scale_mode == SCALE_MODE_LIST_WIDGET)
{
m_list_header_icon_rect = widget_size;
m_list_header_icon_rect.UpperLeftCorner.X = m_list_header_icon_rect.UpperLeftCorner.X + 4;
m_list_header_icon_rect.UpperLeftCorner.Y = m_list_header_icon_rect.UpperLeftCorner.Y + 4;
m_list_header_icon_rect.LowerRightCorner.X = m_list_header_icon_rect.LowerRightCorner.X - 4;
m_list_header_icon_rect.LowerRightCorner.Y = m_list_header_icon_rect.LowerRightCorner.Y - 4;
widget_size = rect<s32>(m_x, m_y, m_x + m_w, m_y + m_h);
}
IGUIButton* btn = GUIEngine::getGUIEnv()->addButton(widget_size,
m_parent,
(m_tab_stop ? getNewID() : getNewNoFocusID()),
L"");
btn->setTabStop(m_tab_stop);
m_element = btn;
m_id = m_element->getID();
if (!m_is_visible)
m_element->setVisible(false);
// ---- label if any
const stringw& message = getText();
if (message.size() > 0)
{
const int label_extra_size =
( m_properties[PROP_EXTEND_LABEL].size() == 0 ?
0 : atoi(m_properties[PROP_EXTEND_LABEL].c_str()) );
const bool word_wrap = (m_properties[PROP_WORD_WRAP] == "true");
if (m_properties[PROP_LABELS_LOCATION] == "hover")
{
core::dimension2du text_size = GUIEngine::getFont()->getDimension(message.c_str());
core::recti pos = btn->getAbsolutePosition();
int center_x = pos.UpperLeftCorner.X + pos.getWidth() / 2;
int x1 = center_x - text_size.Width / 2 - label_extra_size / 2;
int y1 = pos.UpperLeftCorner.Y - (word_wrap ? GUIEngine::getFontHeight() * 2 :
GUIEngine::getFontHeight()) - 15;
int x2 = center_x + text_size.Width / 2 + label_extra_size / 2;
int y2 = pos.UpperLeftCorner.Y - 15;
if (x1 < 0)
{
int diff = -x1;
x1 += diff;
x2 += diff;
}
else if (x2 > (int)irr_driver->getActualScreenSize().Width)
{
int diff = x2 - irr_driver->getActualScreenSize().Width;
x2 -= diff;
x1 -= diff;
}
core::recti parent_pos = m_parent->getAbsolutePosition();
x1 -= parent_pos.UpperLeftCorner.X;
x2 -= parent_pos.UpperLeftCorner.X;
y1 -= parent_pos.UpperLeftCorner.Y;
y2 -= parent_pos.UpperLeftCorner.Y;
widget_size = rect<s32>(x1, y1, x2, y2);
}
else
{
// leave enough room for two lines of text if word wrap is enabled, otherwise a single line
widget_size = rect<s32>(m_x - label_extra_size/2,
m_y + m_h,
m_x + m_w + label_extra_size/2,
m_y + m_h + (word_wrap ? GUIEngine::getFontHeight()*2 :
GUIEngine::getFontHeight()));
}
m_label = GUIEngine::getGUIEnv()->addStaticText(message.c_str(), widget_size,
false, word_wrap, m_parent);
m_label->setTextAlignment(EGUIA_CENTER, EGUIA_UPPERLEFT);
m_label->setTabStop(false);
m_label->setNotClipped(true);
if (m_properties[PROP_LABELS_LOCATION] == "hover")
{
m_label->setVisible(false);
}
if (!m_is_visible)
{
m_label->setVisible(false);
}
setLabelFont();
m_label->setTextRestrainedInside(false);
}
// ---- IDs
m_id = m_element->getID();
if (m_tab_stop) m_element->setTabOrder(m_id);
m_element->setTabGroup(false);
if (!m_is_visible)
m_element->setVisible(false);
}
// -----------------------------------------------------------------------------
void IconButtonWidget::setImage(const char* path_to_texture, IconPathType pathType)
{
if (pathType != ICON_PATH_TYPE_NO_CHANGE)
{
m_icon_path_type = pathType;
}
m_properties[PROP_ICON] = path_to_texture;
if (m_icon_path_type == ICON_PATH_TYPE_ABSOLUTE)
{
setTexture(irr_driver->getTexture(m_properties[PROP_ICON]));
}
else if (m_icon_path_type == ICON_PATH_TYPE_RELATIVE)
{
std::string file = GUIEngine::getSkin()->getThemedIcon(m_properties[PROP_ICON]);
setTexture(irr_driver->getTexture(file));
}
if (!m_texture)
{
Log::error("icon_button", "Texture '%s' not found!\n",
m_properties[PROP_ICON].c_str());
std::string file = file_manager->getAsset(FileManager::GUI_ICON,"main_help.png");
setTexture(irr_driver->getTexture(file));
}
}
// -----------------------------------------------------------------------------
void IconButtonWidget::setImage(ITexture* texture)
{
if (texture != NULL)
{
setTexture(texture);
}
else
{
Log::error("icon_button",
"setImage invoked with NULL image pointer\n");
std::string file = file_manager->getAsset(FileManager::GUI_ICON,"main_help.png");
setTexture(irr_driver->getTexture(file));
}
}
// -----------------------------------------------------------------------------
void IconButtonWidget::setLabel(const stringw& new_label)
{
if (m_label == NULL) return;
m_label->setText( new_label.c_str() );
setLabelFont();
}
// -----------------------------------------------------------------------------
void IconButtonWidget::setLabelFont(irr::gui::ScalableFont* font)
{
m_font = font;
}
// -----------------------------------------------------------------------------
EventPropagation IconButtonWidget::focused(const int playerID)
{
Widget::focused(playerID);
if (m_label != NULL && m_properties[PROP_LABELS_LOCATION] == "hover")
{
m_label->setVisible(true);
}
return EVENT_LET;
}
// -----------------------------------------------------------------------------
void IconButtonWidget::unfocused(const int playerID, Widget* new_focus)
{
Widget::unfocused(playerID, new_focus);
if (m_label != NULL && m_properties[PROP_LABELS_LOCATION] == "hover")
{
m_label->setVisible(false);
}
}
// -----------------------------------------------------------------------------
const video::ITexture* IconButtonWidget::getTexture()
{
if (Widget::isActivated())
{
return m_texture;
}
else
{
if (m_deactivated_texture == NULL)
m_deactivated_texture = getDeactivatedTexture(m_texture);
return m_deactivated_texture;
}
}
// -----------------------------------------------------------------------------
video::ITexture* IconButtonWidget::getDeactivatedTexture(video::ITexture* texture)
{
#if !defined(SERVER_ONLY) && !defined(USE_GLES2)
STKTexture* stk_tex = static_cast<STKTexture*>(texture);
// Compressed texture can't be turned into greyscale
if (stk_tex->isMeshTexture() && CVS->isTextureCompressionEnabled())
return stk_tex;
std::string name = stk_tex->getName().getPtr();
name += "_disabled";
STKTexManager* stkm = STKTexManager::getInstance();
STKTexture* disabled_stk_tex = static_cast<STKTexture*>(stkm->getTexture
(name, NULL/*tc*/, false /*no_upload*/, false/*create_if_unfound*/));
if (disabled_stk_tex == NULL)
{
SColor c;
u32 g;
video::IVideoDriver* driver = irr_driver->getVideoDriver();
video::IImage* image = driver->createImageFromData
(video::ECF_A8R8G8B8, stk_tex->getSize(), stk_tex->lock(),
stk_tex->getTextureImage() == NULL/*ownForeignMemory*/);
texture->unlock();
//Turn the image into grayscale
for (u32 x = 0; x < image->getDimension().Width; x++)
{
for (u32 y = 0; y < image->getDimension().Height; y++)
{
c = image->getPixel(x, y);
g = ((c.getRed() + c.getGreen() + c.getBlue()) / 3);
c.set(std::max (0, (int)c.getAlpha() - 120), g, g, g);
image->setPixel(x, y, c);
}
}
return stkm->addTexture(new STKTexture(image, name));
}
return disabled_stk_tex;
#else
return texture;
#endif // !SERVER_ONLY
}
// -----------------------------------------------------------------------------
void IconButtonWidget::setTexture(video::ITexture* texture)
{
m_texture = texture;
if (texture == NULL)
{
m_deactivated_texture = NULL;
m_texture_w = 0;
m_texture_h = 0;
}
else
{
m_texture_w = texture->getSize().Width;
m_texture_h = texture->getSize().Height;
}
}
// -----------------------------------------------------------------------------
void IconButtonWidget::setLabelFont()
{
if (m_font != NULL)
{
m_label->setOverrideFont( m_font );
}
else
{
const bool word_wrap = (m_properties[PROP_WORD_WRAP] == "true");
const int max_w = m_label->getAbsolutePosition().getWidth();
if (!word_wrap &&
(int)GUIEngine::getFont()->getDimension(m_label->getText()).Width
> max_w + 4) // arbitrarily allow for 4 pixels
{
m_label->setOverrideFont( GUIEngine::getSmallFont() );
}
else
{
m_label->setOverrideFont( NULL );
}
}
}
// -----------------------------------------------------------------------------
void IconButtonWidget::setVisible(bool visible)
{
Widget::setVisible(visible);
if (m_label != NULL)
m_label->setVisible(visible);
}