OgreCEGUITexture.h

Go to the documentation of this file.

/************************************************************************
    filename:   OgreCEGUITexture.h
    created:    11/5/2004
    author:     Paul D Turner
    
    purpose:    Interface to Texture implemented via Ogre engine
*************************************************************************/
/*************************************************************************
    Crazy Eddie's GUI System (http://www.cegui.org.uk)
    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*************************************************************************/
#ifndef _OgreCEGUITexture_h_
#define _OgreCEGUITexture_h_

#include <CEGUIBase.h>
#include <CEGUIRenderer.h>
#include <CEGUITexture.h>
#include "OgreCEGUIRenderer.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class _OgrePrivate OgreCEGUITexture : public Texture
{
private:
    /*************************************************************************
        Friends (to allow construction and destruction)
    *************************************************************************/
    friend  Texture* OgreCEGUIRenderer::createTexture(void);
    friend  Texture* OgreCEGUIRenderer::createTexture(const String& filename, const String& resourceGroup);
    friend  Texture* OgreCEGUIRenderer::createTexture(float size);
    friend  void     OgreCEGUIRenderer::destroyTexture(Texture* texture);


    /*************************************************************************
        Construction & Destruction (by Renderer object only)
    *************************************************************************/
    OgreCEGUITexture(Renderer* owner);
    virtual ~OgreCEGUITexture(void);

public:
    virtual ushort  getWidth(void) const        {return d_width;}


    virtual ushort  getHeight(void) const       {return d_height;}


    virtual void    loadFromFile(const String& filename, const String& resourceGroup);


    virtual void    loadFromMemory(const void* buffPtr, uint buffWidth, uint buffHeight, PixelFormat pixelFormat);


    Ogre::TexturePtr    getOgreTexture(void) const      {return d_ogre_texture;}


    void    setOgreTextureSize(uint size);


    void    setOgreTexture(Ogre::TexturePtr& texture);


private:
    /*************************************************************************
        Implementation Functions
    *************************************************************************/
    // safely free Ogre::Texture texture (can be called multiple times with no ill effect)
    void    freeOgreTexture(void);

    // return a Ogre::string that contains a unique name.
    Ogre::String    getUniqueName(void);


    /*************************************************************************
        Implementation Data
    *************************************************************************/
    static  uint32          d_texturenumber;    

    Ogre::TexturePtr        d_ogre_texture;     

    ushort                  d_width;            
    ushort                  d_height;           

    bool    d_isLinked;     
};


} // End of  CEGUI namespace section


#endif  // end of guard _OgreCEGUITexture_h_