urho3d/Source/Urho3D/UI/ProgressBar.cpp

//
// Copyright (c) 2008-2020 the Urho3D project.
//
// 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 "../Precompiled.h"

#include "../Core/Context.h"
#include "../Input/InputEvents.h"
#include "../IO/Log.h"
#include "../UI/ProgressBar.h"
#include "../UI/UIEvents.h"

namespace Urho3D
{

extern const char* orientations[];
extern const char* UI_CATEGORY;

ProgressBar::ProgressBar(Context * context) :
        BorderImage(context),
        orientation_(O_HORIZONTAL),
        loadingPercentStyle_("Text"),
        range_(1.0f),
        value_(0.0f),
        showPercentText_(true)
{
    SetEnabled(false);
    SetEditable(false);
    SetFocus(false);
    knob_ = CreateChild<BorderImage>("S_Knob");
    knob_->SetInternal(true);

    loadingText_ = CreateChild<Text>("S_Text");
    loadingText_->SetInternal(true);

    UpdateProgressBar();
}

ProgressBar::~ProgressBar() = default;

void ProgressBar::RegisterObject(Context * context)
{
    context->RegisterFactory<ProgressBar>(UI_CATEGORY);

    URHO3D_COPY_BASE_ATTRIBUTES(BorderImage);
    URHO3D_UPDATE_ATTRIBUTE_DEFAULT_VALUE("Is Enabled", true);
    URHO3D_ENUM_ACCESSOR_ATTRIBUTE("Orientation", GetOrientation, SetOrientation, Orientation, orientations, O_HORIZONTAL, AM_FILE);
    URHO3D_ACCESSOR_ATTRIBUTE("Range", GetRange, SetRange, float, 1.0f, AM_FILE);
    URHO3D_ACCESSOR_ATTRIBUTE("Value", GetValue, SetValue, float, 0.0f, AM_FILE);
    URHO3D_ACCESSOR_ATTRIBUTE("Show Percent Text", GetShowPercentText, SetShowPercentText, bool, true, AM_FILE);
}

void ProgressBar::OnResize(const IntVector2& /*newSize*/, const IntVector2& /*delta*/)
{
    UpdateProgressBar();
}

void ProgressBar::SetOrientation(Orientation orientation)
{
    orientation_ = orientation;
    UpdateProgressBar();
}

void ProgressBar::SetRange(float range)
{
    range = Max(range, 0.0f);
    if (range != range_)
    {
        range_ = range;
        UpdateProgressBar();
    }
}

void ProgressBar::SetValue(float value)
{
    value = Clamp(value, 0.0f, range_);
    if (value != value_)
    {
        value_ = value;
        UpdateProgressBar();

        using namespace ProgressBarChanged;

        VariantMap& eventData = GetEventDataMap();
        eventData[P_ELEMENT] = this;
        eventData[P_VALUE] = value_;
        SendEvent(E_PROGRESSBARCHANGED, eventData);
    }
}

void ProgressBar::ChangeValue(float delta)
{
    SetValue(value_ + delta);
}

void ProgressBar::SetShowPercentText(bool enable)
{
    showPercentText_ = enable;
    loadingText_->SetVisible(showPercentText_);
}

bool ProgressBar::FilterImplicitAttributes(XMLElement &dest) const
{
    if (!BorderImage::FilterImplicitAttributes(dest))
        return false;

    XMLElement childElem = dest.GetChild("element");
    if (!childElem)
        return false;
    if (!RemoveChildXML(childElem, "Name", "S_Knob"))
        return false;
    if (!RemoveChildXML(childElem, "Name", "S_Text"))
        return false;
    if (!RemoveChildXML(childElem, "Position"))
        return false;
    if (!RemoveChildXML(childElem, "Size"))
        return false;

    return true;
}

void ProgressBar::UpdateProgressBar()
{
    const IntRect &border = knob_->GetBorder();

    if (range_ > 0.0f)
    {
        if (orientation_ == O_HORIZONTAL)
        {
            auto loadingBarLength = (int) Max((float) GetWidth() * value_ / range_,
                                             (float) (border.left_ + border.right_));
            knob_->SetSize(loadingBarLength, GetHeight());
            knob_->SetPosition(Clamp(0, 0, GetWidth() - knob_->GetWidth()), 0);
        }
        else
        {
            auto loadingBarLength = (int) Max((float) GetHeight() * value_ / range_,
                                             (float) (border.top_ + border.bottom_));
            knob_->SetSize(GetWidth(), loadingBarLength);
            knob_->SetPosition(0, Clamp(GetHeight() - knob_->GetHeight(), 0, GetHeight() - knob_->GetHeight()));
        }
    }
    else
    {
        knob_->SetSize(GetSize());
        knob_->SetPosition(0, 0);
    }

    // Update the text.
    loadingText_->SetStyle(loadingPercentStyle_);
    loadingText_->SetAlignment(HA_CENTER, VA_CENTER);
    loadingText_->SetText(Urho3D::ToString("%d %%", RoundToInt((value_ / range_) * 100.0f)));
}

}