spinner.cpp

// © Copyright 2010 - 2014 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine 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.

    The Mezzanine Engine 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 The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _uispinner_cpp
#define _uispinner_cpp

#include "UI/spinner.h"
#include "UI/button.h"
#include "UI/screen.h"
#include "UI/uimanager.h"

#include "Input/inputmanager.h"
#include "Input/mouse.h"
#include "stringtool.h"
#include "entresol.h"
#include <sstream>

namespace Mezzanine
{
    namespace UI
    {
        /*Spinner::Spinner(const String& name, const Rect& RendRect, const UI::SpinnerStyle& SStyle, const Real& GlyphHeight, Screen* parent)
            : Widget(name,parent),
              IncrementOffset(Vector2(0,0)),
              DecrementOffset(Vector2(0,0)),
              Value(0),
              MinValue(0),
              MaxValue(0),
              DecimalPlaces(0),
              DecimalDisplay(false),
              Editable(false),
              IncrementLock(true),
              DecrementLock(true),
              Increment(NULL),
              Decrement(NULL),
              ValueDisplay(NULL)
        {
            Type = Widget::W_Spinner;
            SpinLayout = SStyle;
            if(RendRect.Relative)
            {
                RelPosition = RendRect.Position;
                RelSize = RendRect.Size;
            }else{
                RelPosition = RendRect.Position / ParentScreen->GetViewportDimensions();
                RelSize = RendRect.Size / ParentScreen->GetViewportDimensions();
            }

            if(UI::Spn_Separate == SpinLayout)
            {
                if(RendRect.Size.X > RendRect.Size.Y * 2)
                {
                    if(RendRect.Relative)
                    {
                        const Vector2& WinDim = ParentScreen->GetViewportDimensions();
                        Vector2 APos = RendRect.Position * WinDim;
                        Vector2 ASize = RendRect.Size * WinDim;
                        CalculateOffsets(ASize);
                        CreateHorizontalSpinner(APos,ASize,GlyphHeight);
                    }else{
                        CalculateOffsets(RendRect.Size);
                        CreateHorizontalSpinner(RendRect.Position,RendRect.Size,GlyphHeight);
                    }
                }
                else if(RendRect.Size.Y > RendRect.Size.X * 2)
                {
                    if(RendRect.Relative)
                    {
                        const Vector2& WinDim = ParentScreen->GetViewportDimensions();
                        Vector2 APos = RendRect.Position * WinDim;
                        Vector2 ASize = RendRect.Size * WinDim;
                        CalculateOffsets(ASize);
                        CreateVerticalSpinner(APos,ASize,GlyphHeight);
                    }else{
                        CalculateOffsets(RendRect.Size);
                        CreateVerticalSpinner(RendRect.Position,RendRect.Size,GlyphHeight);
                    }
                }
                else
                {
                    MEZZ_EXCEPTION(Exception::PARAMETERS_EXCEPTION,"Spinner dimensions incompatible with this widget.");
                }
            }
            else if(UI::Spn_Together_Left == SpinLayout || UI::Spn_Together_Right == SpinLayout)
            {
                if(RendRect.Relative)
                {
                    const Vector2& WinDim = ParentScreen->GetViewportDimensions();
                    Vector2 APos = RendRect.Position * WinDim;
                    Vector2 ASize = RendRect.Size * WinDim;
                    CalculateOffsets(ASize);
                    CreateBoxSpinner(APos,ASize,GlyphHeight);
                }else{
                    CalculateOffsets(RendRect.Size);
                    CreateBoxSpinner(RendRect.Position,RendRect.Size,GlyphHeight);
                }
            }
            CaptureData = new InputCaptureData();
            CaptureData->AddInputRange(Input::KEY_1,Input::KEY_0);
            CaptureData->AddInputRange(Input::KEY_KP_1,Input::KEY_KP_PERIOD);
            CaptureData->AddInput(Input::KEY_PERIOD);
            CaptureData->AddInput(Input::KEY_RETURN);
            CaptureData->AddInput(Input::KEY_KP_ENTER);
        }

        Spinner::~Spinner()
        {
            ParentScreen->DestroyWidget(Increment);
            ParentScreen->DestroyWidget(Decrement);
            ParentScreen->DestroyBasicRenderable(ValueDisplay);
            delete CaptureData;
        }

        void Spinner::CreateHorizontalSpinner(const Vector2& Position, const Vector2& Size, const Real& GlyphHeight)
        {
            const Vector2& WinDim = ParentScreen->GetViewportDimensions();
            Whole ActHeight = (Whole)(GlyphHeight * WinDim.Y);
            std::pair<Whole,Real> GlyphInfo = Manager->SuggestGlyphIndex(ActHeight,ParentScreen->GetPrimaryAtlas());
            Vector2 IncPos = Position + IncrementOffset;
            Vector2 DecPos = Position + DecrementOffset;
            Vector2 ValPos = Position + ValueDisplayOffset;
            Increment = ParentScreen->CreateButton(Name+"Inc",Rect(IncPos,Vector2(Size.Y,Size.Y),false));
            Decrement = ParentScreen->CreateButton(Name+"Dec",Rect(DecPos,Vector2(Size.Y,Size.Y),false));
            ValueDisplay = ParentScreen->CreateCaption(Name+"Dis",Rect(ValPos,Vector2(Size.X - (Size.Y * 2),Size.Y),false),GlyphInfo.first,GetValueAsText());
            AddSubRenderable(0,Increment);
            AddSubRenderable(1,Decrement);
            AddSubRenderable(2,ValueDisplay);
            if(1 != GlyphInfo.second)
                ValueDisplay->SetTextScale(GlyphInfo.second);
        }

        void Spinner::CreateVerticalSpinner(const Vector2& Position, const Vector2& Size, const Real& GlyphHeight)
        {
            const Vector2& WinDim = ParentScreen->GetViewportDimensions();
            Whole ActHeight = (Whole)(GlyphHeight * WinDim.Y);
            std::pair<Whole,Real> GlyphInfo = Manager->SuggestGlyphIndex(ActHeight,ParentScreen->GetPrimaryAtlas());
            Vector2 IncPos = Position + IncrementOffset;
            Vector2 DecPos = Position + DecrementOffset;
            Vector2 ValPos = Position + ValueDisplayOffset;
            Increment = ParentScreen->CreateButton(Name+"Inc",Rect(IncPos,Vector2(Size.X,Size.X),false));
            Decrement = ParentScreen->CreateButton(Name+"Dec",Rect(DecPos,Vector2(Size.X,Size.X),false));
            ValueDisplay = ParentScreen->CreateCaption(Name+"Dis",Rect(ValPos,Vector2(Size.X,Size.Y - (Size.X * 2)),false),GlyphInfo.first,GetValueAsText());
            AddSubRenderable(0,Increment);
            AddSubRenderable(1,Decrement);
            AddSubRenderable(2,ValueDisplay);
            if(1 != GlyphInfo.second)
                ValueDisplay->SetTextScale(GlyphInfo.second);
        }

        void Spinner::CreateBoxSpinner(const Vector2& Position, const Vector2& Size, const Real& GlyphHeight)
        {
            const Vector2& WinDim = ParentScreen->GetViewportDimensions();
            Whole ActHeight = (Whole)(GlyphHeight * WinDim.Y);
            std::pair<Whole,Real> GlyphInfo = Manager->SuggestGlyphIndex(ActHeight,ParentScreen->GetPrimaryAtlas());
            Vector2 IncPos = Position + IncrementOffset;
            Vector2 DecPos = Position + DecrementOffset;
            Vector2 ValPos = Position + ValueDisplayOffset;
            Increment = ParentScreen->CreateButton(Name+"Inc",Rect(IncPos,Vector2(Size.Y * 0.5,Size.Y * 0.5),false));
            Decrement = ParentScreen->CreateButton(Name+"Dec",Rect(DecPos,Vector2(Size.Y * 0.5,Size.Y * 0.5),false));
            ValueDisplay = ParentScreen->CreateCaption(Name+"Dis",Rect(ValPos,Vector2(Size.X - (Size.Y * 0.5),Size.Y),false),GlyphInfo.first,GetValueAsText());
            AddSubRenderable(0,Increment);
            AddSubRenderable(1,Decrement);
            AddSubRenderable(2,ValueDisplay);
            if(1 != GlyphInfo.second)
                ValueDisplay->SetTextScale(GlyphInfo.second);
        }

        void Spinner::CalculateOffsets(const Vector2& Size)
        {
            switch (SpinLayout)
            {
                case UI::Spn_Separate:
                {
                    if(Size.X > Size.Y * 2)
                    {
                        IncrementOffset = Vector2(Size.X - Size.Y,0);
                        DecrementOffset = Vector2(0,0);
                        ValueDisplayOffset = Vector2(Size.Y,0);
                    }
                    else if(Size.Y > Size.X * 2)
                    {
                        IncrementOffset = Vector2(0,0);
                        DecrementOffset = Vector2(0,Size.Y - Size.X);
                        ValueDisplayOffset = Vector2(0,Size.X);
                    }
                    break;
                }
                case UI::Spn_Together_Left:
                {
                    IncrementOffset = Vector2(0,0);
                    DecrementOffset = Vector2(0,Size.Y * 0.5);
                    ValueDisplayOffset = Vector2(Size.Y * 0.5,0);
                    break;
                }
                case UI::Spn_Together_Right:
                {
                    IncrementOffset = Vector2(Size.X - (Size.Y * 0.5),0);
                    DecrementOffset = Vector2(Size.X - (Size.Y * 0.5),Size.Y * 0.5);
                    ValueDisplayOffset = Vector2(0,0);
                    break;
                }
            }
        }

        void Spinner::SetLocation(const Vector2& Position)
        {
            Increment->SetActualPosition(Position + IncrementOffset);
            Decrement->SetActualPosition(Position + DecrementOffset);
            ValueDisplay->SetActualPosition(Position + ValueDisplayOffset);
        }

        void Spinner::SetArea(const Vector2& Size)
        {
            switch (SpinLayout)
            {
                case UI::Spn_Separate:
                {
                    if(Size.X > Size.Y * 2)
                    {
                        Increment->SetActualSize(Vector2(Size.Y,Size.Y));
                        Decrement->SetActualSize(Vector2(Size.Y,Size.Y));
                        ValueDisplay->SetActualSize(Vector2(Size.X - (Size.Y * 2),Size.Y));
                    }
                    else if(Size.Y > Size.X * 2)
                    {
                        Increment->SetActualSize(Vector2(Size.X,Size.X));
                        Decrement->SetActualSize(Vector2(Size.X,Size.X));
                        ValueDisplay->SetActualSize(Vector2(Size.X,Size.Y - (Size.X * 2)));
                    }
                    break;
                }
                case UI::Spn_Together_Left:
                case UI::Spn_Together_Right:
                {
                    Increment->SetActualSize(Vector2(Size.Y * 0.5,Size.Y * 0.5));
                    Decrement->SetActualSize(Vector2(Size.Y * 0.5,Size.Y * 0.5));
                    ValueDisplay->SetActualSize(Vector2(Size.X - (Size.Y * 0.5),Size.Y));
                    break;
                }
            }
        }

        void Spinner::CheckValueLimits()
        {
            if(MinValue != 0 || MaxValue != 0)
            {
                if(Value < MinValue) Value = MinValue;
                if(Value > MaxValue) Value = MaxValue;
            }
        }

        String Spinner::GetValueAsText()
        {
            std::stringstream converter;
            String AsText;
            converter << Value;
            converter >> AsText;
            if(DecimalDisplay)
            {
                String Deci(".");
                if(DecimalPlaces + 1 > AsText.size()) AsText.insert(0,(DecimalPlaces+1) - AsText.size(),'0');
                AsText.insert(AsText.size() - DecimalPlaces,Deci);
            }
            return AsText;
        }

        void Spinner::UpdateImpl(bool Force)
        {
            ProcessCapturedInputs();
            if( HoveredSubWidget && (Widget::W_Button == HoveredSubWidget->GetType()) )
            {
                Input::ButtonState State = InputManager::GetSingletonPtr()->GetSystemMouse()->GetButtonState(1);
                if(Input::BUTTON_PRESSING == State)
                {
                    if(HoveredSubWidget==Increment)
                        IncrementLock = false;
                    else if(HoveredSubWidget==Decrement)
                        DecrementLock = false;
                }
                else if(Input::BUTTON_LIFTING && (!IncrementLock || !DecrementLock))
                {
                    if(HoveredSubWidget==Increment && !IncrementLock)
                    {
                        Value++;
                        CheckValueLimits();
                        ValueDisplay->SetText(GetValueAsText());
                        IncrementLock = true;
                    }
                    else if(HoveredSubWidget==Decrement && !DecrementLock)
                    {
                        Value--;
                        CheckValueLimits();
                        ValueDisplay->SetText(GetValueAsText());
                        DecrementLock = true;
                    }
                }
            }
        }

        void Spinner::SetVisibleImpl(bool visible)
        {
            Increment->SetVisible(visible);
            Decrement->SetVisible(visible);
            ValueDisplay->SetVisible(visible);
        }

        bool Spinner::CheckMouseHoverImpl()
        {
            if(Increment->CheckMouseHover())
            {
                HoveredSubWidget = Increment;
                return true;
            }
            if(Decrement->CheckMouseHover())
            {
                HoveredSubWidget = Decrement;
                return true;
            }
            if(ValueDisplay->CheckMouseHover())
            {
                HoveredSubWidget = NULL;
                return true;
            }
            return false;
        }

        void Spinner::ProcessCapturedInputs()
        {
            if(!Editable)
                return;
            if(0 == CaptureData->GetNumCapturedInputs())
                return;
            std::vector<Input::InputCode>* CCodes = CaptureData->GetCapturedInputs();
            bool EnterPressed = false;
            for( Whole X = 0 ; X < CCodes->size() ; X++ )
            {
                Input::InputCode Current = CCodes->at(X);
                if(Input::KEY_RETURN == Current || Input::KEY_KP_ENTER == Current)
                {
                    EnterPressed = true;
                    continue;
                }else{
                    EditCache+=StringTools::ConvertToString(Current,false);
                }
            }
            if(EnterPressed)
            {
                std::stringstream TempStream;
                if(DecimalDisplay)
                    EditCache.erase(EditCache.find("."),1);
                TempStream << EditCache;
                TempStream >> Value;
                CheckValueLimits();
                ValueDisplay->SetText(GetValueAsText());
                EditCache.clear();
            }
        }

        void Spinner::SetSpinnerValue(const int& ValueToSet)
        {
            Value = ValueToSet;
            CheckValueLimits();
            ValueDisplay->SetText(GetValueAsText());
        }

        int Spinner::GetSpinnerValue()
        {
            return Value;
        }

        void Spinner::SetValueLimits(const int& Lower, const int& Upper)
        {
            MinValue = Lower;
            MaxValue = Upper;
        }

        void Spinner::SetEditable(bool Edit)
        {
            Editable = Edit;
        }

        bool Spinner::GetEditable()
        {
            return Editable;
        }

        void Spinner::EnableDecimalDisplay(bool Enable, const Whole& Places)
        {
            DecimalDisplay = Enable;
            DecimalPlaces = Places;
        }

        void Spinner::SetPosition(const Vector2& Position)
        {
            RelPosition = Position;
            Vector2 Adjusted = Position * ParentScreen->GetViewportDimensions();
            SetLocation(Adjusted);
        }

        void Spinner::SetActualPosition(const Vector2& Position)
        {
            RelPosition = Position / ParentScreen->GetViewportDimensions();
            SetLocation(Position);
        }

        void Spinner::SetSize(const Vector2& Size)
        {
            RelSize = Size;
            Vector2 Adjusted = Size * ParentScreen->GetViewportDimensions();
            CalculateOffsets(Adjusted);
            SetArea(Adjusted);
            SetLocation(GetActualPosition());
        }

        void Spinner::SetActualSize(const Vector2& Size)
        {
            RelSize = Size / ParentScreen->GetViewportDimensions();
            CalculateOffsets(Size);
            SetArea(Size);
            SetLocation(GetActualPosition());
        }

        void Spinner::UpdateDimensions()
        {
            WidgetResult Result = ViewportUpdateTool::UpdateWidget(this);
            RelPosition = Result.first / ViewportUpdateTool::GetNewSize();
            RelSize = Result.second / ViewportUpdateTool::GetNewSize();
            Increment->UpdateDimensions();
            Decrement->UpdateDimensions();
            ValueDisplay->UpdateDimensions();
            CalculateOffsets(Result.second);
            SetPosition(RelPosition);
        }

        Button* Spinner::GetIncrement()
        {
            return Increment;
        }

        Button* Spinner::GetDecrement()
        {
            return Decrement;
        }

        Caption* Spinner::GetValueDisplay()
        {
            return ValueDisplay;
        }

        ///////////////////////////////////////////////////////////////////////////////
        // PageProvider Methods

        Real Spinner::GetMaxXPages() const
            { return this->MaxXPages; }

        Real Spinner::GetMaxYPages() const
            { return this->MaxYPages; }

        Real Spinner::GetCurrentXPage() const
        {
            Real PageValue = static_cast<Real>( this->Target->GetSpinnerValue() );
            if( this->PageOrder == UI::OP_Horizontal_Vertical ) {
                return MathTool::Ceil( PageValue / this->MaxXPages );
            }else if( this->PageOrder == UI::OP_Vertical_Horizontal ) {
                return MathTool::Fmod( PageValue, this->MaxYPages );
            }
            return 1;
        }

        Real Spinner::GetCurrentYPage() const
        {
            Real PageValue = static_cast<Real>( this->Target->GetSpinnerValue() );
            if( this->PageOrder == UI::OP_Horizontal_Vertical ) {
                return MathTool::Ceil( PageValue / this->MaxXPages );
            }else if( this->PageOrder == UI::OP_Vertical_Horizontal ) {
                return MathTool::Fmod( PageValue, this->MaxYPages );
            }
            return 1;
        }

        void Spinner::SetOrdering(const UI::OrderingPriority Order)
            { this->PageOrder = Order; }

        UI::OrderingPriority Spinner::GetOrdering() const
            { return this->PageOrder; }

        ///////////////////////////////////////////////////////////////////////////////
        // Serialization

        void Spinner::ProtoSerializePageData(XML::Node& SelfRoot) const
            {  }

        void Spinner::ProtoDeSerializePageData(const XML::Node& SelfRoot)
            {  }

        ///////////////////////////////////////////////////////////////////////////////
        // Internal Methods

        void Spinner::_SetContainer(PagedContainer* ToUpdate)
            { this->Container = ToUpdate; }

        void Spinner::_NotifyContainerUpdated()
            { this->Target->SetValueLimits(1,this->MaxXPages * this->MaxYPages); }//*/
    }//UI
}//Mezzanine

#endif