\hypertarget{class_ogre_1_1_overlay_system}{}\section{Ogre\+:\+:Overlay\+System Class Reference}
\label{class_ogre_1_1_overlay_system}\index{Ogre\+::\+Overlay\+System@{Ogre\+::\+Overlay\+System}}


This class simplify initialization / finalization of the overlay system.  




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



Inheritance diagram for Ogre\+:\+:Overlay\+System\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_overlay_system__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{group___overlays_gacd5c773075a7591f717fb2382df9a829}{Overlay\+System} ()
\item 
virtual \hyperlink{group___overlays_gad399638657ead9815683c02bc7fdf149}{$\sim$\+Overlay\+System} ()
\item 
virtual void \hyperlink{group___overlays_ga24994f08e629cb6c76ecc52a1deceac9}{event\+Occurred} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&event\+Name, const \hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List} $\ast$parameters)
\item 
virtual void \hyperlink{class_ogre_1_1_render_queue_listener_a0a6a53d54e3215fc2bf2c877fedd47d6}{post\+Render\+Queues} ()
\begin{DoxyCompactList}\small\item\em Event raised after all render queues are processed. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_render_queue_listener_aed637d7bad94336183321b5ee290751c}{pre\+Render\+Queues} ()
\begin{DoxyCompactList}\small\item\em Event raised before all render queues are processed. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_render_queue_listener_a338dd1abf82317692ce7504978c01a5c}{render\+Queue\+Ended} (\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} queue\+Group\+Id, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&invocation, bool \&repeat\+This\+Invocation)
\begin{DoxyCompactList}\small\item\em Event raised after a queue group is rendered. \end{DoxyCompactList}\item 
virtual void \hyperlink{group___overlays_gaa1d17ffff4dbab645e0b6523002539e0}{render\+Queue\+Started} (\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} queue\+Group\+Id, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&invocation, bool \&skip\+This\+Invocation)
\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class simplify initialization / finalization of the overlay system. 

O\+G\+RE root did this steps before the overlay system transformed into a component. \begin{DoxyRemark}{Remarks}
Before you create a concrete instance of the \hyperlink{class_ogre_1_1_overlay_system}{Overlay\+System} the O\+G\+R\+E\+::\+Root must be created but not initialized. In the ctor all relevant systems are created and registered. The dtor must be called before you delete O\+G\+R\+E\+::\+Root. To make the overlays visible (= render into your viewports) you have to register this instance as a \hyperlink{class_ogre_1_1_render_queue_listener}{Render\+Queue\+Listener} in your scenemanager(s). 
\end{DoxyRemark}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_render_queue_listener_aed637d7bad94336183321b5ee290751c}\label{class_ogre_1_1_render_queue_listener_aed637d7bad94336183321b5ee290751c}} 
\index{Ogre\+::\+Overlay\+System@{Ogre\+::\+Overlay\+System}!pre\+Render\+Queues@{pre\+Render\+Queues}}
\index{pre\+Render\+Queues@{pre\+Render\+Queues}!Ogre\+::\+Overlay\+System@{Ogre\+::\+Overlay\+System}}
\subsubsection{\texorpdfstring{pre\+Render\+Queues()}{preRenderQueues()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Render\+Queue\+Listener\+::pre\+Render\+Queues (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Event raised before all render queues are processed. 

\mbox{\Hypertarget{class_ogre_1_1_render_queue_listener_a0a6a53d54e3215fc2bf2c877fedd47d6}\label{class_ogre_1_1_render_queue_listener_a0a6a53d54e3215fc2bf2c877fedd47d6}} 
\index{Ogre\+::\+Overlay\+System@{Ogre\+::\+Overlay\+System}!post\+Render\+Queues@{post\+Render\+Queues}}
\index{post\+Render\+Queues@{post\+Render\+Queues}!Ogre\+::\+Overlay\+System@{Ogre\+::\+Overlay\+System}}
\subsubsection{\texorpdfstring{post\+Render\+Queues()}{postRenderQueues()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Render\+Queue\+Listener\+::post\+Render\+Queues (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Event raised after all render queues are processed. 

\mbox{\Hypertarget{class_ogre_1_1_render_queue_listener_a338dd1abf82317692ce7504978c01a5c}\label{class_ogre_1_1_render_queue_listener_a338dd1abf82317692ce7504978c01a5c}} 
\index{Ogre\+::\+Overlay\+System@{Ogre\+::\+Overlay\+System}!render\+Queue\+Ended@{render\+Queue\+Ended}}
\index{render\+Queue\+Ended@{render\+Queue\+Ended}!Ogre\+::\+Overlay\+System@{Ogre\+::\+Overlay\+System}}
\subsubsection{\texorpdfstring{render\+Queue\+Ended()}{renderQueueEnded()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Render\+Queue\+Listener\+::render\+Queue\+Ended (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8}}]{queue\+Group\+Id,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{invocation,  }\item[{bool \&}]{repeat\+This\+Invocation }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Event raised after a queue group is rendered. 

\begin{DoxyRemark}{Remarks}
This method is called by the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} after each queue group is rendered. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em queue\+Group\+Id} & The id of the queue group which has just been rendered \\
\hline
{\em invocation} & Name of the invocation which is causing this to be called (\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_render_queue_invocation}{Render\+Queue\+Invocation}) 
\end{DoxySeeAlso}

\begin{DoxyParams}{Parameters}
{\em repeat\+This\+Invocation} & A boolean passed by reference which is by default set to false. If the event sets this to true, the queue which has just been rendered will be repeated, and the render\+Queue\+Started and render\+Queue\+Ended events will also be fired for it again. \\
\hline
\end{DoxyParams}


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