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 _OgreExternalTextureSource_H 29 #define _OgreExternalTextureSource_H 30 31 /*************************************************************************** 32 OgreExternalTextureSource.h - 33 Base class that texture plugins need to derive from. This provides the hooks 34 necessary for a plugin developer to easily extend the functionality of dynamic textures. 35 It makes creation/destruction of dynamic textures more streamlined. While the plugin 36 will need to talk with Ogre for the actual modification of textures, this class allows 37 easy integration with Ogre apps. Material script files can be used to aid in the 38 creation of dynamic textures. Functionality can be added that is not defined here 39 through the use of the base dictionary. For an example of how to use this class and the 40 string interface see ffmpegVideoPlugIn. 41 42 ------------------- 43 date : Jan 1 2004 44 email : pjcast@yahoo.com 45 ***************************************************************************/ 46 47 #include "OgreStringInterface.h" 48 #include "OgreResourceGroupManager.h" 49 #include "OgreHeaderPrefix.h" 50 51 namespace Ogre 52 { 53 /** \addtogroup Core 54 * @{ 55 */ 56 /** \addtogroup Materials 57 * @{ 58 */ 59 /** Enum for type of texture play mode */ 60 enum eTexturePlayMode 61 { 62 TextureEffectPause = 0, /// Video starts out paused 63 TextureEffectPlay_ASAP = 1, /// Video starts playing as soon as possible 64 TextureEffectPlay_Looping = 2 /// Video Plays Instantly && Loops 65 }; 66 67 /** IMPORTANT: **Plugins must override default dictionary name!** 68 Base class that texture plugins derive from. Any specific 69 requirements that the plugin needs to have defined before 70 texture/material creation must be define using the stringinterface 71 before calling create defined texture... or it will fail, though, it 72 is up to the plugin to report errors to the log file, or raise an 73 exception if need be. */ 74 class _OgreExport ExternalTextureSource : public StringInterface 75 { 76 public: 77 /** Constructor */ 78 ExternalTextureSource(); 79 /** Virtual destructor */ ~ExternalTextureSource()80 virtual ~ExternalTextureSource() {} 81 82 //------------------------------------------------------------------------------// 83 /* Command objects for specifying some base features */ 84 /* Any Plugins wishing to add more specific params to "ExternalTextureSourcePlugins"*/ 85 /* dictionary, feel free to do so, that's why this is here */ 86 class _OgrePrivate CmdInputFileName : public ParamCommand 87 { 88 public: 89 String doGet(const void* target) const; 90 void doSet(void* target, const String& val); 91 }; 92 class _OgrePrivate CmdFPS : public ParamCommand 93 { 94 public: 95 String doGet(const void* target) const; 96 void doSet(void* target, const String& val); 97 }; 98 class _OgrePrivate CmdPlayMode : public ParamCommand 99 { 100 public: 101 String doGet(const void* target) const; 102 void doSet(void* target, const String& val); 103 }; 104 class _OgrePrivate CmdTecPassState : public ParamCommand 105 { 106 public: 107 String doGet(const void* target) const; 108 void doSet(void* target, const String& val); 109 }; 110 //--------------------------------------------------------// 111 //Base Functions that work with Command String Interface... Or can be called 112 //manually to create video through code 113 114 /// Sets an input file name - if needed by plugin setInputName(String sIN)115 void setInputName( String sIN ) { mInputFileName = sIN; } 116 /// Gets currently set input file name getInputName()117 const String& getInputName( ) const { return mInputFileName; } 118 /// Sets the frames per second - plugin may or may not use this setFPS(int iFPS)119 void setFPS( int iFPS ) { mFramesPerSecond = iFPS; } 120 /// Gets currently set frames per second getFPS()121 int getFPS( ) const { return mFramesPerSecond; } 122 /// Sets a play mode setPlayMode(eTexturePlayMode eMode)123 void setPlayMode( eTexturePlayMode eMode ) { mMode = eMode; } 124 /// Gets currently set play mode getPlayMode()125 eTexturePlayMode getPlayMode() const { return mMode; } 126 127 /// Used for attaching texture to Technique, State, and texture unit layer setTextureTecPassStateLevel(int t,int p,int s)128 void setTextureTecPassStateLevel( int t, int p, int s ) 129 { mTechniqueLevel = t;mPassLevel = p;mStateLevel = s; } 130 /// Get currently selected Texture attribs. getTextureTecPassStateLevel(int & t,int & p,int & s)131 void getTextureTecPassStateLevel( int& t, int& p, int& s ) const 132 {t = mTechniqueLevel; p = mPassLevel; s = mStateLevel;} 133 134 /** Call from derived classes to ensure the dictionary is setup */ 135 void addBaseParams(); 136 137 /** Returns the string name of this Plugin (as set by the Plugin)*/ getPluginStringName(void)138 const String& getPluginStringName( void ) const { return mPluginName; } 139 /** Returns dictionary name */ getDictionaryStringName(void)140 const String& getDictionaryStringName( void ) const { return mDictionaryName; } 141 142 //Pure virtual functions that plugins must Override 143 /** Call this function from manager to init system */ 144 virtual bool initialise() = 0; 145 /** Shuts down Plugin */ 146 virtual void shutDown() = 0; 147 148 /** Creates a texture into an already defined material or one that is created new 149 (it's up to plugin to use a material or create one) 150 Before calling, ensure that needed params have been defined via the stringInterface 151 or regular methods */ 152 virtual void createDefinedTexture( const String& sMaterialName, 153 const String& groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) = 0; 154 /** What this destroys is dependent on the plugin... See specific plugin 155 doc to know what is all destroyed (normally, plugins will destroy only 156 what they created, or used directly - ie. just texture unit) */ 157 virtual void destroyAdvancedTexture( const String& sTextureName, 158 const String& groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) = 0; 159 160 protected: 161 static CmdInputFileName msCmdInputFile; /// Command for setting input file name 162 static CmdFPS msCmdFramesPerSecond; /// Command for setting frames per second 163 static CmdPlayMode msCmdPlayMode; /// Command for setting play mode 164 static CmdTecPassState msCmdTecPassState; /// Command for setting the technique, pass, & state level 165 166 167 /// String Name of this Plugin 168 String mPluginName; 169 170 //------ Vars used for setting/getting dictionary stuff -----------// 171 eTexturePlayMode mMode; 172 173 String mInputFileName; 174 175 bool mUpdateEveryFrame; 176 177 int mFramesPerSecond, 178 mTechniqueLevel, 179 mPassLevel, 180 mStateLevel; 181 //------------------------------------------------------------------// 182 183 protected: 184 /** The string name of the dictionary name - each plugin 185 must override default name */ 186 String mDictionaryName; 187 }; 188 /** @} */ 189 /** @} */ 190 } 191 192 #include "OgreHeaderSuffix.h" 193 194 #endif 195