\hypertarget{class_ogre_1_1_plugin}{}\section{Ogre\+:\+:Plugin Class Reference}
\label{class_ogre_1_1_plugin}\index{Ogre\+::\+Plugin@{Ogre\+::\+Plugin}}


Class defining a generic O\+G\+RE plugin.  




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



Inheritance diagram for Ogre\+:\+:Plugin\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_plugin__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_plugin_a02890fc726dd3163721bdbec1c60339a}{Plugin} ()
\item 
virtual \hyperlink{class_ogre_1_1_plugin_a8f531cb7678768d34140e1aa15335f57}{$\sim$\+Plugin} ()
\item 
virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_plugin_a25a8ef68cc19a03260696ce1c3d3d399}{get\+Name} () const =0
\begin{DoxyCompactList}\small\item\em Get the name of the plugin. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_plugin_a890da15775afd75c14e81bc6207de81f}{initialise} ()=0
\begin{DoxyCompactList}\small\item\em Perform any tasks the plugin needs to perform on full system initialisation. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_plugin_a556fd0c6a5a05cce82dc7df998c99c0f}{install} ()=0
\begin{DoxyCompactList}\small\item\em Perform the plugin initial installation sequence. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_plugin_a17fe6741c49a0fb9153797c70bdb884b}{shutdown} ()=0
\begin{DoxyCompactList}\small\item\em Perform any tasks the plugin needs to perform when the system is shut down. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_plugin_a47748105a90ce86b7e0f99a6910bd31d}{uninstall} ()=0
\begin{DoxyCompactList}\small\item\em Perform the final plugin uninstallation sequence. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Class defining a generic O\+G\+RE plugin. 

\begin{DoxyRemark}{Remarks}
O\+G\+RE is very plugin-\/oriented and you can customise much of its behaviour by registering new plugins, dynamically if you are using dynamic linking. This class abstracts the generic interface that all plugins must support. Within the implementations of this interface, the plugin must call other O\+G\+RE classes in order to register the detailed customisations it is providing, e.\+g. registering a new \hyperlink{class_ogre_1_1_scene_manager_factory}{Scene\+Manager\+Factory}, a new \hyperlink{class_ogre_1_1_movable_object_factory}{Movable\+Object\+Factory}, or a new \hyperlink{class_ogre_1_1_render_system}{Render\+System}. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
Plugins can be linked statically or dynamically. If they are linked dynamically (ie the plugin is in a D\+LL or Shared Object file), then you load the plugin by calling the \hyperlink{class_ogre_1_1_root_af0744e85bddb05885a91809bcdf8f864}{Root\+::load\+Plugin} method (or some other mechanism which leads to that call, e.\+g. plugins.\+cfg), passing the name of the D\+LL. O\+G\+RE will then call a global init function on that D\+LL, and it will be expected to register one or more \hyperlink{class_ogre_1_1_plugin}{Plugin} implementations using \hyperlink{class_ogre_1_1_root_a5ea47cd9c094644e1abac7607e1922fd}{Root\+::install\+Plugin}. The procedure is very similar if you use a static linked plugin, except that you simply instantiate the \hyperlink{class_ogre_1_1_plugin}{Plugin} implementation yourself and pass it to \hyperlink{class_ogre_1_1_root_a5ea47cd9c094644e1abac7607e1922fd}{Root\+::install\+Plugin}. 
\end{DoxyParagraph}
\begin{DoxyNote}{Note}
Lifecycle of a \hyperlink{class_ogre_1_1_plugin}{Plugin} instance is very important. The \hyperlink{class_ogre_1_1_plugin}{Plugin} instance must remain valid until the \hyperlink{class_ogre_1_1_plugin}{Plugin} is uninstalled. Here are the things you must bear in mind\+: 
\begin{DoxyItemize}
\item If your plugin is in a D\+LL\+: 
\begin{DoxyItemize}
\item Create the \hyperlink{class_ogre_1_1_plugin}{Plugin} instance and call \hyperlink{class_ogre_1_1_root_a5ea47cd9c094644e1abac7607e1922fd}{Root\+::install\+Plugin} in dll\+Start\+Plugin 
\item Call \hyperlink{class_ogre_1_1_root_a23417d6cbe7aeeafcc6a1a146a5e7b95}{Root\+::uninstall\+Plugin}, then delete it in dll\+Stop\+Plugin
\end{DoxyItemize}
\item If your plugin is statically linked in your app\+: 
\begin{DoxyItemize}
\item Create the \hyperlink{class_ogre_1_1_plugin}{Plugin} anytime you like 
\item Call \hyperlink{class_ogre_1_1_root_a5ea47cd9c094644e1abac7607e1922fd}{Root\+::install\+Plugin} any time whilst \hyperlink{class_ogre_1_1_root}{Root} is valid 
\item Call \hyperlink{class_ogre_1_1_root_a23417d6cbe7aeeafcc6a1a146a5e7b95}{Root\+::uninstall\+Plugin} if you like so long as \hyperlink{class_ogre_1_1_root}{Root} is valid. However, it will be done for you when \hyperlink{class_ogre_1_1_root}{Root} is destroyed, so the \hyperlink{class_ogre_1_1_plugin}{Plugin} instance must still be valid at that point if you haven\textquotesingle{}t manually uninstalled it.
\end{DoxyItemize}
\end{DoxyItemize}The install and uninstall methods will be called when the plugin is installed or uninstalled. The initialise and shutdown will be called when there is a system initialisation or shutdown, e.\+g. when \hyperlink{class_ogre_1_1_root_a6ab8f204bbfb150ad180eb6e78e4639c}{Root\+::initialise} or \hyperlink{class_ogre_1_1_root_adc677530cc7ef50fbd0e37d75c02e16b}{Root\+::shutdown} are called. 
\end{DoxyNote}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_plugin_a02890fc726dd3163721bdbec1c60339a}\label{class_ogre_1_1_plugin_a02890fc726dd3163721bdbec1c60339a}} 
\index{Ogre\+::\+Plugin@{Ogre\+::\+Plugin}!Plugin@{Plugin}}
\index{Plugin@{Plugin}!Ogre\+::\+Plugin@{Ogre\+::\+Plugin}}
\subsubsection{\texorpdfstring{Plugin()}{Plugin()}}
{\footnotesize\ttfamily Ogre\+::\+Plugin\+::\+Plugin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

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



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_plugin_a25a8ef68cc19a03260696ce1c3d3d399}\label{class_ogre_1_1_plugin_a25a8ef68cc19a03260696ce1c3d3d399}} 
\index{Ogre\+::\+Plugin@{Ogre\+::\+Plugin}!get\+Name@{get\+Name}}
\index{get\+Name@{get\+Name}!Ogre\+::\+Plugin@{Ogre\+::\+Plugin}}
\subsubsection{\texorpdfstring{get\+Name()}{getName()}}
{\footnotesize\ttfamily virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Plugin\+::get\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Get the name of the plugin. 

\begin{DoxyRemark}{Remarks}
An implementation must be supplied for this method to uniquely identify the plugin. 
\end{DoxyRemark}


Implemented in \hyperlink{class_ogre_1_1_p_c_z_plugin_a9267bd8d6a609f4c49e619835b7a8993}{Ogre\+::\+P\+C\+Z\+Plugin}, \hyperlink{class_ogre_1_1_octree_zone_plugin_acf0674262a5a7c4aebd294a9f38ddd7f}{Ogre\+::\+Octree\+Zone\+Plugin}, \hyperlink{class_ogre_1_1_bsp_scene_manager_plugin_a3c0f0b096d2926f3f28f60dee8db5a8a}{Ogre\+::\+Bsp\+Scene\+Manager\+Plugin}, \hyperlink{class_ogre_1_1_particle_f_x_plugin_a4a169f0457021b1e4ac904afb694f2e2}{Ogre\+::\+Particle\+F\+X\+Plugin}, \hyperlink{class_ogre_1_1_g_l_e_s2_plugin_a981f66db6c0d4f2b8445e90fde339f9f}{Ogre\+::\+G\+L\+E\+S2\+Plugin}, \hyperlink{class_ogre_1_1_cg_plugin_ad075d12e894670f4b2fdee7d6c6662c6}{Ogre\+::\+Cg\+Plugin}, \hyperlink{class_ogre_1_1_octree_plugin_a6eb0da0233a3d764804c02a97d3ece7b}{Ogre\+::\+Octree\+Plugin}, \hyperlink{class_ogre_1_1_d3_d11_plugin_ae18e666b053c04affad28155f2c5f1dd}{Ogre\+::\+D3\+D11\+Plugin}, \hyperlink{class_ogre_1_1_d3_d9_plugin_aec7d2d487fad7ab82f0b8b8b4bd4c0fc}{Ogre\+::\+D3\+D9\+Plugin}, \hyperlink{class_ogre_1_1_g_l_plugin_aeabf966246b7c778667f33dc81897aa6}{Ogre\+::\+G\+L\+Plugin}, and \hyperlink{class_ogre_1_1_g_l3_plus_plugin_afb005e38cee58e0f7d67e5ef98b4c69a}{Ogre\+::\+G\+L3\+Plus\+Plugin}.

\mbox{\Hypertarget{class_ogre_1_1_plugin_a556fd0c6a5a05cce82dc7df998c99c0f}\label{class_ogre_1_1_plugin_a556fd0c6a5a05cce82dc7df998c99c0f}} 
\index{Ogre\+::\+Plugin@{Ogre\+::\+Plugin}!install@{install}}
\index{install@{install}!Ogre\+::\+Plugin@{Ogre\+::\+Plugin}}
\subsubsection{\texorpdfstring{install()}{install()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Plugin\+::install (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Perform the plugin initial installation sequence. 

\begin{DoxyRemark}{Remarks}
An implementation must be supplied for this method. It must perform the startup tasks necessary to install any rendersystem customisations or anything else that is not dependent on system initialisation, ie only dependent on the core of \hyperlink{namespace_ogre}{Ogre}. It must not perform any operations that would create rendersystem-\/specific objects at this stage, that should be done in \hyperlink{class_ogre_1_1_plugin_a890da15775afd75c14e81bc6207de81f}{initialise()}. 
\end{DoxyRemark}


Implemented in \hyperlink{class_ogre_1_1_p_c_z_plugin_a54e7b58ac77a99651c71df5fb29634de}{Ogre\+::\+P\+C\+Z\+Plugin}, \hyperlink{class_ogre_1_1_octree_zone_plugin_a28e76b9a177bf5548c04546cfa8d8a86}{Ogre\+::\+Octree\+Zone\+Plugin}, \hyperlink{class_ogre_1_1_bsp_scene_manager_plugin_a4f304f5c47ece3a7e844dac9ff92ed40}{Ogre\+::\+Bsp\+Scene\+Manager\+Plugin}, \hyperlink{class_ogre_1_1_particle_f_x_plugin_af0d441da00274250fbb3b6cf746bd767}{Ogre\+::\+Particle\+F\+X\+Plugin}, \hyperlink{class_ogre_1_1_g_l_e_s2_plugin_a11a9f8b3a25c275d1d35b2a9db5f0ac6}{Ogre\+::\+G\+L\+E\+S2\+Plugin}, \hyperlink{class_ogre_1_1_cg_plugin_a82d874e8cb8b5adcd101cf2f9f6573fc}{Ogre\+::\+Cg\+Plugin}, \hyperlink{class_ogre_1_1_octree_plugin_aab0bc3abb7e83f39589abe57f555d42e}{Ogre\+::\+Octree\+Plugin}, \hyperlink{class_ogre_1_1_d3_d11_plugin_adab23d0c7b46a1edca177b0d2a36da3f}{Ogre\+::\+D3\+D11\+Plugin}, \hyperlink{class_ogre_1_1_d3_d9_plugin_ac36cae5597f61ed2b8f694c23cbac4a8}{Ogre\+::\+D3\+D9\+Plugin}, \hyperlink{class_ogre_1_1_g_l_plugin_a29440516506cf58b40e5731cb887a121}{Ogre\+::\+G\+L\+Plugin}, and \hyperlink{class_ogre_1_1_g_l3_plus_plugin_a55fc9e5ff550436a77ede2f32f266f62}{Ogre\+::\+G\+L3\+Plus\+Plugin}.

\mbox{\Hypertarget{class_ogre_1_1_plugin_a890da15775afd75c14e81bc6207de81f}\label{class_ogre_1_1_plugin_a890da15775afd75c14e81bc6207de81f}} 
\index{Ogre\+::\+Plugin@{Ogre\+::\+Plugin}!initialise@{initialise}}
\index{initialise@{initialise}!Ogre\+::\+Plugin@{Ogre\+::\+Plugin}}
\subsubsection{\texorpdfstring{initialise()}{initialise()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Plugin\+::initialise (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Perform any tasks the plugin needs to perform on full system initialisation. 

\begin{DoxyRemark}{Remarks}
An implementation must be supplied for this method. It is called just after the system is fully initialised (either after \hyperlink{class_ogre_1_1_root_a6ab8f204bbfb150ad180eb6e78e4639c}{Root\+::initialise} if a window is created then, or after the first window is created) and therefore all rendersystem functionality is available at this time. You can use this hook to create any resources which are dependent on a rendersystem or have rendersystem-\/specific implementations. 
\end{DoxyRemark}


Implemented in \hyperlink{class_ogre_1_1_p_c_z_plugin_aceaa39473e822631dcfbc016f106d8da}{Ogre\+::\+P\+C\+Z\+Plugin}, \hyperlink{class_ogre_1_1_octree_zone_plugin_a06462f615fbccf153d56fb0ae8b28de0}{Ogre\+::\+Octree\+Zone\+Plugin}, \hyperlink{class_ogre_1_1_bsp_scene_manager_plugin_ad4ed3db160dbbb447ad84973cc45ca13}{Ogre\+::\+Bsp\+Scene\+Manager\+Plugin}, \hyperlink{class_ogre_1_1_particle_f_x_plugin_abee6bbe7e7d5382201a3cbb29dd30adb}{Ogre\+::\+Particle\+F\+X\+Plugin}, \hyperlink{class_ogre_1_1_g_l_e_s2_plugin_abc32f9504be080a8d866bc5b24a95851}{Ogre\+::\+G\+L\+E\+S2\+Plugin}, \hyperlink{class_ogre_1_1_cg_plugin_a58c8490fa69e0c4b285f7d35620b5cf1}{Ogre\+::\+Cg\+Plugin}, \hyperlink{class_ogre_1_1_octree_plugin_ad2b23416ee0422293069c2a160b16691}{Ogre\+::\+Octree\+Plugin}, \hyperlink{class_ogre_1_1_d3_d11_plugin_a456b2be12aea02c4b5c7de2570da8333}{Ogre\+::\+D3\+D11\+Plugin}, \hyperlink{class_ogre_1_1_d3_d9_plugin_a8946e752e2dcd9d4047d43020607babb}{Ogre\+::\+D3\+D9\+Plugin}, \hyperlink{class_ogre_1_1_g_l_plugin_a99da304c6ca47a79f141f4f4be047009}{Ogre\+::\+G\+L\+Plugin}, and \hyperlink{class_ogre_1_1_g_l3_plus_plugin_a8ac68fa9d444d2274c3fc8639089cc1e}{Ogre\+::\+G\+L3\+Plus\+Plugin}.

\mbox{\Hypertarget{class_ogre_1_1_plugin_a17fe6741c49a0fb9153797c70bdb884b}\label{class_ogre_1_1_plugin_a17fe6741c49a0fb9153797c70bdb884b}} 
\index{Ogre\+::\+Plugin@{Ogre\+::\+Plugin}!shutdown@{shutdown}}
\index{shutdown@{shutdown}!Ogre\+::\+Plugin@{Ogre\+::\+Plugin}}
\subsubsection{\texorpdfstring{shutdown()}{shutdown()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Plugin\+::shutdown (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Perform any tasks the plugin needs to perform when the system is shut down. 

\begin{DoxyRemark}{Remarks}
An implementation must be supplied for this method. This method is called just before key parts of the system are unloaded, such as rendersystems being shut down. You should use this hook to free up resources and decouple custom objects from the O\+G\+RE system, whilst all the instances of other plugins (e.\+g. rendersystems) still exist. 
\end{DoxyRemark}


Implemented in \hyperlink{class_ogre_1_1_p_c_z_plugin_a7a1c863d3084b59b74cf6e74d9c9947b}{Ogre\+::\+P\+C\+Z\+Plugin}, \hyperlink{class_ogre_1_1_octree_zone_plugin_a95629856343f774405e954b5af16dd0e}{Ogre\+::\+Octree\+Zone\+Plugin}, \hyperlink{class_ogre_1_1_bsp_scene_manager_plugin_aaffd22b53362f16d243d170d625663b2}{Ogre\+::\+Bsp\+Scene\+Manager\+Plugin}, \hyperlink{class_ogre_1_1_particle_f_x_plugin_af0414af6ff1a09c8a2f15cf9a94f9607}{Ogre\+::\+Particle\+F\+X\+Plugin}, \hyperlink{class_ogre_1_1_g_l_e_s2_plugin_a4acd95b74d4e842b14acef1ff0d655f8}{Ogre\+::\+G\+L\+E\+S2\+Plugin}, \hyperlink{class_ogre_1_1_cg_plugin_ae4016b58113038ded4045a6dcbedaa8c}{Ogre\+::\+Cg\+Plugin}, \hyperlink{class_ogre_1_1_octree_plugin_af4eb48b179e8db726f34fd7889597441}{Ogre\+::\+Octree\+Plugin}, \hyperlink{class_ogre_1_1_d3_d11_plugin_a9759f24b9afcb50ab23ad7f7449ce479}{Ogre\+::\+D3\+D11\+Plugin}, \hyperlink{class_ogre_1_1_d3_d9_plugin_ae6dade3a09bae91b9e1a1f18d3bc2c7e}{Ogre\+::\+D3\+D9\+Plugin}, \hyperlink{class_ogre_1_1_g_l_plugin_a519863fd21904a777870764ef58da54f}{Ogre\+::\+G\+L\+Plugin}, and \hyperlink{class_ogre_1_1_g_l3_plus_plugin_a29e2df13042ff12887ecbe1b5410f1ec}{Ogre\+::\+G\+L3\+Plus\+Plugin}.

\mbox{\Hypertarget{class_ogre_1_1_plugin_a47748105a90ce86b7e0f99a6910bd31d}\label{class_ogre_1_1_plugin_a47748105a90ce86b7e0f99a6910bd31d}} 
\index{Ogre\+::\+Plugin@{Ogre\+::\+Plugin}!uninstall@{uninstall}}
\index{uninstall@{uninstall}!Ogre\+::\+Plugin@{Ogre\+::\+Plugin}}
\subsubsection{\texorpdfstring{uninstall()}{uninstall()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Plugin\+::uninstall (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Perform the final plugin uninstallation sequence. 

\begin{DoxyRemark}{Remarks}
An implementation must be supplied for this method. It must perform the cleanup tasks which haven\textquotesingle{}t already been performed in \hyperlink{class_ogre_1_1_plugin_a17fe6741c49a0fb9153797c70bdb884b}{shutdown()} (e.\+g. final deletion of custom instances, if you kept them around incase the system was reinitialised). At this stage you cannot be sure what other plugins are still loaded or active. It must therefore not perform any operations that would reference any rendersystem-\/specific objects -\/ those should have been sorted out in the \textquotesingle{}shutdown\textquotesingle{} method. 
\end{DoxyRemark}


Implemented in \hyperlink{class_ogre_1_1_p_c_z_plugin_a5e93d67f654d26cf26aa57d6c92f7791}{Ogre\+::\+P\+C\+Z\+Plugin}, \hyperlink{class_ogre_1_1_octree_zone_plugin_a610c9077ff70835170347720aafcdb5b}{Ogre\+::\+Octree\+Zone\+Plugin}, \hyperlink{class_ogre_1_1_bsp_scene_manager_plugin_a606b81b8f9c5d022aa606c4a75b56a5c}{Ogre\+::\+Bsp\+Scene\+Manager\+Plugin}, \hyperlink{class_ogre_1_1_particle_f_x_plugin_af3e38e8d2b3de3551be9c40834c7c8f5}{Ogre\+::\+Particle\+F\+X\+Plugin}, \hyperlink{class_ogre_1_1_g_l_e_s2_plugin_a204d59b3c13f941c1b72ba2ce1c4b408}{Ogre\+::\+G\+L\+E\+S2\+Plugin}, \hyperlink{class_ogre_1_1_cg_plugin_ac3a598ca1a79ca91b76add26b29af8f6}{Ogre\+::\+Cg\+Plugin}, \hyperlink{class_ogre_1_1_octree_plugin_a210a359e1326c05c6dc49a096e2af227}{Ogre\+::\+Octree\+Plugin}, \hyperlink{class_ogre_1_1_d3_d11_plugin_a616d9c96c8120f9a7471a2ee303bc60a}{Ogre\+::\+D3\+D11\+Plugin}, \hyperlink{class_ogre_1_1_d3_d9_plugin_a3c2122a93a37dc80714f8929f3201b23}{Ogre\+::\+D3\+D9\+Plugin}, \hyperlink{class_ogre_1_1_g_l_plugin_a9c2f7b5f7f802edb13989e2a3b63dc8b}{Ogre\+::\+G\+L\+Plugin}, and \hyperlink{class_ogre_1_1_g_l3_plus_plugin_a86711c2832df5ae3b8e3a155584db4a8}{Ogre\+::\+G\+L3\+Plus\+Plugin}.



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