OgreExternalTextureSourceManager.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef _OgreExternalTextureSourceManager_H
29 #define _OgreExternalTextureSourceManager_H
30 
31 /***************************************************************************
32 OgreExternalTextureSourceManager.h -
33  Handles the registering / unregistering of texture modifier plugins
34 
35 -------------------
36 date : Jan 1 2004
37 email : pjcast@yahoo.com
38 ***************************************************************************/
39 #include "OgreSingleton.h"
40 #include "OgreString.h"
43 #include "OgreHeaderPrefix.h"
44 
45 namespace Ogre
46 {
56  class _OgreExport ExternalTextureSourceManager : public Singleton<ExternalTextureSourceManager>, public ResourceAlloc
57  {
58  public:
63 
65  void setCurrentPlugIn( const String& sTexturePlugInType );
66 
68  ExternalTextureSource* getCurrentPlugIn( void ) const { return mCurrExternalTextureSource; }
69 
72  void destroyAdvancedTexture( const String& sTextureName,
74 
77  ExternalTextureSource* getExternalTextureSource( const String& sTexturePlugInType );
78 
80  void setExternalTextureSource( const String& sTexturePlugInType, ExternalTextureSource* pTextureSystem );
81 
114  protected:
117 
118  // Collection of loaded texture System PlugIns, keyed by registered type
121  };
124 }
125 
126 #include "OgreHeaderSuffix.h"
127 
128 #endif
OgreHeaderSuffix.h
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::map
Definition: OgrePrerequisites.h:534
OgreSingleton.h
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
OgreResourceGroupManager.h
Ogre::ExternalTextureSource
IMPORTANT: Plugins must override default dictionary name! Base class that texture plugins derive from...
Definition: OgreExternalTextureSource.h:75
OgreHeaderPrefix.h
Ogre::ExternalTextureSourceManager::mTextureSystems
TextureSystemList mTextureSystems
Definition: OgreExternalTextureSourceManager.h:120
Ogre::ExternalTextureSourceManager::setExternalTextureSource
void setExternalTextureSource(const String &sTexturePlugInType, ExternalTextureSource *pTextureSystem)
Called from plugin to register itself.
Ogre::Singleton
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:65
Ogre::ExternalTextureSourceManager::getSingleton
static ExternalTextureSourceManager & getSingleton(void)
Override standard Singleton retrieval.
Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME
static String DEFAULT_RESOURCE_GROUP_NAME
Default resource group name.
Definition: OgreResourceGroupManager.h:266
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
OgreExternalTextureSource.h
Ogre::ExternalTextureSourceManager::getSingletonPtr
static ExternalTextureSourceManager * getSingletonPtr(void)
Override standard Singleton retrieval.
Ogre::ExternalTextureSourceManager::~ExternalTextureSourceManager
~ExternalTextureSourceManager()
Destructor.
Ogre::ExternalTextureSourceManager::mCurrExternalTextureSource
ExternalTextureSource * mCurrExternalTextureSource
The current texture controller selected.
Definition: OgreExternalTextureSourceManager.h:116
Ogre::ExternalTextureSourceManager::ExternalTextureSourceManager
ExternalTextureSourceManager()
Constructor.
Ogre::ExternalTextureSourceManager::destroyAdvancedTexture
void destroyAdvancedTexture(const String &sTextureName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
Calls the destroy method of all registered plugins...
Ogre::ExternalTextureSourceManager::TextureSystemList
map< String, ExternalTextureSource * >::type TextureSystemList
Definition: OgreExternalTextureSourceManager.h:119
Ogre::ExternalTextureSourceManager::getExternalTextureSource
ExternalTextureSource * getExternalTextureSource(const String &sTexturePlugInType)
Returns the plugin which registered itself with a specific name (eg.
Ogre::ExternalTextureSourceManager::getCurrentPlugIn
ExternalTextureSource * getCurrentPlugIn(void) const
Returns currently selected plugin, may be null if none selected.
Definition: OgreExternalTextureSourceManager.h:68
Ogre::ExternalTextureSourceManager::setCurrentPlugIn
void setCurrentPlugIn(const String &sTexturePlugInType)
Sets active plugin (ie.
OgreString.h
Ogre::ExternalTextureSourceManager
Singleton Class which handles the registering and control of texture plugins.
Definition: OgreExternalTextureSourceManager.h:57

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.