#include <OgreExternalTextureSource.h>
Public Member Functions | |
ExternalTextureSource () | |
Constructor. | |
virtual | ~ExternalTextureSource () |
Virtual destructor. | |
void | setInputName (String sIN) |
Sets an input file name - if needed by plugin. | |
const String & | getInputName () const |
Gets currently set input file name. | |
void | setFPS (int iFPS) |
Sets the frames per second - plugin may or may not use this. | |
const int | getFPS () const |
Gets currently set frames per second. | |
void | setPlayMode (eTexturePlayMode eMode) |
Sets a play mode. | |
eTexturePlayMode | getPlayMode () const |
Gets currently set play mode. | |
void | setTextureTecPassStateLevel (int t, int p, int s) |
Used for attaching texture to Technique, State, and texture unit layer. | |
void | getTextureTecPassStateLevel (int &t, int &p, int &s) const |
Get currently selected Textute attribs. | |
void | addBaseParams () |
Call from derived classes to ensure the dictionary is setup. | |
const String & | getPlugInStringName (void) const |
Returns the string name of this PlugIn (as set by the PlugIn). | |
const String & | getDictionaryStringName (void) const |
Returns dictionary name. | |
virtual bool | initialise ()=0 |
Call this function from manager to init system. | |
virtual void | shutDown ()=0 |
Shuts down PlugIn. | |
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. | |
virtual void | destroyAdvancedTexture (const String &sTextureName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)=0 |
What this destroys is dependent on the plugin. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
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. | |
Protected Member Functions | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
String | mPlugInName |
Command for setting the technique, pass, & state level. | |
eTexturePlayMode | mMode |
String | mInputFileName |
bool | mUpdateEveryFrame |
int | mFramesPerSecond |
int | mTechniqueLevel |
int | mPassLevel |
int | mStateLevel |
String | mDictionaryName |
The string name of the dictionary name - each plugin must override default name. | |
Static Protected Attributes | |
static CmdInputFileName | msCmdInputFile |
static CmdFPS | msCmdFramesPerSecond |
Command for setting input file name. | |
static CmdPlayMode | msCmdPlayMode |
Command for setting frames per second. | |
static CmdTecPassState | msCmdTecPassState |
Command for setting play mode. | |
Classes | |
class | CmdFPS |
class | CmdInputFileName |
class | CmdPlayMode |
class | CmdTecPassState |
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 68 of file OgreExternalTextureSource.h.
Ogre::ExternalTextureSource::ExternalTextureSource | ( | ) |
Constructor.
virtual Ogre::ExternalTextureSource::~ExternalTextureSource | ( | ) | [virtual] |
void Ogre::ExternalTextureSource::setInputName | ( | String | sIN | ) |
Sets an input file name - if needed by plugin.
Definition at line 109 of file OgreExternalTextureSource.h.
const String& Ogre::ExternalTextureSource::getInputName | ( | ) | const |
void Ogre::ExternalTextureSource::setFPS | ( | int | iFPS | ) |
Sets the frames per second - plugin may or may not use this.
Definition at line 113 of file OgreExternalTextureSource.h.
const int Ogre::ExternalTextureSource::getFPS | ( | ) | const |
void Ogre::ExternalTextureSource::setPlayMode | ( | eTexturePlayMode | eMode | ) |
eTexturePlayMode Ogre::ExternalTextureSource::getPlayMode | ( | ) | const |
void Ogre::ExternalTextureSource::setTextureTecPassStateLevel | ( | int | t, | |
int | p, | |||
int | s | |||
) |
Used for attaching texture to Technique, State, and texture unit layer.
Definition at line 122 of file OgreExternalTextureSource.h.
void Ogre::ExternalTextureSource::getTextureTecPassStateLevel | ( | int & | t, | |
int & | p, | |||
int & | s | |||
) | const |
void Ogre::ExternalTextureSource::addBaseParams | ( | ) |
Call from derived classes to ensure the dictionary is setup.
const String& Ogre::ExternalTextureSource::getPlugInStringName | ( | void | ) | const |
Returns the string name of this PlugIn (as set by the PlugIn).
Definition at line 132 of file OgreExternalTextureSource.h.
const String& Ogre::ExternalTextureSource::getDictionaryStringName | ( | void | ) | const |
virtual bool Ogre::ExternalTextureSource::initialise | ( | ) | [pure virtual] |
Call this function from manager to init system.
virtual void Ogre::ExternalTextureSource::shutDown | ( | ) | [pure virtual] |
Shuts down PlugIn.
virtual void Ogre::ExternalTextureSource::createDefinedTexture | ( | const String & | sMaterialName, | |
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME | |||
) | [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.
virtual void Ogre::ExternalTextureSource::destroyAdvancedTexture | ( | const String & | sTextureName, | |
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME | |||
) | [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)
bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected, inherited] |
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 179 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 212 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 217 of file OgreStringInterface.h.
const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
const String & | value | |||
) | [virtual, inherited] |
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().
virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
paramList | Name/value pair list |
virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 265 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
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 296 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
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.
CmdInputFileName Ogre::ExternalTextureSource::msCmdInputFile [static, protected] |
Definition at line 155 of file OgreExternalTextureSource.h.
CmdFPS Ogre::ExternalTextureSource::msCmdFramesPerSecond [static, protected] |
CmdPlayMode Ogre::ExternalTextureSource::msCmdPlayMode [static, protected] |
CmdTecPassState Ogre::ExternalTextureSource::msCmdTecPassState [static, protected] |
String Ogre::ExternalTextureSource::mPlugInName [protected] |
Command for setting the technique, pass, & state level.
String Name of this PlugIn
Definition at line 162 of file OgreExternalTextureSource.h.
eTexturePlayMode Ogre::ExternalTextureSource::mMode [protected] |
Definition at line 165 of file OgreExternalTextureSource.h.
String Ogre::ExternalTextureSource::mInputFileName [protected] |
Definition at line 167 of file OgreExternalTextureSource.h.
bool Ogre::ExternalTextureSource::mUpdateEveryFrame [protected] |
Definition at line 169 of file OgreExternalTextureSource.h.
int Ogre::ExternalTextureSource::mFramesPerSecond [protected] |
Definition at line 171 of file OgreExternalTextureSource.h.
int Ogre::ExternalTextureSource::mTechniqueLevel [protected] |
Definition at line 171 of file OgreExternalTextureSource.h.
int Ogre::ExternalTextureSource::mPassLevel [protected] |
Definition at line 171 of file OgreExternalTextureSource.h.
int Ogre::ExternalTextureSource::mStateLevel [protected] |
Definition at line 171 of file OgreExternalTextureSource.h.
String Ogre::ExternalTextureSource::mDictionaryName [protected] |
The string name of the dictionary name - each plugin must override default name.
Definition at line 180 of file OgreExternalTextureSource.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:03:19 2009