\hypertarget{class_ogre_1_1_billboard_set_factory}{}\doxysection{Ogre\+::Billboard\+Set\+Factory Class Reference}
\label{class_ogre_1_1_billboard_set_factory}\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}


Factory object for creating \mbox{\hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}} instances.  




{\ttfamily \#include $<$Ogre\+Billboard\+Set.\+h$>$}



Inheritance diagram for Ogre\+::Billboard\+Set\+Factory\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=235pt]{class_ogre_1_1_billboard_set_factory__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_billboard_set_factory_ae9a4de2651c1585f849122d117b607e2}{Billboard\+Set\+Factory}} ()
\item 
\mbox{\hyperlink{class_ogre_1_1_billboard_set_factory_a09ec91b5f9f262975eee3178c4525699}{$\sim$\+Billboard\+Set\+Factory}} ()
\item 
void \mbox{\hyperlink{class_ogre_1_1_movable_object_factory_aa23e112f39b565fa0b97e60e27014de3}{\+\_\+notify\+Type\+Flags}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} flag)
\begin{DoxyCompactList}\small\item\em Notify this factory of the type mask to apply. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_movable_object}{Movable\+Object}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_movable_object_factory_a23f425e96487a07c316b2e828ee3ed2f}{create\+Instance}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name, \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$manager, const \mbox{\hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List}} $\ast$params=0)
\begin{DoxyCompactList}\small\item\em Create a new instance of the object. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_billboard_set_factory_a1d9a309182513810d2bd2ae98cc6e5be}{destroy\+Instance}} (\mbox{\hyperlink{class_ogre_1_1_movable_object}{Movable\+Object}} $\ast$obj)
\begin{DoxyCompactList}\small\item\em Destroy an instance of the object. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \& \mbox{\hyperlink{class_ogre_1_1_billboard_set_factory_a35f510c502749dd9683e1f31cead69e3}{get\+Type}} (void) const
\begin{DoxyCompactList}\small\item\em Get the type of the object to be created. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{class_ogre_1_1_movable_object_factory_a79d691ca0e7dd4e8c96254360e0acd87}{get\+Type\+Flags}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the type flag for this factory. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_movable_object_factory_a7217963ad49147c6d9b1603392ee1408}{request\+Type\+Flags}} (void) const
\begin{DoxyCompactList}\small\item\em Does this factory require the allocation of a \textquotesingle{}type flag\textquotesingle{}, used to selectively include / exclude this type from scene queries? \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \mbox{\hyperlink{class_ogre_1_1_billboard_set_factory_a9973fc338f04f72c1a823f1a6e858b63}{F\+A\+C\+T\+O\+R\+Y\+\_\+\+T\+Y\+P\+E\+\_\+\+N\+A\+ME}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Factory object for creating \mbox{\hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}} instances. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_billboard_set_factory_ae9a4de2651c1585f849122d117b607e2}\label{class_ogre_1_1_billboard_set_factory_ae9a4de2651c1585f849122d117b607e2}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!BillboardSetFactory@{BillboardSetFactory}}
\index{BillboardSetFactory@{BillboardSetFactory}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{BillboardSetFactory()}{BillboardSetFactory()}}
{\footnotesize\ttfamily Ogre\+::\+Billboard\+Set\+Factory\+::\+Billboard\+Set\+Factory (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_billboard_set_factory_a09ec91b5f9f262975eee3178c4525699}\label{class_ogre_1_1_billboard_set_factory_a09ec91b5f9f262975eee3178c4525699}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!````~BillboardSetFactory@{$\sim$BillboardSetFactory}}
\index{````~BillboardSetFactory@{$\sim$BillboardSetFactory}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{$\sim$BillboardSetFactory()}{~BillboardSetFactory()}}
{\footnotesize\ttfamily Ogre\+::\+Billboard\+Set\+Factory\+::$\sim$\+Billboard\+Set\+Factory (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



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



Get the type of the object to be created. 



Implements \mbox{\hyperlink{class_ogre_1_1_movable_object_factory_a0b45580fccdefe99312afa67265264fc}{Ogre\+::\+Movable\+Object\+Factory}}.

\mbox{\Hypertarget{class_ogre_1_1_billboard_set_factory_a1d9a309182513810d2bd2ae98cc6e5be}\label{class_ogre_1_1_billboard_set_factory_a1d9a309182513810d2bd2ae98cc6e5be}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!destroyInstance@{destroyInstance}}
\index{destroyInstance@{destroyInstance}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{destroyInstance()}{destroyInstance()}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+Set\+Factory\+::destroy\+Instance (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_movable_object}{Movable\+Object}} $\ast$}]{obj }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Destroy an instance of the object. 



Implements \mbox{\hyperlink{class_ogre_1_1_movable_object_factory_aae1cdb0b70854af1c84e23d5b45dfb30}{Ogre\+::\+Movable\+Object\+Factory}}.

\mbox{\Hypertarget{class_ogre_1_1_movable_object_factory_a23f425e96487a07c316b2e828ee3ed2f}\label{class_ogre_1_1_movable_object_factory_a23f425e96487a07c316b2e828ee3ed2f}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!createInstance@{createInstance}}
\index{createInstance@{createInstance}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{createInstance()}{createInstance()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_movable_object}{Movable\+Object}}$\ast$ Ogre\+::\+Movable\+Object\+Factory\+::create\+Instance (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name,  }\item[{\mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$}]{manager,  }\item[{const \mbox{\hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List}} $\ast$}]{params = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Create a new instance of the object. 


\begin{DoxyParams}{Parameters}
{\em name} & The name of the new object \\
\hline
{\em manager} & The \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} instance that will be holding the instance once created. \\
\hline
{\em params} & Name/value pair list of additional parameters required to construct the object (defined per subtype). Optional. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_movable_object_factory_a7217963ad49147c6d9b1603392ee1408}\label{class_ogre_1_1_movable_object_factory_a7217963ad49147c6d9b1603392ee1408}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!requestTypeFlags@{requestTypeFlags}}
\index{requestTypeFlags@{requestTypeFlags}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{requestTypeFlags()}{requestTypeFlags()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Movable\+Object\+Factory\+::request\+Type\+Flags (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Does this factory require the allocation of a \textquotesingle{}type flag\textquotesingle{}, used to selectively include / exclude this type from scene queries? 

\begin{DoxyRemark}{Remarks}
The default implementation here is to return \textquotesingle{}false\textquotesingle{}, ie not to request a unique type mask from \mbox{\hyperlink{class_ogre_1_1_root}{Root}}. For objects that never need to be excluded in \mbox{\hyperlink{class_ogre_1_1_scene_query}{Scene\+Query}} results, that\textquotesingle{}s fine, since the default implementation of \mbox{\hyperlink{class_ogre_1_1_movable_object_a2d718f6ed0b708495cc2a31eb653ad84}{Movable\+Object\+::get\+Type\+Flags}} is to return all ones, hence matching any query type mask. However, if you want the objects created by this factory to be filterable by queries using a broad type, you have to give them a (preferably unique) type mask -\/ and given that you don\textquotesingle{}t know what other \mbox{\hyperlink{class_ogre_1_1_movable_object}{Movable\+Object}} types are registered, \mbox{\hyperlink{class_ogre_1_1_root}{Root}} will allocate you one. 
\end{DoxyRemark}


Reimplemented in \mbox{\hyperlink{class_ogre_1_1_portal_factory_a8c1c9edbe1d3af25cf2a10ee6d783dfc}{Ogre\+::\+Portal\+Factory}}, and \mbox{\hyperlink{class_ogre_1_1_anti_portal_factory_a2174deb17522078482d2c7dec12c2ecb}{Ogre\+::\+Anti\+Portal\+Factory}}.

\mbox{\Hypertarget{class_ogre_1_1_movable_object_factory_aa23e112f39b565fa0b97e60e27014de3}\label{class_ogre_1_1_movable_object_factory_aa23e112f39b565fa0b97e60e27014de3}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!\_notifyTypeFlags@{\_notifyTypeFlags}}
\index{\_notifyTypeFlags@{\_notifyTypeFlags}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{\_notifyTypeFlags()}{\_notifyTypeFlags()}}
{\footnotesize\ttfamily void Ogre\+::\+Movable\+Object\+Factory\+::\+\_\+notify\+Type\+Flags (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{flag }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Notify this factory of the type mask to apply. 

\begin{DoxyRemark}{Remarks}
This should normally only be called by \mbox{\hyperlink{class_ogre_1_1_root}{Root}} in response to a \textquotesingle{}true\textquotesingle{} result from request\+Type\+Mask. However, you can actually use it yourself if you\textquotesingle{}re careful; for example to assign the same mask to a number of different types of object, should you always wish them to be treated the same in queries. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_movable_object_factory_a79d691ca0e7dd4e8c96254360e0acd87}\label{class_ogre_1_1_movable_object_factory_a79d691ca0e7dd4e8c96254360e0acd87}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!getTypeFlags@{getTypeFlags}}
\index{getTypeFlags@{getTypeFlags}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{getTypeFlags()}{getTypeFlags()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Movable\+Object\+Factory\+::get\+Type\+Flags (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets the type flag for this factory. 

\begin{DoxyRemark}{Remarks}
A type flag is like a query flag, except that it applies to all instances of a certain type of object. 
\end{DoxyRemark}


\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_billboard_set_factory_a9973fc338f04f72c1a823f1a6e858b63}\label{class_ogre_1_1_billboard_set_factory_a9973fc338f04f72c1a823f1a6e858b63}} 
\index{Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}!FACTORY\_TYPE\_NAME@{FACTORY\_TYPE\_NAME}}
\index{FACTORY\_TYPE\_NAME@{FACTORY\_TYPE\_NAME}!Ogre::BillboardSetFactory@{Ogre::BillboardSetFactory}}
\doxysubsubsection{\texorpdfstring{FACTORY\_TYPE\_NAME}{FACTORY\_TYPE\_NAME}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} Ogre\+::\+Billboard\+Set\+Factory\+::\+F\+A\+C\+T\+O\+R\+Y\+\_\+\+T\+Y\+P\+E\+\_\+\+N\+A\+ME\hspace{0.3cm}{\ttfamily [static]}}



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