\hypertarget{class_ogre_1_1_cg_fx_script_loader}{}\section{Ogre\+:\+:Cg\+Fx\+Script\+Loader Class Reference}
\label{class_ogre_1_1_cg_fx_script_loader}\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}


Manages \hyperlink{class_ogre_1_1_overlay}{Overlay} objects, parsing them from .overlay files and storing a lookup library of them.  




{\ttfamily \#include $<$Ogre\+Cg\+Fx\+Script\+Loader.\+h$>$}



Inheritance diagram for Ogre\+:\+:Cg\+Fx\+Script\+Loader\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_cg_fx_script_loader__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_cg_fx_script_loader_ad49475d8c23dc210475cd8d65ace72a4}{Cg\+Fx\+Script\+Loader} ()
\item 
virtual \hyperlink{class_ogre_1_1_cg_fx_script_loader_a3670a8d9b0c6b3f3f5bc125624ded6c5}{$\sim$\+Cg\+Fx\+Script\+Loader} ()
\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_cg_fx_script_loader_a48bcf80ad0eabe9317777920b5d8d1a2}{get\+Loading\+Order} (void) const
\begin{DoxyCompactList}\small\item\em Gets the relative loading order of scripts of this type. \end{DoxyCompactList}\item 
const \hyperlink{group___general_ga783e5227595f351519627abfb740ec85}{String\+Vector} \& \hyperlink{class_ogre_1_1_cg_fx_script_loader_af6a6df38b68d59f327ba875b45c6780e}{get\+Script\+Patterns} (void) const
\begin{DoxyCompactList}\small\item\em Gets the file patterns which should be used to find scripts for this class. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_cg_fx_script_loader_a8cc3006cecef12aceeeefa7733ebc541}{parse\+Script} (\hyperlink{namespace_ogre_a8a2a961b4205aacff9c01e81e08d7781}{Data\+Stream\+Ptr} \&stream, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&group\+Name)
\begin{DoxyCompactList}\small\item\em Parse a script file. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{class_ogre_1_1_cg_fx_script_loader}{Cg\+Fx\+Script\+Loader} \& \hyperlink{class_ogre_1_1_cg_fx_script_loader_ad21a320aa22feb20ac3685e064973cf4}{get\+Singleton} (void)
\begin{DoxyCompactList}\small\item\em Get the singleton instance. \end{DoxyCompactList}\item 
static \hyperlink{class_ogre_1_1_cg_fx_script_loader}{Cg\+Fx\+Script\+Loader} $\ast$ \hyperlink{class_ogre_1_1_cg_fx_script_loader_a930f43b6d3493e5a7183e1422874d085}{get\+Singleton\+Ptr} (void)
\begin{DoxyCompactList}\small\item\em Get the singleton instance. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Manages \hyperlink{class_ogre_1_1_overlay}{Overlay} objects, parsing them from .overlay files and storing a lookup library of them. 

Alo manages the creation of Overlay\+Containers and Overlay\+Elements, used for non-\/interactive 2D elements such as H\+U\+Ds. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_cg_fx_script_loader_ad49475d8c23dc210475cd8d65ace72a4}\label{class_ogre_1_1_cg_fx_script_loader_ad49475d8c23dc210475cd8d65ace72a4}} 
\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}!Cg\+Fx\+Script\+Loader@{Cg\+Fx\+Script\+Loader}}
\index{Cg\+Fx\+Script\+Loader@{Cg\+Fx\+Script\+Loader}!Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}
\subsubsection{\texorpdfstring{Cg\+Fx\+Script\+Loader()}{CgFxScriptLoader()}}
{\footnotesize\ttfamily Ogre\+::\+Cg\+Fx\+Script\+Loader\+::\+Cg\+Fx\+Script\+Loader (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_cg_fx_script_loader_a3670a8d9b0c6b3f3f5bc125624ded6c5}\label{class_ogre_1_1_cg_fx_script_loader_a3670a8d9b0c6b3f3f5bc125624ded6c5}} 
\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}!````~Cg\+Fx\+Script\+Loader@{$\sim$\+Cg\+Fx\+Script\+Loader}}
\index{````~Cg\+Fx\+Script\+Loader@{$\sim$\+Cg\+Fx\+Script\+Loader}!Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}
\subsubsection{\texorpdfstring{$\sim$\+Cg\+Fx\+Script\+Loader()}{~CgFxScriptLoader()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Cg\+Fx\+Script\+Loader\+::$\sim$\+Cg\+Fx\+Script\+Loader (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_cg_fx_script_loader_af6a6df38b68d59f327ba875b45c6780e}\label{class_ogre_1_1_cg_fx_script_loader_af6a6df38b68d59f327ba875b45c6780e}} 
\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}!get\+Script\+Patterns@{get\+Script\+Patterns}}
\index{get\+Script\+Patterns@{get\+Script\+Patterns}!Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}
\subsubsection{\texorpdfstring{get\+Script\+Patterns()}{getScriptPatterns()}}
{\footnotesize\ttfamily const \hyperlink{group___general_ga783e5227595f351519627abfb740ec85}{String\+Vector}\& Ogre\+::\+Cg\+Fx\+Script\+Loader\+::get\+Script\+Patterns (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Gets the file patterns which should be used to find scripts for this class. 

\begin{DoxyRemark}{Remarks}
This method is called when a resource group is loaded if you use \hyperlink{class_ogre_1_1_resource_group_manager_aafd69be90e1774f2a4b34c4e6dcaa38a}{Resource\+Group\+Manager\+::\+\_\+register\+Script\+Loader}. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
A list of file patterns, in the order they should be searched in. 
\end{DoxyReturn}


Implements \hyperlink{class_ogre_1_1_script_loader_a78189fd757a233f34d5d272f76f6abf6}{Ogre\+::\+Script\+Loader}.

\mbox{\Hypertarget{class_ogre_1_1_cg_fx_script_loader_a8cc3006cecef12aceeeefa7733ebc541}\label{class_ogre_1_1_cg_fx_script_loader_a8cc3006cecef12aceeeefa7733ebc541}} 
\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}!parse\+Script@{parse\+Script}}
\index{parse\+Script@{parse\+Script}!Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}
\subsubsection{\texorpdfstring{parse\+Script()}{parseScript()}}
{\footnotesize\ttfamily void Ogre\+::\+Cg\+Fx\+Script\+Loader\+::parse\+Script (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_a8a2a961b4205aacff9c01e81e08d7781}{Data\+Stream\+Ptr} \&}]{stream,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{group\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Parse a script file. 


\begin{DoxyParams}{Parameters}
{\em stream} & Weak reference to a data stream which is the source of the script \\
\hline
{\em group\+Name} & The name of a resource group which should be used if any resources are created during the parse of this script. \\
\hline
\end{DoxyParams}


Implements \hyperlink{class_ogre_1_1_script_loader_a6bd73a15503c5cb29ed8b7e264e12293}{Ogre\+::\+Script\+Loader}.

\mbox{\Hypertarget{class_ogre_1_1_cg_fx_script_loader_a48bcf80ad0eabe9317777920b5d8d1a2}\label{class_ogre_1_1_cg_fx_script_loader_a48bcf80ad0eabe9317777920b5d8d1a2}} 
\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}!get\+Loading\+Order@{get\+Loading\+Order}}
\index{get\+Loading\+Order@{get\+Loading\+Order}!Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}
\subsubsection{\texorpdfstring{get\+Loading\+Order()}{getLoadingOrder()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Cg\+Fx\+Script\+Loader\+::get\+Loading\+Order (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Gets the relative loading order of scripts of this type. 

\begin{DoxyRemark}{Remarks}
There are dependencies between some kinds of scripts, and to enforce this all implementors of this interface must define a loading order. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
A value representing the relative loading order of these scripts compared to other script users, where higher values load later. 
\end{DoxyReturn}


Implements \hyperlink{class_ogre_1_1_script_loader_a12af311e1399d48c02c57bb545b50497}{Ogre\+::\+Script\+Loader}.

\mbox{\Hypertarget{class_ogre_1_1_cg_fx_script_loader_ad21a320aa22feb20ac3685e064973cf4}\label{class_ogre_1_1_cg_fx_script_loader_ad21a320aa22feb20ac3685e064973cf4}} 
\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}!get\+Singleton@{get\+Singleton}}
\index{get\+Singleton@{get\+Singleton}!Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}
\subsubsection{\texorpdfstring{get\+Singleton()}{getSingleton()}}
{\footnotesize\ttfamily static \hyperlink{class_ogre_1_1_cg_fx_script_loader}{Cg\+Fx\+Script\+Loader}\& Ogre\+::\+Cg\+Fx\+Script\+Loader\+::get\+Singleton (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Get the singleton instance. 

\mbox{\Hypertarget{class_ogre_1_1_cg_fx_script_loader_a930f43b6d3493e5a7183e1422874d085}\label{class_ogre_1_1_cg_fx_script_loader_a930f43b6d3493e5a7183e1422874d085}} 
\index{Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}!get\+Singleton\+Ptr@{get\+Singleton\+Ptr}}
\index{get\+Singleton\+Ptr@{get\+Singleton\+Ptr}!Ogre\+::\+Cg\+Fx\+Script\+Loader@{Ogre\+::\+Cg\+Fx\+Script\+Loader}}
\subsubsection{\texorpdfstring{get\+Singleton\+Ptr()}{getSingletonPtr()}}
{\footnotesize\ttfamily static \hyperlink{class_ogre_1_1_cg_fx_script_loader}{Cg\+Fx\+Script\+Loader}$\ast$ Ogre\+::\+Cg\+Fx\+Script\+Loader\+::get\+Singleton\+Ptr (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Get the singleton instance. 



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_cg_fx_script_loader_8h}{Ogre\+Cg\+Fx\+Script\+Loader.\+h}\end{DoxyCompactItemize}
