Picture.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_PICTURE_INCLUDED_
#define _TGUI_PICTURE_INCLUDED_


namespace tgui
{

    struct TGUI_API Picture : public OBJECT
    {
        Picture();


        Picture(const Picture& copy);


        virtual ~Picture();


        Picture& operator= (const Picture& right);


        virtual Picture* clone();


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


        virtual void setSize(float width, float height);


        virtual Vector2u getSize() const;


        virtual Vector2f getScaledSize() const;


        virtual std::string getLoadedFilename() const;


        // These functions are used to receive callback from the 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);


    protected:

        // 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;


    protected:

        sf::Texture* m_Texture;
        sf::Sprite   m_Sprite;

        // The size of the picture
        Vector2f  m_Size;

        // The filename used to load the picture
        std::string m_LoadedFilename;
    };

}


#endif //_TGUI_PICTURE_INCLUDED_