AnimatedPicture.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 Bruno Van de Velde (vdv_b@tgui.eu)
//
// 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_HPP
#define TGUI_ANIMATED_PICTURE_HPP

#include <TGUI/ClickableWidget.hpp>


namespace tgui
{
 class TGUI_API AnimatedPicture : public ClickableWidget
 {
 public:

 typedef SharedWidgetPtr<AnimatedPicture> Ptr;


 AnimatedPicture();


 AnimatedPicture(const AnimatedPicture& copy);


 virtual ~AnimatedPicture();


 AnimatedPicture& operator= (const AnimatedPicture& right);


 // Makes a copy of the widget by calling the copy constructor.
 // This function calls new and if you use this function then you are responsible for calling delete.
 virtual AnimatedPicture* clone();


 bool addFrame(const std::string& filename, sf::Time frameDuration = sf::Time());


 void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 void play();


 void pause();


 void stop();


 bool setFrame(unsigned int frame);


 int getCurrentFrame() const;


 sf::Time getCurrentFrameDuration() const;


 unsigned int getFrames() const;


 bool removeFrame(unsigned int frame);


 void removeAllFrames();


 void setLooping(bool loop = true);


 bool getLooping() const;


 bool isPlaying() const;


 virtual void setTransparency(unsigned char transparency);


 // This function is a (slow) way to set properties on the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool setProperty(std::string property, const std::string& value);

 // This function is a (slow) way to get properties of the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool getProperty(std::string property, std::string& value) const;


 // Returns a list of all properties that can be used in setProperty and getProperty.
 // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
 virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


 protected:

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


 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 enum AnimatedPictureCallbacks
 {
 AnimationFinished = ClickableWidgetCallbacksCount * 1, 
 AllAnimatedPictureCallbacks = ClickableWidgetCallbacksCount * 2 - 1, 
 AnimatedPictureCallbacksCount = ClickableWidgetCallbacksCount * 2
 };

 protected:

 std::vector<Texture> m_Textures;
 std::vector<sf::Time> m_FrameDuration;

 int m_CurrentFrame;

 bool m_Playing;
 bool m_Looping;
 };

}


#endif // TGUI_ANIMATED_PICTURE_HPP