\hypertarget{class_ogre_1_1_overlay_container}{}\section{Ogre\+:\+:Overlay\+Container Class Reference}
\label{class_ogre_1_1_overlay_container}\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}


A 2D element which contains other \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} instances.  




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



Inheritance diagram for Ogre\+:\+:Overlay\+Container\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_overlay_container__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef \hyperlink{class_ogre_1_1_map_iterator}{Map\+Iterator}$<$ \hyperlink{class_ogre_1_1_overlay_container_a9656b67c4beb90b991ac1595731f7143}{Child\+Container\+Map} $>$ \hyperlink{class_ogre_1_1_overlay_container_a000e571565ca93dc4ec617a32f632946}{Child\+Container\+Iterator}
\item 
typedef std\+::map$<$ \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}, \hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$ $>$ \hyperlink{class_ogre_1_1_overlay_container_a9656b67c4beb90b991ac1595731f7143}{Child\+Container\+Map}
\item 
typedef \hyperlink{class_ogre_1_1_map_iterator}{Map\+Iterator}$<$ \hyperlink{class_ogre_1_1_overlay_container_a774a54c9ca32f2107a1a391ca2439862}{Child\+Map} $>$ \hyperlink{class_ogre_1_1_overlay_container_aab02a8f87528fb846039ef718b4d3ba8}{Child\+Iterator}
\item 
typedef std\+::map$<$ \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}, \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$ $>$ \hyperlink{class_ogre_1_1_overlay_container_a774a54c9ca32f2107a1a391ca2439862}{Child\+Map}
\item 
typedef \hyperlink{class_ogre_1_1_shared_ptr}{Shared\+Ptr}$<$ \hyperlink{class_ogre_1_1_renderable_1_1_render_system_data}{Render\+System\+Data} $>$ \hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_overlay_container_a0f09017210064bf2fc19066e01f002d1}{Overlay\+Container} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name)
\begin{DoxyCompactList}\small\item\em Constructor\+: do not call direct, use \hyperlink{class_ogre_1_1_overlay_manager_a58166a773d27c22437323e8ef710406b}{Overlay\+Manager\+::create\+Overlay\+Element}. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_overlay_container_a3cd4e551ef0573d2158e14aecf94000f}{$\sim$\+Overlay\+Container} ()
\item 
void \hyperlink{class_ogre_1_1_overlay_container_a1b22eddee9083be54a60c09b3a129e9d}{\+\_\+add\+Child} (\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$elem)
\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a97b633566faac55256ad2bfe1dc3ae43}{\+\_\+get\+Clipping\+Region} (\hyperlink{group___general_ga3e1c672c1d342ffb4f122f44e342bc90}{Real\+Rect} \&clipping\+Region)
\begin{DoxyCompactList}\small\item\em Gets the clipping region of the element. \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_abbb23a245b83f33926222206f81f7496}{\+\_\+get\+Derived\+Left} (void)
\begin{DoxyCompactList}\small\item\em Gets the \textquotesingle{}left\textquotesingle{} position as derived from own left and that of parents. \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_a149ed9dba547535540a515c0936cc1f2}{\+\_\+get\+Derived\+Top} (void)
\begin{DoxyCompactList}\small\item\em Gets the \textquotesingle{}top\textquotesingle{} position as derived from own left and that of parents. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_ac8b8dd7b643fe7fa5b1e31bb0a0d570d}{\+\_\+get\+Height} (void) const
\begin{DoxyCompactList}\small\item\em Gets the height of this element in relation to the screen (where 1.\+0 = screen height) \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_afd5bad2f48558fedb9d76f5547214903}{\+\_\+get\+Left} (void) const
\begin{DoxyCompactList}\small\item\em Gets the left of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_a99536a748f2b9518ee323ca15bd80832}{\+\_\+get\+Relative\+Height} (void)
\begin{DoxyCompactList}\small\item\em Gets the \textquotesingle{}height\textquotesingle{} as derived from own height and metrics mode. \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_ad10ec98d6f8dd0906cb42f0f0b75eb8a}{\+\_\+get\+Relative\+Width} (void)
\begin{DoxyCompactList}\small\item\em Gets the \textquotesingle{}width\textquotesingle{} as derived from own width and metrics mode. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_a749d499624e7358cf1ac1d2d9bc90cf1}{\+\_\+get\+Top} (void) const
\begin{DoxyCompactList}\small\item\em Gets the top of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_a6f748e91dac18f0fdd80c97422d048c0}{\+\_\+get\+Width} (void) const
\begin{DoxyCompactList}\small\item\em Gets the width of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_a4914991f1125756625245adcbd80e541}{\+\_\+notify\+Parent} (\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$parent, \hyperlink{class_ogre_1_1_overlay}{Overlay} $\ast$overlay)
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_a6b6282e844bd8ee4161f8139a69c2431}{\+\_\+notify\+Viewport} ()
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_a59d52ac949c39a2dda2e4bb83b9f16b4}{\+\_\+notify\+World\+Transforms} (const \hyperlink{class_ogre_1_1_matrix4}{Matrix4} \&xform)
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} \hyperlink{class_ogre_1_1_overlay_container_a9e997f6bce139aa736aef6a32a8bcc01}{\+\_\+notify\+Z\+Order} (\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} new\+Z\+Order)
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_abde71af791eaecaefafe5bbb88da5ab2}{\+\_\+positions\+Out\+Of\+Date} (void)
\begin{DoxyCompactList}\small\item\em Tell the object and its children to recalculate. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a02a099eba37c9f0f0700919535af0821}{\+\_\+release\+Manual\+Hardware\+Resources} ()
\begin{DoxyCompactList}\small\item\em Notifies that hardware resources were lost. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_container_a1c4711038030d7464ca3c2b60c380175}{\+\_\+remove\+Child} (\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$elem)
\item 
void \hyperlink{class_ogre_1_1_overlay_container_a8453a3a1a55f906b8add0878233b1340}{\+\_\+remove\+Child} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name)
\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a581e6d515f04ce71f410711e828c3786}{\+\_\+restore\+Manual\+Hardware\+Resources} ()
\begin{DoxyCompactList}\small\item\em Notifies that hardware resources should be restored. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a7379d47f6b4ece51964f992cfa29fddb}{\+\_\+set\+Dimensions} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} width, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} height)
\begin{DoxyCompactList}\small\item\em Sets the width and height of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_af4378d361e04e03e1ca8c63c73e53fc4}{\+\_\+set\+Height} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} height)
\begin{DoxyCompactList}\small\item\em Sets the height of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a56d279033055d57e7872d00fea0a13e8}{\+\_\+set\+Left} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} left)
\begin{DoxyCompactList}\small\item\em Sets the left of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a950a51f806779b3ae50adc1cb05fff95}{\+\_\+set\+Parent} (\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$parent)
\item 
void \hyperlink{class_ogre_1_1_overlay_element_a0984444e5ea957fea4880a8a2855e5d3}{\+\_\+set\+Position} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} left, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} top)
\begin{DoxyCompactList}\small\item\em Sets the left and top of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a1d18a26a0680bd724220ea282722d48c}{\+\_\+set\+Top} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} top)
\begin{DoxyCompactList}\small\item\em Sets the top of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a65b2d7026e7e1a966f346d0500047989}{\+\_\+set\+Width} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} width)
\begin{DoxyCompactList}\small\item\em Sets the width of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_a94c71181fdb53c1057800b44f2098e9f}{\+\_\+update} (void)
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_renderable_a742052f8185975e8b92103c924b005d3}{\+\_\+update\+Custom\+Gpu\+Parameter} (const \hyperlink{class_ogre_1_1_gpu_program_parameters_1_1_auto_constant_entry}{Gpu\+Program\+Parameters\+::\+Auto\+Constant\+Entry} \&constant\+Entry, \hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters} $\ast$params) const
\begin{DoxyCompactList}\small\item\em Update a custom \hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters} constant which is derived from information only this \hyperlink{class_ogre_1_1_renderable}{Renderable} knows. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a98050c3c2f7e3bf91769e9f98c203e64}{\+\_\+update\+From\+Parent} (void)
\begin{DoxyCompactList}\small\item\em Updates this elements transform based on it\textquotesingle{}s parent. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_a617e36034a316252c1ea199815abba53}{\+\_\+update\+Render\+Queue} (\hyperlink{class_ogre_1_1_render_queue}{Render\+Queue} $\ast$queue)
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_aa9eec8f6dca98ac61766fc4785b84661}{add\+Child} (\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$elem)
\begin{DoxyCompactList}\small\item\em Adds another \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} to this container. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_ac3fe3b72570a82f97bd89032ba8ddd49}{add\+Child\+Impl} (\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$elem)
\begin{DoxyCompactList}\small\item\em Adds another \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} to this container. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_ad3694ec31ad22357270320457e6409a8}{add\+Child\+Impl} (\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$cont)
\begin{DoxyCompactList}\small\item\em Add a nested container to this container. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$ \hyperlink{class_ogre_1_1_overlay_container_a6fdeb7a613ce1ff5e5bb04b59e014fd6}{clone} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&instance\+Name)
\item 
virtual bool \hyperlink{class_ogre_1_1_overlay_element_aa6e49822c99b847fe7e5eb7b3bbc7035}{contains} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} x, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} y) const
\begin{DoxyCompactList}\small\item\em Returns true if xy is within the constraints of the component. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_container_a46f2140e07bf4dd584814a4edb2dcf1b}{copy\+From\+Template} (\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$template\+Overlay)
\item 
void \hyperlink{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}{copy\+Parameters\+To} (\hyperlink{class_ogre_1_1_string_interface}{String\+Interface} $\ast$dest) const
\begin{DoxyCompactList}\small\item\em Method for copying this object\textquotesingle{}s parameters to another object. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$ \hyperlink{class_ogre_1_1_overlay_container_a142c71975a49dc2712e71b7a15bb6ad6}{find\+Element\+At} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} x, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} y)
\begin{DoxyCompactList}\small\item\em This returns a \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} at position x,y. \end{DoxyCompactList}\item 
virtual const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Display\+String} \& \hyperlink{class_ogre_1_1_overlay_element_a71d6e12ca511ff55ba6638758ecb5d2c}{get\+Caption} (void) const
\begin{DoxyCompactList}\small\item\em Gets the caption for this element. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_renderable_a3d5e8933145d36977b8c2b64e307bc59}{get\+Casts\+Shadows} (void) const
\begin{DoxyCompactList}\small\item\em Method which reports whether this renderable would normally cast a shadow. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$ \hyperlink{class_ogre_1_1_overlay_container_afa199b851b646c4a17d182023f2a60ee}{get\+Child} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name)
\begin{DoxyCompactList}\small\item\em Gets the named child of this container. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_overlay_container_a000e571565ca93dc4ec617a32f632946}{Child\+Container\+Iterator} \hyperlink{class_ogre_1_1_overlay_container_a90e2ac9ae2779b4045c31a84025e8dc4}{get\+Child\+Container\+Iterator} (void)
\begin{DoxyCompactList}\small\item\em Gets an iterator for just the container children of this object. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_overlay_container_aab02a8f87528fb846039ef718b4d3ba8}{Child\+Iterator} \hyperlink{class_ogre_1_1_overlay_container_aef91545671c664dcd0511075ac309d36}{get\+Child\+Iterator} (void)
\begin{DoxyCompactList}\small\item\em Gets an object for iterating over all the children of this object. \end{DoxyCompactList}\item 
virtual const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \& \hyperlink{class_ogre_1_1_overlay_element_a95dd4d95ea99622dab22545b2e6c2d24}{get\+Colour} (void) const
\begin{DoxyCompactList}\small\item\em Gets the colour for this element. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_vector4}{Vector4} \& \hyperlink{class_ogre_1_1_renderable_ae3ad78c8e756ea5fb43d7830462abb1f}{get\+Custom\+Parameter} (size\+\_\+t index) const
\begin{DoxyCompactList}\small\item\em Gets the custom value associated with this \hyperlink{class_ogre_1_1_renderable}{Renderable} at the given index. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_a1fff3e0b4ad1470a0cb25a73779d3291}{get\+Height} (void) const
\begin{DoxyCompactList}\small\item\em Gets the height of this element in relation to the screen (where 1.\+0 = screen height) \end{DoxyCompactList}\item 
virtual \hyperlink{group___overlays_ga3396780cdb2d731aa5e4389148bdc5f3}{Gui\+Horizontal\+Alignment} \hyperlink{class_ogre_1_1_overlay_element_adb3d293046df601c1ab5c38ed6b2fb05}{get\+Horizontal\+Alignment} (void) const
\begin{DoxyCompactList}\small\item\em Gets the horizontal alignment for this element. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_aaf5fe0e1b686d33d2ecc7cb4b0569c80}{get\+Left} (void) const
\begin{DoxyCompactList}\small\item\em Gets the left of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) \end{DoxyCompactList}\item 
const \hyperlink{group___general_gaab30ef14aae93306a6044cb38d835f0c}{Light\+List} \& \hyperlink{class_ogre_1_1_overlay_element_ac284aa2a870b719353e73d424e3122ee}{get\+Lights} (void) const
\begin{DoxyCompactList}\small\item\em Gets a list of lights, ordered relative to how close they are to this renderable. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \& \hyperlink{class_ogre_1_1_overlay_element_a0d5508d74e0d742ed04ba5ba6c1a7113}{get\+Material} (void) const
\begin{DoxyCompactList}\small\item\em See \hyperlink{class_ogre_1_1_renderable}{Renderable}. \end{DoxyCompactList}\item 
virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_overlay_element_a5808d6a6f03a5844af55b99f326a7646}{get\+Material\+Name} (void) const
\begin{DoxyCompactList}\small\item\em Gets the name of the material this element uses. \end{DoxyCompactList}\item 
virtual \hyperlink{group___overlays_gaa7655e44eacdfd45427ff35bde855f36}{Gui\+Metrics\+Mode} \hyperlink{class_ogre_1_1_overlay_element_a25345420a3a217103f2624080cb48f45}{get\+Metrics\+Mode} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves the current settings of how the element metrics are interpreted. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_overlay_element_a8b3e2a88f0466020472aff121463d13f}{get\+Name} (void) const
\begin{DoxyCompactList}\small\item\em Gets the name of this overlay. \end{DoxyCompactList}\item 
virtual unsigned short \hyperlink{class_ogre_1_1_renderable_a47508d27a6c799998047c50ec43e9897}{get\+Num\+World\+Transforms} (void) const
\begin{DoxyCompactList}\small\item\em Returns the number of world transform matrices this renderable requires. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} $\ast$ \hyperlink{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}{get\+Param\+Dictionary} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the parameter dictionary for this class. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} $\ast$ \hyperlink{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}{get\+Param\+Dictionary} (void) const
\item 
\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \hyperlink{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}{get\+Parameter} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name) const
\begin{DoxyCompactList}\small\item\em Generic parameter retrieval method. \end{DoxyCompactList}\item 
const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List} \& \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{get\+Parameters} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a list of parameters valid for this object. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$ \hyperlink{class_ogre_1_1_overlay_element_a27ee755fb36de22d7866f1ca994d8391}{get\+Parent} ()
\begin{DoxyCompactList}\small\item\em Returns the parent container. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_renderable_ae944917873dd68126c129f05e51622d3}{get\+Polygon\+Mode\+Overrideable} (void) const
\begin{DoxyCompactList}\small\item\em Gets whether this renderable\textquotesingle{}s chosen detail level can be overridden (downgraded) by the camera setting. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_renderable_a3621cee2a019e59d3671c1a204caf4c7}{get\+Render\+Operation} (\hyperlink{class_ogre_1_1_render_operation}{Render\+Operation} \&op)=0
\begin{DoxyCompactList}\small\item\em Gets the render operation required to send this object to the frame buffer. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr} \& \hyperlink{class_ogre_1_1_renderable_a8043bede518f35c709880e4f3248a026}{get\+Render\+System\+Data} () const
\begin{DoxyCompactList}\small\item\em Gets \hyperlink{class_ogre_1_1_render_system}{Render\+System} private data. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$ \hyperlink{class_ogre_1_1_overlay_element_a6b27dcd535fa6377ca55dcf481563f8d}{get\+Source\+Template} () const
\begin{DoxyCompactList}\small\item\em Returns the Source\+Template for this element. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_adabf24ef7077a14dcc7a92a90dd04d07}{get\+Squared\+View\+Depth} (const \hyperlink{class_ogre_1_1_camera}{Camera} $\ast$cam) const
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_renderable}{Renderable}. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_technique}{Technique} $\ast$ \hyperlink{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}{get\+Technique} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a pointer to the \hyperlink{class_ogre_1_1_material}{Material} \hyperlink{class_ogre_1_1_technique}{Technique} this renderable object uses. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_ae88216e2bab2a230b25cc8341981a6c1}{get\+Top} (void) const
\begin{DoxyCompactList}\small\item\em Gets the top of this element in relation to the screen (where 0 = top, 1.\+0 = bottom) \end{DoxyCompactList}\item 
virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_overlay_element_a29106f2b51e110e0f159050df246b26f}{get\+Type\+Name} (void) const =0
\begin{DoxyCompactList}\small\item\em Gets the type name of the element. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_renderable_af630e6230261ecca2ecbfcf0b0ee9ce9}{get\+Use\+Identity\+Projection} (void) const
\begin{DoxyCompactList}\small\item\em Returns whether or not to use an \textquotesingle{}identity\textquotesingle{} projection. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_renderable_a869e7226c48fbff5dafef92b2b929b5e}{get\+Use\+Identity\+View} (void) const
\begin{DoxyCompactList}\small\item\em Returns whether or not to use an \textquotesingle{}identity\textquotesingle{} view. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_any}{Any} \& \hyperlink{class_ogre_1_1_renderable_a9cf204a5b5df75c8c745560551657358}{get\+User\+Any} (void) const
\item 
\hyperlink{class_ogre_1_1_user_object_bindings}{User\+Object\+Bindings} \& \hyperlink{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}{get\+User\+Object\+Bindings} ()
\begin{DoxyCompactList}\small\item\em Return an instance of user objects binding associated with this class. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_user_object_bindings}{User\+Object\+Bindings} \& \hyperlink{class_ogre_1_1_renderable_a472c926a6d05d05752fc195c8d606a85}{get\+User\+Object\+Bindings} () const
\begin{DoxyCompactList}\small\item\em Return an instance of user objects binding associated with this class. \end{DoxyCompactList}\item 
virtual \hyperlink{group___overlays_gab0815ab90a2d9635695ec7e20e6c372e}{Gui\+Vertical\+Alignment} \hyperlink{class_ogre_1_1_overlay_element_ac035cc5777b3b03fcec0e4173735929f}{get\+Vertical\+Alignment} (void) const
\begin{DoxyCompactList}\small\item\em Gets the vertical alignment for this element. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_overlay_element_a14e63d4c3d587b01ea94904a9e4d1c6b}{get\+Width} (void) const
\begin{DoxyCompactList}\small\item\em Gets the width of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_aab630843ec2ac1e18e4bd22f61f91527}{get\+World\+Transforms} (\hyperlink{class_ogre_1_1_matrix4}{Matrix4} $\ast$xform) const
\begin{DoxyCompactList}\small\item\em See \hyperlink{class_ogre_1_1_renderable}{Renderable}. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} \hyperlink{class_ogre_1_1_overlay_element_ad0eb53760ccf63b90ec10739a6ca0733}{get\+Z\+Order} () const
\begin{DoxyCompactList}\small\item\em Returns the z\+Order of the element. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_renderable_a812d3b0f5df694b92084a98387d8f215}{has\+Custom\+Parameter} (size\+\_\+t index) const
\begin{DoxyCompactList}\small\item\em Checks whether a custom value is associated with this \hyperlink{class_ogre_1_1_renderable}{Renderable} at the given index. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a33d8945bd771e80d61bd3d36a32738eb}{hide} (void)
\begin{DoxyCompactList}\small\item\em Hides this element if it was visible. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_container_a9cac0a3c00fea6445a697c5d9a0ec31b}{initialise} (void)
\begin{DoxyCompactList}\small\item\em Initialise gui element. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_overlay_container_a741d3800b0b91697befa270b2da1e660}{is\+Children\+Process\+Events} () const
\begin{DoxyCompactList}\small\item\em Should this container pass events to their children. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_overlay_element_a0e3fe5ec8406c5824cd4e4fa25f9e783}{is\+Cloneable} () const
\item 
bool \hyperlink{class_ogre_1_1_overlay_container_a2a11b6d6153cdada71a50c2fb3f13399}{is\+Container} () const
\begin{DoxyCompactList}\small\item\em Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_overlay_element_a84d6b68f81eebf46e42201d9a8a510ec}{is\+Enabled} () const
\item 
virtual bool \hyperlink{class_ogre_1_1_overlay_element_a74d4bfd771df0fedfc37fd79d968141d}{is\+Key\+Enabled} () const
\item 
bool \hyperlink{class_ogre_1_1_overlay_element_a623e4aa0f508e2079edc11bf8917b070}{is\+Visible} (void) const
\begin{DoxyCompactList}\small\item\em Returns whether or not the element is visible. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_renderable_a77230eea8136b7c296cc0a5db1dba9ee}{post\+Render} (\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} $\ast$sm, \hyperlink{class_ogre_1_1_render_system}{Render\+System} $\ast$rsys)
\begin{DoxyCompactList}\small\item\em Called immediately after the \hyperlink{class_ogre_1_1_renderable}{Renderable} has been rendered. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_renderable_afcbf4cb36d5911a9d40a40c57e94f23b}{pre\+Render} (\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} $\ast$sm, \hyperlink{class_ogre_1_1_render_system}{Render\+System} $\ast$rsys)
\begin{DoxyCompactList}\small\item\em Called just prior to the \hyperlink{class_ogre_1_1_renderable}{Renderable} being rendered. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_ab5e6dad5b67266583e13ad2374d0d74f}{remove\+Child} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name)
\begin{DoxyCompactList}\small\item\em Removes a named element from this container. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_renderable_a0c726a0326e8a7d9e80d030541b6bddf}{remove\+Custom\+Parameter} (size\+\_\+t index)
\begin{DoxyCompactList}\small\item\em Removes a custom value which is associated with this \hyperlink{class_ogre_1_1_renderable}{Renderable} at the given index. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_abcb1a77f5c2ed706e8374b9aa9ae8c90}{set\+Caption} (const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Display\+String} \&text)
\begin{DoxyCompactList}\small\item\em Sets the caption on elements that support it. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_container_acc3dbfd57c14ce83efcc89c22ef621b7}{set\+Children\+Process\+Events} (bool val)
\begin{DoxyCompactList}\small\item\em Should this container pass events to their children. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a5677c2c826a60e516aadececb38c86ab}{set\+Cloneable} (bool c)
\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a2a7bfb2c2dea0e1c13ce51d102967f61}{set\+Colour} (const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&col)
\begin{DoxyCompactList}\small\item\em Sets the colour on elements that support it. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_renderable_a572c0331ef2ec650d56063fdc17435f5}{set\+Custom\+Parameter} (size\+\_\+t index, const \hyperlink{class_ogre_1_1_vector4}{Vector4} \&value)
\begin{DoxyCompactList}\small\item\em Sets a custom parameter for this \hyperlink{class_ogre_1_1_renderable}{Renderable}, which may be used to drive calculations for this specific \hyperlink{class_ogre_1_1_renderable}{Renderable}, like G\+PU program parameters. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a4e88f177d868c60525d6905a40d786db}{set\+Dimensions} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} width, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} height)
\begin{DoxyCompactList}\small\item\em Sets the dimensions of this element in relation to the screen (1.\+0 = screen width/height). \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a153af53d919497af7340413866470613}{set\+Enabled} (bool b)
\item 
void \hyperlink{class_ogre_1_1_overlay_element_a8fde301c55f7eb5b89333bffceaab32d}{set\+Height} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} height)
\begin{DoxyCompactList}\small\item\em Sets the height of this element in relation to the screen (where 1.\+0 = screen height) \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a35178b40251066c1fd27d6573603638c}{set\+Horizontal\+Alignment} (\hyperlink{group___overlays_ga3396780cdb2d731aa5e4389148bdc5f3}{Gui\+Horizontal\+Alignment} gha)
\begin{DoxyCompactList}\small\item\em Sets the horizontal origin for this element. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_ae7b546ce6736b50bdcd5807d98cf156b}{set\+Left} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} left)
\begin{DoxyCompactList}\small\item\em Sets the left of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a1548c9c20d0c4e4ff2c73590681dbddb}{set\+Material} (const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \&mat)
\begin{DoxyCompactList}\small\item\em Sets the the material this element will use. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a5e792a41e37dd3c37cc3634cdc078ba2}{set\+Material\+Name} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&mat\+Name, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&group=\hyperlink{class_ogre_1_1_overlay_element_af7360f8bd59d3ffdefcaed91769b17dd}{D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP})
\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_aaced65311a9f2256254b63f7846340a9}{set\+Metrics\+Mode} (\hyperlink{group___overlays_gaa7655e44eacdfd45427ff35bde855f36}{Gui\+Metrics\+Mode} gmm)
\begin{DoxyCompactList}\small\item\em Tells this element how to interpret the position and dimension values it is given. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}{set\+Parameter} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&value)
\begin{DoxyCompactList}\small\item\em Generic parameter setting method. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}{set\+Parameter\+List} (const \hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List} \&param\+List)
\begin{DoxyCompactList}\small\item\em Generic multiple parameter setting method. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_renderable_a2f770d6ba9b3d97bdc63ecf0e3888aab}{set\+Polygon\+Mode\+Overrideable} (bool override)
\begin{DoxyCompactList}\small\item\em Sets whether this renderable\textquotesingle{}s chosen detail level can be overridden (downgraded) by the camera setting. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a1e819a321a51a47238428307510559b7}{set\+Position} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} left, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} top)
\begin{DoxyCompactList}\small\item\em Sets the position of the top-\/left corner of the element, relative to the screen size (1.\+0 = screen width / height) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_renderable_a3dc69374127d00ea2c2f9f39cf2105bb}{set\+Render\+System\+Data} (\hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr} val) const
\begin{DoxyCompactList}\small\item\em Sets \hyperlink{class_ogre_1_1_render_system}{Render\+System} private data. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a4e79181c0b92ef6a7ee05a558e4784aa}{set\+Top} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Top)
\begin{DoxyCompactList}\small\item\em Sets the top of this element in relation to the screen (where 0 = top, 1.\+0 = bottom) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_renderable_a4136ce4b9d3add5203339327015d872d}{set\+Use\+Identity\+Projection} (bool use\+Identity\+Projection)
\begin{DoxyCompactList}\small\item\em Sets whether or not to use an \textquotesingle{}identity\textquotesingle{} projection. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_renderable_ae53cff42a16304f582ef83ad3017d614}{set\+Use\+Identity\+View} (bool use\+Identity\+View)
\begin{DoxyCompactList}\small\item\em Sets whether or not to use an \textquotesingle{}identity\textquotesingle{} view. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_renderable_abd85c7ae6f5de865b8037f37e426886e}{set\+User\+Any} (const \hyperlink{class_ogre_1_1_any}{Any} \&anything)
\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_ad8950ca2d32913491c5064f3b5fffba9}{set\+Vertical\+Alignment} (\hyperlink{group___overlays_gab0815ab90a2d9635695ec7e20e6c372e}{Gui\+Vertical\+Alignment} gva)
\begin{DoxyCompactList}\small\item\em Sets the vertical origin for this element. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_a536908a4cdb6c35077dddbde9dda384b}{set\+Width} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} width)
\begin{DoxyCompactList}\small\item\em Sets the width of this element in relation to the screen (where 1.\+0 = screen width) \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_overlay_element_a85b9d78b68cffc0a3e0a967e31774243}{show} (void)
\begin{DoxyCompactList}\small\item\em Shows this element if it was hidden. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_overlay_element_af15092ccb2db4413a5d5a74f02ca5dfd}{visit\+Renderables} (\hyperlink{class_ogre_1_1_renderable_1_1_visitor}{Renderable\+::\+Visitor} $\ast$visitor, bool debug\+Renderables=false)
\begin{DoxyCompactList}\small\item\em Method to allow a caller to abstractly iterate over the \hyperlink{class_ogre_1_1_renderable}{Renderable} instances that this \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} will add to the render queue when asked, if any. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static void \hyperlink{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}{cleanup\+Dictionary} ()
\begin{DoxyCompactList}\small\item\em Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \hyperlink{namespace_ogre}{Ogre}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} implementers (e.\+g. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_overlay_element_af7360f8bd59d3ffdefcaed91769b17dd}{D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
A 2D element which contains other \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} instances. 

\begin{DoxyRemark}{Remarks}
This is a specialisation of \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} for 2D elements that contain other elements. These are also the smallest elements that can be attached directly to an \hyperlink{class_ogre_1_1_overlay}{Overlay}. 

Overlay\+Containers should be managed using \hyperlink{class_ogre_1_1_overlay_manager}{Overlay\+Manager}. This class is responsible for instantiating / deleting elements, and also for accepting new types of element from plugins etc. 
\end{DoxyRemark}


\subsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a774a54c9ca32f2107a1a391ca2439862}\label{class_ogre_1_1_overlay_container_a774a54c9ca32f2107a1a391ca2439862}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!Child\+Map@{Child\+Map}}
\index{Child\+Map@{Child\+Map}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{Child\+Map}{ChildMap}}
{\footnotesize\ttfamily typedef std\+::map$<$\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}, \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}$\ast$$>$ \hyperlink{class_ogre_1_1_overlay_container_a774a54c9ca32f2107a1a391ca2439862}{Ogre\+::\+Overlay\+Container\+::\+Child\+Map}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_aab02a8f87528fb846039ef718b4d3ba8}\label{class_ogre_1_1_overlay_container_aab02a8f87528fb846039ef718b4d3ba8}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!Child\+Iterator@{Child\+Iterator}}
\index{Child\+Iterator@{Child\+Iterator}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{Child\+Iterator}{ChildIterator}}
{\footnotesize\ttfamily typedef \hyperlink{class_ogre_1_1_map_iterator}{Map\+Iterator}$<$\hyperlink{class_ogre_1_1_overlay_container_a774a54c9ca32f2107a1a391ca2439862}{Child\+Map}$>$ \hyperlink{class_ogre_1_1_overlay_container_aab02a8f87528fb846039ef718b4d3ba8}{Ogre\+::\+Overlay\+Container\+::\+Child\+Iterator}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a9656b67c4beb90b991ac1595731f7143}\label{class_ogre_1_1_overlay_container_a9656b67c4beb90b991ac1595731f7143}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!Child\+Container\+Map@{Child\+Container\+Map}}
\index{Child\+Container\+Map@{Child\+Container\+Map}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{Child\+Container\+Map}{ChildContainerMap}}
{\footnotesize\ttfamily typedef std\+::map$<$\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}, \hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}$\ast$$>$ \hyperlink{class_ogre_1_1_overlay_container_a9656b67c4beb90b991ac1595731f7143}{Ogre\+::\+Overlay\+Container\+::\+Child\+Container\+Map}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a000e571565ca93dc4ec617a32f632946}\label{class_ogre_1_1_overlay_container_a000e571565ca93dc4ec617a32f632946}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!Child\+Container\+Iterator@{Child\+Container\+Iterator}}
\index{Child\+Container\+Iterator@{Child\+Container\+Iterator}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{Child\+Container\+Iterator}{ChildContainerIterator}}
{\footnotesize\ttfamily typedef \hyperlink{class_ogre_1_1_map_iterator}{Map\+Iterator}$<$\hyperlink{class_ogre_1_1_overlay_container_a9656b67c4beb90b991ac1595731f7143}{Child\+Container\+Map}$>$ \hyperlink{class_ogre_1_1_overlay_container_a000e571565ca93dc4ec617a32f632946}{Ogre\+::\+Overlay\+Container\+::\+Child\+Container\+Iterator}}

\mbox{\Hypertarget{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}\label{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!Render\+System\+Data\+Ptr@{Render\+System\+Data\+Ptr}}
\index{Render\+System\+Data\+Ptr@{Render\+System\+Data\+Ptr}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{Render\+System\+Data\+Ptr}{RenderSystemDataPtr}}
{\footnotesize\ttfamily typedef \hyperlink{class_ogre_1_1_shared_ptr}{Shared\+Ptr}$<$\hyperlink{class_ogre_1_1_renderable_1_1_render_system_data}{Render\+System\+Data}$>$ \hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Ogre\+::\+Renderable\+::\+Render\+System\+Data\+Ptr}\hspace{0.3cm}{\ttfamily [inherited]}}



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



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

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



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_overlay_container_aa9eec8f6dca98ac61766fc4785b84661}\label{class_ogre_1_1_overlay_container_aa9eec8f6dca98ac61766fc4785b84661}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!add\+Child@{add\+Child}}
\index{add\+Child@{add\+Child}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{add\+Child()}{addChild()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::add\+Child (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$}]{elem }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Adds another \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} to this container. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_ac3fe3b72570a82f97bd89032ba8ddd49}\label{class_ogre_1_1_overlay_container_ac3fe3b72570a82f97bd89032ba8ddd49}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!add\+Child\+Impl@{add\+Child\+Impl}}
\index{add\+Child\+Impl@{add\+Child\+Impl}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{add\+Child\+Impl()}{addChildImpl()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::add\+Child\+Impl (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$}]{elem }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Adds another \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} to this container. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_ad3694ec31ad22357270320457e6409a8}\label{class_ogre_1_1_overlay_container_ad3694ec31ad22357270320457e6409a8}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!add\+Child\+Impl@{add\+Child\+Impl}}
\index{add\+Child\+Impl@{add\+Child\+Impl}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{add\+Child\+Impl()}{addChildImpl()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::add\+Child\+Impl (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$}]{cont }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Add a nested container to this container. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_ab5e6dad5b67266583e13ad2374d0d74f}\label{class_ogre_1_1_overlay_container_ab5e6dad5b67266583e13ad2374d0d74f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!remove\+Child@{remove\+Child}}
\index{remove\+Child@{remove\+Child}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{remove\+Child()}{removeChild()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::remove\+Child (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Removes a named element from this container. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_afa199b851b646c4a17d182023f2a60ee}\label{class_ogre_1_1_overlay_container_afa199b851b646c4a17d182023f2a60ee}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Child@{get\+Child}}
\index{get\+Child@{get\+Child}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Child()}{getChild()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}$\ast$ Ogre\+::\+Overlay\+Container\+::get\+Child (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Gets the named child of this container. 

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



Initialise gui element. 



Implements \hyperlink{class_ogre_1_1_overlay_element_a6226080248f5cf285a21b3996e845564}{Ogre\+::\+Overlay\+Element}.



Reimplemented in \hyperlink{class_ogre_1_1_panel_overlay_element_a47197d5e8538f5b13d281bbf02233db3}{Ogre\+::\+Panel\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a1b22eddee9083be54a60c09b3a129e9d}\label{class_ogre_1_1_overlay_container_a1b22eddee9083be54a60c09b3a129e9d}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+add\+Child@{\+\_\+add\+Child}}
\index{\+\_\+add\+Child@{\+\_\+add\+Child}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+add\+Child()}{\_addChild()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Container\+::\+\_\+add\+Child (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$}]{elem }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a1c4711038030d7464ca3c2b60c380175}\label{class_ogre_1_1_overlay_container_a1c4711038030d7464ca3c2b60c380175}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+remove\+Child@{\+\_\+remove\+Child}}
\index{\+\_\+remove\+Child@{\+\_\+remove\+Child}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+remove\+Child()}{\_removeChild()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Container\+::\+\_\+remove\+Child (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$}]{elem }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



References \+\_\+remove\+Child(), and Ogre\+::\+Overlay\+Element\+::get\+Name().



Referenced by \+\_\+remove\+Child().

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a8453a3a1a55f906b8add0878233b1340}\label{class_ogre_1_1_overlay_container_a8453a3a1a55f906b8add0878233b1340}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+remove\+Child@{\+\_\+remove\+Child}}
\index{\+\_\+remove\+Child@{\+\_\+remove\+Child}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+remove\+Child()}{\_removeChild()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Container\+::\+\_\+remove\+Child (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_aef91545671c664dcd0511075ac309d36}\label{class_ogre_1_1_overlay_container_aef91545671c664dcd0511075ac309d36}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Child\+Iterator@{get\+Child\+Iterator}}
\index{get\+Child\+Iterator@{get\+Child\+Iterator}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Child\+Iterator()}{getChildIterator()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_overlay_container_aab02a8f87528fb846039ef718b4d3ba8}{Child\+Iterator} Ogre\+::\+Overlay\+Container\+::get\+Child\+Iterator (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Gets an object for iterating over all the children of this object. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a90e2ac9ae2779b4045c31a84025e8dc4}\label{class_ogre_1_1_overlay_container_a90e2ac9ae2779b4045c31a84025e8dc4}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Child\+Container\+Iterator@{get\+Child\+Container\+Iterator}}
\index{get\+Child\+Container\+Iterator@{get\+Child\+Container\+Iterator}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Child\+Container\+Iterator()}{getChildContainerIterator()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_overlay_container_a000e571565ca93dc4ec617a32f632946}{Child\+Container\+Iterator} Ogre\+::\+Overlay\+Container\+::get\+Child\+Container\+Iterator (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Gets an iterator for just the container children of this object. 

\begin{DoxyRemark}{Remarks}
Good for cascading updates without having to use R\+T\+TI 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_overlay_container_abde71af791eaecaefafe5bbb88da5ab2}\label{class_ogre_1_1_overlay_container_abde71af791eaecaefafe5bbb88da5ab2}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+positions\+Out\+Of\+Date@{\+\_\+positions\+Out\+Of\+Date}}
\index{\+\_\+positions\+Out\+Of\+Date@{\+\_\+positions\+Out\+Of\+Date}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+positions\+Out\+Of\+Date()}{\_positionsOutOfDate()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::\+\_\+positions\+Out\+Of\+Date (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Tell the object and its children to recalculate. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_a332f2ee98117ef701d8db7cc194a8f7d}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a94c71181fdb53c1057800b44f2098e9f}\label{class_ogre_1_1_overlay_container_a94c71181fdb53c1057800b44f2098e9f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+update@{\+\_\+update}}
\index{\+\_\+update@{\+\_\+update}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+update()}{\_update()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::\+\_\+update (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_ac2ac7daa6c0d03c72800fdde69c1636f}{Ogre\+::\+Overlay\+Element}.



Reimplemented in \hyperlink{class_ogre_1_1_border_panel_overlay_element_a99f805d644deeba4626100020eb1b141}{Ogre\+::\+Border\+Panel\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a9e997f6bce139aa736aef6a32a8bcc01}\label{class_ogre_1_1_overlay_container_a9e997f6bce139aa736aef6a32a8bcc01}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+notify\+Z\+Order@{\+\_\+notify\+Z\+Order}}
\index{\+\_\+notify\+Z\+Order@{\+\_\+notify\+Z\+Order}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+notify\+Z\+Order()}{\_notifyZOrder()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} Ogre\+::\+Overlay\+Container\+::\+\_\+notify\+Z\+Order (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort}}]{new\+Z\+Order }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_a712333ce516ee70e1ad7e72fd4bf0336}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a6b6282e844bd8ee4161f8139a69c2431}\label{class_ogre_1_1_overlay_container_a6b6282e844bd8ee4161f8139a69c2431}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+notify\+Viewport@{\+\_\+notify\+Viewport}}
\index{\+\_\+notify\+Viewport@{\+\_\+notify\+Viewport}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+notify\+Viewport()}{\_notifyViewport()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::\+\_\+notify\+Viewport (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_a6affb58cf2e01ef086baf8ba49ea0fe5}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a59d52ac949c39a2dda2e4bb83b9f16b4}\label{class_ogre_1_1_overlay_container_a59d52ac949c39a2dda2e4bb83b9f16b4}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+notify\+World\+Transforms@{\+\_\+notify\+World\+Transforms}}
\index{\+\_\+notify\+World\+Transforms@{\+\_\+notify\+World\+Transforms}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+notify\+World\+Transforms()}{\_notifyWorldTransforms()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::\+\_\+notify\+World\+Transforms (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_matrix4}{Matrix4} \&}]{xform }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_aee3b76c1c274a0995437e3e4bf095674}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a4914991f1125756625245adcbd80e541}\label{class_ogre_1_1_overlay_container_a4914991f1125756625245adcbd80e541}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+notify\+Parent@{\+\_\+notify\+Parent}}
\index{\+\_\+notify\+Parent@{\+\_\+notify\+Parent}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+notify\+Parent()}{\_notifyParent()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::\+\_\+notify\+Parent (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$}]{parent,  }\item[{\hyperlink{class_ogre_1_1_overlay}{Overlay} $\ast$}]{overlay }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_a30ed52ccd1e7911239a0cd0209ca5f09}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a617e36034a316252c1ea199815abba53}\label{class_ogre_1_1_overlay_container_a617e36034a316252c1ea199815abba53}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+update\+Render\+Queue@{\+\_\+update\+Render\+Queue}}
\index{\+\_\+update\+Render\+Queue@{\+\_\+update\+Render\+Queue}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+update\+Render\+Queue()}{\_updateRenderQueue()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::\+\_\+update\+Render\+Queue (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_render_queue}{Render\+Queue} $\ast$}]{queue }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_a278c8fdde2e52a5851bbd308cf3e6180}{Ogre\+::\+Overlay\+Element}.



Reimplemented in \hyperlink{class_ogre_1_1_border_panel_overlay_element_ab8e424c05e8311fe6ea5a4134fc8ea45}{Ogre\+::\+Border\+Panel\+Overlay\+Element}, and \hyperlink{class_ogre_1_1_panel_overlay_element_a55270b88fc4a02b0f6b8d2816aa36d28}{Ogre\+::\+Panel\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a2a11b6d6153cdada71a50c2fb3f13399}\label{class_ogre_1_1_overlay_container_a2a11b6d6153cdada71a50c2fb3f13399}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!is\+Container@{is\+Container}}
\index{is\+Container@{is\+Container}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{is\+Container()}{isContainer()}}
{\footnotesize\ttfamily bool Ogre\+::\+Overlay\+Container\+::is\+Container (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Overridden from \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}. 



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_af7bea868b91b54dd2ea9a2df3a96e2e0}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a741d3800b0b91697befa270b2da1e660}\label{class_ogre_1_1_overlay_container_a741d3800b0b91697befa270b2da1e660}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!is\+Children\+Process\+Events@{is\+Children\+Process\+Events}}
\index{is\+Children\+Process\+Events@{is\+Children\+Process\+Events}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{is\+Children\+Process\+Events()}{isChildrenProcessEvents()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Overlay\+Container\+::is\+Children\+Process\+Events (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Should this container pass events to their children. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_acc3dbfd57c14ce83efcc89c22ef621b7}\label{class_ogre_1_1_overlay_container_acc3dbfd57c14ce83efcc89c22ef621b7}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Children\+Process\+Events@{set\+Children\+Process\+Events}}
\index{set\+Children\+Process\+Events@{set\+Children\+Process\+Events}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Children\+Process\+Events()}{setChildrenProcessEvents()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Container\+::set\+Children\+Process\+Events (\begin{DoxyParamCaption}\item[{bool}]{val }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Should this container pass events to their children. 

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



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



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_afec476ad794323ca4c2a579390be2a9d}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a46f2140e07bf4dd584814a4edb2dcf1b}\label{class_ogre_1_1_overlay_container_a46f2140e07bf4dd584814a4edb2dcf1b}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!copy\+From\+Template@{copy\+From\+Template}}
\index{copy\+From\+Template@{copy\+From\+Template}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{copy\+From\+Template()}{copyFromTemplate()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Container\+::copy\+From\+Template (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} $\ast$}]{template\+Overlay }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_acdc6b75cd6f309b8af62a9e70e1e6a20}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_container_a6fdeb7a613ce1ff5e5bb04b59e014fd6}\label{class_ogre_1_1_overlay_container_a6fdeb7a613ce1ff5e5bb04b59e014fd6}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!clone@{clone}}
\index{clone@{clone}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{clone()}{clone()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}$\ast$ Ogre\+::\+Overlay\+Container\+::clone (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{instance\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reimplemented from \hyperlink{class_ogre_1_1_overlay_element_a8204a7415430d596be613b7669993944}{Ogre\+::\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a02a099eba37c9f0f0700919535af0821}\label{class_ogre_1_1_overlay_element_a02a099eba37c9f0f0700919535af0821}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+release\+Manual\+Hardware\+Resources@{\+\_\+release\+Manual\+Hardware\+Resources}}
\index{\+\_\+release\+Manual\+Hardware\+Resources@{\+\_\+release\+Manual\+Hardware\+Resources}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+release\+Manual\+Hardware\+Resources()}{\_releaseManualHardwareResources()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::\+\_\+release\+Manual\+Hardware\+Resources (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Notifies that hardware resources were lost. 



Reimplemented in \hyperlink{class_ogre_1_1_panel_overlay_element_afc03fc37949c1f977dd8d9c9d7465688}{Ogre\+::\+Panel\+Overlay\+Element}, \hyperlink{class_ogre_1_1_border_panel_overlay_element_a0951728a2782426b57bc346141a532dd}{Ogre\+::\+Border\+Panel\+Overlay\+Element}, and \hyperlink{class_ogre_1_1_text_area_overlay_element_a8168ba395517d0e1e55ffe3e60c7fdf1}{Ogre\+::\+Text\+Area\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a581e6d515f04ce71f410711e828c3786}\label{class_ogre_1_1_overlay_element_a581e6d515f04ce71f410711e828c3786}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+restore\+Manual\+Hardware\+Resources@{\+\_\+restore\+Manual\+Hardware\+Resources}}
\index{\+\_\+restore\+Manual\+Hardware\+Resources@{\+\_\+restore\+Manual\+Hardware\+Resources}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+restore\+Manual\+Hardware\+Resources()}{\_restoreManualHardwareResources()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::\+\_\+restore\+Manual\+Hardware\+Resources (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Notifies that hardware resources should be restored. 



Reimplemented in \hyperlink{class_ogre_1_1_panel_overlay_element_ac7c2fdaa5fbf32c456f8f3cddcbc5a70}{Ogre\+::\+Panel\+Overlay\+Element}, \hyperlink{class_ogre_1_1_border_panel_overlay_element_a34f87bb5dee0eeaddefa30c7251e9dd7}{Ogre\+::\+Border\+Panel\+Overlay\+Element}, and \hyperlink{class_ogre_1_1_text_area_overlay_element_a0ebce9dc210cf2461130bac8bc91e10e}{Ogre\+::\+Text\+Area\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a8b3e2a88f0466020472aff121463d13f}\label{class_ogre_1_1_overlay_element_a8b3e2a88f0466020472aff121463d13f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Name@{get\+Name}}
\index{get\+Name@{get\+Name}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Name()}{getName()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Overlay\+Element\+::get\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Gets the name of this overlay. 



Referenced by \+\_\+remove\+Child().

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a85b9d78b68cffc0a3e0a967e31774243}\label{class_ogre_1_1_overlay_element_a85b9d78b68cffc0a3e0a967e31774243}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!show@{show}}
\index{show@{show}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{show()}{show()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::show (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Shows this element if it was hidden. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a33d8945bd771e80d61bd3d36a32738eb}\label{class_ogre_1_1_overlay_element_a33d8945bd771e80d61bd3d36a32738eb}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!hide@{hide}}
\index{hide@{hide}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{hide()}{hide()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::hide (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Hides this element if it was visible. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a623e4aa0f508e2079edc11bf8917b070}\label{class_ogre_1_1_overlay_element_a623e4aa0f508e2079edc11bf8917b070}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!is\+Visible@{is\+Visible}}
\index{is\+Visible@{is\+Visible}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{is\+Visible()}{isVisible()}}
{\footnotesize\ttfamily bool Ogre\+::\+Overlay\+Element\+::is\+Visible (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Returns whether or not the element is visible. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a84d6b68f81eebf46e42201d9a8a510ec}\label{class_ogre_1_1_overlay_element_a84d6b68f81eebf46e42201d9a8a510ec}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!is\+Enabled@{is\+Enabled}}
\index{is\+Enabled@{is\+Enabled}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{is\+Enabled()}{isEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Overlay\+Element\+::is\+Enabled (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a153af53d919497af7340413866470613}\label{class_ogre_1_1_overlay_element_a153af53d919497af7340413866470613}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Enabled@{set\+Enabled}}
\index{set\+Enabled@{set\+Enabled}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Enabled()}{setEnabled()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::set\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{b }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a4e88f177d868c60525d6905a40d786db}\label{class_ogre_1_1_overlay_element_a4e88f177d868c60525d6905a40d786db}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Dimensions@{set\+Dimensions}}
\index{set\+Dimensions@{set\+Dimensions}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Dimensions()}{setDimensions()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Dimensions (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{width,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{height }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the dimensions of this element in relation to the screen (1.\+0 = screen width/height). 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a1e819a321a51a47238428307510559b7}\label{class_ogre_1_1_overlay_element_a1e819a321a51a47238428307510559b7}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Position@{set\+Position}}
\index{set\+Position@{set\+Position}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Position()}{setPosition()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Position (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{left,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{top }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the position of the top-\/left corner of the element, relative to the screen size (1.\+0 = screen width / height) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a536908a4cdb6c35077dddbde9dda384b}\label{class_ogre_1_1_overlay_element_a536908a4cdb6c35077dddbde9dda384b}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Width@{set\+Width}}
\index{set\+Width@{set\+Width}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Width()}{setWidth()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Width (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{width }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the width of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a14e63d4c3d587b01ea94904a9e4d1c6b}\label{class_ogre_1_1_overlay_element_a14e63d4c3d587b01ea94904a9e4d1c6b}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Width@{get\+Width}}
\index{get\+Width@{get\+Width}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Width()}{getWidth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::get\+Width (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Gets the width of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a8fde301c55f7eb5b89333bffceaab32d}\label{class_ogre_1_1_overlay_element_a8fde301c55f7eb5b89333bffceaab32d}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Height@{set\+Height}}
\index{set\+Height@{set\+Height}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Height()}{setHeight()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Height (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{height }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the height of this element in relation to the screen (where 1.\+0 = screen height) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a1fff3e0b4ad1470a0cb25a73779d3291}\label{class_ogre_1_1_overlay_element_a1fff3e0b4ad1470a0cb25a73779d3291}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Height@{get\+Height}}
\index{get\+Height@{get\+Height}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Height()}{getHeight()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::get\+Height (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Gets the height of this element in relation to the screen (where 1.\+0 = screen height) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ae7b546ce6736b50bdcd5807d98cf156b}\label{class_ogre_1_1_overlay_element_ae7b546ce6736b50bdcd5807d98cf156b}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Left@{set\+Left}}
\index{set\+Left@{set\+Left}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Left()}{setLeft()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Left (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{left }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the left of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_aaf5fe0e1b686d33d2ecc7cb4b0569c80}\label{class_ogre_1_1_overlay_element_aaf5fe0e1b686d33d2ecc7cb4b0569c80}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Left@{get\+Left}}
\index{get\+Left@{get\+Left}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Left()}{getLeft()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::get\+Left (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Gets the left of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a4e79181c0b92ef6a7ee05a558e4784aa}\label{class_ogre_1_1_overlay_element_a4e79181c0b92ef6a7ee05a558e4784aa}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Top@{set\+Top}}
\index{set\+Top@{set\+Top}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Top()}{setTop()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Top (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{Top }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the top of this element in relation to the screen (where 0 = top, 1.\+0 = bottom) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ae88216e2bab2a230b25cc8341981a6c1}\label{class_ogre_1_1_overlay_element_ae88216e2bab2a230b25cc8341981a6c1}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Top@{get\+Top}}
\index{get\+Top@{get\+Top}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Top()}{getTop()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::get\+Top (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Gets the top of this element in relation to the screen (where 0 = top, 1.\+0 = bottom) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_afd5bad2f48558fedb9d76f5547214903}\label{class_ogre_1_1_overlay_element_afd5bad2f48558fedb9d76f5547214903}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Left@{\+\_\+get\+Left}}
\index{\+\_\+get\+Left@{\+\_\+get\+Left}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Left()}{\_getLeft()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Left (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets the left of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a749d499624e7358cf1ac1d2d9bc90cf1}\label{class_ogre_1_1_overlay_element_a749d499624e7358cf1ac1d2d9bc90cf1}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Top@{\+\_\+get\+Top}}
\index{\+\_\+get\+Top@{\+\_\+get\+Top}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Top()}{\_getTop()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Top (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets the top of this element in relation to the screen (where 0 = far left, 1.\+0 = far right) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a6f748e91dac18f0fdd80c97422d048c0}\label{class_ogre_1_1_overlay_element_a6f748e91dac18f0fdd80c97422d048c0}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Width@{\+\_\+get\+Width}}
\index{\+\_\+get\+Width@{\+\_\+get\+Width}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Width()}{\_getWidth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Width (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets the width of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ac8b8dd7b643fe7fa5b1e31bb0a0d570d}\label{class_ogre_1_1_overlay_element_ac8b8dd7b643fe7fa5b1e31bb0a0d570d}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Height@{\+\_\+get\+Height}}
\index{\+\_\+get\+Height@{\+\_\+get\+Height}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Height()}{\_getHeight()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Height (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets the height of this element in relation to the screen (where 1.\+0 = screen height) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a56d279033055d57e7872d00fea0a13e8}\label{class_ogre_1_1_overlay_element_a56d279033055d57e7872d00fea0a13e8}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+set\+Left@{\+\_\+set\+Left}}
\index{\+\_\+set\+Left@{\+\_\+set\+Left}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+set\+Left()}{\_setLeft()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::\+\_\+set\+Left (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{left }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the left of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a1d18a26a0680bd724220ea282722d48c}\label{class_ogre_1_1_overlay_element_a1d18a26a0680bd724220ea282722d48c}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+set\+Top@{\+\_\+set\+Top}}
\index{\+\_\+set\+Top@{\+\_\+set\+Top}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+set\+Top()}{\_setTop()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::\+\_\+set\+Top (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{top }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the top of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a65b2d7026e7e1a966f346d0500047989}\label{class_ogre_1_1_overlay_element_a65b2d7026e7e1a966f346d0500047989}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+set\+Width@{\+\_\+set\+Width}}
\index{\+\_\+set\+Width@{\+\_\+set\+Width}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+set\+Width()}{\_setWidth()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::\+\_\+set\+Width (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{width }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the width of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_af4378d361e04e03e1ca8c63c73e53fc4}\label{class_ogre_1_1_overlay_element_af4378d361e04e03e1ca8c63c73e53fc4}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+set\+Height@{\+\_\+set\+Height}}
\index{\+\_\+set\+Height@{\+\_\+set\+Height}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+set\+Height()}{\_setHeight()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::\+\_\+set\+Height (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{height }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the height of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a0984444e5ea957fea4880a8a2855e5d3}\label{class_ogre_1_1_overlay_element_a0984444e5ea957fea4880a8a2855e5d3}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+set\+Position@{\+\_\+set\+Position}}
\index{\+\_\+set\+Position@{\+\_\+set\+Position}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+set\+Position()}{\_setPosition()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::\+\_\+set\+Position (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{left,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{top }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the left and top of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a7379d47f6b4ece51964f992cfa29fddb}\label{class_ogre_1_1_overlay_element_a7379d47f6b4ece51964f992cfa29fddb}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+set\+Dimensions@{\+\_\+set\+Dimensions}}
\index{\+\_\+set\+Dimensions@{\+\_\+set\+Dimensions}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+set\+Dimensions()}{\_setDimensions()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::\+\_\+set\+Dimensions (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{width,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{height }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the width and height of this element in relation to the screen (where 1.\+0 = screen width) 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a5808d6a6f03a5844af55b99f326a7646}\label{class_ogre_1_1_overlay_element_a5808d6a6f03a5844af55b99f326a7646}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Material\+Name@{get\+Material\+Name}}
\index{get\+Material\+Name@{get\+Material\+Name}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Material\+Name()}{getMaterialName()}}
{\footnotesize\ttfamily virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Overlay\+Element\+::get\+Material\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the name of the material this element uses. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a1548c9c20d0c4e4ff2c73590681dbddb}\label{class_ogre_1_1_overlay_element_a1548c9c20d0c4e4ff2c73590681dbddb}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Material@{set\+Material}}
\index{set\+Material@{set\+Material}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Material()}{setMaterial()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Material (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \&}]{mat }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Sets the the material this element will use. 

\begin{DoxyRemark}{Remarks}
Different elements will use different materials. One constant about them all though is that a \hyperlink{class_ogre_1_1_material}{Material} used for a \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} must have it\textquotesingle{}s depth checking set to \textquotesingle{}off\textquotesingle{}, which means it always gets rendered on top. O\+G\+RE will set this flag for you if necessary. What it does mean though is that you should not use the same \hyperlink{class_ogre_1_1_material}{Material} for rendering Overlay\+Elements as standard scene objects. It\textquotesingle{}s fine to use the same textures, just not the same \hyperlink{class_ogre_1_1_material}{Material}. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a5e792a41e37dd3c37cc3634cdc078ba2}\label{class_ogre_1_1_overlay_element_a5e792a41e37dd3c37cc3634cdc078ba2}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Material\+Name@{set\+Material\+Name}}
\index{set\+Material\+Name@{set\+Material\+Name}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Material\+Name()}{setMaterialName()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::set\+Material\+Name (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{mat\+Name,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{group = {\ttfamily \hyperlink{class_ogre_1_1_overlay_element_af7360f8bd59d3ffdefcaed91769b17dd}{D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \mbox{\Hypertarget{class_ogre_1_1_overlay_element_a0d5508d74e0d742ed04ba5ba6c1a7113}\label{class_ogre_1_1_overlay_element_a0d5508d74e0d742ed04ba5ba6c1a7113}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Material@{get\+Material}}
\index{get\+Material@{get\+Material}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Material()}{getMaterial()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}\& Ogre\+::\+Overlay\+Element\+::get\+Material (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



See \hyperlink{class_ogre_1_1_renderable}{Renderable}. 



Implements \hyperlink{class_ogre_1_1_renderable_a7132944645c7b62d6b2bfff6a64fad31}{Ogre\+::\+Renderable}.



Reimplemented in \hyperlink{class_ogre_1_1_text_area_overlay_element_aedd9f92ea4ef4e5420d709449cd1de9a}{Ogre\+::\+Text\+Area\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_aab630843ec2ac1e18e4bd22f61f91527}\label{class_ogre_1_1_overlay_element_aab630843ec2ac1e18e4bd22f61f91527}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+World\+Transforms@{get\+World\+Transforms}}
\index{get\+World\+Transforms@{get\+World\+Transforms}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+World\+Transforms()}{getWorldTransforms()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::get\+World\+Transforms (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_matrix4}{Matrix4} $\ast$}]{xform }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



See \hyperlink{class_ogre_1_1_renderable}{Renderable}. 



Implements \hyperlink{class_ogre_1_1_renderable_a897d64f73a5e6ccc45d52a88e86392e1}{Ogre\+::\+Renderable}.



Referenced by Ogre\+::\+Border\+Renderable\+::get\+World\+Transforms().

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a98050c3c2f7e3bf91769e9f98c203e64}\label{class_ogre_1_1_overlay_element_a98050c3c2f7e3bf91769e9f98c203e64}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+update\+From\+Parent@{\+\_\+update\+From\+Parent}}
\index{\+\_\+update\+From\+Parent@{\+\_\+update\+From\+Parent}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+update\+From\+Parent()}{\_updateFromParent()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::\+\_\+update\+From\+Parent (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Updates this elements transform based on it\textquotesingle{}s parent. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_abbb23a245b83f33926222206f81f7496}\label{class_ogre_1_1_overlay_element_abbb23a245b83f33926222206f81f7496}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Derived\+Left@{\+\_\+get\+Derived\+Left}}
\index{\+\_\+get\+Derived\+Left@{\+\_\+get\+Derived\+Left}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Derived\+Left()}{\_getDerivedLeft()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Derived\+Left (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the \textquotesingle{}left\textquotesingle{} position as derived from own left and that of parents. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a149ed9dba547535540a515c0936cc1f2}\label{class_ogre_1_1_overlay_element_a149ed9dba547535540a515c0936cc1f2}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Derived\+Top@{\+\_\+get\+Derived\+Top}}
\index{\+\_\+get\+Derived\+Top@{\+\_\+get\+Derived\+Top}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Derived\+Top()}{\_getDerivedTop()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Derived\+Top (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the \textquotesingle{}top\textquotesingle{} position as derived from own left and that of parents. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ad10ec98d6f8dd0906cb42f0f0b75eb8a}\label{class_ogre_1_1_overlay_element_ad10ec98d6f8dd0906cb42f0f0b75eb8a}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Relative\+Width@{\+\_\+get\+Relative\+Width}}
\index{\+\_\+get\+Relative\+Width@{\+\_\+get\+Relative\+Width}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Relative\+Width()}{\_getRelativeWidth()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Relative\+Width (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the \textquotesingle{}width\textquotesingle{} as derived from own width and metrics mode. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a99536a748f2b9518ee323ca15bd80832}\label{class_ogre_1_1_overlay_element_a99536a748f2b9518ee323ca15bd80832}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Relative\+Height@{\+\_\+get\+Relative\+Height}}
\index{\+\_\+get\+Relative\+Height@{\+\_\+get\+Relative\+Height}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Relative\+Height()}{\_getRelativeHeight()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Relative\+Height (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the \textquotesingle{}height\textquotesingle{} as derived from own height and metrics mode. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a97b633566faac55256ad2bfe1dc3ae43}\label{class_ogre_1_1_overlay_element_a97b633566faac55256ad2bfe1dc3ae43}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+get\+Clipping\+Region@{\+\_\+get\+Clipping\+Region}}
\index{\+\_\+get\+Clipping\+Region@{\+\_\+get\+Clipping\+Region}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+get\+Clipping\+Region()}{\_getClippingRegion()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::\+\_\+get\+Clipping\+Region (\begin{DoxyParamCaption}\item[{\hyperlink{group___general_ga3e1c672c1d342ffb4f122f44e342bc90}{Real\+Rect} \&}]{clipping\+Region }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the clipping region of the element. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_af15092ccb2db4413a5d5a74f02ca5dfd}\label{class_ogre_1_1_overlay_element_af15092ccb2db4413a5d5a74f02ca5dfd}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!visit\+Renderables@{visit\+Renderables}}
\index{visit\+Renderables@{visit\+Renderables}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{visit\+Renderables()}{visitRenderables()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::visit\+Renderables (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_renderable_1_1_visitor}{Renderable\+::\+Visitor} $\ast$}]{visitor,  }\item[{bool}]{debug\+Renderables = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Method to allow a caller to abstractly iterate over the \hyperlink{class_ogre_1_1_renderable}{Renderable} instances that this \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} will add to the render queue when asked, if any. 


\begin{DoxyParams}{Parameters}
{\em visitor} & Pointer to a class implementing the \hyperlink{class_ogre_1_1_renderable_1_1_visitor}{Renderable\+::\+Visitor} interface which will be called back for each \hyperlink{class_ogre_1_1_renderable}{Renderable} which will be queued. Bear in mind that the state of the \hyperlink{class_ogre_1_1_renderable}{Renderable} instances may not be finalised depending on when you call this. \\
\hline
{\em debug\+Renderables} & If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a29106f2b51e110e0f159050df246b26f}\label{class_ogre_1_1_overlay_element_a29106f2b51e110e0f159050df246b26f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Type\+Name@{get\+Type\+Name}}
\index{get\+Type\+Name@{get\+Type\+Name}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Type\+Name()}{getTypeName()}}
{\footnotesize\ttfamily virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Overlay\+Element\+::get\+Type\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}, {\ttfamily [inherited]}}



Gets the type name of the element. 

All concrete subclasses must implement this. 

Implemented in \hyperlink{class_ogre_1_1_panel_overlay_element_a6586e759ef81a128de5bf89e9b38317b}{Ogre\+::\+Panel\+Overlay\+Element}, \hyperlink{class_ogre_1_1_text_area_overlay_element_ae51e9863ef4eeaa133145908b9947b3d}{Ogre\+::\+Text\+Area\+Overlay\+Element}, and \hyperlink{class_ogre_1_1_border_panel_overlay_element_a9affa49c78bfbd7e02fd8a817432d431}{Ogre\+::\+Border\+Panel\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_abcb1a77f5c2ed706e8374b9aa9ae8c90}\label{class_ogre_1_1_overlay_element_abcb1a77f5c2ed706e8374b9aa9ae8c90}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Caption@{set\+Caption}}
\index{set\+Caption@{set\+Caption}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Caption()}{setCaption()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::set\+Caption (\begin{DoxyParamCaption}\item[{const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Display\+String} \&}]{text }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets the caption on elements that support it. 

\begin{DoxyRemark}{Remarks}
This property doesn\textquotesingle{}t do something on all elements, just those that support it. However, being a common requirement it is in the top-\/level interface to avoid having to set it via the \hyperlink{class_ogre_1_1_string_interface}{String\+Interface} all the time. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_text_area_overlay_element_a8be256d62aaf9c363957b4f99b322e33}{Ogre\+::\+Text\+Area\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a71d6e12ca511ff55ba6638758ecb5d2c}\label{class_ogre_1_1_overlay_element_a71d6e12ca511ff55ba6638758ecb5d2c}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Caption@{get\+Caption}}
\index{get\+Caption@{get\+Caption}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Caption()}{getCaption()}}
{\footnotesize\ttfamily virtual const \hyperlink{group___overlays_ga12ec415f18ba8932c5e0bfa49036fc5b}{Display\+String}\& Ogre\+::\+Overlay\+Element\+::get\+Caption (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the caption for this element. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a2a7bfb2c2dea0e1c13ce51d102967f61}\label{class_ogre_1_1_overlay_element_a2a7bfb2c2dea0e1c13ce51d102967f61}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Colour@{set\+Colour}}
\index{set\+Colour@{set\+Colour}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Colour()}{setColour()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::set\+Colour (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&}]{col }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets the colour on elements that support it. 

\begin{DoxyRemark}{Remarks}
This property doesn\textquotesingle{}t do something on all elements, just those that support it. However, being a common requirement it is in the top-\/level interface to avoid having to set it via the \hyperlink{class_ogre_1_1_string_interface}{String\+Interface} all the time. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_text_area_overlay_element_ac4e71a50cdcffc080da0ec4061cbae29}{Ogre\+::\+Text\+Area\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a95dd4d95ea99622dab22545b2e6c2d24}\label{class_ogre_1_1_overlay_element_a95dd4d95ea99622dab22545b2e6c2d24}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Colour@{get\+Colour}}
\index{get\+Colour@{get\+Colour}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Colour()}{getColour()}}
{\footnotesize\ttfamily virtual const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}\& Ogre\+::\+Overlay\+Element\+::get\+Colour (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the colour for this element. 



Reimplemented in \hyperlink{class_ogre_1_1_text_area_overlay_element_a43574b610df98a2eba2fe54f46e15b1b}{Ogre\+::\+Text\+Area\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_aaced65311a9f2256254b63f7846340a9}\label{class_ogre_1_1_overlay_element_aaced65311a9f2256254b63f7846340a9}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Metrics\+Mode@{set\+Metrics\+Mode}}
\index{set\+Metrics\+Mode@{set\+Metrics\+Mode}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Metrics\+Mode()}{setMetricsMode()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::set\+Metrics\+Mode (\begin{DoxyParamCaption}\item[{\hyperlink{group___overlays_gaa7655e44eacdfd45427ff35bde855f36}{Gui\+Metrics\+Mode}}]{gmm }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Tells this element how to interpret the position and dimension values it is given. 

\begin{DoxyRemark}{Remarks}
By default, Overlay\+Elements are positioned and sized according to relative dimensions of the screen. This is to ensure portability between different resolutions when you want things to be positioned and sized the same way across all resolutions. However, sometimes you want things to be sized according to fixed pixels. In order to do this, you can call this method with the parameter G\+M\+M\+\_\+\+P\+I\+X\+E\+LS. Note that if you then want to place your element relative to the center, right or bottom of it\textquotesingle{}s parent, you will need to use the set\+Horizontal\+Alignment and set\+Vertical\+Alignment methods. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_border_panel_overlay_element_a5c0cf38bdc01f45b238a2e6ce0d8117d}{Ogre\+::\+Border\+Panel\+Overlay\+Element}, and \hyperlink{class_ogre_1_1_text_area_overlay_element_a1b0c7cd37893cb1f27114121bd4edd46}{Ogre\+::\+Text\+Area\+Overlay\+Element}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a25345420a3a217103f2624080cb48f45}\label{class_ogre_1_1_overlay_element_a25345420a3a217103f2624080cb48f45}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Metrics\+Mode@{get\+Metrics\+Mode}}
\index{get\+Metrics\+Mode@{get\+Metrics\+Mode}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Metrics\+Mode()}{getMetricsMode()}}
{\footnotesize\ttfamily virtual \hyperlink{group___overlays_gaa7655e44eacdfd45427ff35bde855f36}{Gui\+Metrics\+Mode} Ogre\+::\+Overlay\+Element\+::get\+Metrics\+Mode (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Retrieves the current settings of how the element metrics are interpreted. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a35178b40251066c1fd27d6573603638c}\label{class_ogre_1_1_overlay_element_a35178b40251066c1fd27d6573603638c}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Horizontal\+Alignment@{set\+Horizontal\+Alignment}}
\index{set\+Horizontal\+Alignment@{set\+Horizontal\+Alignment}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Horizontal\+Alignment()}{setHorizontalAlignment()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::set\+Horizontal\+Alignment (\begin{DoxyParamCaption}\item[{\hyperlink{group___overlays_ga3396780cdb2d731aa5e4389148bdc5f3}{Gui\+Horizontal\+Alignment}}]{gha }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets the horizontal origin for this element. 

\begin{DoxyRemark}{Remarks}
By default, the horizontal origin for a \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} is the left edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-\/based metrics (see set\+Metrics\+Mode) since in this mode you can\textquotesingle{}t use relative positioning. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
For example, if you were using G\+M\+M\+\_\+\+P\+I\+X\+E\+LS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use G\+H\+A\+\_\+\+C\+E\+N\+T\+ER with a \textquotesingle{}left\textquotesingle{} property of -\/15. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
Note that neither G\+H\+A\+\_\+\+C\+E\+N\+T\+ER or G\+H\+A\+\_\+\+R\+I\+G\+HT alter the position of the element based on it\textquotesingle{}s width, you have to alter the \textquotesingle{}left\textquotesingle{} to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and right with different \textquotesingle{}left\textquotesingle{} offsets for maximum flexibility. 
\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_overlay_element_adb3d293046df601c1ab5c38ed6b2fb05}\label{class_ogre_1_1_overlay_element_adb3d293046df601c1ab5c38ed6b2fb05}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Horizontal\+Alignment@{get\+Horizontal\+Alignment}}
\index{get\+Horizontal\+Alignment@{get\+Horizontal\+Alignment}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Horizontal\+Alignment()}{getHorizontalAlignment()}}
{\footnotesize\ttfamily virtual \hyperlink{group___overlays_ga3396780cdb2d731aa5e4389148bdc5f3}{Gui\+Horizontal\+Alignment} Ogre\+::\+Overlay\+Element\+::get\+Horizontal\+Alignment (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the horizontal alignment for this element. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ad8950ca2d32913491c5064f3b5fffba9}\label{class_ogre_1_1_overlay_element_ad8950ca2d32913491c5064f3b5fffba9}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Vertical\+Alignment@{set\+Vertical\+Alignment}}
\index{set\+Vertical\+Alignment@{set\+Vertical\+Alignment}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Vertical\+Alignment()}{setVerticalAlignment()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::set\+Vertical\+Alignment (\begin{DoxyParamCaption}\item[{\hyperlink{group___overlays_gab0815ab90a2d9635695ec7e20e6c372e}{Gui\+Vertical\+Alignment}}]{gva }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets the vertical origin for this element. 

\begin{DoxyRemark}{Remarks}
By default, the vertical origin for a \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element} is the top edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-\/based metrics (see set\+Metrics\+Mode) since in this mode you can\textquotesingle{}t use relative positioning. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
For example, if you were using G\+M\+M\+\_\+\+P\+I\+X\+E\+LS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use G\+H\+A\+\_\+\+C\+E\+N\+T\+ER with a \textquotesingle{}top\textquotesingle{} property of -\/15. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
Note that neither G\+V\+A\+\_\+\+C\+E\+N\+T\+ER or G\+V\+A\+\_\+\+B\+O\+T\+T\+OM alter the position of the element based on it\textquotesingle{}s height, you have to alter the \textquotesingle{}top\textquotesingle{} to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and bottom with different \textquotesingle{}top\textquotesingle{} offsets for maximum flexibility. 
\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ac035cc5777b3b03fcec0e4173735929f}\label{class_ogre_1_1_overlay_element_ac035cc5777b3b03fcec0e4173735929f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Vertical\+Alignment@{get\+Vertical\+Alignment}}
\index{get\+Vertical\+Alignment@{get\+Vertical\+Alignment}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Vertical\+Alignment()}{getVerticalAlignment()}}
{\footnotesize\ttfamily virtual \hyperlink{group___overlays_gab0815ab90a2d9635695ec7e20e6c372e}{Gui\+Vertical\+Alignment} Ogre\+::\+Overlay\+Element\+::get\+Vertical\+Alignment (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the vertical alignment for this element. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_aa6e49822c99b847fe7e5eb7b3bbc7035}\label{class_ogre_1_1_overlay_element_aa6e49822c99b847fe7e5eb7b3bbc7035}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!contains@{contains}}
\index{contains@{contains}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{contains()}{contains()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Overlay\+Element\+::contains (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{x,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{y }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns true if xy is within the constraints of the component. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a74d4bfd771df0fedfc37fd79d968141d}\label{class_ogre_1_1_overlay_element_a74d4bfd771df0fedfc37fd79d968141d}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!is\+Key\+Enabled@{is\+Key\+Enabled}}
\index{is\+Key\+Enabled@{is\+Key\+Enabled}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{is\+Key\+Enabled()}{isKeyEnabled()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Overlay\+Element\+::is\+Key\+Enabled (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a0e3fe5ec8406c5824cd4e4fa25f9e783}\label{class_ogre_1_1_overlay_element_a0e3fe5ec8406c5824cd4e4fa25f9e783}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!is\+Cloneable@{is\+Cloneable}}
\index{is\+Cloneable@{is\+Cloneable}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{is\+Cloneable()}{isCloneable()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Overlay\+Element\+::is\+Cloneable (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a5677c2c826a60e516aadececb38c86ab}\label{class_ogre_1_1_overlay_element_a5677c2c826a60e516aadececb38c86ab}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Cloneable@{set\+Cloneable}}
\index{set\+Cloneable@{set\+Cloneable}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Cloneable()}{setCloneable()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Overlay\+Element\+::set\+Cloneable (\begin{DoxyParamCaption}\item[{bool}]{c }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a27ee755fb36de22d7866f1ca994d8391}\label{class_ogre_1_1_overlay_element_a27ee755fb36de22d7866f1ca994d8391}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Parent@{get\+Parent}}
\index{get\+Parent@{get\+Parent}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Parent()}{getParent()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container}$\ast$ Ogre\+::\+Overlay\+Element\+::get\+Parent (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Returns the parent container. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a950a51f806779b3ae50adc1cb05fff95}\label{class_ogre_1_1_overlay_element_a950a51f806779b3ae50adc1cb05fff95}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+set\+Parent@{\+\_\+set\+Parent}}
\index{\+\_\+set\+Parent@{\+\_\+set\+Parent}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+set\+Parent()}{\_setParent()}}
{\footnotesize\ttfamily void Ogre\+::\+Overlay\+Element\+::\+\_\+set\+Parent (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_overlay_container}{Overlay\+Container} $\ast$}]{parent }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ad0eb53760ccf63b90ec10739a6ca0733}\label{class_ogre_1_1_overlay_element_ad0eb53760ccf63b90ec10739a6ca0733}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Z\+Order@{get\+Z\+Order}}
\index{get\+Z\+Order@{get\+Z\+Order}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Z\+Order()}{getZOrder()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} Ogre\+::\+Overlay\+Element\+::get\+Z\+Order (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Returns the z\+Order of the element. 

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_adabf24ef7077a14dcc7a92a90dd04d07}\label{class_ogre_1_1_overlay_element_adabf24ef7077a14dcc7a92a90dd04d07}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Squared\+View\+Depth@{get\+Squared\+View\+Depth}}
\index{get\+Squared\+View\+Depth@{get\+Squared\+View\+Depth}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Squared\+View\+Depth()}{getSquaredViewDepth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Overlay\+Element\+::get\+Squared\+View\+Depth (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_camera}{Camera} $\ast$}]{cam }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Overridden from \hyperlink{class_ogre_1_1_renderable}{Renderable}. 



Implements \hyperlink{class_ogre_1_1_renderable_a32353addc2f1d02512314b5d1a53c5c1}{Ogre\+::\+Renderable}.



Referenced by Ogre\+::\+Border\+Renderable\+::get\+Squared\+View\+Depth().

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_ac284aa2a870b719353e73d424e3122ee}\label{class_ogre_1_1_overlay_element_ac284aa2a870b719353e73d424e3122ee}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Lights@{get\+Lights}}
\index{get\+Lights@{get\+Lights}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Lights()}{getLights()}}
{\footnotesize\ttfamily const \hyperlink{group___general_gaab30ef14aae93306a6044cb38d835f0c}{Light\+List}\& Ogre\+::\+Overlay\+Element\+::get\+Lights (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets a list of lights, ordered relative to how close they are to this renderable. 

\begin{DoxyRemark}{Remarks}
Directional lights, which have no position, will always be first on this list. 
\end{DoxyRemark}


Implements \hyperlink{class_ogre_1_1_renderable_a91a5cc5e517b7c79fa510b9fdcc98691}{Ogre\+::\+Renderable}.

\mbox{\Hypertarget{class_ogre_1_1_overlay_element_a6b27dcd535fa6377ca55dcf481563f8d}\label{class_ogre_1_1_overlay_element_a6b27dcd535fa6377ca55dcf481563f8d}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Source\+Template@{get\+Source\+Template}}
\index{get\+Source\+Template@{get\+Source\+Template}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Source\+Template()}{getSourceTemplate()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_overlay_element}{Overlay\+Element}$\ast$ Ogre\+::\+Overlay\+Element\+::get\+Source\+Template (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Returns the Source\+Template for this element. 

\mbox{\Hypertarget{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}\label{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Param\+Dictionary@{get\+Param\+Dictionary}}
\index{get\+Param\+Dictionary@{get\+Param\+Dictionary}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Param\+Dictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Retrieves the parameter dictionary for this class. 

\begin{DoxyRemark}{Remarks}
Only valid to call this after create\+Param\+Dictionary. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
Pointer to \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} shared by all instances of this class which you can add parameters to, retrieve parameters etc. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}\label{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Param\+Dictionary@{get\+Param\+Dictionary}}
\index{get\+Param\+Dictionary@{get\+Param\+Dictionary}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Param\+Dictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}\label{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Parameters@{get\+Parameters}}
\index{get\+Parameters@{get\+Parameters}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Parameters()}{getParameters()}}
{\footnotesize\ttfamily const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}\& Ogre\+::\+String\+Interface\+::get\+Parameters (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Retrieves a list of parameters valid for this object. 

\begin{DoxyReturn}{Returns}
A reference to a static list of \hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def} objects. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}\label{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Parameter@{set\+Parameter}}
\index{set\+Parameter@{set\+Parameter}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Parameter()}{setParameter()}}
{\footnotesize\ttfamily bool Ogre\+::\+String\+Interface\+::set\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic parameter setting method. 

\begin{DoxyRemark}{Remarks}
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to set \\
\hline
{\em value} & String value. Must be in the right format for the type specified in the parameter definition. See the \hyperlink{class_ogre_1_1_string_converter}{String\+Converter} class for more information. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if set was successful, false otherwise (NB no exceptions thrown -\/ tolerant method) 
\end{DoxyReturn}


Referenced by Ogre\+::\+String\+Interface\+::copy\+Parameters\+To().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}\label{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Parameter\+List@{set\+Parameter\+List}}
\index{set\+Parameter\+List@{set\+Parameter\+List}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Parameter\+List()}{setParameterList()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::set\+Parameter\+List (\begin{DoxyParamCaption}\item[{const \hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List} \&}]{param\+List }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic multiple parameter setting method. 

\begin{DoxyRemark}{Remarks}
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em param\+List} & Name/value pair list \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}\label{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Parameter@{get\+Parameter}}
\index{get\+Parameter@{get\+Parameter}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Parameter()}{getParameter()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} Ogre\+::\+String\+Interface\+::get\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Generic parameter retrieval method. 

\begin{DoxyRemark}{Remarks}
Call this method with the name of a parameter to retrieve a string-\/format value of the parameter in question. If in doubt, check the parameter definition in the list returned from get\+Parameters for the type of this parameter. If you like you can use \hyperlink{class_ogre_1_1_string_converter}{String\+Converter} to convert this string back into a native type. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to get \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
String value of parameter, blank if not found 
\end{DoxyReturn}


References Ogre\+::\+Param\+Command\+::do\+Get().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}\label{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!copy\+Parameters\+To@{copy\+Parameters\+To}}
\index{copy\+Parameters\+To@{copy\+Parameters\+To}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{copy\+Parameters\+To()}{copyParametersTo()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::copy\+Parameters\+To (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_string_interface}{String\+Interface} $\ast$}]{dest }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Method for copying this object\textquotesingle{}s parameters to another object. 

\begin{DoxyRemark}{Remarks}
This method takes the values of all the object\textquotesingle{}s parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
\hyperlink{class_ogre_1_1_any}{Any} unrecognised parameters will be ignored as with set\+Parameter method. 
\end{DoxyParagraph}

\begin{DoxyParams}{Parameters}
{\em dest} & Pointer to object to have it\textquotesingle{}s parameters set the same as this object. \\
\hline
\end{DoxyParams}


References Ogre\+::\+String\+Interface\+::set\+Parameter().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}\label{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!cleanup\+Dictionary@{cleanup\+Dictionary}}
\index{cleanup\+Dictionary@{cleanup\+Dictionary}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{cleanup\+Dictionary()}{cleanupDictionary()}}
{\footnotesize\ttfamily static void Ogre\+::\+String\+Interface\+::cleanup\+Dictionary (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \hyperlink{namespace_ogre}{Ogre}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} implementers (e.\+g. 

\hyperlink{class_ogre_1_1_material_manager}{Material\+Manager}) initializes. \mbox{\Hypertarget{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}\label{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Technique@{get\+Technique}}
\index{get\+Technique@{get\+Technique}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Technique()}{getTechnique()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_technique}{Technique}$\ast$ Ogre\+::\+Renderable\+::get\+Technique (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Retrieves a pointer to the \hyperlink{class_ogre_1_1_material}{Material} \hyperlink{class_ogre_1_1_technique}{Technique} this renderable object uses. 

\begin{DoxyRemark}{Remarks}
This is to allow Renderables to use a chosen \hyperlink{class_ogre_1_1_technique}{Technique} if they wish, otherwise they will use the best \hyperlink{class_ogre_1_1_technique}{Technique} available for the \hyperlink{class_ogre_1_1_material}{Material} they are using. 
\end{DoxyRemark}


Reimplemented in \hyperlink{group___scene_ga669f14748bd5c2cf8c8559c83371bdf5}{Ogre\+::\+Instance\+Batch}, \hyperlink{class_ogre_1_1_static_geometry_1_1_geometry_bucket_ae7444c827119bceb08313bb8c73fbab3}{Ogre\+::\+Static\+Geometry\+::\+Geometry\+Bucket}, and \hyperlink{class_ogre_1_1_sub_entity_a782d3a85919ab3b17a4fb79f218eed34}{Ogre\+::\+Sub\+Entity}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a3621cee2a019e59d3671c1a204caf4c7}\label{class_ogre_1_1_renderable_a3621cee2a019e59d3671c1a204caf4c7}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Render\+Operation@{get\+Render\+Operation}}
\index{get\+Render\+Operation@{get\+Render\+Operation}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Render\+Operation()}{getRenderOperation()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Renderable\+::get\+Render\+Operation (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_render_operation}{Render\+Operation} \&}]{op }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}, {\ttfamily [inherited]}}



Gets the render operation required to send this object to the frame buffer. 



Implemented in \hyperlink{class_ogre_1_1_billboard_set_a337b67f8d397c8c42a038cebe5f84b48}{Ogre\+::\+Billboard\+Set}, \hyperlink{class_ogre_1_1_frustum_ac5c36a072555e23b20d4039ef1895cd7}{Ogre\+::\+Frustum}, \hyperlink{class_ogre_1_1_manual_object_1_1_manual_object_section_a677a42144e3342df0de20bff9892bbfc}{Ogre\+::\+Manual\+Object\+::\+Manual\+Object\+Section}, \hyperlink{group___scene_gadcb91b7c109b3b4b74504b7dd5f7a13d}{Ogre\+::\+Instance\+Batch}, \hyperlink{class_ogre_1_1_border_renderable_aff78b58d992411bed6aa1670fdb4b871}{Ogre\+::\+Border\+Renderable}, \hyperlink{class_ogre_1_1_billboard_chain_a21555a72ccbad1a4845c80529e2ebd1e}{Ogre\+::\+Billboard\+Chain}, \hyperlink{class_ogre_1_1_static_geometry_1_1_geometry_bucket_a443a670d4074e562338ad668d5c5b0fc}{Ogre\+::\+Static\+Geometry\+::\+Geometry\+Bucket}, \hyperlink{class_ogre_1_1_sub_entity_a816f4c356b83e1b4f9d6e3058d5ee9dd}{Ogre\+::\+Sub\+Entity}, \hyperlink{class_ogre_1_1_node_1_1_debug_renderable_a9f268ab9bb393670ea6cd46b666c5bfa}{Ogre\+::\+Node\+::\+Debug\+Renderable}, \hyperlink{class_ogre_1_1_panel_overlay_element_a92fd1f38c3e1038a1bf9aa74ca7affa8}{Ogre\+::\+Panel\+Overlay\+Element}, \hyperlink{class_ogre_1_1_text_area_overlay_element_a2b6859ea5a0984c568296922f555e7e3}{Ogre\+::\+Text\+Area\+Overlay\+Element}, \hyperlink{class_ogre_1_1_simple_renderable_a51c5ae135793c602557d46be10c59b8d}{Ogre\+::\+Simple\+Renderable}, and \hyperlink{class_ogre_1_1_shadow_renderable_a36d3d1a31ec2661d66faa4675391ed25}{Ogre\+::\+Shadow\+Renderable}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_afcbf4cb36d5911a9d40a40c57e94f23b}\label{class_ogre_1_1_renderable_afcbf4cb36d5911a9d40a40c57e94f23b}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!pre\+Render@{pre\+Render}}
\index{pre\+Render@{pre\+Render}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{pre\+Render()}{preRender()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Renderable\+::pre\+Render (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} $\ast$}]{sm,  }\item[{\hyperlink{class_ogre_1_1_render_system}{Render\+System} $\ast$}]{rsys }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Called just prior to the \hyperlink{class_ogre_1_1_renderable}{Renderable} being rendered. 

\begin{DoxyRemark}{Remarks}
O\+G\+RE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering \& grouping of renders without the discovery process having to be aware of it. It also means O\+G\+RE uses declarative render information rather than immediate mode rendering -\/ this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
This method allows a \hyperlink{class_ogre_1_1_renderable}{Renderable} to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this \hyperlink{class_ogre_1_1_renderable}{Renderable} has already been set, all that is left to do is to bind the buffers and perform the render. The \hyperlink{class_ogre_1_1_renderable}{Renderable} may modify render state itself if it wants to (and restore it in the post\+Render call) before the automated render happens, or by returning \textquotesingle{}false\textquotesingle{} from this method can actually suppress the automatic render and perform one of its own. 
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
true if the automatic render should proceed, false to skip it on the assumption that the \hyperlink{class_ogre_1_1_renderable}{Renderable} has done it manually. 
\end{DoxyReturn}


Reimplemented in \hyperlink{class_ogre_1_1_billboard_chain_af43447bc7d8a6090d856c008907cc2c0}{Ogre\+::\+Billboard\+Chain}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a77230eea8136b7c296cc0a5db1dba9ee}\label{class_ogre_1_1_renderable_a77230eea8136b7c296cc0a5db1dba9ee}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!post\+Render@{post\+Render}}
\index{post\+Render@{post\+Render}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{post\+Render()}{postRender()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Renderable\+::post\+Render (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} $\ast$}]{sm,  }\item[{\hyperlink{class_ogre_1_1_render_system}{Render\+System} $\ast$}]{rsys }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Called immediately after the \hyperlink{class_ogre_1_1_renderable}{Renderable} has been rendered. 

\mbox{\Hypertarget{class_ogre_1_1_renderable_a47508d27a6c799998047c50ec43e9897}\label{class_ogre_1_1_renderable_a47508d27a6c799998047c50ec43e9897}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Num\+World\+Transforms@{get\+Num\+World\+Transforms}}
\index{get\+Num\+World\+Transforms@{get\+Num\+World\+Transforms}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Num\+World\+Transforms()}{getNumWorldTransforms()}}
{\footnotesize\ttfamily virtual unsigned short Ogre\+::\+Renderable\+::get\+Num\+World\+Transforms (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns the number of world transform matrices this renderable requires. 

\begin{DoxyRemark}{Remarks}
When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_border_renderable_a5aa0618332344aa34d1e9aa602375812}{Ogre\+::\+Border\+Renderable}, \hyperlink{class_ogre_1_1_sub_entity_a34ce8f7cdbd23af4880bd32ad2949826}{Ogre\+::\+Sub\+Entity}, \hyperlink{group___scene_ga14b022135fb927a586edef028403a39d}{Ogre\+::\+Base\+Instance\+Batch\+V\+TF}, \hyperlink{group___scene_ga63d739ff9b72315e8466bc8197cf1223}{Ogre\+::\+Instance\+Batch\+HW}, and \hyperlink{group___scene_ga86c7f5afb1cde4b73937c687d02970b6}{Ogre\+::\+Instance\+Batch\+Shader}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a4136ce4b9d3add5203339327015d872d}\label{class_ogre_1_1_renderable_a4136ce4b9d3add5203339327015d872d}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Use\+Identity\+Projection@{set\+Use\+Identity\+Projection}}
\index{set\+Use\+Identity\+Projection@{set\+Use\+Identity\+Projection}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Use\+Identity\+Projection()}{setUseIdentityProjection()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Use\+Identity\+Projection (\begin{DoxyParamCaption}\item[{bool}]{use\+Identity\+Projection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Sets whether or not to use an \textquotesingle{}identity\textquotesingle{} projection. 

\begin{DoxyRemark}{Remarks}
Usually \hyperlink{class_ogre_1_1_renderable}{Renderable} objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a \{-\/1, 1\} view space. Useful for overlay rendering. Normal renderables need not change this. The default is false. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_renderable_af630e6230261ecca2ecbfcf0b0ee9ce9}{Renderable\+::get\+Use\+Identity\+Projection} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_af630e6230261ecca2ecbfcf0b0ee9ce9}\label{class_ogre_1_1_renderable_af630e6230261ecca2ecbfcf0b0ee9ce9}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Use\+Identity\+Projection@{get\+Use\+Identity\+Projection}}
\index{get\+Use\+Identity\+Projection@{get\+Use\+Identity\+Projection}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Use\+Identity\+Projection()}{getUseIdentityProjection()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::get\+Use\+Identity\+Projection (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Returns whether or not to use an \textquotesingle{}identity\textquotesingle{} projection. 

\begin{DoxyRemark}{Remarks}
Usually \hyperlink{class_ogre_1_1_renderable}{Renderable} objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a \{-\/1, 1\} view space. Useful for overlay rendering. Normal renderables need not change this. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_renderable_a4136ce4b9d3add5203339327015d872d}{Renderable\+::set\+Use\+Identity\+Projection} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_ae53cff42a16304f582ef83ad3017d614}\label{class_ogre_1_1_renderable_ae53cff42a16304f582ef83ad3017d614}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Use\+Identity\+View@{set\+Use\+Identity\+View}}
\index{set\+Use\+Identity\+View@{set\+Use\+Identity\+View}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Use\+Identity\+View()}{setUseIdentityView()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Use\+Identity\+View (\begin{DoxyParamCaption}\item[{bool}]{use\+Identity\+View }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Sets whether or not to use an \textquotesingle{}identity\textquotesingle{} view. 

\begin{DoxyRemark}{Remarks}
Usually \hyperlink{class_ogre_1_1_renderable}{Renderable} objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this. The default is false. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_renderable_a869e7226c48fbff5dafef92b2b929b5e}{Renderable\+::get\+Use\+Identity\+View} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a869e7226c48fbff5dafef92b2b929b5e}\label{class_ogre_1_1_renderable_a869e7226c48fbff5dafef92b2b929b5e}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Use\+Identity\+View@{get\+Use\+Identity\+View}}
\index{get\+Use\+Identity\+View@{get\+Use\+Identity\+View}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Use\+Identity\+View()}{getUseIdentityView()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::get\+Use\+Identity\+View (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Returns whether or not to use an \textquotesingle{}identity\textquotesingle{} view. 

\begin{DoxyRemark}{Remarks}
Usually \hyperlink{class_ogre_1_1_renderable}{Renderable} objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_renderable_ae53cff42a16304f582ef83ad3017d614}{Renderable\+::set\+Use\+Identity\+View} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a3d5e8933145d36977b8c2b64e307bc59}\label{class_ogre_1_1_renderable_a3d5e8933145d36977b8c2b64e307bc59}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Casts\+Shadows@{get\+Casts\+Shadows}}
\index{get\+Casts\+Shadows@{get\+Casts\+Shadows}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Casts\+Shadows()}{getCastsShadows()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Renderable\+::get\+Casts\+Shadows (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Method which reports whether this renderable would normally cast a shadow. 

\begin{DoxyRemark}{Remarks}
Subclasses should override this if they could have been used to generate a shadow. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_sub_entity_a78ac1f345bce62b0b4e0139de66e58e1}{Ogre\+::\+Sub\+Entity}, and \hyperlink{class_ogre_1_1_static_geometry_1_1_geometry_bucket_a73b08c84308b798a2e18dfdf3d5caea0}{Ogre\+::\+Static\+Geometry\+::\+Geometry\+Bucket}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a572c0331ef2ec650d56063fdc17435f5}\label{class_ogre_1_1_renderable_a572c0331ef2ec650d56063fdc17435f5}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Custom\+Parameter@{set\+Custom\+Parameter}}
\index{set\+Custom\+Parameter@{set\+Custom\+Parameter}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Custom\+Parameter()}{setCustomParameter()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index,  }\item[{const \hyperlink{class_ogre_1_1_vector4}{Vector4} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Sets a custom parameter for this \hyperlink{class_ogre_1_1_renderable}{Renderable}, which may be used to drive calculations for this specific \hyperlink{class_ogre_1_1_renderable}{Renderable}, like G\+PU program parameters. 

\begin{DoxyRemark}{Remarks}
Calling this method simply associates a numeric index with a 4-\/dimensional value for this specific \hyperlink{class_ogre_1_1_renderable}{Renderable}. This is most useful if the material which this \hyperlink{class_ogre_1_1_renderable}{Renderable} uses a vertex or fragment program, and has an A\+C\+T\+\_\+\+C\+U\+S\+T\+OM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em index} & The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a G\+PU program parameter index -\/ the mapping between the two is performed by the A\+C\+T\+\_\+\+C\+U\+S\+T\+OM entry, if that is used. \\
\hline
{\em value} & The value to associate. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a0c726a0326e8a7d9e80d030541b6bddf}\label{class_ogre_1_1_renderable_a0c726a0326e8a7d9e80d030541b6bddf}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!remove\+Custom\+Parameter@{remove\+Custom\+Parameter}}
\index{remove\+Custom\+Parameter@{remove\+Custom\+Parameter}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{remove\+Custom\+Parameter()}{removeCustomParameter()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::remove\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Removes a custom value which is associated with this \hyperlink{class_ogre_1_1_renderable}{Renderable} at the given index. 


\begin{DoxyParams}{Parameters}
{\em index} & Index of the parameter to remove. \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_renderable_a572c0331ef2ec650d56063fdc17435f5}{set\+Custom\+Parameter} for full details. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a812d3b0f5df694b92084a98387d8f215}\label{class_ogre_1_1_renderable_a812d3b0f5df694b92084a98387d8f215}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!has\+Custom\+Parameter@{has\+Custom\+Parameter}}
\index{has\+Custom\+Parameter@{has\+Custom\+Parameter}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{has\+Custom\+Parameter()}{hasCustomParameter()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::has\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Checks whether a custom value is associated with this \hyperlink{class_ogre_1_1_renderable}{Renderable} at the given index. 


\begin{DoxyParams}{Parameters}
{\em index} & Index of the parameter to check for existence. \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_renderable_a572c0331ef2ec650d56063fdc17435f5}{set\+Custom\+Parameter} for full details. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_ae3ad78c8e756ea5fb43d7830462abb1f}\label{class_ogre_1_1_renderable_ae3ad78c8e756ea5fb43d7830462abb1f}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Custom\+Parameter@{get\+Custom\+Parameter}}
\index{get\+Custom\+Parameter@{get\+Custom\+Parameter}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Custom\+Parameter()}{getCustomParameter()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_vector4}{Vector4}\& Ogre\+::\+Renderable\+::get\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets the custom value associated with this \hyperlink{class_ogre_1_1_renderable}{Renderable} at the given index. 


\begin{DoxyParams}{Parameters}
{\em index} & Index of the parameter to retrieve. \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_renderable_a572c0331ef2ec650d56063fdc17435f5}{set\+Custom\+Parameter} for full details. 
\end{DoxySeeAlso}


References Ogre\+::\+Exception\+::\+E\+R\+R\+\_\+\+I\+T\+E\+M\+\_\+\+N\+O\+T\+\_\+\+F\+O\+U\+ND, and O\+G\+R\+E\+\_\+\+E\+X\+C\+E\+PT.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a742052f8185975e8b92103c924b005d3}\label{class_ogre_1_1_renderable_a742052f8185975e8b92103c924b005d3}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!\+\_\+update\+Custom\+Gpu\+Parameter@{\+\_\+update\+Custom\+Gpu\+Parameter}}
\index{\+\_\+update\+Custom\+Gpu\+Parameter@{\+\_\+update\+Custom\+Gpu\+Parameter}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{\+\_\+update\+Custom\+Gpu\+Parameter()}{\_updateCustomGpuParameter()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Renderable\+::\+\_\+update\+Custom\+Gpu\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_gpu_program_parameters_1_1_auto_constant_entry}{Gpu\+Program\+Parameters\+::\+Auto\+Constant\+Entry} \&}]{constant\+Entry,  }\item[{\hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters} $\ast$}]{params }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Update a custom \hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters} constant which is derived from information only this \hyperlink{class_ogre_1_1_renderable}{Renderable} knows. 

\begin{DoxyRemark}{Remarks}
This method allows a \hyperlink{class_ogre_1_1_renderable}{Renderable} to map in a custom G\+PU program parameter based on it\textquotesingle{}s own data. This is represented by a G\+PU auto parameter of A\+C\+T\+\_\+\+C\+U\+S\+T\+OM, and to allow there to be more than one of these per \hyperlink{class_ogre_1_1_renderable}{Renderable}, the \textquotesingle{}data\textquotesingle{} field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a \textquotesingle{}set\+Constant\textquotesingle{} method on the passed in \hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters} object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
You do not need to override this method if you\textquotesingle{}re using the standard sets of data associated with the \hyperlink{class_ogre_1_1_renderable}{Renderable} as provided by set\+Custom\+Parameter and get\+Custom\+Parameter. By default, the implementation will map from the value indexed by the \textquotesingle{}constant\+Entry.\+data\textquotesingle{} parameter to a value previously set by set\+Custom\+Parameter. But custom Renderables are free to override this if they want, in any case. 
\end{DoxyParagraph}

\begin{DoxyParams}{Parameters}
{\em constant\+Entry} & The auto constant entry referring to the parameter being updated \\
\hline
{\em params} & The parameters object which this method should call to set the updated parameters. \\
\hline
\end{DoxyParams}


Reimplemented in \hyperlink{class_ogre_1_1_sub_entity_a70e8e50ec5b0d713a0b75255a9afe744}{Ogre\+::\+Sub\+Entity}.



References Ogre\+::\+Gpu\+Program\+Parameters\+::\+\_\+write\+Raw\+Constant(), Ogre\+::\+Gpu\+Program\+Parameters\+::\+Auto\+Constant\+Entry\+::data, Ogre\+::\+Gpu\+Program\+Parameters\+::\+Auto\+Constant\+Entry\+::element\+Count, and Ogre\+::\+Gpu\+Program\+Parameters\+::\+Auto\+Constant\+Entry\+::physical\+Index.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a2f770d6ba9b3d97bdc63ecf0e3888aab}\label{class_ogre_1_1_renderable_a2f770d6ba9b3d97bdc63ecf0e3888aab}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Polygon\+Mode\+Overrideable@{set\+Polygon\+Mode\+Overrideable}}
\index{set\+Polygon\+Mode\+Overrideable@{set\+Polygon\+Mode\+Overrideable}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Polygon\+Mode\+Overrideable()}{setPolygonModeOverrideable()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Polygon\+Mode\+Overrideable (\begin{DoxyParamCaption}\item[{bool}]{override }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Sets whether this renderable\textquotesingle{}s chosen detail level can be overridden (downgraded) by the camera setting. 


\begin{DoxyParams}{Parameters}
{\em override} & true means that a lower camera detail will override this renderables detail level, false means it won\textquotesingle{}t. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_renderable_ae944917873dd68126c129f05e51622d3}\label{class_ogre_1_1_renderable_ae944917873dd68126c129f05e51622d3}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Polygon\+Mode\+Overrideable@{get\+Polygon\+Mode\+Overrideable}}
\index{get\+Polygon\+Mode\+Overrideable@{get\+Polygon\+Mode\+Overrideable}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Polygon\+Mode\+Overrideable()}{getPolygonModeOverrideable()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::get\+Polygon\+Mode\+Overrideable (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets whether this renderable\textquotesingle{}s chosen detail level can be overridden (downgraded) by the camera setting. 



Referenced by Ogre\+::\+Border\+Renderable\+::get\+Polygon\+Mode\+Overrideable().

\mbox{\Hypertarget{class_ogre_1_1_renderable_abd85c7ae6f5de865b8037f37e426886e}\label{class_ogre_1_1_renderable_abd85c7ae6f5de865b8037f37e426886e}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+User\+Any@{set\+User\+Any}}
\index{set\+User\+Any@{set\+User\+Any}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+User\+Any()}{setUserAny()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+User\+Any (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_any}{Any} \&}]{anything }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000095}{Deprecated}]use \hyperlink{class_ogre_1_1_user_object_bindings_ac6d05bbca44c5c3b44860c36205f9a68}{User\+Object\+Bindings\+::set\+User\+Any} via \hyperlink{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}{get\+User\+Object\+Bindings()} instead.\end{DoxyRefDesc}
Sets any kind of user value on this object. \begin{DoxyRemark}{Remarks}
This method allows you to associate any user value you like with this \hyperlink{class_ogre_1_1_renderable}{Renderable}. This can be a pointer back to one of your own classes for instance. 
\end{DoxyRemark}


Referenced by Ogre\+::\+Instance\+Batch\+::get\+Render\+Operation().

\mbox{\Hypertarget{class_ogre_1_1_renderable_a9cf204a5b5df75c8c745560551657358}\label{class_ogre_1_1_renderable_a9cf204a5b5df75c8c745560551657358}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+User\+Any@{get\+User\+Any}}
\index{get\+User\+Any@{get\+User\+Any}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+User\+Any()}{getUserAny()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_any}{Any}\& Ogre\+::\+Renderable\+::get\+User\+Any (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\begin{DoxyRefDesc}{Deprecated}
\item[\hyperlink{deprecated__deprecated000096}{Deprecated}]use \hyperlink{class_ogre_1_1_user_object_bindings_a7b0c9bd7cf25e2d95aea3ee5138ef5b5}{User\+Object\+Bindings\+::get\+User\+Any} via \hyperlink{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}{get\+User\+Object\+Bindings()} instead.\end{DoxyRefDesc}
Retrieves the custom user value associated with this object. 

Referenced by Ogre\+::\+Instance\+Batch\+::get\+Render\+Operation().

\mbox{\Hypertarget{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}\label{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+User\+Object\+Bindings@{get\+User\+Object\+Bindings}}
\index{get\+User\+Object\+Bindings@{get\+User\+Object\+Bindings}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+User\+Object\+Bindings()}{getUserObjectBindings()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_user_object_bindings}{User\+Object\+Bindings}\& Ogre\+::\+Renderable\+::get\+User\+Object\+Bindings (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Return an instance of user objects binding associated with this class. 

You can use it to associate one or more custom objects with this class instance. \begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_user_object_bindings_ac6d05bbca44c5c3b44860c36205f9a68}{User\+Object\+Bindings\+::set\+User\+Any}. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a472c926a6d05d05752fc195c8d606a85}\label{class_ogre_1_1_renderable_a472c926a6d05d05752fc195c8d606a85}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+User\+Object\+Bindings@{get\+User\+Object\+Bindings}}
\index{get\+User\+Object\+Bindings@{get\+User\+Object\+Bindings}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+User\+Object\+Bindings()}{getUserObjectBindings()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_user_object_bindings}{User\+Object\+Bindings}\& Ogre\+::\+Renderable\+::get\+User\+Object\+Bindings (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Return an instance of user objects binding associated with this class. 

You can use it to associate one or more custom objects with this class instance. \begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_user_object_bindings_ac6d05bbca44c5c3b44860c36205f9a68}{User\+Object\+Bindings\+::set\+User\+Any}. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a8043bede518f35c709880e4f3248a026}\label{class_ogre_1_1_renderable_a8043bede518f35c709880e4f3248a026}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!get\+Render\+System\+Data@{get\+Render\+System\+Data}}
\index{get\+Render\+System\+Data@{get\+Render\+System\+Data}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{get\+Render\+System\+Data()}{getRenderSystemData()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr}\& Ogre\+::\+Renderable\+::get\+Render\+System\+Data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets \hyperlink{class_ogre_1_1_render_system}{Render\+System} private data. 

\begin{DoxyRemark}{Remarks}
This should only be used by a \hyperlink{class_ogre_1_1_render_system}{Render\+System} 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a3dc69374127d00ea2c2f9f39cf2105bb}\label{class_ogre_1_1_renderable_a3dc69374127d00ea2c2f9f39cf2105bb}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!set\+Render\+System\+Data@{set\+Render\+System\+Data}}
\index{set\+Render\+System\+Data@{set\+Render\+System\+Data}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{set\+Render\+System\+Data()}{setRenderSystemData()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Render\+System\+Data (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr}}]{val }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Sets \hyperlink{class_ogre_1_1_render_system}{Render\+System} private data. 

\begin{DoxyRemark}{Remarks}
This should only be used by a \hyperlink{class_ogre_1_1_render_system}{Render\+System} 
\end{DoxyRemark}


\subsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_overlay_element_af7360f8bd59d3ffdefcaed91769b17dd}\label{class_ogre_1_1_overlay_element_af7360f8bd59d3ffdefcaed91769b17dd}} 
\index{Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}!D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP@{D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP}}
\index{D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP@{D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP}!Ogre\+::\+Overlay\+Container@{Ogre\+::\+Overlay\+Container}}
\subsubsection{\texorpdfstring{D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP}{DEFAULT\_RESOURCE\_GROUP}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Overlay\+Element\+::\+D\+E\+F\+A\+U\+L\+T\+\_\+\+R\+E\+S\+O\+U\+R\+C\+E\+\_\+\+G\+R\+O\+UP\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



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