LoadingBar.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012 Bruno Van de Velde (VDV_B@hotmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef _TGUI_LOADING_BAR_INCLUDED_
#define _TGUI_LOADING_BAR_INCLUDED_


namespace tgui
{

    struct TGUI_API LoadingBar : public OBJECT
    {
        LoadingBar();


        LoadingBar(const LoadingBar& copy);


        virtual ~LoadingBar();


        LoadingBar& operator= (const LoadingBar& right);


        virtual void initialize();


        virtual LoadingBar* clone();


        virtual bool load(const std::string& pathname);


        virtual void setSize(float width, float height);


        virtual Vector2u getSize() const;


        virtual Vector2f getScaledSize() const;


        virtual std::string getLoadedPathname() const;


        virtual void setMinimum(unsigned int minimum);


        virtual void setMaximum(unsigned int maximum);


        virtual void setValue(unsigned int value);


        virtual unsigned int getMinimum() const;


        virtual unsigned int getMaximum() const;


        virtual unsigned int getValue() const;


        virtual unsigned int incrementValue();


        virtual void setText(const sf::String& text);


        virtual sf::String getText() const;


        virtual void setTextFont(const sf::Font& font);


        virtual const sf::Font* getTextFont() const;


        virtual void setTextColor(const sf::Color& color);


        virtual const sf::Color& getTextColor() const;


        virtual void setTextSize(unsigned int size);


        virtual unsigned int getTextSize() const;


        // This function tells the EventManager if the mouse is on top of the loading bar.
        bool mouseOnObject(float x, float y);


    protected:


        // When the value changes, or when the minimum/maximum limits change then a smaller of bigger piece of the front image
        // must be drawn. This function is called to calculate the size of the piece to draw.
        virtual void recalculateSize();


        // Because this struct is derived from sf::Drawable, you can just call the draw function from your sf::RenderTarget.
        // This function will be called and it will draw the loading bar on the render target.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


    protected:

        unsigned int m_Minimum;
        unsigned int m_Maximum;
        unsigned int m_Value;

        // If this is true then the L, M and R images will be used.
        // If it is false then the button is just one big image that will be stored in the M image.
        bool m_SplitImage;

        // The size of the loading bar
        Vector2f m_Size;

        sf::Texture* m_TextureBack_L;
        sf::Texture* m_TextureBack_M;
        sf::Texture* m_TextureBack_R;
        sf::Texture* m_TextureFront_L;
        sf::Texture* m_TextureFront_M;
        sf::Texture* m_TextureFront_R;

        sf::Sprite   m_SpriteBack_L;
        sf::Sprite   m_SpriteBack_M;
        sf::Sprite   m_SpriteBack_R;
        sf::Sprite   m_SpriteFront_L;
        sf::Sprite   m_SpriteFront_M;
        sf::Sprite   m_SpriteFront_R;

        // The text that is (optionally) drawn on top of the loading bar
        sf::Text     m_Text;
        unsigned int m_TextSize;

        // The pathname used to load the loading bar
        std::string m_LoadedPathname;
    };

}


#endif //_TGUI_LOADING_BAR_INCLUDED_