OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::ExternalTextureSourceManager Class Reference

Singleton Class which handles the registering and control of texture plugins. More...

#include <OgreExternalTextureSourceManager.h>

+ Inheritance diagram for Ogre::ExternalTextureSourceManager:
+ Collaboration diagram for Ogre::ExternalTextureSourceManager:

Public Member Functions

 ExternalTextureSourceManager ()
 Constructor. More...
 
 ~ExternalTextureSourceManager ()
 Destructor. More...
 
void destroyAdvancedTexture (const String &sTextureName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
 Calls the destroy method of all registered plugins... More...
 
ExternalTextureSourcegetCurrentPlugIn (void) const
 Returns currently selected plugin, may be null if none selected. More...
 
ExternalTextureSourcegetExternalTextureSource (const String &sTexturePlugInType)
 Returns the plugin which registered itself with a specific name (eg. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
void setCurrentPlugIn (const String &sTexturePlugInType)
 Sets active plugin (ie. More...
 
void setExternalTextureSource (const String &sTexturePlugInType, ExternalTextureSource *pTextureSystem)
 Called from plugin to register itself. More...
 

Static Public Member Functions

static
ExternalTextureSourceManager
getSingleton (void)
 Override standard Singleton retrieval. More...
 
static
ExternalTextureSourceManager
getSingletonPtr (void)
 Override standard Singleton retrieval. More...
 

Protected Types

typedef map< String,
ExternalTextureSource * >
::type 
TextureSystemList
 

Protected Attributes

ExternalTextureSourcemCurrExternalTextureSource
 The current texture controller selected. More...
 
TextureSystemList mTextureSystems
 

Static Protected Attributes

static
ExternalTextureSourceManager
msSingleton
 

Detailed Description

Singleton Class which handles the registering and control of texture plugins.

The plugins will be mostly controlled via a string interface.

Definition at line 56 of file OgreExternalTextureSourceManager.h.

Member Typedef Documentation

Constructor & Destructor Documentation

Ogre::ExternalTextureSourceManager::ExternalTextureSourceManager ( )

Constructor.

Ogre::ExternalTextureSourceManager::~ExternalTextureSourceManager ( )

Destructor.

Member Function Documentation

void Ogre::ExternalTextureSourceManager::destroyAdvancedTexture ( const String sTextureName,
const String groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME 
)

Calls the destroy method of all registered plugins...

Only the owner plugin should perform the destroy action.

ExternalTextureSource* Ogre::ExternalTextureSourceManager::getCurrentPlugIn ( void  ) const
inline

Returns currently selected plugin, may be null if none selected.

Definition at line 68 of file OgreExternalTextureSourceManager.h.

ExternalTextureSource* Ogre::ExternalTextureSourceManager::getExternalTextureSource ( const String sTexturePlugInType)

Returns the plugin which registered itself with a specific name (eg.

"video"), or null if specified plugin not found

static ExternalTextureSourceManager& Ogre::ExternalTextureSourceManager::getSingleton ( void  )
static

Override standard Singleton retrieval.

Remarks
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.
This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.
static ExternalTextureSourceManager* Ogre::ExternalTextureSourceManager::getSingletonPtr ( void  )
static

Override standard Singleton retrieval.

Remarks
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.
This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::ExternalTextureSourceManager::setCurrentPlugIn ( const String sTexturePlugInType)

Sets active plugin (ie.

"video", "effect", "generic", etc..)

void Ogre::ExternalTextureSourceManager::setExternalTextureSource ( const String sTexturePlugInType,
ExternalTextureSource pTextureSystem 
)

Called from plugin to register itself.

Member Data Documentation

ExternalTextureSource* Ogre::ExternalTextureSourceManager::mCurrExternalTextureSource
protected

The current texture controller selected.

Definition at line 116 of file OgreExternalTextureSourceManager.h.

Definition at line 75 of file OgreSingleton.h.

TextureSystemList Ogre::ExternalTextureSourceManager::mTextureSystems
protected

Definition at line 120 of file OgreExternalTextureSourceManager.h.


The documentation for this class was generated from the following file: