\hypertarget{class_ogre_1_1_shadow_renderable}{}\doxysection{Ogre\+::Shadow\+Renderable Class Reference}
\label{class_ogre_1_1_shadow_renderable}\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}


Class which represents the renderable aspects of a set of shadow volume faces.  




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



Inheritance diagram for Ogre\+::Shadow\+Renderable\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=302pt]{class_ogre_1_1_shadow_renderable__inherit__graph}
\end{center}
\end{figure}
\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_shadow_renderable_afd48548fe3314d5d419c695c0788b278}{Shadow\+Renderable}} ()
\begin{DoxyCompactList}\small\item\em Used only if is\+Light\+Cap\+Separate == true. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a3b9d5d4abdc4158e035c174816748305}{$\sim$\+Shadow\+Renderable}} ()
\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 
\mbox{\hyperlink{class_ogre_1_1_shadow_renderable}{Shadow\+Renderable}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a9039657d8484c4c1d5bc249aa4bce723}{get\+Light\+Cap\+Renderable}} (void)
\begin{DoxyCompactList}\small\item\em Get the light cap version of this renderable. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{group___general_gaab30ef14aae93306a6044cb38d835f0c}{Light\+List}} \& \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a780dea05596c055abec25b96c97b36bb}{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 \mbox{\hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}} \& \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_ad370623a75bf210c21d8a475ee89884a}{get\+Material}} (void) const
\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 
void \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a36d3d1a31ec2661d66faa4675391ed25}{get\+Render\+Operation}} (\mbox{\hyperlink{class_ogre_1_1_render_operation}{Render\+Operation}} \&op)
\begin{DoxyCompactList}\small\item\em Gets the render operation required to send this object to the frame buffer. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_render_operation}{Render\+Operation}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_ae192ff33315f05bee1865a64547fe9a2}{get\+Render\+Operation\+For\+Update}} (void)
\begin{DoxyCompactList}\small\item\em Get the internal render operation for set up. \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 
\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_ad4d31186be309dad3b735e1a5438f7e8}{get\+Squared\+View\+Depth}} (const \mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$) const
\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 
void \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a3ec300ee9b2531c6f8a6330fd029e50b}{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 
bool \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a5845cf9423b49ec45db0258dd6f0035c}{is\+Light\+Cap\+Separate}} (void) const
\begin{DoxyCompactList}\small\item\em Does this renderable require a separate light cap? \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_a08ca1f26af48c8e5b6ac6e028d5eb761}{is\+Visible}} (void) const
\begin{DoxyCompactList}\small\item\em Should this \mbox{\hyperlink{class_ogre_1_1_shadow_renderable}{Shadow\+Renderable}} be treated as visible? \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 
virtual void \mbox{\hyperlink{class_ogre_1_1_shadow_renderable_aa344a268ddb3202b7d74d84314f9f647}{rebind\+Index\+Buffer}} (const \mbox{\hyperlink{namespace_ogre_ae906cf8e579ba8ade19879ec05b1a456}{Hardware\+Index\+Buffer\+Shared\+Ptr}} \&index\+Buffer)=0
\begin{DoxyCompactList}\small\item\em This function informs the shadow renderable that the global index buffer from the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} has been updated. \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_shadow_renderable_a624c5d9e88df9caeb2f7d57e69dab2be}{set\+Material}} (const \mbox{\hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}} \&mat)
\begin{DoxyCompactList}\small\item\em Set the material to be used by the shadow, should be set by the caller before adding to a render queue. \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}
Class which represents the renderable aspects of a set of shadow volume faces. 

\begin{DoxyRemark}{Remarks}
Note that for casters comprised of more than one set of vertex buffers (e.\+g. Sub\+Meshes each using their own geometry), it will take more than one \mbox{\hyperlink{class_ogre_1_1_shadow_renderable}{Shadow\+Renderable}} to render the shadow volume. Therefore for shadow caster geometry, it is best to stick to one set of vertex buffers (not necessarily one buffer, but the positions for the entire geometry should come from one buffer if possible) 
\end{DoxyRemark}


\doxysubsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}\label{class_ogre_1_1_renderable_adc7212015bff66546a8a351355d7b5fb}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!RenderSystemDataPtr@{RenderSystemDataPtr}}
\index{RenderSystemDataPtr@{RenderSystemDataPtr}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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}}\hspace{0.3cm}{\ttfamily [inherited]}}



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



Used only if is\+Light\+Cap\+Separate == true. 

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



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_a624c5d9e88df9caeb2f7d57e69dab2be}\label{class_ogre_1_1_shadow_renderable_a624c5d9e88df9caeb2f7d57e69dab2be}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!setMaterial@{setMaterial}}
\index{setMaterial@{setMaterial}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{setMaterial()}{setMaterial()}}
{\footnotesize\ttfamily void Ogre\+::\+Shadow\+Renderable\+::set\+Material (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}} \&}]{mat }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Set the material to be used by the shadow, should be set by the caller before adding to a render queue. 

\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_ad370623a75bf210c21d8a475ee89884a}\label{class_ogre_1_1_shadow_renderable_ad370623a75bf210c21d8a475ee89884a}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getMaterial@{getMaterial}}
\index{getMaterial@{getMaterial}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{getMaterial()}{getMaterial()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}}\& Ogre\+::\+Shadow\+Renderable\+::get\+Material (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [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}


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

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



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



Implements \mbox{\hyperlink{class_ogre_1_1_renderable_a3621cee2a019e59d3671c1a204caf4c7}{Ogre\+::\+Renderable}}.

\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_ae192ff33315f05bee1865a64547fe9a2}\label{class_ogre_1_1_shadow_renderable_ae192ff33315f05bee1865a64547fe9a2}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getRenderOperationForUpdate@{getRenderOperationForUpdate}}
\index{getRenderOperationForUpdate@{getRenderOperationForUpdate}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{getRenderOperationForUpdate()}{getRenderOperationForUpdate()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_render_operation}{Render\+Operation}}$\ast$ Ogre\+::\+Shadow\+Renderable\+::get\+Render\+Operation\+For\+Update (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Get the internal render operation for set up. 

\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_a3ec300ee9b2531c6f8a6330fd029e50b}\label{class_ogre_1_1_shadow_renderable_a3ec300ee9b2531c6f8a6330fd029e50b}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getWorldTransforms@{getWorldTransforms}}
\index{getWorldTransforms@{getWorldTransforms}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{getWorldTransforms()}{getWorldTransforms()}}
{\footnotesize\ttfamily void Ogre\+::\+Shadow\+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}


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



Implemented in \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{\Hypertarget{class_ogre_1_1_shadow_renderable_ad4d31186be309dad3b735e1a5438f7e8}\label{class_ogre_1_1_shadow_renderable_ad4d31186be309dad3b735e1a5438f7e8}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getSquaredViewDepth@{getSquaredViewDepth}}
\index{getSquaredViewDepth@{getSquaredViewDepth}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{getSquaredViewDepth()}{getSquaredViewDepth()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} Ogre\+::\+Shadow\+Renderable\+::get\+Squared\+View\+Depth (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [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}


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

\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_a780dea05596c055abec25b96c97b36bb}\label{class_ogre_1_1_shadow_renderable_a780dea05596c055abec25b96c97b36bb}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getLights@{getLights}}
\index{getLights@{getLights}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{getLights()}{getLights()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{group___general_gaab30ef14aae93306a6044cb38d835f0c}{Light\+List}}\& Ogre\+::\+Shadow\+Renderable\+::get\+Lights (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [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}


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

\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_a5845cf9423b49ec45db0258dd6f0035c}\label{class_ogre_1_1_shadow_renderable_a5845cf9423b49ec45db0258dd6f0035c}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!isLightCapSeparate@{isLightCapSeparate}}
\index{isLightCapSeparate@{isLightCapSeparate}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{isLightCapSeparate()}{isLightCapSeparate()}}
{\footnotesize\ttfamily bool Ogre\+::\+Shadow\+Renderable\+::is\+Light\+Cap\+Separate (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Does this renderable require a separate light cap? 

\begin{DoxyRemark}{Remarks}
If possible, the light cap (when required) should be contained in the usual geometry of the shadow renderable. However, if for some reason the normal depth function (less than) could cause artefacts, then a separate light cap with a depth function of \textquotesingle{}always fail\textquotesingle{} can be used instead. The primary example of this is when there are floating point inaccuracies caused by calculating the shadow geometry separately from the real geometry. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_a9039657d8484c4c1d5bc249aa4bce723}\label{class_ogre_1_1_shadow_renderable_a9039657d8484c4c1d5bc249aa4bce723}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getLightCapRenderable@{getLightCapRenderable}}
\index{getLightCapRenderable@{getLightCapRenderable}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{getLightCapRenderable()}{getLightCapRenderable()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_shadow_renderable}{Shadow\+Renderable}}$\ast$ Ogre\+::\+Shadow\+Renderable\+::get\+Light\+Cap\+Renderable (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Get the light cap version of this renderable. 

\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_a08ca1f26af48c8e5b6ac6e028d5eb761}\label{class_ogre_1_1_shadow_renderable_a08ca1f26af48c8e5b6ac6e028d5eb761}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!isVisible@{isVisible}}
\index{isVisible@{isVisible}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{isVisible()}{isVisible()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Shadow\+Renderable\+::is\+Visible (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Should this \mbox{\hyperlink{class_ogre_1_1_shadow_renderable}{Shadow\+Renderable}} be treated as visible? 

\mbox{\Hypertarget{class_ogre_1_1_shadow_renderable_aa344a268ddb3202b7d74d84314f9f647}\label{class_ogre_1_1_shadow_renderable_aa344a268ddb3202b7d74d84314f9f647}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!rebindIndexBuffer@{rebindIndexBuffer}}
\index{rebindIndexBuffer@{rebindIndexBuffer}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\doxysubsubsection{\texorpdfstring{rebindIndexBuffer()}{rebindIndexBuffer()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Shadow\+Renderable\+::rebind\+Index\+Buffer (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_ae906cf8e579ba8ade19879ec05b1a456}{Hardware\+Index\+Buffer\+Shared\+Ptr}} \&}]{index\+Buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



This function informs the shadow renderable that the global index buffer from the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} has been updated. 

As all shadow use this buffer their pointer must be updated as well. 
\begin{DoxyParams}{Parameters}
{\em index\+Buffer} & Pointer to the new index buffer. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{class_ogre_1_1_manual_object_1_1_manual_object_section_shadow_renderable_a827dcc40d041c4d94ef843ea5298b0af}{Ogre\+::\+Manual\+Object\+::\+Manual\+Object\+Section\+Shadow\+Renderable}}.

\mbox{\Hypertarget{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}\label{class_ogre_1_1_renderable_acc31580439662586a72b25a5604b300f}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getTechnique@{getTechnique}}
\index{getTechnique@{getTechnique}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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_afcbf4cb36d5911a9d40a40c57e94f23b}\label{class_ogre_1_1_renderable_afcbf4cb36d5911a9d40a40c57e94f23b}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!preRender@{preRender}}
\index{preRender@{preRender}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!postRender@{postRender}}
\index{postRender@{postRender}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



Called immediately after the \mbox{\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::ShadowRenderable@{Ogre::ShadowRenderable}!getNumWorldTransforms@{getNumWorldTransforms}}
\index{getNumWorldTransforms@{getNumWorldTransforms}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\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 \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::ShadowRenderable@{Ogre::ShadowRenderable}!setUseIdentityProjection@{setUseIdentityProjection}}
\index{setUseIdentityProjection@{setUseIdentityProjection}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!getUseIdentityProjection@{getUseIdentityProjection}}
\index{getUseIdentityProjection@{getUseIdentityProjection}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!setUseIdentityView@{setUseIdentityView}}
\index{setUseIdentityView@{setUseIdentityView}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!getUseIdentityView@{getUseIdentityView}}
\index{getUseIdentityView@{getUseIdentityView}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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_a3d5e8933145d36977b8c2b64e307bc59}\label{class_ogre_1_1_renderable_a3d5e8933145d36977b8c2b64e307bc59}} 
\index{Ogre::ShadowRenderable@{Ogre::ShadowRenderable}!getCastsShadows@{getCastsShadows}}
\index{getCastsShadows@{getCastsShadows}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\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 \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::ShadowRenderable@{Ogre::ShadowRenderable}!setCustomParameter@{setCustomParameter}}
\index{setCustomParameter@{setCustomParameter}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!removeCustomParameter@{removeCustomParameter}}
\index{removeCustomParameter@{removeCustomParameter}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!hasCustomParameter@{hasCustomParameter}}
\index{hasCustomParameter@{hasCustomParameter}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!getCustomParameter@{getCustomParameter}}
\index{getCustomParameter@{getCustomParameter}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!\_updateCustomGpuParameter@{\_updateCustomGpuParameter}}
\index{\_updateCustomGpuParameter@{\_updateCustomGpuParameter}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!setPolygonModeOverrideable@{setPolygonModeOverrideable}}
\index{setPolygonModeOverrideable@{setPolygonModeOverrideable}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\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::ShadowRenderable@{Ogre::ShadowRenderable}!getPolygonModeOverrideable@{getPolygonModeOverrideable}}
\index{getPolygonModeOverrideable@{getPolygonModeOverrideable}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\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::ShadowRenderable@{Ogre::ShadowRenderable}!setUserAny@{setUserAny}}
\index{setUserAny@{setUserAny}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}

\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::ShadowRenderable@{Ogre::ShadowRenderable}!getUserAny@{getUserAny}}
\index{getUserAny@{getUserAny}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}

\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::ShadowRenderable@{Ogre::ShadowRenderable}!getUserObjectBindings@{getUserObjectBindings}}
\index{getUserObjectBindings@{getUserObjectBindings}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\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}
\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::ShadowRenderable@{Ogre::ShadowRenderable}!getUserObjectBindings@{getUserObjectBindings}}
\index{getUserObjectBindings@{getUserObjectBindings}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\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}
\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::ShadowRenderable@{Ogre::ShadowRenderable}!getRenderSystemData@{getRenderSystemData}}
\index{getRenderSystemData@{getRenderSystemData}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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::ShadowRenderable@{Ogre::ShadowRenderable}!setRenderSystemData@{setRenderSystemData}}
\index{setRenderSystemData@{setRenderSystemData}!Ogre::ShadowRenderable@{Ogre::ShadowRenderable}}
\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]}, {\ttfamily [inherited]}}



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_shadow_caster_8h}{Ogre\+Shadow\+Caster.\+h}}\end{DoxyCompactItemize}
