SpriteSheet.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_SPRITE_SHEET_INCLUDED_
#define _TGUI_SPRITE_SHEET_INCLUDED_


namespace tgui
{
    struct TGUI_API SpriteSheet : public Picture
    {
        SpriteSheet();


        SpriteSheet(const SpriteSheet& copy);


        SpriteSheet& operator= (const SpriteSheet& right);


        virtual SpriteSheet* clone();


        virtual void setSize(float width, float height);


        virtual Vector2u getSize() const;


        virtual Vector2f getScaledSize() const;


        virtual void setCells(unsigned int rows, unsigned int columns);


        virtual void setRows(unsigned int rows);


        virtual unsigned int getRows() const;


        virtual void setColumns(unsigned int columns);


        virtual unsigned int getColumns() const;


        virtual void setVisibleCell(unsigned int row, unsigned int column);


        virtual sf::Vector2u getVisibleCell() const;


    protected:

        unsigned int m_Rows;
        unsigned int m_Columns;

        sf::Vector2u m_VisibleCell;
    };

}


#endif //_TGUI_SPRITE_SHEET_INCLUDED_