IGUISpriteBank.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_GUI_SPRITE_BANK_H_INCLUDED__
#define __I_GUI_SPRITE_BANK_H_INCLUDED__

#include "IReferenceCounted.h"
#include "irrArray.h"
#include "SColor.h"
#include "rect.h"

namespace irr
{

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
struct SGUISpriteFrame
{
        SGUISpriteFrame() : textureNumber(0), rectNumber(0)
        {
        }

        SGUISpriteFrame(u32 textureIndex, u32 positionIndex)
        : textureNumber(textureIndex), rectNumber(positionIndex)
        {
        }

        u32 textureNumber;

        u32 rectNumber;
};

// Note for implementer: Can't fix variable names to uppercase as this is a public interface used since a while
struct SGUISprite
{
        SGUISprite() : frameTime(0) {}
        SGUISprite(const SGUISpriteFrame& firstFrame) : frameTime(0)
        {
                Frames.push_back(firstFrame);
        }

        core::array<SGUISpriteFrame> Frames;
        u32 frameTime;
};



class IGUISpriteBank : public virtual IReferenceCounted
{
public:

        virtual core::array< core::rect<s32> >& getPositions() = 0;

        virtual core::array< SGUISprite >& getSprites() = 0;

        virtual u32 getTextureCount() const = 0;

        virtual video::ITexture* getTexture(u32 index) const = 0;

        virtual void addTexture(video::ITexture* texture) = 0;

        virtual void setTexture(u32 index, video::ITexture* texture) = 0;


        virtual s32 addTextureAsSprite(video::ITexture* texture) = 0;

        virtual void clear() = 0;


        virtual void draw2DSprite(u32 index, const core::position2di& pos,
                        const core::rect<s32>* clip=0,
                        const video::SColor& color= video::SColor(255,255,255,255),
                        u32 starttime=0, u32 currenttime=0,
                        bool loop=true, bool center=false) = 0;


        virtual void draw2DSprite(u32 index, const core::rect<s32>& destRect,
                        const core::rect<s32>* clip=0,
                        const video::SColor * const colors=0,
                        u32 timeTicks = 0,
                        bool loop=true) = 0;

        virtual void draw2DSpriteBatch(const core::array<u32>& indices, const core::array<core::position2di>& pos,
                        const core::rect<s32>* clip=0,
                        const video::SColor& color= video::SColor(255,255,255,255),
                        u32 starttime=0, u32 currenttime=0,
                        bool loop=true, bool center=false) = 0;
};


} // end namespace gui
} // end namespace irr

#endif // __I_GUI_SPRITE_BANK_H_INCLUDED__