AnimatedPicture.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_PICTURE_INCLUDED_
#define _TGUI_ANIMATED_PICTURE_INCLUDED_


namespace tgui
{
    struct TGUI_API AnimatedPicture : public OBJECT, OBJECT_ANIMATION
    {
        AnimatedPicture();


        AnimatedPicture(const AnimatedPicture& copy);


        virtual ~AnimatedPicture();


        AnimatedPicture& operator= (const AnimatedPicture& right);


        virtual AnimatedPicture* clone();


        virtual unsigned int addFrame(const std::string& filename, sf::Time frameDurarion = sf::Time());


        virtual void setSize(float width, float height);


        virtual Vector2u getSize() const;


        virtual Vector2f getScaledSize() const;


        virtual void play();


        virtual void pause();


        virtual void stop();


        virtual void setFrame(unsigned int frame);


        virtual unsigned int getCurrentFrame() const;


        virtual void setFrameDuration(unsigned int frame, sf::Time frameDuration = sf::Time());


        virtual sf::Time getCurrentFrameDuration() const;


        virtual unsigned int getFrames() const;


        virtual std::vector<std::string> getLoadedFilenames() const;


        virtual void removeFrame(unsigned int frame);


        virtual void removeAllFrames();


        // With this function, the object will tell the EventManager if the mouse is on top of it or not.
        virtual bool mouseOnObject(float x, float y);


    protected:

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


    public:

        bool loop;


    protected:

        Vector2f m_Size;

        std::vector<sf::Texture*> m_Textures;
        std::vector<sf::Sprite>   m_Sprites;
        std::vector<std::string>  m_LoadedFilenames;
        std::vector<sf::Time>     m_FrameDuration;

        unsigned int m_CurrentFrame;

        bool m_Playing;
    };

}


#endif //_TGUI_ANIMATED_PICTURE_INCLUDED_