\hypertarget{class_ogre_1_1_external_texture_source}{}\section{Ogre\+:\+:External\+Texture\+Source Class Reference}
\label{class_ogre_1_1_external_texture_source}\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}


I\+M\+P\+O\+R\+T\+A\+NT\+: {\bfseries Plugins must override default dictionary name!} Base class that texture plugins derive from.  




{\ttfamily \#include $<$Ogre\+External\+Texture\+Source.\+h$>$}



Inheritance diagram for Ogre\+:\+:External\+Texture\+Source\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=235pt]{class_ogre_1_1_external_texture_source__inherit__graph}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \hyperlink{class_ogre_1_1_external_texture_source_1_1_cmd_f_p_s}{Cmd\+F\+PS}
\item 
class \hyperlink{class_ogre_1_1_external_texture_source_1_1_cmd_input_file_name}{Cmd\+Input\+File\+Name}
\item 
class \hyperlink{class_ogre_1_1_external_texture_source_1_1_cmd_play_mode}{Cmd\+Play\+Mode}
\item 
class \hyperlink{class_ogre_1_1_external_texture_source_1_1_cmd_tec_pass_state}{Cmd\+Tec\+Pass\+State}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_external_texture_source_a0e34ec6e53b5700a266933002bc79304}{External\+Texture\+Source} ()
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_external_texture_source_aa919b910a2fbfb4fb250265545730468}{$\sim$\+External\+Texture\+Source} ()
\begin{DoxyCompactList}\small\item\em Virtual destructor. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_external_texture_source_a55ce04b61a516a3e0d4286230f41bb84}{add\+Base\+Params} ()
\begin{DoxyCompactList}\small\item\em Call from derived classes to ensure the dictionary is setup. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}{copy\+Parameters\+To} (\hyperlink{class_ogre_1_1_string_interface}{String\+Interface} $\ast$dest) const
\begin{DoxyCompactList}\small\item\em Method for copying this object\textquotesingle{}s parameters to another object. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_external_texture_source_a72f123ce494815d9871a7ab94bba5d17}{create\+Defined\+Texture} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&s\+Material\+Name, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&group\+Name=\hyperlink{class_ogre_1_1_resource_group_manager_a3c7d7dc6bb59e43db49e77cd3d8a44c4}{Resource\+Group\+Manager\+::\+D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+U\+P\+\_\+\+N\+A\+ME})=0
\begin{DoxyCompactList}\small\item\em Creates a texture into an already defined material or one that is created new (it\textquotesingle{}s up to plugin to use a material or create one) Before calling, ensure that needed params have been defined via the string\+Interface or regular methods. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_external_texture_source_a0b6b1db913cfa51bbbcc5ba11263c8fa}{destroy\+Advanced\+Texture} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&s\+Texture\+Name, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&group\+Name=\hyperlink{class_ogre_1_1_resource_group_manager_a3c7d7dc6bb59e43db49e77cd3d8a44c4}{Resource\+Group\+Manager\+::\+D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+U\+P\+\_\+\+N\+A\+ME})=0
\begin{DoxyCompactList}\small\item\em What this destroys is dependent on the plugin... \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_external_texture_source_a6f6034d93836fc00c6339c88a8a5371b}{get\+Dictionary\+String\+Name} (void) const
\begin{DoxyCompactList}\small\item\em Returns dictionary name. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_external_texture_source_a085dc6585df6442685fa013f43b13ddf}{get\+F\+PS} () const
\begin{DoxyCompactList}\small\item\em Gets currently set frames per second. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_external_texture_source_a2a2bd7be90d6273e1de7b2f607506916}{get\+Input\+Name} () const
\begin{DoxyCompactList}\small\item\em Gets currently set input file name. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} $\ast$ \hyperlink{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}{get\+Param\+Dictionary} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the parameter dictionary for this class. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} $\ast$ \hyperlink{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}{get\+Param\+Dictionary} (void) const
\item 
\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \hyperlink{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}{get\+Parameter} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name) const
\begin{DoxyCompactList}\small\item\em Generic parameter retrieval method. \end{DoxyCompactList}\item 
const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List} \& \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{get\+Parameters} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a list of parameters valid for this object. \end{DoxyCompactList}\item 
\hyperlink{group___materials_gaff53586ca60f891d5c6019a6ffb347a8}{e\+Texture\+Play\+Mode} \hyperlink{class_ogre_1_1_external_texture_source_a8b457801720e830b1c43319f04594371}{get\+Play\+Mode} () const
\begin{DoxyCompactList}\small\item\em Gets currently set play mode. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_external_texture_source_a772e6174e52f78249054e11c95165810}{get\+Plugin\+String\+Name} (void) const
\begin{DoxyCompactList}\small\item\em Returns the string name of this \hyperlink{class_ogre_1_1_plugin}{Plugin} (as set by the \hyperlink{class_ogre_1_1_plugin}{Plugin}) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_external_texture_source_a6e906c28c92fc75c2a2a1be9b5ed2969}{get\+Texture\+Tec\+Pass\+State\+Level} (int \&t, int \&p, int \&s) const
\begin{DoxyCompactList}\small\item\em Get currently selected \hyperlink{class_ogre_1_1_texture}{Texture} attribs. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_external_texture_source_a4a1824ba326c263664991a548fe0658e}{initialise} ()=0
\begin{DoxyCompactList}\small\item\em Call this function from manager to init system. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_external_texture_source_ae13e199734e244f9155e28a4d534cee3}{set\+F\+PS} (int i\+F\+PS)
\begin{DoxyCompactList}\small\item\em Sets the frames per second -\/ plugin may or may not use this. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_external_texture_source_a141a783e97bfce2a1a1d715257c8e9f2}{set\+Input\+Name} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&s\+IN)
\begin{DoxyCompactList}\small\item\em Sets an input file name -\/ if needed by plugin. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}{set\+Parameter} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&value)
\begin{DoxyCompactList}\small\item\em Generic parameter setting method. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}{set\+Parameter\+List} (const \hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List} \&param\+List)
\begin{DoxyCompactList}\small\item\em Generic multiple parameter setting method. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_external_texture_source_a6fdbcf165cc87a51d9a6436162e04080}{set\+Play\+Mode} (\hyperlink{group___materials_gaff53586ca60f891d5c6019a6ffb347a8}{e\+Texture\+Play\+Mode} e\+Mode)
\begin{DoxyCompactList}\small\item\em Sets a play mode. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_external_texture_source_aa19976a1f1c0399882c95e26ece310dc}{set\+Texture\+Tec\+Pass\+State\+Level} (int t, int p, int s)
\begin{DoxyCompactList}\small\item\em Used for attaching texture to \hyperlink{class_ogre_1_1_technique}{Technique}, State, and texture unit layer. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_external_texture_source_acc278d166ca69e6a171a2ff12bc74b9f}{shut\+Down} ()=0
\begin{DoxyCompactList}\small\item\em Shuts down \hyperlink{class_ogre_1_1_plugin}{Plugin}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static void \hyperlink{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}{cleanup\+Dictionary} ()
\begin{DoxyCompactList}\small\item\em Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \hyperlink{namespace_ogre}{Ogre}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} implementers (e.\+g. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
I\+M\+P\+O\+R\+T\+A\+NT\+: {\bfseries Plugins must override default dictionary name!} Base class that texture plugins derive from. 

\hyperlink{class_ogre_1_1_any}{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. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a0e34ec6e53b5700a266933002bc79304}\label{class_ogre_1_1_external_texture_source_a0e34ec6e53b5700a266933002bc79304}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!External\+Texture\+Source@{External\+Texture\+Source}}
\index{External\+Texture\+Source@{External\+Texture\+Source}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{External\+Texture\+Source()}{ExternalTextureSource()}}
{\footnotesize\ttfamily Ogre\+::\+External\+Texture\+Source\+::\+External\+Texture\+Source (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Constructor. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_aa919b910a2fbfb4fb250265545730468}\label{class_ogre_1_1_external_texture_source_aa919b910a2fbfb4fb250265545730468}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!````~External\+Texture\+Source@{$\sim$\+External\+Texture\+Source}}
\index{````~External\+Texture\+Source@{$\sim$\+External\+Texture\+Source}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{$\sim$\+External\+Texture\+Source()}{~ExternalTextureSource()}}
{\footnotesize\ttfamily virtual Ogre\+::\+External\+Texture\+Source\+::$\sim$\+External\+Texture\+Source (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Virtual destructor. 



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a141a783e97bfce2a1a1d715257c8e9f2}\label{class_ogre_1_1_external_texture_source_a141a783e97bfce2a1a1d715257c8e9f2}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!set\+Input\+Name@{set\+Input\+Name}}
\index{set\+Input\+Name@{set\+Input\+Name}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{set\+Input\+Name()}{setInputName()}}
{\footnotesize\ttfamily void Ogre\+::\+External\+Texture\+Source\+::set\+Input\+Name (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{s\+IN }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets an input file name -\/ if needed by plugin. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a2a2bd7be90d6273e1de7b2f607506916}\label{class_ogre_1_1_external_texture_source_a2a2bd7be90d6273e1de7b2f607506916}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Input\+Name@{get\+Input\+Name}}
\index{get\+Input\+Name@{get\+Input\+Name}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Input\+Name()}{getInputName()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+External\+Texture\+Source\+::get\+Input\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets currently set input file name. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_ae13e199734e244f9155e28a4d534cee3}\label{class_ogre_1_1_external_texture_source_ae13e199734e244f9155e28a4d534cee3}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!set\+F\+PS@{set\+F\+PS}}
\index{set\+F\+PS@{set\+F\+PS}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{set\+F\+P\+S()}{setFPS()}}
{\footnotesize\ttfamily void Ogre\+::\+External\+Texture\+Source\+::set\+F\+PS (\begin{DoxyParamCaption}\item[{int}]{i\+F\+PS }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



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

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a085dc6585df6442685fa013f43b13ddf}\label{class_ogre_1_1_external_texture_source_a085dc6585df6442685fa013f43b13ddf}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+F\+PS@{get\+F\+PS}}
\index{get\+F\+PS@{get\+F\+PS}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+F\+P\+S()}{getFPS()}}
{\footnotesize\ttfamily int Ogre\+::\+External\+Texture\+Source\+::get\+F\+PS (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets currently set frames per second. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a6fdbcf165cc87a51d9a6436162e04080}\label{class_ogre_1_1_external_texture_source_a6fdbcf165cc87a51d9a6436162e04080}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!set\+Play\+Mode@{set\+Play\+Mode}}
\index{set\+Play\+Mode@{set\+Play\+Mode}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{set\+Play\+Mode()}{setPlayMode()}}
{\footnotesize\ttfamily void Ogre\+::\+External\+Texture\+Source\+::set\+Play\+Mode (\begin{DoxyParamCaption}\item[{\hyperlink{group___materials_gaff53586ca60f891d5c6019a6ffb347a8}{e\+Texture\+Play\+Mode}}]{e\+Mode }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets a play mode. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a8b457801720e830b1c43319f04594371}\label{class_ogre_1_1_external_texture_source_a8b457801720e830b1c43319f04594371}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Play\+Mode@{get\+Play\+Mode}}
\index{get\+Play\+Mode@{get\+Play\+Mode}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Play\+Mode()}{getPlayMode()}}
{\footnotesize\ttfamily \hyperlink{group___materials_gaff53586ca60f891d5c6019a6ffb347a8}{e\+Texture\+Play\+Mode} Ogre\+::\+External\+Texture\+Source\+::get\+Play\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets currently set play mode. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_aa19976a1f1c0399882c95e26ece310dc}\label{class_ogre_1_1_external_texture_source_aa19976a1f1c0399882c95e26ece310dc}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!set\+Texture\+Tec\+Pass\+State\+Level@{set\+Texture\+Tec\+Pass\+State\+Level}}
\index{set\+Texture\+Tec\+Pass\+State\+Level@{set\+Texture\+Tec\+Pass\+State\+Level}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{set\+Texture\+Tec\+Pass\+State\+Level()}{setTextureTecPassStateLevel()}}
{\footnotesize\ttfamily void Ogre\+::\+External\+Texture\+Source\+::set\+Texture\+Tec\+Pass\+State\+Level (\begin{DoxyParamCaption}\item[{int}]{t,  }\item[{int}]{p,  }\item[{int}]{s }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Used for attaching texture to \hyperlink{class_ogre_1_1_technique}{Technique}, State, and texture unit layer. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a6e906c28c92fc75c2a2a1be9b5ed2969}\label{class_ogre_1_1_external_texture_source_a6e906c28c92fc75c2a2a1be9b5ed2969}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Texture\+Tec\+Pass\+State\+Level@{get\+Texture\+Tec\+Pass\+State\+Level}}
\index{get\+Texture\+Tec\+Pass\+State\+Level@{get\+Texture\+Tec\+Pass\+State\+Level}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Texture\+Tec\+Pass\+State\+Level()}{getTextureTecPassStateLevel()}}
{\footnotesize\ttfamily void Ogre\+::\+External\+Texture\+Source\+::get\+Texture\+Tec\+Pass\+State\+Level (\begin{DoxyParamCaption}\item[{int \&}]{t,  }\item[{int \&}]{p,  }\item[{int \&}]{s }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get currently selected \hyperlink{class_ogre_1_1_texture}{Texture} attribs. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a55ce04b61a516a3e0d4286230f41bb84}\label{class_ogre_1_1_external_texture_source_a55ce04b61a516a3e0d4286230f41bb84}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!add\+Base\+Params@{add\+Base\+Params}}
\index{add\+Base\+Params@{add\+Base\+Params}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{add\+Base\+Params()}{addBaseParams()}}
{\footnotesize\ttfamily void Ogre\+::\+External\+Texture\+Source\+::add\+Base\+Params (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Call from derived classes to ensure the dictionary is setup. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a772e6174e52f78249054e11c95165810}\label{class_ogre_1_1_external_texture_source_a772e6174e52f78249054e11c95165810}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Plugin\+String\+Name@{get\+Plugin\+String\+Name}}
\index{get\+Plugin\+String\+Name@{get\+Plugin\+String\+Name}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Plugin\+String\+Name()}{getPluginStringName()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+External\+Texture\+Source\+::get\+Plugin\+String\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the string name of this \hyperlink{class_ogre_1_1_plugin}{Plugin} (as set by the \hyperlink{class_ogre_1_1_plugin}{Plugin}) 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a6f6034d93836fc00c6339c88a8a5371b}\label{class_ogre_1_1_external_texture_source_a6f6034d93836fc00c6339c88a8a5371b}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Dictionary\+String\+Name@{get\+Dictionary\+String\+Name}}
\index{get\+Dictionary\+String\+Name@{get\+Dictionary\+String\+Name}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Dictionary\+String\+Name()}{getDictionaryStringName()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+External\+Texture\+Source\+::get\+Dictionary\+String\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns dictionary name. 



References Ogre\+::\+Resource\+Group\+Manager\+::\+D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+U\+P\+\_\+\+N\+A\+ME.

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a4a1824ba326c263664991a548fe0658e}\label{class_ogre_1_1_external_texture_source_a4a1824ba326c263664991a548fe0658e}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!initialise@{initialise}}
\index{initialise@{initialise}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{initialise()}{initialise()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+External\+Texture\+Source\+::initialise (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Call this function from manager to init system. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_acc278d166ca69e6a171a2ff12bc74b9f}\label{class_ogre_1_1_external_texture_source_acc278d166ca69e6a171a2ff12bc74b9f}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!shut\+Down@{shut\+Down}}
\index{shut\+Down@{shut\+Down}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{shut\+Down()}{shutDown()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+External\+Texture\+Source\+::shut\+Down (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Shuts down \hyperlink{class_ogre_1_1_plugin}{Plugin}. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a72f123ce494815d9871a7ab94bba5d17}\label{class_ogre_1_1_external_texture_source_a72f123ce494815d9871a7ab94bba5d17}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!create\+Defined\+Texture@{create\+Defined\+Texture}}
\index{create\+Defined\+Texture@{create\+Defined\+Texture}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{create\+Defined\+Texture()}{createDefinedTexture()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+External\+Texture\+Source\+::create\+Defined\+Texture (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{s\+Material\+Name,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{group\+Name = {\ttfamily \hyperlink{class_ogre_1_1_resource_group_manager_a3c7d7dc6bb59e43db49e77cd3d8a44c4}{Resource\+Group\+Manager\+::\+D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+U\+P\+\_\+\+N\+A\+ME}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Creates a texture into an already defined material or one that is created new (it\textquotesingle{}s up to plugin to use a material or create one) Before calling, ensure that needed params have been defined via the string\+Interface or regular methods. 

\mbox{\Hypertarget{class_ogre_1_1_external_texture_source_a0b6b1db913cfa51bbbcc5ba11263c8fa}\label{class_ogre_1_1_external_texture_source_a0b6b1db913cfa51bbbcc5ba11263c8fa}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!destroy\+Advanced\+Texture@{destroy\+Advanced\+Texture}}
\index{destroy\+Advanced\+Texture@{destroy\+Advanced\+Texture}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{destroy\+Advanced\+Texture()}{destroyAdvancedTexture()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+External\+Texture\+Source\+::destroy\+Advanced\+Texture (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{s\+Texture\+Name,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{group\+Name = {\ttfamily \hyperlink{class_ogre_1_1_resource_group_manager_a3c7d7dc6bb59e43db49e77cd3d8a44c4}{Resource\+Group\+Manager\+::\+D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+U\+P\+\_\+\+N\+A\+ME}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [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) \mbox{\Hypertarget{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}\label{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Param\+Dictionary@{get\+Param\+Dictionary}}
\index{get\+Param\+Dictionary@{get\+Param\+Dictionary}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Param\+Dictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Retrieves the parameter dictionary for this class. 

\begin{DoxyRemark}{Remarks}
Only valid to call this after create\+Param\+Dictionary. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
Pointer to \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} shared by all instances of this class which you can add parameters to, retrieve parameters etc. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}\label{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Param\+Dictionary@{get\+Param\+Dictionary}}
\index{get\+Param\+Dictionary@{get\+Param\+Dictionary}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Param\+Dictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}\label{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Parameters@{get\+Parameters}}
\index{get\+Parameters@{get\+Parameters}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Parameters()}{getParameters()}}
{\footnotesize\ttfamily const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}\& Ogre\+::\+String\+Interface\+::get\+Parameters (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Retrieves a list of parameters valid for this object. 

\begin{DoxyReturn}{Returns}
A reference to a static list of \hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def} objects. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}\label{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!set\+Parameter@{set\+Parameter}}
\index{set\+Parameter@{set\+Parameter}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{set\+Parameter()}{setParameter()}}
{\footnotesize\ttfamily bool Ogre\+::\+String\+Interface\+::set\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic parameter setting method. 

\begin{DoxyRemark}{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 \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to set \\
\hline
{\em value} & String value. Must be in the right format for the type specified in the parameter definition. See the \hyperlink{class_ogre_1_1_string_converter}{String\+Converter} class for more information. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if set was successful, false otherwise (NB no exceptions thrown -\/ tolerant method) 
\end{DoxyReturn}


Referenced by Ogre\+::\+String\+Interface\+::copy\+Parameters\+To().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}\label{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!set\+Parameter\+List@{set\+Parameter\+List}}
\index{set\+Parameter\+List@{set\+Parameter\+List}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{set\+Parameter\+List()}{setParameterList()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::set\+Parameter\+List (\begin{DoxyParamCaption}\item[{const \hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List} \&}]{param\+List }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic multiple parameter setting method. 

\begin{DoxyRemark}{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 \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em param\+List} & Name/value pair list \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}\label{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!get\+Parameter@{get\+Parameter}}
\index{get\+Parameter@{get\+Parameter}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{get\+Parameter()}{getParameter()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} Ogre\+::\+String\+Interface\+::get\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Generic parameter retrieval method. 

\begin{DoxyRemark}{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 get\+Parameters for the type of this parameter. If you like you can use \hyperlink{class_ogre_1_1_string_converter}{String\+Converter} to convert this string back into a native type. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to get \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
String value of parameter, blank if not found 
\end{DoxyReturn}


References Ogre\+::\+Param\+Command\+::do\+Get().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}\label{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!copy\+Parameters\+To@{copy\+Parameters\+To}}
\index{copy\+Parameters\+To@{copy\+Parameters\+To}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{copy\+Parameters\+To()}{copyParametersTo()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::copy\+Parameters\+To (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_string_interface}{String\+Interface} $\ast$}]{dest }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Method for copying this object\textquotesingle{}s parameters to another object. 

\begin{DoxyRemark}{Remarks}
This method takes the values of all the object\textquotesingle{}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. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
\hyperlink{class_ogre_1_1_any}{Any} unrecognised parameters will be ignored as with set\+Parameter method. 
\end{DoxyParagraph}

\begin{DoxyParams}{Parameters}
{\em dest} & Pointer to object to have it\textquotesingle{}s parameters set the same as this object. \\
\hline
\end{DoxyParams}


References Ogre\+::\+String\+Interface\+::set\+Parameter().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}\label{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}} 
\index{Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}!cleanup\+Dictionary@{cleanup\+Dictionary}}
\index{cleanup\+Dictionary@{cleanup\+Dictionary}!Ogre\+::\+External\+Texture\+Source@{Ogre\+::\+External\+Texture\+Source}}
\subsubsection{\texorpdfstring{cleanup\+Dictionary()}{cleanupDictionary()}}
{\footnotesize\ttfamily static void Ogre\+::\+String\+Interface\+::cleanup\+Dictionary (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \hyperlink{namespace_ogre}{Ogre}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} implementers (e.\+g. 

\hyperlink{class_ogre_1_1_material_manager}{Material\+Manager}) initializes. 

The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_external_texture_source_8h}{Ogre\+External\+Texture\+Source.\+h}\end{DoxyCompactItemize}
