OpenGUI::OgreStaticTexture Class Reference

#include <Renderer_Ogre_Texture.h>

Inheritance diagram for OpenGUI::OgreStaticTexture:

OpenGUI::OgreTexture List of all members.

Detailed Description

An OpenGUI::Texture implementation used by OgreRenderer to load and represent Ogre textures.


Public Member Functions

 OgreStaticTexture ()
virtual ~OgreStaticTexture ()
virtual const Ogre::String & getOgreTextureName () const
 Returns the name of this texture as held by Ogre.
void loadFile (const std::string &filename, const std::string &resourceGroup)
 loads a new texture from a file
void loadOgreTexture (Ogre::TexturePtr ogreTexture)
 assigns an existing Ogre texture to this object
void loadFromTextureData (const TextureData *textureData, const std::string &groupName)
 load a texture with the contents of an OpenGUI TextureData object (aka: from memory)
virtual void getOgreUVScale (float &u, float &v)
 Pass through to OpenGUI::Texture::getUVs.

Protected Member Functions

void freeOgreTexture ()
 frees the attached Ogre texture. Infinitely recallable
bool validOgreTexture ()
 Returns true if this texture object is currently representing an Ogre texture.

Private Attributes

bool mNotOwner
Ogre::TexturePtr mOgreTexturePtr


Constructor & Destructor Documentation

OpenGUI::OgreStaticTexture::OgreStaticTexture (  )  [inline]

virtual OpenGUI::OgreStaticTexture::~OgreStaticTexture (  )  [inline, virtual]


Member Function Documentation

void OpenGUI::OgreStaticTexture::freeOgreTexture (  )  [protected]

frees the attached Ogre texture. Infinitely recallable

const Ogre::String & OpenGUI::OgreStaticTexture::getOgreTextureName (  )  const [virtual]

Returns the name of this texture as held by Ogre.

Implements OpenGUI::OgreTexture.

virtual void OpenGUI::OgreStaticTexture::getOgreUVScale ( float &  u,
float &  v 
) [inline, virtual]

Pass through to OpenGUI::Texture::getUVs.

Implements OpenGUI::OgreTexture.

void OpenGUI::OgreStaticTexture::loadFile ( const std::string &  filename,
const std::string &  resourceGroup 
)

loads a new texture from a file

void OpenGUI::OgreStaticTexture::loadFromTextureData ( const TextureData *  textureData,
const std::string &  groupName 
)

load a texture with the contents of an OpenGUI TextureData object (aka: from memory)

void OpenGUI::OgreStaticTexture::loadOgreTexture ( Ogre::TexturePtr  ogreTexture  ) 

assigns an existing Ogre texture to this object

bool OpenGUI::OgreStaticTexture::validOgreTexture (  )  [inline, protected]

Returns true if this texture object is currently representing an Ogre texture.


Member Data Documentation

bool OpenGUI::OgreStaticTexture::mNotOwner [private]

Ogre::TexturePtr OpenGUI::OgreStaticTexture::mOgreTexturePtr [private]


The documentation for this class was generated from the following files:
Copyright © 2006 OpenGUI | OpenGUI.SF.net
Generated: Fri Jan 5 23:05:42 2007