#include <OgreExternalTextureSource.h>
Inheritance diagram for Ogre::ExternalTextureSource:
Public Methods | |
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 () |
Returns the string name of this PlugIn (as set by the PlugIn). | |
const String & | getDictionaryStringName () |
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 (String sMaterialName)=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 class setParameter( .. | |
virtual void | DestroyAdvancedTexture (String sTextureName)=0 |
Destroys the texture, material, and mem associated with this texture. | |
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 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. | |
Protected Methods | |
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 tecnique, pass, & state level String Name of this PlugIn. | |
eTexturePlayMode | mMode |
String | mInputFileName |
bool | mUpdateEveryFrame |
int | mFramesPerSecond |
int | mTechniqueLevel |
int | mPassLevel |
int | mStateLevel |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
Static Protected Attributes | |
CmdInputFileName | msCmdInputFile |
CmdFPS | msCmdFramesPerSecond |
Command for setting input file name. | |
CmdPlayMode | msCmdPlayMode |
Command for setting frames per second. | |
CmdTecPassState | msCmdTecPassState |
Command for setting play mode. | |
ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
Private Attributes | |
String | mDictionaryName |
The string name of the dictionary name. |
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 60 of file OgreExternalTextureSource.h.
|
Constructor.
Definition at line 50 of file OgreExternalTextureSource.cpp. References mDictionaryName, mFramesPerSecond, mInputFileName, mMode, mUpdateEveryFrame, and Ogre::TextureEffectPause. |
|
Virtual destructor.
Definition at line 66 of file OgreExternalTextureSource.h. |
|
Call from derived classes to ensure the dictionary is setup.
Definition at line 61 of file OgreExternalTextureSource.cpp. References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::createParamDictionary(), Ogre::StringInterface::getParamDictionary(), mDictionaryName, Ogre::PT_INT, and Ogre::PT_STRING. |
|
Method for copying this object's parameters to another object.
Definition at line 293 of file OgreStringInterface.h. References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter(). Referenced by Ogre::GuiElement::clone(), Ogre::GuiElement::copyFromTemplate(), Ogre::GuiContainer::copyFromTemplate(), and Ogre::ParticleSystem::operator=(). |
|
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 class setParameter( .. ) |
|
|
Destroys the texture, material, and mem associated with this texture.
|
|
Returns dictionary name.
Definition at line 126 of file OgreExternalTextureSource.h. |
|
Gets currently set frames per second.
Definition at line 107 of file OgreExternalTextureSource.h. Referenced by Ogre::ExternalTextureSource::CmdFPS::doGet(). |
|
Gets currently set input file name.
Definition at line 103 of file OgreExternalTextureSource.h. |
|
Definition at line 206 of file OgreStringInterface.h. |
|
Retrieves the parameter dictionary for this class.
Definition at line 193 of file OgreStringInterface.h. Referenced by Ogre::TTYGuiElement::addBaseParameters(), Ogre::TextBoxGuiElement::addBaseParameters(), Ogre::TextAreaGuiElement::addBaseParameters(), Ogre::ScrollBarGuiElement::addBaseParameters(), Ogre::PopupMenuGuiElement::addBaseParameters(), Ogre::ParticleEmitter::addBaseParameters(), Ogre::PanelGuiElement::addBaseParameters(), Ogre::ListGuiElement::addBaseParameters(), Ogre::GuiElement::addBaseParameters(), Ogre::CursorGuiElement::addBaseParameters(), Ogre::ButtonGuiElement::addBaseParameters(), Ogre::BorderPanelGuiElement::addBaseParameters(), Ogre::BorderButtonGuiElement::addBaseParameters(), addBaseParams(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::RingEmitter::RingEmitter(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), and Ogre::StringInterface::setParameter(). |
|
Generic parameter retrieval method.
Definition at line 262 of file OgreStringInterface.h. References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand(). |
|
Retrieves a list of parameters valid for this object.
Definition at line 224 of file OgreStringInterface.h. References Ogre::ParamDictionary::getParameters(), and Ogre::ParameterList. |
|
Gets currently set play mode.
Definition at line 111 of file OgreExternalTextureSource.h. References Ogre::eTexturePlayMode. |
|
Returns the string name of this PlugIn (as set by the PlugIn).
Definition at line 124 of file OgreExternalTextureSource.h. Referenced by Ogre::ExternalTextureSourceManager::setExternalTextureSource(). |
|
Get currently selected Textute attribs.
Definition at line 117 of file OgreExternalTextureSource.h. |
|
Call this function from manager to init system.
Referenced by Ogre::ExternalTextureSourceManager::SetCurrentPlugIn(). |
|
Sets the frames per second - plugin may or may not use this.
Definition at line 105 of file OgreExternalTextureSource.h. |
|
Sets an input file name - if needed by plugin.
Definition at line 101 of file OgreExternalTextureSource.h. |
|
Generic parameter setting method.
Definition at line 33 of file OgreStringInterface.cpp. References Ogre::ParamCommand::doSet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::StringInterface::getParamDictionary(). Referenced by Ogre::StringInterface::copyParametersTo(), Ogre::Profiler::createContainer(), Ogre::Profiler::createTextArea(), Ogre::MaterialSerializer::finishProgramDefinition(), Ogre::ParticleSystemManager::parseAffectorAttrib(), Ogre::ParticleSystemManager::parseAttrib(), Ogre::OverlayManager::parseElementAttrib(), and Ogre::ParticleSystemManager::parseEmitterAttrib(). |
|
Sets a play mode.
Definition at line 109 of file OgreExternalTextureSource.h. References Ogre::eTexturePlayMode. |
|
Used for attaching texture to Technique, State, and texture unit layer.
Definition at line 114 of file OgreExternalTextureSource.h. |
|
Shuts down PlugIn.
|
|
The string name of the dictionary name.
Definition at line 167 of file OgreExternalTextureSource.h. Referenced by addBaseParams(), and ExternalTextureSource(). |
|
Definition at line 159 of file OgreExternalTextureSource.h. Referenced by ExternalTextureSource(). |
|
Definition at line 155 of file OgreExternalTextureSource.h. Referenced by ExternalTextureSource(). |
|
Definition at line 153 of file OgreExternalTextureSource.h. Referenced by ExternalTextureSource(). |
|
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 157 of file OgreStringInterface.h. |
|
Definition at line 159 of file OgreExternalTextureSource.h. |
|
Command for setting the tecnique, pass, & state level String Name of this PlugIn.
Definition at line 150 of file OgreExternalTextureSource.h. |
|
Command for setting input file name.
Definition at line 44 of file OgreExternalTextureSource.cpp. |
|
Definition at line 43 of file OgreExternalTextureSource.cpp. |
|
Command for setting frames per second.
Definition at line 45 of file OgreExternalTextureSource.cpp. |
|
Command for setting play mode.
Definition at line 46 of file OgreExternalTextureSource.cpp. |
|
Dictionary of parameters.
Definition at line 30 of file OgreStringInterface.cpp. |
|
Definition at line 159 of file OgreExternalTextureSource.h. |
|
Definition at line 159 of file OgreExternalTextureSource.h. |
|
Definition at line 157 of file OgreExternalTextureSource.h. Referenced by ExternalTextureSource(). |
Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:26:07 2004