IMPORTANT: Plugins must override default dictionary name! Base class that texture plugins derive from. More...
#include <OgreExternalTextureSource.h>
Classes | |
class | CmdFPS |
class | CmdInputFileName |
class | CmdPlayMode |
class | CmdTecPassState |
Public Member Functions | |
ExternalTextureSource () | |
Constructor. More... | |
virtual | ~ExternalTextureSource () |
Virtual destructor. More... | |
void | addBaseParams () |
Call from derived classes to ensure the dictionary is setup. More... | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
virtual void | createDefinedTexture (const String &sMaterialName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)=0 |
Creates a texture into an already defined material or one that is created new (it's up to plugin to use a material or create one) Before calling, ensure that needed params have been defined via the stringInterface or regular methods. More... | |
virtual void | destroyAdvancedTexture (const String &sTextureName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)=0 |
What this destroys is dependent on the plugin... More... | |
const String & | getDictionaryStringName (void) const |
Returns dictionary name. More... | |
int | getFPS () const |
Gets currently set frames per second. More... | |
const String & | getInputName () const |
Gets currently set input file name. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
eTexturePlayMode | getPlayMode () const |
Gets currently set play mode. More... | |
const String & | getPluginStringName (void) const |
Returns the string name of this Plugin (as set by the Plugin) More... | |
void | getTextureTecPassStateLevel (int &t, int &p, int &s) const |
Get currently selected Texture attribs. More... | |
virtual bool | initialise ()=0 |
Call this function from manager to init system. More... | |
void | setFPS (int iFPS) |
Sets the frames per second - plugin may or may not use this. More... | |
void | setInputName (String sIN) |
Sets an input file name - if needed by plugin. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
void | setPlayMode (eTexturePlayMode eMode) |
Sets a play mode. More... | |
void | setTextureTecPassStateLevel (int t, int p, int s) |
Used for attaching texture to Technique, State, and texture unit layer. More... | |
virtual void | shutDown ()=0 |
Shuts down Plugin. More... | |
Static Public Member Functions | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More... | |
Protected Member Functions | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. More... | |
Protected Attributes | |
String | mDictionaryName |
The string name of the dictionary name - each plugin must override default name. More... | |
int | mFramesPerSecond |
String | mInputFileName |
eTexturePlayMode | mMode |
int | mPassLevel |
String | mPluginName |
Command for setting the technique, pass, & state level. More... | |
int | mStateLevel |
int | mTechniqueLevel |
bool | mUpdateEveryFrame |
Static Protected Attributes | |
static CmdFPS | msCmdFramesPerSecond |
Command for setting input file name. More... | |
static CmdInputFileName | msCmdInputFile |
static CmdPlayMode | msCmdPlayMode |
Command for setting frames per second. More... | |
static CmdTecPassState | msCmdTecPassState |
Command for setting play mode. More... | |
IMPORTANT: Plugins must override default dictionary name! Base class that texture plugins derive from.
Any specific requirements that the plugin needs to have defined before texture/material creation must be define using the stringinterface before calling create defined texture... or it will fail, though, it is up to the plugin to report errors to the log file, or raise an exception if need be.
Definition at line 74 of file OgreExternalTextureSource.h.
Ogre::ExternalTextureSource::ExternalTextureSource | ( | ) |
Constructor.
|
inlinevirtual |
Virtual destructor.
Definition at line 80 of file OgreExternalTextureSource.h.
void Ogre::ExternalTextureSource::addBaseParams | ( | ) |
Call from derived classes to ensure the dictionary is setup.
|
staticinherited |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
|
inlinevirtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 303 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
|
pure virtual |
Creates a texture into an already defined material or one that is created new (it's up to plugin to use a material or create one) Before calling, ensure that needed params have been defined via the stringInterface or regular methods.
|
inlineprotectedinherited |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
|
pure virtual |
What this destroys is dependent on the plugin...
See specific plugin doc to know what is all destroyed (normally, plugins will destroy only what they created, or used directly - ie. just texture unit)
|
inline |
Returns dictionary name.
Definition at line 140 of file OgreExternalTextureSource.h.
|
inline |
Gets currently set frames per second.
Definition at line 121 of file OgreExternalTextureSource.h.
|
inline |
Gets currently set input file name.
Definition at line 117 of file OgreExternalTextureSource.h.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 224 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
|
inline |
Gets currently set play mode.
Definition at line 125 of file OgreExternalTextureSource.h.
|
inline |
Returns the string name of this Plugin (as set by the Plugin)
Definition at line 138 of file OgreExternalTextureSource.h.
|
inline |
Get currently selected Texture attribs.
Definition at line 131 of file OgreExternalTextureSource.h.
|
pure virtual |
Call this function from manager to init system.
|
inline |
Sets the frames per second - plugin may or may not use this.
Definition at line 119 of file OgreExternalTextureSource.h.
|
inline |
Sets an input file name - if needed by plugin.
Definition at line 115 of file OgreExternalTextureSource.h.
|
virtualinherited |
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
|
inline |
Sets a play mode.
Definition at line 123 of file OgreExternalTextureSource.h.
|
inline |
Used for attaching texture to Technique, State, and texture unit layer.
Definition at line 128 of file OgreExternalTextureSource.h.
|
pure virtual |
Shuts down Plugin.
|
protected |
The string name of the dictionary name - each plugin must override default name.
Definition at line 186 of file OgreExternalTextureSource.h.
|
protected |
Definition at line 177 of file OgreExternalTextureSource.h.
|
protected |
Definition at line 173 of file OgreExternalTextureSource.h.
|
protected |
Definition at line 171 of file OgreExternalTextureSource.h.
|
protected |
Definition at line 177 of file OgreExternalTextureSource.h.
|
protected |
Command for setting the technique, pass, & state level.
String Name of this Plugin
Definition at line 168 of file OgreExternalTextureSource.h.
|
staticprotected |
Command for setting input file name.
Definition at line 162 of file OgreExternalTextureSource.h.
|
staticprotected |
Definition at line 161 of file OgreExternalTextureSource.h.
|
staticprotected |
Command for setting frames per second.
Definition at line 163 of file OgreExternalTextureSource.h.
|
staticprotected |
Command for setting play mode.
Definition at line 164 of file OgreExternalTextureSource.h.
|
protected |
Definition at line 177 of file OgreExternalTextureSource.h.
|
protected |
Definition at line 177 of file OgreExternalTextureSource.h.
|
protected |
Definition at line 175 of file OgreExternalTextureSource.h.