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

Class to manage the available shadow textures which may be shared between many SceneManager instances if formats agree. More...

#include <OgreShadowTextureManager.h>

+ Inheritance diagram for Ogre::ShadowTextureManager:
+ Collaboration diagram for Ogre::ShadowTextureManager:

Public Member Functions

 ShadowTextureManager ()
 
virtual ~ShadowTextureManager ()
 
virtual void clear ()
 Dereference all the shadow textures kept in this class and remove them from TextureManager; note that it is up to the SceneManagers to clear their local references. More...
 
virtual void clearUnused ()
 Remove any shadow textures that are no longer being referenced. More...
 
virtual void getAllShadowTextures (ShadowTextureList &listToPopulate)
 Populate an incoming list with all shadow texture references. More...
 
virtual TexturePtr getNullShadowTexture (PixelFormat format)
 Get an appropriately defined 'null' texture, i.e. More...
 
virtual void getShadowTextures (const ShadowTextureConfigList &config, ShadowTextureList &listToPopulate)
 Populate an incoming list with shadow texture references as requested in the configuration list. 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)
 

Static Public Member Functions

static ShadowTextureManagergetSingleton (void)
 Override standard Singleton retrieval. More...
 
static ShadowTextureManagergetSingletonPtr (void)
 Override standard Singleton retrieval. More...
 

Protected Attributes

size_t mCount
 
ShadowTextureList mNullTextureList
 
ShadowTextureList mTextureList
 

Static Protected Attributes

static ShadowTextureManagermsSingleton
 

Detailed Description

Class to manage the available shadow textures which may be shared between many SceneManager instances if formats agree.

Remarks
The management of the list of shadow textures has been separated out into a dedicated class to enable the clean management of shadow textures across many scene manager instances. Where multiple scene managers are used with shadow textures, the configuration of those shadows may or may not be consistent - if it is, it is good to centrally manage the textures so that creation and destruction responsibility is clear.

Definition at line 79 of file OgreShadowTextureManager.h.

Constructor & Destructor Documentation

Ogre::ShadowTextureManager::ShadowTextureManager ( )
virtual Ogre::ShadowTextureManager::~ShadowTextureManager ( )
virtual

Member Function Documentation

virtual void Ogre::ShadowTextureManager::clear ( )
virtual

Dereference all the shadow textures kept in this class and remove them from TextureManager; note that it is up to the SceneManagers to clear their local references.

virtual void Ogre::ShadowTextureManager::clearUnused ( )
virtual

Remove any shadow textures that are no longer being referenced.

Remarks
This should be called fairly regularly since references may take a little while to disappear in some cases (if referenced by materials)
virtual void Ogre::ShadowTextureManager::getAllShadowTextures ( ShadowTextureList listToPopulate)
inlinevirtual

Populate an incoming list with all shadow texture references.

Definition at line 98 of file OgreShadowTextureManager.h.

virtual TexturePtr Ogre::ShadowTextureManager::getNullShadowTexture ( PixelFormat  format)
virtual

Get an appropriately defined 'null' texture, i.e.

one which will always result in no shadows.

virtual void Ogre::ShadowTextureManager::getShadowTextures ( const ShadowTextureConfigList config,
ShadowTextureList listToPopulate 
)
virtual

Populate an incoming list with shadow texture references as requested in the configuration list.

static ShadowTextureManager& Ogre::ShadowTextureManager::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 ShadowTextureManager* Ogre::ShadowTextureManager::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.

Member Data Documentation

size_t Ogre::ShadowTextureManager::mCount
protected

Definition at line 84 of file OgreShadowTextureManager.h.

ShadowTextureList Ogre::ShadowTextureManager::mNullTextureList
protected

Definition at line 83 of file OgreShadowTextureManager.h.

ShadowTextureManager * Ogre::Singleton< ShadowTextureManager >::msSingleton
staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.

ShadowTextureList Ogre::ShadowTextureManager::mTextureList
protected

Definition at line 82 of file OgreShadowTextureManager.h.


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