Ogre::ExternalTextureSource Class Referenceabstract
Core » Materials

IMPORTANT: Plugins must override default dictionary name! Base class that texture plugins derive from. More...

`#include <OgreExternalTextureSource.h>`

Inheritance diagram for Ogre::ExternalTextureSource:
[legend]

## 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 &paramList)
| 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...

## Detailed Description

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.

## Constructor & Destructor Documentation

## ExternalTextureSource()

Ogre::ExternalTextureSource::ExternalTextureSource | ( |  | ) |

Constructor.

## ~ExternalTextureSource()

virtual Ogre::ExternalTextureSource::~ExternalTextureSource | ( |  | ) |

virtual

Virtual destructor.

Definition at line 80 of file OgreExternalTextureSource.h.

## Member Function Documentation

## addBaseParams()

void Ogre::ExternalTextureSource::addBaseParams | ( |  | ) |

Call from derived classes to ensure the dictionary is setup.

## cleanupDictionary()

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.

## copyParametersTo()

virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const

virtual inherited

Method for copying this object's parameters to another object.

Remarks
  This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

  Any unrecognised parameters will be ignored as with setParameter method.

Parameters

  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().

## createDefinedTexture()

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.

## createParamDictionary()

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.

Remarks
  This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters

  className | the name of the class using the dictionary

Returns
  true if a new dictionary was created, false if it was already there

Definition at line 186 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

## destroyAdvancedTexture()

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)

## getDictionaryStringName()

const String& Ogre::ExternalTextureSource::getDictionaryStringName | ( | void |  | ) | const

Returns dictionary name.

Definition at line 140 of file OgreExternalTextureSource.h.

References Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME.

## getFPS()

int Ogre::ExternalTextureSource::getFPS | ( |  | ) | const

Gets currently set frames per second.

Definition at line 121 of file OgreExternalTextureSource.h.

## getInputName()

const String& Ogre::ExternalTextureSource::getInputName | ( |  | ) | const

Gets currently set input file name.

Definition at line 117 of file OgreExternalTextureSource.h.

## getParamDictionary() [1/2]

ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) |

inherited

Retrieves the parameter dictionary for this class.

Remarks
  Only valid to call this after createParamDictionary.

Returns
  Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 219 of file OgreStringInterface.h.

## getParamDictionary() [2/2]

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const

inherited

Definition at line 224 of file OgreStringInterface.h.

## getParameter()

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const

virtual inherited

Generic parameter retrieval method.

Remarks
  Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters

  name | The name of the parameter to get

Returns
  String value of parameter, blank if not found

Definition at line 272 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

## getParameters()

const ParameterList& Ogre::StringInterface::getParameters | ( | void |  | ) | const

inherited

Retrieves a list of parameters valid for this object.

Returns
  A reference to a static list of ParameterDef objects.

## getPlayMode()

eTexturePlayMode Ogre::ExternalTextureSource::getPlayMode | ( |  | ) | const

Gets currently set play mode.

Definition at line 125 of file OgreExternalTextureSource.h.

## getPluginStringName()

const String& Ogre::ExternalTextureSource::getPluginStringName | ( | void |  | ) | const

Returns the string name of this Plugin (as set by the Plugin)

Definition at line 138 of file OgreExternalTextureSource.h.

## getTextureTecPassStateLevel()

void Ogre::ExternalTextureSource::getTextureTecPassStateLevel | ( | int & | t,
|  | int & | p,
|  | int & | s
| ) |  | const

Get currently selected Texture attribs.

Definition at line 131 of file OgreExternalTextureSource.h.

## initialise()

virtual bool Ogre::ExternalTextureSource::initialise | ( |  | ) |

pure virtual

Call this function from manager to init system.

## setFPS()

void Ogre::ExternalTextureSource::setFPS | ( | int | iFPS | ) |

Sets the frames per second - plugin may or may not use this.

Definition at line 119 of file OgreExternalTextureSource.h.

## setInputName()

void Ogre::ExternalTextureSource::setInputName | ( | String | sIN | ) |

Sets an input file name - if needed by plugin.

Definition at line 115 of file OgreExternalTextureSource.h.

## setParameter()

virtual bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) |  |

virtual inherited

Generic parameter setting method.

Remarks
  Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

  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.

Returns
  true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

## setParameterList()

virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) |

virtual inherited

Generic multiple parameter setting method.

Remarks
  Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

  paramList | Name/value pair list

## setPlayMode()

void Ogre::ExternalTextureSource::setPlayMode | ( | eTexturePlayMode | eMode | ) |

Sets a play mode.

Definition at line 123 of file OgreExternalTextureSource.h.

## setTextureTecPassStateLevel()

void Ogre::ExternalTextureSource::setTextureTecPassStateLevel | ( | int | t,
|  | int | p,
|  | int | s
| ) |  |

Used for attaching texture to Technique, State, and texture unit layer.

Definition at line 128 of file OgreExternalTextureSource.h.

## shutDown()

virtual void Ogre::ExternalTextureSource::shutDown | ( |  | ) |

pure virtual

Shuts down Plugin.

## Member Data Documentation

## mDictionaryName

String Ogre::ExternalTextureSource::mDictionaryName

protected

The string name of the dictionary name - each plugin must override default name.

Definition at line 186 of file OgreExternalTextureSource.h.

## mFramesPerSecond

int Ogre::ExternalTextureSource::mFramesPerSecond

protected

Definition at line 177 of file OgreExternalTextureSource.h.

## mInputFileName

String Ogre::ExternalTextureSource::mInputFileName

protected

Definition at line 173 of file OgreExternalTextureSource.h.

## mMode

eTexturePlayMode Ogre::ExternalTextureSource::mMode

protected

Definition at line 171 of file OgreExternalTextureSource.h.

## mPassLevel

int Ogre::ExternalTextureSource::mPassLevel

protected

Definition at line 177 of file OgreExternalTextureSource.h.

## mPluginName

String Ogre::ExternalTextureSource::mPluginName

protected

Command for setting the technique, pass, & state level.

String Name of this Plugin

Definition at line 168 of file OgreExternalTextureSource.h.

## msCmdFramesPerSecond

CmdFPS Ogre::ExternalTextureSource::msCmdFramesPerSecond

static protected

Command for setting input file name.

Definition at line 162 of file OgreExternalTextureSource.h.

## msCmdInputFile

CmdInputFileName Ogre::ExternalTextureSource::msCmdInputFile

static protected

Definition at line 161 of file OgreExternalTextureSource.h.

## msCmdPlayMode

CmdPlayMode Ogre::ExternalTextureSource::msCmdPlayMode

static protected

Command for setting frames per second.

Definition at line 163 of file OgreExternalTextureSource.h.

## msCmdTecPassState

CmdTecPassState Ogre::ExternalTextureSource::msCmdTecPassState

static protected

Command for setting play mode.

Definition at line 164 of file OgreExternalTextureSource.h.

## mStateLevel

int Ogre::ExternalTextureSource::mStateLevel

protected

Definition at line 177 of file OgreExternalTextureSource.h.

## mTechniqueLevel

int Ogre::ExternalTextureSource::mTechniqueLevel

protected

Definition at line 177 of file OgreExternalTextureSource.h.

## mUpdateEveryFrame

bool Ogre::ExternalTextureSource::mUpdateEveryFrame

protected

Definition at line 175 of file OgreExternalTextureSource.h.

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

- OgreExternalTextureSource.h

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