\hypertarget{class_ogre_1_1_overlay}{}\doxysection{Ogre\+::Overlay Class Reference}
\label{class_ogre_1_1_overlay}\index{Ogre::Overlay@{Ogre::Overlay}}


Represents a layer which is rendered on top of the \textquotesingle{}normal\textquotesingle{} scene contents.  




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



Inheritance diagram for Ogre\+::Overlay\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=164pt]{class_ogre_1_1_overlay__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef std\+::list$<$ \mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}} $\ast$ $>$ \mbox{\hyperlink{class_ogre_1_1_overlay_a8f3f648a05816f72743c966c51e948dd}{Overlay\+Container\+List}}
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_overlay_a8d6c54081ea142edf528d4253f32a913}{Overlay}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name)
\begin{DoxyCompactList}\small\item\em Constructor\+: do not call direct, use \mbox{\hyperlink{class_ogre_1_1_overlay_manager_ab6eb3dcc484ba5b06904ab2fb6b1aa23}{Overlay\+Manager\+::create}}. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_overlay_a5a4051af0e9d239f4cb3d03f092565c3}{$\sim$\+Overlay}} ()
\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a60564ce854e4a17f29a7af999ea50fda}{\+\_\+find\+Visible\+Objects}} (\mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$cam, \mbox{\hyperlink{class_ogre_1_1_render_queue}{Render\+Queue}} $\ast$queue, \mbox{\hyperlink{class_ogre_1_1_viewport}{Viewport}} $\ast$vp)
\begin{DoxyCompactList}\small\item\em Internal method to put the overlay contents onto the render queue. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a306fcb0e15b270f7cd1c436fbb3b7b54}{\+\_\+get\+World\+Transforms}} (\mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$xform) const
\begin{DoxyCompactList}\small\item\em Used to transform the overlay when scrolling, scaling etc. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_ae48bf2a6596b514f95e9d3a437d8e1e0}{\+\_\+notify\+Origin}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&origin)
\begin{DoxyCompactList}\small\item\em Notify this overlay of it\textquotesingle{}s origin. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a702b15ebaa6d3f8dbb2918500b76c9f0}{add2D}} (\mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}} $\ast$cont)
\begin{DoxyCompactList}\small\item\em Adds a 2D \textquotesingle{}container\textquotesingle{} to the overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a296d54af42cc05fddd20e07b5209ab1a}{add3D}} (\mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} $\ast$node)
\begin{DoxyCompactList}\small\item\em Adds a node capable of holding 3D objects to the overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a81c8a84fa283a0341a8c14b6c8168ccb}{clear}} ()
\begin{DoxyCompactList}\small\item\em Clears the overlay of all attached items. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_overlay_aaf8b4bc3c953b8eeaf5ce8e6f3bfac9f}{find\+Element\+At}} (\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} x, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} y)
\begin{DoxyCompactList}\small\item\em This returns a \mbox{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}} at position x,y. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{class_ogre_1_1_overlay_a8f3f648a05816f72743c966c51e948dd}{Overlay\+Container\+List}} \& \mbox{\hyperlink{class_ogre_1_1_overlay_a22aa861e3d8e54211dbea41751c2f95a}{get2\+D\+Elements}} () const
\begin{DoxyCompactList}\small\item\em Returns all 2D elements in this manager. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_overlay_a5d12ab2635efc92de84fece5ae97ed5a}{get\+Child}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name)
\item 
const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \& \mbox{\hyperlink{class_ogre_1_1_overlay_a61f58ff3fe6a288d9c1e68d5c421703b}{get\+Name}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the name of this overlay. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \& \mbox{\hyperlink{class_ogre_1_1_overlay_aea5d72ca41e435998d6f0d5a3c736274}{get\+Origin}} (void) const
\begin{DoxyCompactList}\small\item\em Get the origin of this overlay, e.\+g. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} \& \mbox{\hyperlink{class_ogre_1_1_overlay_a5f7fbb799f4cee6415b223cc6fe1625e}{get\+Rotate}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the rotation applied to this overlay, in degrees. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} \mbox{\hyperlink{class_ogre_1_1_overlay_aa9b73c92c3a8e4ff41c65be87d545de6}{get\+ScaleX}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the current X scale value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} \mbox{\hyperlink{class_ogre_1_1_overlay_a5263af45959efb44ed9f9fdb96cecc14}{get\+ScaleY}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the current Y scale value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} \mbox{\hyperlink{class_ogre_1_1_overlay_aa3b4520fdfd5eb8841ced874e470c4b4}{get\+ScrollX}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the current X scroll value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} \mbox{\hyperlink{class_ogre_1_1_overlay_a3476e577f32a23de48954723d6d2cfcd}{get\+ScrollY}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the current Y scroll value. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort}} \mbox{\hyperlink{class_ogre_1_1_overlay_a27113e2d2a11d4a25b39de408949ac5f}{get\+Z\+Order}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the Z-\/order of this overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_ab210b07a317329bb66df4e674de2a367}{hide}} (void)
\begin{DoxyCompactList}\small\item\em Hides the overlay if it was visible. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_ogre_1_1_overlay_a40e4504c4421065e1ef7e5ddc78b8444}{is\+Initialised}} (void) const
\begin{DoxyCompactList}\small\item\em Gets whether the overlay is initialised or not. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_ogre_1_1_overlay_a67425b4b8e3b9e614b498b40c8ada39c}{is\+Visible}} (void) const
\begin{DoxyCompactList}\small\item\em Gets whether the overlay is displayed or not. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a5c6182483591872da63ac4cea94671af}{remove2D}} (\mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}} $\ast$cont)
\begin{DoxyCompactList}\small\item\em Removes a 2D container from the overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a2ff5331b691cd4f07ee66e63f237baef}{remove3D}} (\mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} $\ast$node)
\begin{DoxyCompactList}\small\item\em Removes a 3D element from the overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a8282553a59253170ddd0488ab7179792}{rotate}} (const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} \&angle)
\begin{DoxyCompactList}\small\item\em Adds the passed in angle to the rotation applied to this overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_ae07b1a57498aad0299f0781b09ca9b39}{scroll}} (\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} xoff, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} yoff)
\begin{DoxyCompactList}\small\item\em Scrolls the overlay by the offsets provided. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a69d5f4c12c15f00efc7818d201e02e86}{set\+Rotate}} (const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} \&angle)
\begin{DoxyCompactList}\small\item\em Sets the rotation applied to this overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_adea3b88baa3697a657e7b5785f0ffedb}{set\+Scale}} (\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} x, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} y)
\begin{DoxyCompactList}\small\item\em Sets the scaling factor of this overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_ae268ad3250bac5058c6d08e00c060289}{set\+Scroll}} (\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} x, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} y)
\begin{DoxyCompactList}\small\item\em Sets the scrolling factor of this overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a5d8481d5fa0990846e53345f1a1cc705}{set\+Z\+Order}} (\mbox{\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort}} zorder)
\begin{DoxyCompactList}\small\item\em Alters the Z-\/order of this overlay. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_overlay_a3c565f3e5cf61f43fa33542d713e8ccf}{show}} (void)
\begin{DoxyCompactList}\small\item\em Shows the overlay if it was hidden. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Represents a layer which is rendered on top of the \textquotesingle{}normal\textquotesingle{} scene contents. 

\begin{DoxyRemark}{Remarks}
An overlay is a container for visual components (2D and 3D) which will be rendered after the main scene in order to composite heads-\/up-\/displays, menus or other layers on top of the contents of the scene. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
An overlay always takes up the entire size of the viewport, although the components attached to it do not have to. An overlay has no visual element in itself, it it merely a container for visual elements. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
Overlays are created by calling \mbox{\hyperlink{class_ogre_1_1_overlay_manager_ab6eb3dcc484ba5b06904ab2fb6b1aa23}{Overlay\+Manager\+::create}}, or by defining them in special text scripts (.overlay files). As many overlays as you like can be defined; after creation an overlay is hidden i.\+e. not visible until you specifically enable it by calling \textquotesingle{}show\textquotesingle{}. This allows you to have multiple overlays predefined (menus etc) which you make visible only when you want. It is possible to have multiple overlays enabled at once; in this case the relative \textquotesingle{}zorder\textquotesingle{} parameter of the overlays determine which one is displayed on top. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
By default overlays are rendered into all viewports. This is fine when you only have fullscreen viewports, but if you have picture-\/in-\/picture views, you probably don\textquotesingle{}t want the overlay displayed in the smaller viewports. You turn this off for a specific viewport by calling the Viewport\+::set\+Display\+Overlays method. 
\end{DoxyParagraph}


\doxysubsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a8f3f648a05816f72743c966c51e948dd}\label{class_ogre_1_1_overlay_a8f3f648a05816f72743c966c51e948dd}} 
\index{Ogre::Overlay@{Ogre::Overlay}!OverlayContainerList@{OverlayContainerList}}
\index{OverlayContainerList@{OverlayContainerList}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{OverlayContainerList}{OverlayContainerList}}
{\footnotesize\ttfamily typedef std\+::list$<$\mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}}$\ast$$>$ \mbox{\hyperlink{class_ogre_1_1_overlay_a8f3f648a05816f72743c966c51e948dd}{Ogre\+::\+Overlay\+::\+Overlay\+Container\+List}}}



\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a8d6c54081ea142edf528d4253f32a913}\label{class_ogre_1_1_overlay_a8d6c54081ea142edf528d4253f32a913}} 
\index{Ogre::Overlay@{Ogre::Overlay}!Overlay@{Overlay}}
\index{Overlay@{Overlay}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{Overlay()}{Overlay()}}
{\footnotesize\ttfamily Ogre\+::\+Overlay\+::\+Overlay (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name }\end{DoxyParamCaption})}



Constructor\+: do not call direct, use \mbox{\hyperlink{class_ogre_1_1_overlay_manager_ab6eb3dcc484ba5b06904ab2fb6b1aa23}{Overlay\+Manager\+::create}}. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a5a4051af0e9d239f4cb3d03f092565c3}\label{class_ogre_1_1_overlay_a5a4051af0e9d239f4cb3d03f092565c3}} 
\index{Ogre::Overlay@{Ogre::Overlay}!````~Overlay@{$\sim$Overlay}}
\index{````~Overlay@{$\sim$Overlay}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{$\sim$Overlay()}{~Overlay()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Overlay\+::$\sim$\+Overlay (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a5d12ab2635efc92de84fece5ae97ed5a}\label{class_ogre_1_1_overlay_a5d12ab2635efc92de84fece5ae97ed5a}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getChild@{getChild}}
\index{getChild@{getChild}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getChild()}{getChild()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}}$\ast$ Ogre\+::\+Overlay\+::get\+Child (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_overlay_a61f58ff3fe6a288d9c1e68d5c421703b}\label{class_ogre_1_1_overlay_a61f58ff3fe6a288d9c1e68d5c421703b}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getName@{getName}}
\index{getName@{getName}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}}\& Ogre\+::\+Overlay\+::get\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the name of this overlay. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a5d8481d5fa0990846e53345f1a1cc705}\label{class_ogre_1_1_overlay_a5d8481d5fa0990846e53345f1a1cc705}} 
\index{Ogre::Overlay@{Ogre::Overlay}!setZOrder@{setZOrder}}
\index{setZOrder@{setZOrder}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{setZOrder()}{setZOrder()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::set\+Z\+Order (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort}}}]{zorder }\end{DoxyParamCaption})}



Alters the Z-\/order of this overlay. 

\begin{DoxyRemark}{Remarks}
Values between 0 and 650 are valid here. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a27113e2d2a11d4a25b39de408949ac5f}\label{class_ogre_1_1_overlay_a27113e2d2a11d4a25b39de408949ac5f}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getZOrder@{getZOrder}}
\index{getZOrder@{getZOrder}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getZOrder()}{getZOrder()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort}} Ogre\+::\+Overlay\+::get\+Z\+Order (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the Z-\/order of this overlay. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a67425b4b8e3b9e614b498b40c8ada39c}\label{class_ogre_1_1_overlay_a67425b4b8e3b9e614b498b40c8ada39c}} 
\index{Ogre::Overlay@{Ogre::Overlay}!isVisible@{isVisible}}
\index{isVisible@{isVisible}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{isVisible()}{isVisible()}}
{\footnotesize\ttfamily bool Ogre\+::\+Overlay\+::is\+Visible (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets whether the overlay is displayed or not. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a40e4504c4421065e1ef7e5ddc78b8444}\label{class_ogre_1_1_overlay_a40e4504c4421065e1ef7e5ddc78b8444}} 
\index{Ogre::Overlay@{Ogre::Overlay}!isInitialised@{isInitialised}}
\index{isInitialised@{isInitialised}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{isInitialised()}{isInitialised()}}
{\footnotesize\ttfamily bool Ogre\+::\+Overlay\+::is\+Initialised (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets whether the overlay is initialised or not. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a3c565f3e5cf61f43fa33542d713e8ccf}\label{class_ogre_1_1_overlay_a3c565f3e5cf61f43fa33542d713e8ccf}} 
\index{Ogre::Overlay@{Ogre::Overlay}!show@{show}}
\index{show@{show}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{show()}{show()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::show (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Shows the overlay if it was hidden. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_ab210b07a317329bb66df4e674de2a367}\label{class_ogre_1_1_overlay_ab210b07a317329bb66df4e674de2a367}} 
\index{Ogre::Overlay@{Ogre::Overlay}!hide@{hide}}
\index{hide@{hide}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{hide()}{hide()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::hide (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Hides the overlay if it was visible. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a702b15ebaa6d3f8dbb2918500b76c9f0}\label{class_ogre_1_1_overlay_a702b15ebaa6d3f8dbb2918500b76c9f0}} 
\index{Ogre::Overlay@{Ogre::Overlay}!add2D@{add2D}}
\index{add2D@{add2D}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{add2D()}{add2D()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::add2D (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}} $\ast$}]{cont }\end{DoxyParamCaption})}



Adds a 2D \textquotesingle{}container\textquotesingle{} to the overlay. 

\begin{DoxyRemark}{Remarks}
Containers are created and managed using the \mbox{\hyperlink{class_ogre_1_1_overlay_manager}{Overlay\+Manager}}. A container could be as simple as a square panel, or something more complex like a grid or tree view. Containers group collections of other elements, giving them a relative coordinate space and a common z-\/order. If you want to attach a G\+UI widget to an overlay, you have to do it via a container. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em cont} & Pointer to a container to add, created using \mbox{\hyperlink{class_ogre_1_1_overlay_manager}{Overlay\+Manager}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a5c6182483591872da63ac4cea94671af}\label{class_ogre_1_1_overlay_a5c6182483591872da63ac4cea94671af}} 
\index{Ogre::Overlay@{Ogre::Overlay}!remove2D@{remove2D}}
\index{remove2D@{remove2D}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{remove2D()}{remove2D()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::remove2D (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}} $\ast$}]{cont }\end{DoxyParamCaption})}



Removes a 2D container from the overlay. 

\begin{DoxyRemark}{Remarks}
N\+OT F\+A\+ST. Consider \mbox{\hyperlink{class_ogre_1_1_overlay_element_a33d8945bd771e80d61bd3d36a32738eb}{Overlay\+Element\+::hide}}. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a296d54af42cc05fddd20e07b5209ab1a}\label{class_ogre_1_1_overlay_a296d54af42cc05fddd20e07b5209ab1a}} 
\index{Ogre::Overlay@{Ogre::Overlay}!add3D@{add3D}}
\index{add3D@{add3D}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{add3D()}{add3D()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::add3D (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} $\ast$}]{node }\end{DoxyParamCaption})}



Adds a node capable of holding 3D objects to the overlay. 

\begin{DoxyRemark}{Remarks}
~\newline
 Although overlays are traditionally associated with 2D elements, there are reasons why you might want to attach 3D elements to the overlay too. For example, if you wanted to have a 3D cockpit, which was overlaid with a H\+UD, then you would create 2 overlays, one with a 3D object attached for the cockpit, and one with the H\+UD elements attached (the zorder of the H\+UD overlay would be higher than the cockpit to ensure it was always on top). 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
~\newline
 A \mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} can have any number of 3D objects attached to it. Scene\+Nodes are usually created using \mbox{\hyperlink{class_ogre_1_1_scene_manager_ab31f9c018b801240c238c7a048439150}{Scene\+Manager\+::create\+Scene\+Node}}, but in this case you should create a standard \mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} instance {\bfseries{manually}}; this is because these scene nodes are not managed by the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} and some custom \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} plugins will rely on specialist behaviour the overlay does not support. By attaching a \mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} to an overlay, you indicate that\+:
\begin{DoxyEnumerate}
\item You want the contents of this node to only appear when the overlay is active 
\item You want the node to inherit a coordinate space relative to the camera, rather than relative to the root scene node 
\item You want these objects to be rendered after the contents of the main scene to ensure they are rendered on top 
\end{DoxyEnumerate}One major consideration when using 3D objects in overlays is the behaviour of the depth buffer. Overlays should use materials with depth checking off, to ensure that their contents are always displayed on top of the main scene (to do otherwise would result in objects \textquotesingle{}poking through\textquotesingle{} the overlay). The problem with using 3D objects is that if they are concave, or self-\/overlap, then you can get artefacts because of the lack of depth buffer checking. So you should ensure that any 3D objects you us in the overlay are convex, and don\textquotesingle{}t overlap each other. If they must overlap, split them up and put them in 2 overlays. Alternatively, use a 2D element underneath them which will clear the depth buffer values underneath ready for the 3D element to be rendered correctly. 
\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a2ff5331b691cd4f07ee66e63f237baef}\label{class_ogre_1_1_overlay_a2ff5331b691cd4f07ee66e63f237baef}} 
\index{Ogre::Overlay@{Ogre::Overlay}!remove3D@{remove3D}}
\index{remove3D@{remove3D}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{remove3D()}{remove3D()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::remove3D (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} $\ast$}]{node }\end{DoxyParamCaption})}



Removes a 3D element from the overlay. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a81c8a84fa283a0341a8c14b6c8168ccb}\label{class_ogre_1_1_overlay_a81c8a84fa283a0341a8c14b6c8168ccb}} 
\index{Ogre::Overlay@{Ogre::Overlay}!clear@{clear}}
\index{clear@{clear}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{clear()}{clear()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::clear (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Clears the overlay of all attached items. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_ae268ad3250bac5058c6d08e00c060289}\label{class_ogre_1_1_overlay_ae268ad3250bac5058c6d08e00c060289}} 
\index{Ogre::Overlay@{Ogre::Overlay}!setScroll@{setScroll}}
\index{setScroll@{setScroll}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{setScroll()}{setScroll()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::set\+Scroll (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{x,  }\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{y }\end{DoxyParamCaption})}



Sets the scrolling factor of this overlay. 

\begin{DoxyRemark}{Remarks}
You can use this to set an offset to be used to scroll an overlay around the screen. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em x} & Horizontal scroll value, where 0 = normal, -\/0.\+5 = scroll so that only the right half the screen is visible etc \\
\hline
{\em y} & Vertical scroll value, where 0 = normal, 0.\+5 = scroll down by half a screen etc. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_overlay_aa3b4520fdfd5eb8841ced874e470c4b4}\label{class_ogre_1_1_overlay_aa3b4520fdfd5eb8841ced874e470c4b4}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getScrollX@{getScrollX}}
\index{getScrollX@{getScrollX}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getScrollX()}{getScrollX()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} Ogre\+::\+Overlay\+::get\+ScrollX (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the current X scroll value. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a3476e577f32a23de48954723d6d2cfcd}\label{class_ogre_1_1_overlay_a3476e577f32a23de48954723d6d2cfcd}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getScrollY@{getScrollY}}
\index{getScrollY@{getScrollY}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getScrollY()}{getScrollY()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} Ogre\+::\+Overlay\+::get\+ScrollY (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the current Y scroll value. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_ae07b1a57498aad0299f0781b09ca9b39}\label{class_ogre_1_1_overlay_ae07b1a57498aad0299f0781b09ca9b39}} 
\index{Ogre::Overlay@{Ogre::Overlay}!scroll@{scroll}}
\index{scroll@{scroll}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{scroll()}{scroll()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::scroll (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{xoff,  }\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{yoff }\end{DoxyParamCaption})}



Scrolls the overlay by the offsets provided. 

\begin{DoxyRemark}{Remarks}
This method moves the overlay by the amounts provided. As with other methods on this object, a full screen width / height is represented by the value 1.\+0. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_overlay_a69d5f4c12c15f00efc7818d201e02e86}\label{class_ogre_1_1_overlay_a69d5f4c12c15f00efc7818d201e02e86}} 
\index{Ogre::Overlay@{Ogre::Overlay}!setRotate@{setRotate}}
\index{setRotate@{setRotate}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{setRotate()}{setRotate()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::set\+Rotate (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} \&}]{angle }\end{DoxyParamCaption})}



Sets the rotation applied to this overlay. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a5f7fbb799f4cee6415b223cc6fe1625e}\label{class_ogre_1_1_overlay_a5f7fbb799f4cee6415b223cc6fe1625e}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getRotate@{getRotate}}
\index{getRotate@{getRotate}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getRotate()}{getRotate()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}}\& Ogre\+::\+Overlay\+::get\+Rotate (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets the rotation applied to this overlay, in degrees. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a8282553a59253170ddd0488ab7179792}\label{class_ogre_1_1_overlay_a8282553a59253170ddd0488ab7179792}} 
\index{Ogre::Overlay@{Ogre::Overlay}!rotate@{rotate}}
\index{rotate@{rotate}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{rotate()}{rotate()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::rotate (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} \&}]{angle }\end{DoxyParamCaption})}



Adds the passed in angle to the rotation applied to this overlay. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_adea3b88baa3697a657e7b5785f0ffedb}\label{class_ogre_1_1_overlay_adea3b88baa3697a657e7b5785f0ffedb}} 
\index{Ogre::Overlay@{Ogre::Overlay}!setScale@{setScale}}
\index{setScale@{setScale}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{setScale()}{setScale()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::set\+Scale (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{x,  }\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{y }\end{DoxyParamCaption})}



Sets the scaling factor of this overlay. 

\begin{DoxyRemark}{Remarks}
You can use this to set an scale factor to be used to zoom an overlay. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em x} & Horizontal scale value, where 1.\+0 = normal, 0.\+5 = half size etc \\
\hline
{\em y} & Vertical scale value, where 1.\+0 = normal, 0.\+5 = half size etc \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_overlay_aa9b73c92c3a8e4ff41c65be87d545de6}\label{class_ogre_1_1_overlay_aa9b73c92c3a8e4ff41c65be87d545de6}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getScaleX@{getScaleX}}
\index{getScaleX@{getScaleX}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getScaleX()}{getScaleX()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} Ogre\+::\+Overlay\+::get\+ScaleX (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the current X scale value. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a5263af45959efb44ed9f9fdb96cecc14}\label{class_ogre_1_1_overlay_a5263af45959efb44ed9f9fdb96cecc14}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getScaleY@{getScaleY}}
\index{getScaleY@{getScaleY}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getScaleY()}{getScaleY()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} Ogre\+::\+Overlay\+::get\+ScaleY (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the current Y scale value. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a306fcb0e15b270f7cd1c436fbb3b7b54}\label{class_ogre_1_1_overlay_a306fcb0e15b270f7cd1c436fbb3b7b54}} 
\index{Ogre::Overlay@{Ogre::Overlay}!\_getWorldTransforms@{\_getWorldTransforms}}
\index{\_getWorldTransforms@{\_getWorldTransforms}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{\_getWorldTransforms()}{\_getWorldTransforms()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::\+\_\+get\+World\+Transforms (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$}]{xform }\end{DoxyParamCaption}) const}



Used to transform the overlay when scrolling, scaling etc. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a60564ce854e4a17f29a7af999ea50fda}\label{class_ogre_1_1_overlay_a60564ce854e4a17f29a7af999ea50fda}} 
\index{Ogre::Overlay@{Ogre::Overlay}!\_findVisibleObjects@{\_findVisibleObjects}}
\index{\_findVisibleObjects@{\_findVisibleObjects}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{\_findVisibleObjects()}{\_findVisibleObjects()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::\+\_\+find\+Visible\+Objects (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$}]{cam,  }\item[{\mbox{\hyperlink{class_ogre_1_1_render_queue}{Render\+Queue}} $\ast$}]{queue,  }\item[{\mbox{\hyperlink{class_ogre_1_1_viewport}{Viewport}} $\ast$}]{vp }\end{DoxyParamCaption})}



Internal method to put the overlay contents onto the render queue. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_aaf8b4bc3c953b8eeaf5ce8e6f3bfac9f}\label{class_ogre_1_1_overlay_aaf8b4bc3c953b8eeaf5ce8e6f3bfac9f}} 
\index{Ogre::Overlay@{Ogre::Overlay}!findElementAt@{findElementAt}}
\index{findElementAt@{findElementAt}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{findElementAt()}{findElementAt()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}}$\ast$ Ogre\+::\+Overlay\+::find\+Element\+At (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{x,  }\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{y }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



This returns a \mbox{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}} at position x,y. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_a22aa861e3d8e54211dbea41751c2f95a}\label{class_ogre_1_1_overlay_a22aa861e3d8e54211dbea41751c2f95a}} 
\index{Ogre::Overlay@{Ogre::Overlay}!get2DElements@{get2DElements}}
\index{get2DElements@{get2DElements}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{get2DElements()}{get2DElements()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{class_ogre_1_1_overlay_a8f3f648a05816f72743c966c51e948dd}{Overlay\+Container\+List}}\& Ogre\+::\+Overlay\+::get2\+D\+Elements (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns all 2D elements in this manager. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_aea5d72ca41e435998d6f0d5a3c736274}\label{class_ogre_1_1_overlay_aea5d72ca41e435998d6f0d5a3c736274}} 
\index{Ogre::Overlay@{Ogre::Overlay}!getOrigin@{getOrigin}}
\index{getOrigin@{getOrigin}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{getOrigin()}{getOrigin()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}}\& Ogre\+::\+Overlay\+::get\+Origin (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the origin of this overlay, e.\+g. 

a script file name. \begin{DoxyRemark}{Remarks}
This property will only contain something if the creator of this overlay chose to populate it. Script loaders are advised to populate it. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_overlay_ae48bf2a6596b514f95e9d3a437d8e1e0}\label{class_ogre_1_1_overlay_ae48bf2a6596b514f95e9d3a437d8e1e0}} 
\index{Ogre::Overlay@{Ogre::Overlay}!\_notifyOrigin@{\_notifyOrigin}}
\index{\_notifyOrigin@{\_notifyOrigin}!Ogre::Overlay@{Ogre::Overlay}}
\doxysubsubsection{\texorpdfstring{\_notifyOrigin()}{\_notifyOrigin()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+::\+\_\+notify\+Origin (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{origin }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Notify this overlay of it\textquotesingle{}s origin. 



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