\hypertarget{class_ogre_1_1_renderable}{}\doxysection{Ogre\+::Renderable Class Reference}
\label{class_ogre_1_1_renderable}\index{Ogre::Renderable@{Ogre::Renderable}}


Abstract class defining the interface all renderable objects must implement.  




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



Inheritance diagram for Ogre\+::Renderable\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_renderable__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \mbox{\hyperlink{class_ogre_1_1_renderable_1_1_render_system_data}{Render\+System\+Data}}
\begin{DoxyCompactList}\small\item\em An internal class that should be used only by a render system for internal use. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_ogre_1_1_renderable_1_1_visitor}{Visitor}}
\begin{DoxyCompactList}\small\item\em \mbox{\hyperlink{class_ogre_1_1_renderable_1_1_visitor}{Visitor}} object that can be used to iterate over a collection of \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} instances abstractly. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef \mbox{\hyperlink{class_ogre_1_1_shared_ptr}{Shared\+Ptr}}$<$ \mbox{\hyperlink{class_ogre_1_1_renderable_1_1_render_system_data}{Render\+System\+Data}} $>$ \mbox{\hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr}}
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_renderable_aed186856b59bf967f3188bfa70546957}{Renderable}} ()
\item 
virtual \mbox{\hyperlink{class_ogre_1_1_renderable_ae5a6101851f1e45229f7b4bc20a69815}{$\sim$\+Renderable}} ()
\begin{DoxyCompactList}\small\item\em Virtual destructor needed as class has virtual methods. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_renderable_a742052f8185975e8b92103c924b005d3}{\+\_\+update\+Custom\+Gpu\+Parameter}} (const \mbox{\hyperlink{class_ogre_1_1_gpu_program_parameters_1_1_auto_constant_entry}{Gpu\+Program\+Parameters\+::\+Auto\+Constant\+Entry}} \&constant\+Entry, \mbox{\hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters}} $\ast$params) const
\begin{DoxyCompactList}\small\item\em Update a custom \mbox{\hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters}} constant which is derived from information only this \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} knows. \end{DoxyCompactList}\item 
virtual bool \mbox{\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 
const \mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}} \& \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} at the given index. \end{DoxyCompactList}\item 
virtual const \mbox{\hyperlink{group___general_gaab30ef14aae93306a6044cb38d835f0c}{Light\+List}} \& \mbox{\hyperlink{class_ogre_1_1_renderable_a91a5cc5e517b7c79fa510b9fdcc98691}{get\+Lights}} (void) const =0
\begin{DoxyCompactList}\small\item\em Gets a list of lights, ordered relative to how close they are to this renderable. \end{DoxyCompactList}\item 
virtual const \mbox{\hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}} \& \mbox{\hyperlink{class_ogre_1_1_renderable_a7132944645c7b62d6b2bfff6a64fad31}{get\+Material}} (void) const =0
\begin{DoxyCompactList}\small\item\em Retrieves a weak reference to the material this renderable object uses. \end{DoxyCompactList}\item 
virtual unsigned short \mbox{\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 
bool \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable_a3621cee2a019e59d3671c1a204caf4c7}{get\+Render\+Operation}} (\mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr}} \& \mbox{\hyperlink{class_ogre_1_1_renderable_a8043bede518f35c709880e4f3248a026}{get\+Render\+System\+Data}} () const
\begin{DoxyCompactList}\small\item\em Gets \mbox{\hyperlink{class_ogre_1_1_render_system}{Render\+System}} private data. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} \mbox{\hyperlink{class_ogre_1_1_renderable_a32353addc2f1d02512314b5d1a53c5c1}{get\+Squared\+View\+Depth}} (const \mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$cam) const =0
\begin{DoxyCompactList}\small\item\em Returns the camera-\/relative squared depth of this renderable. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_technique}{Technique}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}{get\+Technique}} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a pointer to the \mbox{\hyperlink{class_ogre_1_1_material}{Material}} \mbox{\hyperlink{class_ogre_1_1_technique}{Technique}} this renderable object uses. \end{DoxyCompactList}\item 
bool \mbox{\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 \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_any}{Any}} \& \mbox{\hyperlink{class_ogre_1_1_renderable_a9cf204a5b5df75c8c745560551657358}{get\+User\+Any}} (void) const
\item 
\mbox{\hyperlink{class_ogre_1_1_user_object_bindings}{User\+Object\+Bindings}} \& \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_user_object_bindings}{User\+Object\+Bindings}} \& \mbox{\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 void \mbox{\hyperlink{class_ogre_1_1_renderable_a897d64f73a5e6ccc45d52a88e86392e1}{get\+World\+Transforms}} (\mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$xform) const =0
\begin{DoxyCompactList}\small\item\em Gets the world transform matrix / matrices for this renderable object. \end{DoxyCompactList}\item 
bool \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} at the given index. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_renderable_a77230eea8136b7c296cc0a5db1dba9ee}{post\+Render}} (\mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$sm, \mbox{\hyperlink{class_ogre_1_1_render_system}{Render\+System}} $\ast$rsys)
\begin{DoxyCompactList}\small\item\em Called immediately after the \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} has been rendered. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_renderable_afcbf4cb36d5911a9d40a40c57e94f23b}{pre\+Render}} (\mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$sm, \mbox{\hyperlink{class_ogre_1_1_render_system}{Render\+System}} $\ast$rsys)
\begin{DoxyCompactList}\small\item\em Called just prior to the \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} being rendered. \end{DoxyCompactList}\item 
void \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} at the given index. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_renderable_a572c0331ef2ec650d56063fdc17435f5}{set\+Custom\+Parameter}} (size\+\_\+t index, const \mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}} \&value)
\begin{DoxyCompactList}\small\item\em Sets a custom parameter for this \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}}, which may be used to drive calculations for this specific \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}}, like G\+PU program parameters. \end{DoxyCompactList}\item 
void \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable_a3dc69374127d00ea2c2f9f39cf2105bb}{set\+Render\+System\+Data}} (\mbox{\hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr}} val) const
\begin{DoxyCompactList}\small\item\em Sets \mbox{\hyperlink{class_ogre_1_1_render_system}{Render\+System}} private data. \end{DoxyCompactList}\item 
void \mbox{\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 \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable_abd85c7ae6f5de865b8037f37e426886e}{set\+User\+Any}} (const \mbox{\hyperlink{class_ogre_1_1_any}{Any}} \&anything)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Abstract class defining the interface all renderable objects must implement. 

\begin{DoxyRemark}{Remarks}
This interface abstracts renderable discrete objects which will be queued in the render pipeline, grouped by material. Classes implementing this interface must be based on a single material, a single world matrix (or a collection of world matrices which are blended by weights), and must be renderable via a single render operation. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
Note that deciding whether to put these objects in the rendering pipeline is done from the more specific classes e.\+g. entities. Only once it is decided that the specific class is to be rendered is the abstract version created (could be more than one per visible object) and pushed onto the rendering queue. 
\end{DoxyParagraph}


\doxysubsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}\label{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}} 
\index{Ogre::Renderable@{Ogre::Renderable}!RenderSystemDataPtr@{RenderSystemDataPtr}}
\index{RenderSystemDataPtr@{RenderSystemDataPtr}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{RenderSystemDataPtr}{RenderSystemDataPtr}}
{\footnotesize\ttfamily typedef \mbox{\hyperlink{class_ogre_1_1_shared_ptr}{Shared\+Ptr}}$<$\mbox{\hyperlink{class_ogre_1_1_renderable_1_1_render_system_data}{Render\+System\+Data}}$>$ \mbox{\hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Ogre\+::\+Renderable\+::\+Render\+System\+Data\+Ptr}}}



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

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



Virtual destructor needed as class has virtual methods. 



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a7132944645c7b62d6b2bfff6a64fad31}\label{class_ogre_1_1_renderable_a7132944645c7b62d6b2bfff6a64fad31}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getMaterial@{getMaterial}}
\index{getMaterial@{getMaterial}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getMaterial()}{getMaterial()}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}}\& Ogre\+::\+Renderable\+::get\+Material (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Retrieves a weak reference to the material this renderable object uses. 

\begin{DoxyRemark}{Remarks}
Note that the \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} also has the option to override the get\+Technique method to specify a particular \mbox{\hyperlink{class_ogre_1_1_technique}{Technique}} to use instead of the best one available. 
\end{DoxyRemark}


Implemented in \mbox{\hyperlink{class_ogre_1_1_billboard_set_acd120afe31390d7a8c07b3a0467e5ed3}{Ogre\+::\+Billboard\+Set}}, \mbox{\hyperlink{class_ogre_1_1_frustum_af31f1095812cd5fe300cd176bbde969e}{Ogre\+::\+Frustum}}, \mbox{\hyperlink{class_ogre_1_1_sub_entity_a4f293b784eef45cb78bb8c442a8a58f6}{Ogre\+::\+Sub\+Entity}}, \mbox{\hyperlink{class_ogre_1_1_manual_object_1_1_manual_object_section_a483ab64355ac4bee7a58ec442845ce2c}{Ogre\+::\+Manual\+Object\+::\+Manual\+Object\+Section}}, \mbox{\hyperlink{group___scene_gabf2e0f5e70a4984aeafc67d016111e46}{Ogre\+::\+Instance\+Batch}}, \mbox{\hyperlink{class_ogre_1_1_border_renderable_aa3872e64374081e3177c7af9ea8c5ff0}{Ogre\+::\+Border\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_overlay_element_a0d5508d74e0d742ed04ba5ba6c1a7113}{Ogre\+::\+Overlay\+Element}}, \mbox{\hyperlink{class_ogre_1_1_billboard_chain_a644788a6a8756d0c3bb55fd81e87679d}{Ogre\+::\+Billboard\+Chain}}, \mbox{\hyperlink{class_ogre_1_1_static_geometry_1_1_geometry_bucket_a02d5dbcc56ff5a71762dedb5aa439a1f}{Ogre\+::\+Static\+Geometry\+::\+Geometry\+Bucket}}, \mbox{\hyperlink{class_ogre_1_1_node_1_1_debug_renderable_a40dda5f052e0f4da0075f2761efb5252}{Ogre\+::\+Node\+::\+Debug\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_text_area_overlay_element_aedd9f92ea4ef4e5420d709449cd1de9a}{Ogre\+::\+Text\+Area\+Overlay\+Element}}, \mbox{\hyperlink{class_ogre_1_1_simple_renderable_ac335b5661abd751352cb41f180731d74}{Ogre\+::\+Simple\+Renderable}}, and \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_ad370623a75bf210c21d8a475ee89884a}{Ogre\+::\+Shadow\+Renderable}}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}\label{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getTechnique@{getTechnique}}
\index{getTechnique@{getTechnique}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getTechnique()}{getTechnique()}}
{\footnotesize\ttfamily virtual \mbox{\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]}}



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

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


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

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



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



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

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



Called just prior to the \mbox{\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 \mbox{\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 \mbox{\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 \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}} has done it manually. 
\end{DoxyReturn}


Reimplemented in \mbox{\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::Renderable@{Ogre::Renderable}!postRender@{postRender}}
\index{postRender@{postRender}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{postRender()}{postRender()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Renderable\+::post\+Render (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$}]{sm,  }\item[{\mbox{\hyperlink{class_ogre_1_1_render_system}{Render\+System}} $\ast$}]{rsys }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



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

\mbox{\Hypertarget{class_ogre_1_1_renderable_a897d64f73a5e6ccc45d52a88e86392e1}\label{class_ogre_1_1_renderable_a897d64f73a5e6ccc45d52a88e86392e1}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getWorldTransforms@{getWorldTransforms}}
\index{getWorldTransforms@{getWorldTransforms}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getWorldTransforms()}{getWorldTransforms()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Renderable\+::get\+World\+Transforms (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$}]{xform }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Gets the world transform matrix / matrices for this renderable object. 

\begin{DoxyRemark}{Remarks}
If the object has any derived transforms, these are expected to be up to date as long as all the \mbox{\hyperlink{class_ogre_1_1_scene_node}{Scene\+Node}} structures have been updated before this is called. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
This method will populate transform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from get\+Num\+World\+Transforms. 
\end{DoxyParagraph}
\begin{DoxyNote}{Note}
Internal \mbox{\hyperlink{namespace_ogre}{Ogre}} never supports non-\/affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-\/affine matrix here. 
\end{DoxyNote}


Implemented in \mbox{\hyperlink{class_ogre_1_1_billboard_set_a7f519e15da70c5fc081ce5a368857947}{Ogre\+::\+Billboard\+Set}}, \mbox{\hyperlink{class_ogre_1_1_manual_object_1_1_manual_object_section_shadow_renderable_af9e79d811e65174172b5021341f899c7}{Ogre\+::\+Manual\+Object\+::\+Manual\+Object\+Section\+Shadow\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_frustum_a3a93c98653dc4268deda21919f64a05e}{Ogre\+::\+Frustum}}, \mbox{\hyperlink{class_ogre_1_1_sub_entity_a12a37b302d178da62a38a025ced2f0d3}{Ogre\+::\+Sub\+Entity}}, \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a3ec300ee9b2531c6f8a6330fd029e50b}{Ogre\+::\+Shadow\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_manual_object_1_1_manual_object_section_ae1df2988b1f4b919d59840aebfa9584e}{Ogre\+::\+Manual\+Object\+::\+Manual\+Object\+Section}}, \mbox{\hyperlink{class_ogre_1_1_border_renderable_ac63f4204d3733523975908ac00c4658a}{Ogre\+::\+Border\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_overlay_element_aab630843ec2ac1e18e4bd22f61f91527}{Ogre\+::\+Overlay\+Element}}, \mbox{\hyperlink{class_ogre_1_1_static_geometry_1_1_geometry_bucket_ae0f423bc22cdfa50fd2d1ade70d70421}{Ogre\+::\+Static\+Geometry\+::\+Geometry\+Bucket}}, \mbox{\hyperlink{group___scene_gab3834d2766e67d617c779ac4d3910fc2}{Ogre\+::\+Base\+Instance\+Batch\+V\+TF}}, \mbox{\hyperlink{class_ogre_1_1_node_1_1_debug_renderable_a8e42846ab4669997af47fcb687a3bcc7}{Ogre\+::\+Node\+::\+Debug\+Renderable}}, \mbox{\hyperlink{group___scene_ga847694cbc167072792784c10613a4379}{Ogre\+::\+Instance\+Batch\+HW}}, \mbox{\hyperlink{group___scene_gadc4b75711e16b37a1bf7f4a7caa82c4c}{Ogre\+::\+Instance\+Batch\+Shader}}, \mbox{\hyperlink{class_ogre_1_1_simple_renderable_abcad7984aae510f1d97e05bc7dbf7477}{Ogre\+::\+Simple\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_camera_a9e4fc72f1b725bebf8701aefc9ca2e30}{Ogre\+::\+Camera}}, and \mbox{\hyperlink{class_ogre_1_1_billboard_chain_af8bb82ab6a1db3ffdf92eb800d99f447}{Ogre\+::\+Billboard\+Chain}}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a47508d27a6c799998047c50ec43e9897}\label{class_ogre_1_1_renderable_a47508d27a6c799998047c50ec43e9897}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getNumWorldTransforms@{getNumWorldTransforms}}
\index{getNumWorldTransforms@{getNumWorldTransforms}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getNumWorldTransforms()}{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]}}



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 \mbox{\hyperlink{class_ogre_1_1_sub_entity_a6d8a7f259f4c67cd0c7a371e783da5ac}{Ogre\+::\+Sub\+Entity}}, \mbox{\hyperlink{class_ogre_1_1_border_renderable_a5aa0618332344aa34d1e9aa602375812}{Ogre\+::\+Border\+Renderable}}, \mbox{\hyperlink{group___scene_ga14b022135fb927a586edef028403a39d}{Ogre\+::\+Base\+Instance\+Batch\+V\+TF}}, \mbox{\hyperlink{group___scene_ga63d739ff9b72315e8466bc8197cf1223}{Ogre\+::\+Instance\+Batch\+HW}}, and \mbox{\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::Renderable@{Ogre::Renderable}!setUseIdentityProjection@{setUseIdentityProjection}}
\index{setUseIdentityProjection@{setUseIdentityProjection}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{setUseIdentityProjection()}{setUseIdentityProjection()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Use\+Identity\+Projection (\begin{DoxyParamCaption}\item[{bool}]{use\+Identity\+Projection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



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

\begin{DoxyRemark}{Remarks}
Usually \mbox{\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}
\mbox{\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::Renderable@{Ogre::Renderable}!getUseIdentityProjection@{getUseIdentityProjection}}
\index{getUseIdentityProjection@{getUseIdentityProjection}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getUseIdentityProjection()}{getUseIdentityProjection()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::get\+Use\+Identity\+Projection (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



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

\begin{DoxyRemark}{Remarks}
Usually \mbox{\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}
\mbox{\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::Renderable@{Ogre::Renderable}!setUseIdentityView@{setUseIdentityView}}
\index{setUseIdentityView@{setUseIdentityView}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{setUseIdentityView()}{setUseIdentityView()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Use\+Identity\+View (\begin{DoxyParamCaption}\item[{bool}]{use\+Identity\+View }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



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

\begin{DoxyRemark}{Remarks}
Usually \mbox{\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}
\mbox{\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::Renderable@{Ogre::Renderable}!getUseIdentityView@{getUseIdentityView}}
\index{getUseIdentityView@{getUseIdentityView}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getUseIdentityView()}{getUseIdentityView()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::get\+Use\+Identity\+View (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



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

\begin{DoxyRemark}{Remarks}
Usually \mbox{\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}
\mbox{\hyperlink{class_ogre_1_1_renderable_ae53cff42a16304f582ef83ad3017d614}{Renderable\+::set\+Use\+Identity\+View}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a32353addc2f1d02512314b5d1a53c5c1}\label{class_ogre_1_1_renderable_a32353addc2f1d02512314b5d1a53c5c1}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getSquaredViewDepth@{getSquaredViewDepth}}
\index{getSquaredViewDepth@{getSquaredViewDepth}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getSquaredViewDepth()}{getSquaredViewDepth()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} Ogre\+::\+Renderable\+::get\+Squared\+View\+Depth (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$}]{cam }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Returns the camera-\/relative squared depth of this renderable. 

\begin{DoxyRemark}{Remarks}
Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result. 
\end{DoxyRemark}


Implemented in \mbox{\hyperlink{class_ogre_1_1_manual_object_1_1_manual_object_section_ad5047e0f9d67a33cda0696d03da36e05}{Ogre\+::\+Manual\+Object\+::\+Manual\+Object\+Section}}, \mbox{\hyperlink{class_ogre_1_1_volume_1_1_chunk_ad9cdfe7c9e58b4bad34f5e71c63080f6}{Ogre\+::\+Volume\+::\+Chunk}}, \mbox{\hyperlink{class_ogre_1_1_billboard_set_a5b3be98132fbab3edefa4f58b0e17629}{Ogre\+::\+Billboard\+Set}}, \mbox{\hyperlink{class_ogre_1_1_frustum_ae14768f06c5c0a1c8b720323bbffe9a1}{Ogre\+::\+Frustum}}, \mbox{\hyperlink{class_ogre_1_1_sub_entity_a3caaede53821eb09dba70594694ab831}{Ogre\+::\+Sub\+Entity}}, \mbox{\hyperlink{class_ogre_1_1_overlay_element_adabf24ef7077a14dcc7a92a90dd04d07}{Ogre\+::\+Overlay\+Element}}, \mbox{\hyperlink{group___scene_ga0cb7f8123b4fa74968839c1f57f655f8}{Ogre\+::\+Instance\+Batch}}, \mbox{\hyperlink{class_ogre_1_1_border_renderable_aa7f6b2da6115e327f9743643beb255c1}{Ogre\+::\+Border\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_billboard_chain_adeb5d707e6464f5695ba872f8d62ebdc}{Ogre\+::\+Billboard\+Chain}}, \mbox{\hyperlink{class_ogre_1_1_static_geometry_1_1_geometry_bucket_a5b82fb54354153c07a215fe45261981e}{Ogre\+::\+Static\+Geometry\+::\+Geometry\+Bucket}}, \mbox{\hyperlink{class_ogre_1_1_node_1_1_debug_renderable_a58513470617aaf9f2d07b75a2ceb8f35}{Ogre\+::\+Node\+::\+Debug\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_rectangle2_d_ae5afda39ae20a10e7e8ef94c67ab572f}{Ogre\+::\+Rectangle2D}}, \mbox{\hyperlink{class_ogre_1_1_wire_bounding_box_ab57710753598934826fc811699230c29}{Ogre\+::\+Wire\+Bounding\+Box}}, and \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_ad4d31186be309dad3b735e1a5438f7e8}{Ogre\+::\+Shadow\+Renderable}}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a91a5cc5e517b7c79fa510b9fdcc98691}\label{class_ogre_1_1_renderable_a91a5cc5e517b7c79fa510b9fdcc98691}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getLights@{getLights}}
\index{getLights@{getLights}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getLights()}{getLights()}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{group___general_gaab30ef14aae93306a6044cb38d835f0c}{Light\+List}}\& Ogre\+::\+Renderable\+::get\+Lights (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



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}


Implemented in \mbox{\hyperlink{class_ogre_1_1_frustum_af5110d09a7c8646bb3dd25ab77815397}{Ogre\+::\+Frustum}}, \mbox{\hyperlink{class_ogre_1_1_sub_entity_a145a255aacf3a820da46604d5423c8ed}{Ogre\+::\+Sub\+Entity}}, \mbox{\hyperlink{class_ogre_1_1_simple_renderable_aae866b208d5a1fe71a7c7e7cd0359226}{Ogre\+::\+Simple\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_billboard_set_aaf12aab9e038713c4dbe402faaf638c4}{Ogre\+::\+Billboard\+Set}}, \mbox{\hyperlink{class_ogre_1_1_manual_object_1_1_manual_object_section_aa6f8918e74a4507e4188d7c8f98a7e70}{Ogre\+::\+Manual\+Object\+::\+Manual\+Object\+Section}}, \mbox{\hyperlink{class_ogre_1_1_overlay_element_ac284aa2a870b719353e73d424e3122ee}{Ogre\+::\+Overlay\+Element}}, \mbox{\hyperlink{group___scene_ga286e02d5a387e4a629a440446418f26e}{Ogre\+::\+Instance\+Batch}}, \mbox{\hyperlink{class_ogre_1_1_border_renderable_a4743371d6b9adc24feb775fa05eac38a}{Ogre\+::\+Border\+Renderable}}, \mbox{\hyperlink{class_ogre_1_1_billboard_chain_a49a22e6bac909fe90e7d49d068aefc10}{Ogre\+::\+Billboard\+Chain}}, \mbox{\hyperlink{class_ogre_1_1_static_geometry_1_1_geometry_bucket_ab7cc0ef0f4f59eb6081c00ea59b4ce75}{Ogre\+::\+Static\+Geometry\+::\+Geometry\+Bucket}}, \mbox{\hyperlink{class_ogre_1_1_node_1_1_debug_renderable_a801e13663dcf5c62f1dd34954f9d8a25}{Ogre\+::\+Node\+::\+Debug\+Renderable}}, and \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a780dea05596c055abec25b96c97b36bb}{Ogre\+::\+Shadow\+Renderable}}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_a3d5e8933145d36977b8c2b64e307bc59}\label{class_ogre_1_1_renderable_a3d5e8933145d36977b8c2b64e307bc59}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getCastsShadows@{getCastsShadows}}
\index{getCastsShadows@{getCastsShadows}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getCastsShadows()}{getCastsShadows()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Renderable\+::get\+Casts\+Shadows (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



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 \mbox{\hyperlink{class_ogre_1_1_sub_entity_a3089f68613852ba8b15d1eed7dea3b4c}{Ogre\+::\+Sub\+Entity}}, and \mbox{\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::Renderable@{Ogre::Renderable}!setCustomParameter@{setCustomParameter}}
\index{setCustomParameter@{setCustomParameter}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{setCustomParameter()}{setCustomParameter()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index,  }\item[{const \mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets a custom parameter for this \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}}, which may be used to drive calculations for this specific \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}}. This is most useful if the material which this \mbox{\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::Renderable@{Ogre::Renderable}!removeCustomParameter@{removeCustomParameter}}
\index{removeCustomParameter@{removeCustomParameter}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{removeCustomParameter()}{removeCustomParameter()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::remove\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Removes a custom value which is associated with this \mbox{\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}
\mbox{\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::Renderable@{Ogre::Renderable}!hasCustomParameter@{hasCustomParameter}}
\index{hasCustomParameter@{hasCustomParameter}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{hasCustomParameter()}{hasCustomParameter()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::has\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Checks whether a custom value is associated with this \mbox{\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}
\mbox{\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::Renderable@{Ogre::Renderable}!getCustomParameter@{getCustomParameter}}
\index{getCustomParameter@{getCustomParameter}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getCustomParameter()}{getCustomParameter()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}}\& Ogre\+::\+Renderable\+::get\+Custom\+Parameter (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{index }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets the custom value associated with this \mbox{\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}
\mbox{\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::Renderable@{Ogre::Renderable}!\_updateCustomGpuParameter@{\_updateCustomGpuParameter}}
\index{\_updateCustomGpuParameter@{\_updateCustomGpuParameter}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{\_updateCustomGpuParameter()}{\_updateCustomGpuParameter()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Renderable\+::\+\_\+update\+Custom\+Gpu\+Parameter (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_gpu_program_parameters_1_1_auto_constant_entry}{Gpu\+Program\+Parameters\+::\+Auto\+Constant\+Entry}} \&}]{constant\+Entry,  }\item[{\mbox{\hyperlink{class_ogre_1_1_gpu_program_parameters}{Gpu\+Program\+Parameters}} $\ast$}]{params }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



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

\begin{DoxyRemark}{Remarks}
This method allows a \mbox{\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 \mbox{\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 \mbox{\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 \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_sub_entity_a1aaeb495aa688f33f0637179f3f17170}{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::Renderable@{Ogre::Renderable}!setPolygonModeOverrideable@{setPolygonModeOverrideable}}
\index{setPolygonModeOverrideable@{setPolygonModeOverrideable}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{setPolygonModeOverrideable()}{setPolygonModeOverrideable()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Polygon\+Mode\+Overrideable (\begin{DoxyParamCaption}\item[{bool}]{override }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



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::Renderable@{Ogre::Renderable}!getPolygonModeOverrideable@{getPolygonModeOverrideable}}
\index{getPolygonModeOverrideable@{getPolygonModeOverrideable}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getPolygonModeOverrideable()}{getPolygonModeOverrideable()}}
{\footnotesize\ttfamily bool Ogre\+::\+Renderable\+::get\+Polygon\+Mode\+Overrideable (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



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::Renderable@{Ogre::Renderable}!setUserAny@{setUserAny}}
\index{setUserAny@{setUserAny}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{setUserAny()}{setUserAny()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+User\+Any (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_any}{Any}} \&}]{anything }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000116}{Deprecated}}]use \mbox{\hyperlink{class_ogre_1_1_user_object_bindings_ac6d05bbca44c5c3b44860c36205f9a68}{User\+Object\+Bindings\+::set\+User\+Any}} via \mbox{\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 \mbox{\hyperlink{class_ogre_1_1_renderable}{Renderable}}. This can be a pointer back to one of your own classes for instance. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_renderable_a9cf204a5b5df75c8c745560551657358}\label{class_ogre_1_1_renderable_a9cf204a5b5df75c8c745560551657358}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getUserAny@{getUserAny}}
\index{getUserAny@{getUserAny}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getUserAny()}{getUserAny()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{class_ogre_1_1_any}{Any}}\& Ogre\+::\+Renderable\+::get\+User\+Any (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000117}{Deprecated}}]use \mbox{\hyperlink{class_ogre_1_1_user_object_bindings_a7b0c9bd7cf25e2d95aea3ee5138ef5b5}{User\+Object\+Bindings\+::get\+User\+Any}} via \mbox{\hyperlink{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}{get\+User\+Object\+Bindings()}} instead.\end{DoxyRefDesc}
Retrieves the custom user value associated with this object. \mbox{\Hypertarget{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}\label{class_ogre_1_1_renderable_a2ed9a2f3c1decac6286f8af974ce2ffc}} 
\index{Ogre::Renderable@{Ogre::Renderable}!getUserObjectBindings@{getUserObjectBindings}}
\index{getUserObjectBindings@{getUserObjectBindings}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getUserObjectBindings()}{getUserObjectBindings()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \mbox{\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]}}



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}
\mbox{\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::Renderable@{Ogre::Renderable}!getUserObjectBindings@{getUserObjectBindings}}
\index{getUserObjectBindings@{getUserObjectBindings}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getUserObjectBindings()}{getUserObjectBindings()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const \mbox{\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]}}



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}
\mbox{\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::Renderable@{Ogre::Renderable}!getRenderSystemData@{getRenderSystemData}}
\index{getRenderSystemData@{getRenderSystemData}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{getRenderSystemData()}{getRenderSystemData()}}
{\footnotesize\ttfamily const \mbox{\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]}}



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

\begin{DoxyRemark}{Remarks}
This should only be used by a \mbox{\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::Renderable@{Ogre::Renderable}!setRenderSystemData@{setRenderSystemData}}
\index{setRenderSystemData@{setRenderSystemData}!Ogre::Renderable@{Ogre::Renderable}}
\doxysubsubsection{\texorpdfstring{setRenderSystemData()}{setRenderSystemData()}}
{\footnotesize\ttfamily void Ogre\+::\+Renderable\+::set\+Render\+System\+Data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}{Render\+System\+Data\+Ptr}}}]{val }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



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

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


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