AnimatedButton.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_ANIMATED_BUTTON_INCLUDED_
#define _TGUI_ANIMATED_BUTTON_INCLUDED_


namespace tgui
{

    struct TGUI_API AnimatedButton : public OBJECT, OBJECT_ANIMATION
    {
        AnimatedButton();


        AnimatedButton(const AnimatedButton& copy);


        virtual ~AnimatedButton();


        AnimatedButton& operator= (const AnimatedButton& right);


        virtual void initialize();


        virtual AnimatedButton* 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 setText(const sf::String& text);


        virtual sf::String getText() const;


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


        virtual const sf::Font* getTextFont();


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


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


        virtual void setTextSize(unsigned int size);


        virtual unsigned int getTextSize() const;


        virtual void setFrame(unsigned int frame);


        // These functions are used to receive callback from EventManager.
        // You normally don't need them, but you can use them to simulate an event.
        virtual bool mouseOnObject(float x, float y);
        virtual void leftMousePressed(float x, float y);
        virtual void leftMouseReleased(float x, float y);
        virtual void mouseMoved(float x, float y);
        virtual void keyPressed(sf::Keyboard::Key key);
        virtual void objectFocused();
        virtual void mouseNotOnObject();
        virtual void mouseNoLongerDown();


    protected:

        // Used internally by the load function.
        virtual unsigned int getLoadingID(const std::string& property);


        // When the elapsed time changes then this function is called.
        virtual void update();


        // 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 button on the render target.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


    protected:

        // The size of the button
        Vector2f m_Size;

        // The SFML textures
        std::vector<sf::Texture*> m_TexturesNormal;
        std::vector<sf::Texture*> m_TexturesMouseHover;
        std::vector<sf::Texture*> m_TexturesMouseDown;
        std::vector<sf::Texture*> m_TexturesFocused;

        // The SFML sprites
        std::vector<sf::Sprite>   m_SpritesNormal;
        std::vector<sf::Sprite>   m_SpritesMouseHover;
        std::vector<sf::Sprite>   m_SpritesMouseDown;
        std::vector<sf::Sprite>   m_SpritesFocused;

        // Frame durations (in milliseconds)
        std::vector<int> m_DurationsNormal;
        std::vector<int> m_DurationsMouseHover;
        std::vector<int> m_DurationsMouseDown;
        std::vector<int> m_DurationsFocused;

        // The pathname used to load the animated button
        std::string m_LoadedPathname;

        // Is there a separate hover image, or is it a semi-transparent image that is drawn on top of the others?
        bool m_SeparateHoverImage;

        // The SFML text
        sf::Text m_Text;

        // This will store the size of the text ( 0 to auto size )
        unsigned int m_TextSize;

        // The frame that is currently displayed
        unsigned int m_CurrentFrame;
    };

}


#endif //_TGUI_ANIMATED_BUTTON_INCLUDED_