\hypertarget{class_ogre_1_1_file_system_archive_factory}{}\doxysection{Ogre\+::File\+System\+Archive\+Factory Class Reference}
\label{class_ogre_1_1_file_system_archive_factory}\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}


Specialisation of the \mbox{\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory}} to allow reading of files from filesystem folders / directories.  




{\ttfamily \#include $<$Ogre\+File\+System.\+h$>$}



Inheritance diagram for Ogre\+::File\+System\+Archive\+Factory\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=332pt]{class_ogre_1_1_file_system_archive_factory__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_file_system_archive_factory_a29c98713d1e9463bc3ab19d17be5635c}{create\+Instance}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name) \mbox{\hyperlink{_ogre_platform_8h_a11162eebee0099930c48076229cc6f04}{O\+G\+R\+E\+\_\+\+N\+O\+D\+I\+S\+C\+A\+RD}}
\item 
virtual \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_archive_factory_a29c98713d1e9463bc3ab19d17be5635c}{create\+Instance}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name) \mbox{\hyperlink{_ogre_platform_8h_a11162eebee0099930c48076229cc6f04}{O\+G\+R\+E\+\_\+\+N\+O\+D\+I\+S\+C\+A\+RD}}
\begin{DoxyCompactList}\small\item\em Creates a new object. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_file_system_archive_factory_abf77dd8271bb5c237ef56f888f666e34}{create\+Instance}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name, bool read\+Only)
\begin{DoxyCompactList}\small\item\em Creates a new object. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_file_system_archive_factory_ac066010038914bc460a192d7d1ce9ce3}{create\+Instance}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name, bool read\+Only) \mbox{\hyperlink{_ogre_platform_8h_a11162eebee0099930c48076229cc6f04}{O\+G\+R\+E\+\_\+\+N\+O\+D\+I\+S\+C\+A\+RD}}=0
\begin{DoxyCompactList}\small\item\em Creates a new object. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_file_system_archive_factory_a1eb9e2ef1abd9aa441091438c44daef4}{destroy\+Instance}} (\mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$ptr)
\begin{DoxyCompactList}\small\item\em Destroys an object which was created by this factory. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \& \mbox{\hyperlink{class_ogre_1_1_file_system_archive_factory_a0aa13f124f25755334dcc35a28076ce1}{get\+Type}} (void) const
\begin{DoxyCompactList}\small\item\em Returns the factory type. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static bool \mbox{\hyperlink{class_ogre_1_1_file_system_archive_factory_a1bcf459933c38f70ccd8c7c235b725c2}{get\+Ignore\+Hidden}} ()
\begin{DoxyCompactList}\small\item\em Get whether hidden files are ignored during filesystem enumeration. \end{DoxyCompactList}\item 
static void \mbox{\hyperlink{class_ogre_1_1_file_system_archive_factory_ac73fdb14c70cf79e753d86a13273c2a3}{set\+Ignore\+Hidden}} (bool ignore)
\begin{DoxyCompactList}\small\item\em Set whether filesystem enumeration will include hidden files or not. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Specialisation of the \mbox{\hyperlink{class_ogre_1_1_archive_factory}{Archive\+Factory}} to allow reading of files from filesystem folders / directories. 

\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_file_system_archive_factory_a0aa13f124f25755334dcc35a28076ce1}\label{class_ogre_1_1_file_system_archive_factory_a0aa13f124f25755334dcc35a28076ce1}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!getType@{getType}}
\index{getType@{getType}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{getType()}{getType()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}}\& Ogre\+::\+File\+System\+Archive\+Factory\+::get\+Type (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the factory type. 

\begin{DoxyReturn}{Returns}
The factory type. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{class_ogre_1_1_factory_obj_a3d8aef92fb9e0eac7ed41167fb686a10}{Ogre\+::\+Factory\+Obj$<$ Archive $>$}}.

\mbox{\Hypertarget{class_ogre_1_1_file_system_archive_factory_abf77dd8271bb5c237ef56f888f666e34}\label{class_ogre_1_1_file_system_archive_factory_abf77dd8271bb5c237ef56f888f666e34}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!createInstance@{createInstance}}
\index{createInstance@{createInstance}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{createInstance()}{createInstance()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}}$\ast$ Ogre\+::\+File\+System\+Archive\+Factory\+::create\+Instance (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name,  }\item[{bool}]{read\+Only }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Creates a new object. 


\begin{DoxyParams}{Parameters}
{\em name} & Name of the object to create \\
\hline
{\em read\+Only} & whether the \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} is read only \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
An object created by the factory. The type of the object depends on the factory. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{class_ogre_1_1_archive_factory_ac066010038914bc460a192d7d1ce9ce3}{Ogre\+::\+Archive\+Factory}}.

\mbox{\Hypertarget{class_ogre_1_1_file_system_archive_factory_a1eb9e2ef1abd9aa441091438c44daef4}\label{class_ogre_1_1_file_system_archive_factory_a1eb9e2ef1abd9aa441091438c44daef4}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!destroyInstance@{destroyInstance}}
\index{destroyInstance@{destroyInstance}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{destroyInstance()}{destroyInstance()}}
{\footnotesize\ttfamily void Ogre\+::\+File\+System\+Archive\+Factory\+::destroy\+Instance (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} $\ast$}]{ptr }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Destroys an object which was created by this factory. 


\begin{DoxyParams}{Parameters}
{\em ptr} & Pointer to the object to destroy \\
\hline
\end{DoxyParams}


Implements \mbox{\hyperlink{class_ogre_1_1_factory_obj_adb934021afa323e7867bd3b52dffe1cc}{Ogre\+::\+Factory\+Obj$<$ Archive $>$}}.



References O\+G\+R\+E\+\_\+\+D\+E\+L\+E\+TE.

\mbox{\Hypertarget{class_ogre_1_1_file_system_archive_factory_ac73fdb14c70cf79e753d86a13273c2a3}\label{class_ogre_1_1_file_system_archive_factory_ac73fdb14c70cf79e753d86a13273c2a3}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!setIgnoreHidden@{setIgnoreHidden}}
\index{setIgnoreHidden@{setIgnoreHidden}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{setIgnoreHidden()}{setIgnoreHidden()}}
{\footnotesize\ttfamily static void Ogre\+::\+File\+System\+Archive\+Factory\+::set\+Ignore\+Hidden (\begin{DoxyParamCaption}\item[{bool}]{ignore }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Set whether filesystem enumeration will include hidden files or not. 

This should be called prior to declaring and/or initializing filesystem resource locations. The default is true (ignore hidden files). \mbox{\Hypertarget{class_ogre_1_1_file_system_archive_factory_a1bcf459933c38f70ccd8c7c235b725c2}\label{class_ogre_1_1_file_system_archive_factory_a1bcf459933c38f70ccd8c7c235b725c2}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!getIgnoreHidden@{getIgnoreHidden}}
\index{getIgnoreHidden@{getIgnoreHidden}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{getIgnoreHidden()}{getIgnoreHidden()}}
{\footnotesize\ttfamily static bool Ogre\+::\+File\+System\+Archive\+Factory\+::get\+Ignore\+Hidden (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Get whether hidden files are ignored during filesystem enumeration. 

\mbox{\Hypertarget{class_ogre_1_1_file_system_archive_factory_ac066010038914bc460a192d7d1ce9ce3}\label{class_ogre_1_1_file_system_archive_factory_ac066010038914bc460a192d7d1ce9ce3}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!createInstance@{createInstance}}
\index{createInstance@{createInstance}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{createInstance()}{createInstance()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}}$\ast$ Ogre\+::\+Archive\+Factory\+::create\+Instance}



Creates a new object. 


\begin{DoxyParams}{Parameters}
{\em name} & Name of the object to create \\
\hline
{\em read\+Only} & whether the \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}} is read only \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
An object created by the factory. The type of the object depends on the factory. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_file_system_archive_factory_a29c98713d1e9463bc3ab19d17be5635c}\label{class_ogre_1_1_file_system_archive_factory_a29c98713d1e9463bc3ab19d17be5635c}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!createInstance@{createInstance}}
\index{createInstance@{createInstance}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{createInstance()}{createInstance()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}}$\ast$ Ogre\+::\+Archive\+Factory\+::create\+Instance\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_archive_factory_a29c98713d1e9463bc3ab19d17be5635c}\label{class_ogre_1_1_archive_factory_a29c98713d1e9463bc3ab19d17be5635c}} 
\index{Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}!createInstance@{createInstance}}
\index{createInstance@{createInstance}!Ogre::FileSystemArchiveFactory@{Ogre::FileSystemArchiveFactory}}
\doxysubsubsection{\texorpdfstring{createInstance()}{createInstance()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_archive}{Archive}}$\ast$ Ogre\+::\+Archive\+Factory\+::create\+Instance (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Creates a new object. 


\begin{DoxyParams}{Parameters}
{\em name} & Name of the object to create \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
An object created by the factory. The type of the object depends on the factory. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{class_ogre_1_1_factory_obj_a0a4a382d89b01a0c24e27b02af71153a}{Ogre\+::\+Factory\+Obj$<$ Archive $>$}}.



References Ogre\+::\+Archive\+Factory\+::create\+Instance().



Referenced by Ogre\+::\+Archive\+Factory\+::create\+Instance().



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_file_system_8h}{Ogre\+File\+System.\+h}}\end{DoxyCompactItemize}
