IGUISpriteBank.hpp

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in duckcpp/duckcpp.hpp
 
#ifndef DCPP_I_GUI_SPRITE_BANK_HPP_INCLUDED
#define DCPP_I_GUI_SPRITE_BANK_HPP_INCLUDED
 
#include <duckcpp/core/engine/IReferenceCounted.hpp>
#include <duckcpp/core/engine/irrArray.hpp>
#include <duckcpp/core/engine/SColor.hpp>
#include <duckcpp/core/engine/rect.hpp>
 
namespace dcpp
{
 
namespace video
{
    class ITexture;
} // end namespace video
 
namespace gui
{
 
// Note for implementer: Can't fix variable names to uppercase as this is a public interface used since a while
class SGUISpriteFrame
{
public:
    SGUISpriteFrame() : textureNumber(0), rectNumber(0)
    {
    }
 
public:
    SGUISpriteFrame(dcpp::uint32_kt textureIndex, dcpp::uint32_kt positionIndex)
    : textureNumber(textureIndex), rectNumber(positionIndex)
    {
    }
 
public:
    dcpp::uint32_kt textureNumber;
 
    dcpp::uint32_kt rectNumber;
};
 
// Note for implementer: Can't fix variable names to uppercase as this is a public interface used since a while
class SGUISprite
{
public:
    SGUISprite() : frameTime(0) {}
 
public:
    SGUISprite(const SGUISpriteFrame& firstFrame) : frameTime(0)
    {
        Frames.push_back(firstFrame);
    }
 
public:
    dcpp::nub::array<SGUISpriteFrame> Frames;
    dcpp::uint32_kt frameTime;
};
 
 
 
class IGUISpriteBank : public virtual IReferenceCounted
{
public:
 
    virtual dcpp::nub::array< dcpp::nub::recti >& getPositions() = 0;
 
    virtual dcpp::nub::array< SGUISprite >& getSprites() = 0;
 
    virtual dcpp::uint32_kt getTextureCount() const = 0;
 
    virtual dcpp::video::ITexture* getTexture(dcpp::uint32_kt index) const = 0;
 
    virtual void addTexture(dcpp::video::ITexture* texture) = 0;
 
    virtual void setTexture(dcpp::uint32_kt index, dcpp::video::ITexture* texture) = 0;
 
 
    virtual dcpp::int32_kt addTextureAsSprite(dcpp::video::ITexture* texture) = 0;
 
    virtual void clear() = 0;
 
 
    virtual void draw2DSprite(dcpp::uint32_kt index, const dcpp::nub::position2di& pos,
            const dcpp::nub::recti* clip=0,
            const dcpp::video::SColor& color= dcpp::video::SColor(255,255,255,255),
            dcpp::uint32_kt starttime=0, dcpp::uint32_kt currenttime=0,
            bool loop=true, bool center=false) = 0;
 
 
    virtual void draw2DSprite(dcpp::uint32_kt index, const dcpp::nub::recti& destRect,
            const dcpp::nub::recti* clip=0,
            const dcpp::video::SColor * const colors=0,
            dcpp::uint32_kt timeTicks = 0,
            bool loop=true) = 0;
 
    virtual void draw2DSpriteBatch(const dcpp::nub::array<dcpp::uint32_kt>& indices, const dcpp::nub::array<dcpp::nub::position2di>& pos,
            const dcpp::nub::recti* clip=0,
            const dcpp::video::SColor& color= dcpp::video::SColor(255,255,255,255),
            dcpp::uint32_kt starttime=0, dcpp::uint32_kt currenttime=0,
            bool loop=true, bool center=false) = 0;
};
 
 
} // end namespace gui
} // end namespace dcpp
 
#endif // DCPP_I_GUI_SPRITE_BANK_HPP_INCLUDED