source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1BorderRenderable.html @ 657

Revision 657, 56.1 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::BorderRenderable class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::BorderRenderable Class Reference</h1>Class for rendering the border of a <a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::BorderRenderable:
16<p><center><img src="classOgre_1_1BorderRenderable.png" usemap="#Ogre::BorderRenderable_map" border="0" alt=""></center>
17<map name="Ogre::BorderRenderable_map">
18<area href="classOgre_1_1Renderable.html" alt="Ogre::Renderable" shape="rect" coords="0,0,151,24">
19</map>
20<a href="classOgre_1_1BorderRenderable-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea0">BorderRenderable</a> (<a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a> *parent)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructed with pointers to parent.  <a href="#Ogre_1_1BorderRenderablea0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea1">getMaterial</a> (void) const </td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a weak reference to the material this renderable object uses.  <a href="#Ogre_1_1BorderRenderablea1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea2">getRenderOperation</a> (<a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> &amp;op)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the render operation required to send this object to the frame buffer.  <a href="#Ogre_1_1BorderRenderablea2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea3">getWorldTransforms</a> (<a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> *xform) const </td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the world transform matrix / matrices for this renderable object.  <a href="#Ogre_1_1BorderRenderablea3"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea4">getWorldOrientation</a> (void) const </td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex &amp; fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.  <a href="#Ogre_1_1BorderRenderablea4"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea5">getWorldPosition</a> (void) const </td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex &amp; fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.  <a href="#Ogre_1_1BorderRenderablea5"></a><br><br></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned short&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea6">getNumWorldTransforms</a> (void) const </td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of world transform matrices this renderable requires.  <a href="#Ogre_1_1BorderRenderablea6"></a><br><br></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea7">useIdentityProjection</a> (void) const </td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not to use an 'identity' projection.  <a href="#Ogre_1_1BorderRenderablea7"></a><br><br></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea8">useIdentityView</a> (void) const </td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not to use an 'identity' projection.  <a href="#Ogre_1_1BorderRenderablea8"></a><br><br></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea9">getSquaredViewDepth</a> (const <a class="el" href="classOgre_1_1Camera.html">Camera</a> *cam) const </td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the camera-relative squared depth of this renderable.  <a href="#Ogre_1_1BorderRenderablea9"></a><br><br></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a59">LightList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea10">getLights</a> (void) const </td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets a list of lights, ordered relative to how close they are to this renderable.  <a href="#Ogre_1_1BorderRenderablea10"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablea11">getRenderDetailOverrideable</a> (void) const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.  <a href="#Ogre_1_1BorderRenderablea11"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1Technique.html">Technique</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa42">getTechnique</a> (void) const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a pointer to the <a class="el" href="classOgre_1_1Material.html">Material</a> <a class="el" href="classOgre_1_1Technique.html">Technique</a> this renderable object uses.  <a href="#Ogre_1_1WireBoundingBoxa42"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a646">SceneDetailLevel</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa46">getRenderDetail</a> () const </td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the preferred rasterisation mode of this renderable.  <a href="#Ogre_1_1WireBoundingBoxa46"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa47">getNormaliseNormals</a> (void) const </td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> wishes the hardware to normalise normals.  <a href="#Ogre_1_1WireBoundingBoxa47"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="namespaceOgre.html#a410">PlaneList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa48">getClipPlanes</a> () const </td></tr>
69
70<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa49">getCastsShadows</a> (void) const </td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method which reports whether this renderable would normally cast a shadow.  <a href="#Ogre_1_1WireBoundingBoxa49"></a><br><br></td></tr>
73<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa50">setCustomParameter</a> (size_t index, const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &amp;value)</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets a custom parameter for this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a>, which may be used to drive calculations for this specific <a class="el" href="classOgre_1_1Renderable.html">Renderable</a>, like GPU program parameters.  <a href="#Ogre_1_1WireBoundingBoxa50"></a><br><br></td></tr>
76<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa51">getCustomParameter</a> (size_t index) const </td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the custom value associated with this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> at the given index.  <a href="#Ogre_1_1WireBoundingBoxa51"></a><br><br></td></tr>
79<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa52">_updateCustomGpuParameter</a> (const <a class="el" href="classOgre_1_1GpuProgramParameters_1_1AutoConstantEntry.html">GpuProgramParameters::AutoConstantEntry</a> &amp;constantEntry, <a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> *<a class="el" href="OgreGLPrerequisites_8h.html#a74">params</a>) const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update a custom <a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> constant which is derived from information only this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> knows.  <a href="#Ogre_1_1WireBoundingBoxa52"></a><br><br></td></tr>
82<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa53">setRenderDetailOverrideable</a> (bool override)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.  <a href="#Ogre_1_1WireBoundingBoxa53"></a><br><br></td></tr>
85<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; size_t,<br>
87 <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx0">CustomParameterMap</a></td></tr>
88
89<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablep0">mParent</a></td></tr>
91
92<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx0">CustomParameterMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp20">mCustomParameters</a></td></tr>
93
94<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp21">mRenderDetailOverrideable</a></td></tr>
95
96<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
97<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a410">PlaneList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxt1">msDummyPlaneList</a></td></tr>
98
99</table>
100<hr><a name="_details"></a><h2>Detailed Description</h2>
101Class for rendering the border of a <a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a>.
102<p>
103<dl compact><dt><b>Remarks:</b></dt><dd>We need this because we have to render twice, once with the inner panel's repeating material (handled by superclass) and once for the border's separate meterial. </dd></dl>
104
105<p>
106
107<p>
108Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00308">308</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.<hr><h2>Member Typedef Documentation</h2>
109<a class="anchor" name="Ogre_1_1WireBoundingBoxx0" doxytag="Ogre::BorderRenderable::CustomParameterMap" ></a><p>
110<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
111  <tr>
112    <td class="mdRow">
113      <table cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td class="md" nowrap valign="top"> typedef std::map&lt;size_t, <a class="el" href="classOgre_1_1Vector4.html">Vector4</a>&gt; <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx0">Ogre::Renderable::CustomParameterMap</a><code> [protected, inherited]</code>
116      </table>
117    </td>
118  </tr>
119</table>
120<table cellspacing=5 cellpadding=0 border=0>
121  <tr>
122    <td>
123      &nbsp;
124    </td>
125    <td>
126
127<p>
128
129<p>
130Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00251">251</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
131  </tr>
132</table>
133<hr><h2>Constructor &amp; Destructor Documentation</h2>
134<a class="anchor" name="Ogre_1_1BorderRenderablea0" doxytag="Ogre::BorderRenderable::BorderRenderable" ></a><p>
135<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
136  <tr>
137    <td class="mdRow">
138      <table cellpadding="0" cellspacing="0" border="0">
139        <tr>
140          <td class="md" nowrap valign="top"> Ogre::BorderRenderable::BorderRenderable </td>
141          <td class="md" valign="top">(&nbsp;</td>
142          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a> *&nbsp;</td>
143          <td class="mdname1" valign="top" nowrap> <em>parent</em>          </td>
144          <td class="md" valign="top">&nbsp;)&nbsp;</td>
145          <td class="md" nowrap></td>
146        </tr>
147
148      </table>
149    </td>
150  </tr>
151</table>
152<table cellspacing=5 cellpadding=0 border=0>
153  <tr>
154    <td>
155      &nbsp;
156    </td>
157    <td>
158
159<p>
160Constructed with pointers to parent.
161<p>
162
163<p>
164Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00314">314</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
165  </tr>
166</table>
167<hr><h2>Member Function Documentation</h2>
168<a class="anchor" name="Ogre_1_1WireBoundingBoxa52" doxytag="Ogre::BorderRenderable::_updateCustomGpuParameter" ></a><p>
169<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
170  <tr>
171    <td class="mdRow">
172      <table cellpadding="0" cellspacing="0" border="0">
173        <tr>
174          <td class="md" nowrap valign="top"> virtual void Ogre::Renderable::_updateCustomGpuParameter </td>
175          <td class="md" valign="top">(&nbsp;</td>
176          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1GpuProgramParameters_1_1AutoConstantEntry.html">GpuProgramParameters::AutoConstantEntry</a> &amp;&nbsp;</td>
177          <td class="mdname" nowrap> <em>constantEntry</em>, </td>
178        </tr>
179        <tr>
180          <td class="md" nowrap align="right"></td>
181          <td></td>
182          <td class="md" nowrap><a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> *&nbsp;</td>
183          <td class="mdname" nowrap> <em>params</em></td>
184        </tr>
185        <tr>
186          <td></td>
187          <td class="md">)&nbsp;</td>
188          <td class="md" colspan="2"> const<code> [virtual, inherited]</code></td>
189        </tr>
190
191      </table>
192    </td>
193  </tr>
194</table>
195<table cellspacing=5 cellpadding=0 border=0>
196  <tr>
197    <td>
198      &nbsp;
199    </td>
200    <td>
201
202<p>
203Update a custom <a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> constant which is derived from information only this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> knows.
204<p>
205<dl compact><dt><b>Remarks:</b></dt><dd>This method allows a <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per <a class="el" href="classOgre_1_1Renderable.html">Renderable</a>, the 'data' 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 'setConstant' method on the passed in <a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter. </dd></dl>
206<dl compact><dt><b></b></dt><dd>You do not need to override this method if you're using the standard sets of data associated with the <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case. </dd></dl>
207<dl compact><dt><b>Parameters:</b></dt><dd>
208  <table border="0" cellspacing="2" cellpadding="0">
209    <tr><td valign=top><em>constantEntry</em>&nbsp;</td><td>The auto constant entry referring to the parameter being updated </td></tr>
210    <tr><td valign=top><em>params</em>&nbsp;</td><td>The parameters object which this method should call to set the updated parameters. </td></tr>
211  </table>
212</dl>
213
214<p>
215Reimplemented in <a class="el" href="classOgre_1_1TerrainRenderable.html#Ogre_1_1TerrainRenderablea27">Ogre::TerrainRenderable</a>.
216<p>
217Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00219">219</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.
218<p>
219References <a class="el" href="OgreGpuProgram_8h-source.html#l00291">Ogre::GpuProgramParameters::AutoConstantEntry::data</a>, <a class="el" href="OgreGpuProgram_8h-source.html#l00288">Ogre::GpuProgramParameters::AutoConstantEntry::index</a>, and <a class="el" href="OgreGLPrerequisites_8h-source.html#l00208">params</a>.    </td>
220  </tr>
221</table>
222<a class="anchor" name="Ogre_1_1WireBoundingBoxa49" doxytag="Ogre::BorderRenderable::getCastsShadows" ></a><p>
223<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
224  <tr>
225    <td class="mdRow">
226      <table cellpadding="0" cellspacing="0" border="0">
227        <tr>
228          <td class="md" nowrap valign="top"> virtual bool Ogre::Renderable::getCastsShadows </td>
229          <td class="md" valign="top">(&nbsp;</td>
230          <td class="md" nowrap valign="top">void&nbsp;</td>
231          <td class="mdname1" valign="top" nowrap>          </td>
232          <td class="md" valign="top">&nbsp;)&nbsp;</td>
233          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
234        </tr>
235
236      </table>
237    </td>
238  </tr>
239</table>
240<table cellspacing=5 cellpadding=0 border=0>
241  <tr>
242    <td>
243      &nbsp;
244    </td>
245    <td>
246
247<p>
248Method which reports whether this renderable would normally cast a shadow.
249<p>
250<dl compact><dt><b>Remarks:</b></dt><dd>Subclasses should override this if they could have been used to generate a shadow. </dd></dl>
251
252<p>
253Reimplemented in <a class="el" href="classOgre_1_1StaticGeometry_1_1GeometryBucket.html#Ogre_1_1StaticGeometry_1_1GeometryBucketa13">Ogre::StaticGeometry::GeometryBucket</a>, and <a class="el" href="classOgre_1_1SubEntity.html#Ogre_1_1SubEntitya18">Ogre::SubEntity</a>.
254<p>
255Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00154">154</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
256  </tr>
257</table>
258<a class="anchor" name="Ogre_1_1WireBoundingBoxa48" doxytag="Ogre::BorderRenderable::getClipPlanes" ></a><p>
259<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
260  <tr>
261    <td class="mdRow">
262      <table cellpadding="0" cellspacing="0" border="0">
263        <tr>
264          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a410">PlaneList</a>&amp; Ogre::Renderable::getClipPlanes </td>
265          <td class="md" valign="top">(&nbsp;</td>
266          <td class="mdname1" valign="top" nowrap>          </td>
267          <td class="md" valign="top">&nbsp;)&nbsp;</td>
268          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
269        </tr>
270
271      </table>
272    </td>
273  </tr>
274</table>
275<table cellspacing=5 cellpadding=0 border=0>
276  <tr>
277    <td>
278      &nbsp;
279    </td>
280    <td>
281
282<p>
283
284<p>
285Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00146">146</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.
286<p>
287References <a class="el" href="OgrePlane_8h-source.html#l00100">Ogre::PlaneList</a>.    </td>
288  </tr>
289</table>
290<a class="anchor" name="Ogre_1_1WireBoundingBoxa51" doxytag="Ogre::BorderRenderable::getCustomParameter" ></a><p>
291<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
292  <tr>
293    <td class="mdRow">
294      <table cellpadding="0" cellspacing="0" border="0">
295        <tr>
296          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a>&amp; Ogre::Renderable::getCustomParameter </td>
297          <td class="md" valign="top">(&nbsp;</td>
298          <td class="md" nowrap valign="top">size_t&nbsp;</td>
299          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
300          <td class="md" valign="top">&nbsp;)&nbsp;</td>
301          <td class="md" nowrap> const<code> [inherited]</code></td>
302        </tr>
303
304      </table>
305    </td>
306  </tr>
307</table>
308<table cellspacing=5 cellpadding=0 border=0>
309  <tr>
310    <td>
311      &nbsp;
312    </td>
313    <td>
314
315<p>
316Gets the custom value associated with this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> at the given index.
317<p>
318<dl compact><dt><b>Parameters:</b></dt><dd>
319  <table border="0" cellspacing="2" cellpadding="0">
320    <tr><td valign=top><em>@see</em>&nbsp;</td><td>setCustomParaemter for full details. </td></tr>
321  </table>
322</dl>
323
324<p>
325Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00180">180</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.
326<p>
327References <a class="el" href="OgreException_8h-source.html#l00033">OGRE_EXCEPT</a>.    </td>
328  </tr>
329</table>
330<a class="anchor" name="Ogre_1_1BorderRenderablea10" doxytag="Ogre::BorderRenderable::getLights" ></a><p>
331<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
332  <tr>
333    <td class="mdRow">
334      <table cellpadding="0" cellspacing="0" border="0">
335        <tr>
336          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a59">LightList</a>&amp; Ogre::BorderRenderable::getLights </td>
337          <td class="md" valign="top">(&nbsp;</td>
338          <td class="md" nowrap valign="top">void&nbsp;</td>
339          <td class="mdname1" valign="top" nowrap>          </td>
340          <td class="md" valign="top">&nbsp;)&nbsp;</td>
341          <td class="md" nowrap> const<code> [virtual]</code></td>
342        </tr>
343
344      </table>
345    </td>
346  </tr>
347</table>
348<table cellspacing=5 cellpadding=0 border=0>
349  <tr>
350    <td>
351      &nbsp;
352    </td>
353    <td>
354
355<p>
356Gets a list of lights, ordered relative to how close they are to this renderable.
357<p>
358<dl compact><dt><b>Remarks:</b></dt><dd>Directional lights, which have no position, will always be first on this list. </dd></dl>
359
360<p>
361Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea14">Ogre::Renderable</a>.
362<p>
363Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00324">324</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.
364<p>
365References <a class="el" href="OgreCommon_8h-source.html#l00195">Ogre::LightList</a>.    </td>
366  </tr>
367</table>
368<a class="anchor" name="Ogre_1_1BorderRenderablea1" doxytag="Ogre::BorderRenderable::getMaterial" ></a><p>
369<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
370  <tr>
371    <td class="mdRow">
372      <table cellpadding="0" cellspacing="0" border="0">
373        <tr>
374          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a>&amp; Ogre::BorderRenderable::getMaterial </td>
375          <td class="md" valign="top">(&nbsp;</td>
376          <td class="md" nowrap valign="top">void&nbsp;</td>
377          <td class="mdname1" valign="top" nowrap>          </td>
378          <td class="md" valign="top">&nbsp;)&nbsp;</td>
379          <td class="md" nowrap> const<code> [virtual]</code></td>
380        </tr>
381
382      </table>
383    </td>
384  </tr>
385</table>
386<table cellspacing=5 cellpadding=0 border=0>
387  <tr>
388    <td>
389      &nbsp;
390    </td>
391    <td>
392
393<p>
394Retrieves a weak reference to the material this renderable object uses.
395<p>
396<dl compact><dt><b>Remarks:</b></dt><dd>Note that the <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> also has the option to override the getTechnique method to specify a particular <a class="el" href="classOgre_1_1Technique.html">Technique</a> to use instead of the best one available. </dd></dl>
397
398<p>
399Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea2">Ogre::Renderable</a>.
400<p>
401Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00315">315</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
402  </tr>
403</table>
404<a class="anchor" name="Ogre_1_1WireBoundingBoxa47" doxytag="Ogre::BorderRenderable::getNormaliseNormals" ></a><p>
405<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
406  <tr>
407    <td class="mdRow">
408      <table cellpadding="0" cellspacing="0" border="0">
409        <tr>
410          <td class="md" nowrap valign="top"> virtual bool Ogre::Renderable::getNormaliseNormals </td>
411          <td class="md" valign="top">(&nbsp;</td>
412          <td class="md" nowrap valign="top">void&nbsp;</td>
413          <td class="mdname1" valign="top" nowrap>          </td>
414          <td class="md" valign="top">&nbsp;)&nbsp;</td>
415          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
416        </tr>
417
418      </table>
419    </td>
420  </tr>
421</table>
422<table cellspacing=5 cellpadding=0 border=0>
423  <tr>
424    <td>
425      &nbsp;
426    </td>
427    <td>
428
429<p>
430Returns whether or not this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> wishes the hardware to normalise normals.
431<p>
432
433<p>
434Reimplemented in <a class="el" href="classOgre_1_1SubEntity.html#Ogre_1_1SubEntitya11">Ogre::SubEntity</a>.
435<p>
436Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00138">138</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
437  </tr>
438</table>
439<a class="anchor" name="Ogre_1_1BorderRenderablea6" doxytag="Ogre::BorderRenderable::getNumWorldTransforms" ></a><p>
440<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
441  <tr>
442    <td class="mdRow">
443      <table cellpadding="0" cellspacing="0" border="0">
444        <tr>
445          <td class="md" nowrap valign="top"> unsigned short Ogre::BorderRenderable::getNumWorldTransforms </td>
446          <td class="md" valign="top">(&nbsp;</td>
447          <td class="md" nowrap valign="top">void&nbsp;</td>
448          <td class="mdname1" valign="top" nowrap>          </td>
449          <td class="md" valign="top">&nbsp;)&nbsp;</td>
450          <td class="md" nowrap> const<code> [virtual]</code></td>
451        </tr>
452
453      </table>
454    </td>
455  </tr>
456</table>
457<table cellspacing=5 cellpadding=0 border=0>
458  <tr>
459    <td>
460      &nbsp;
461    </td>
462    <td>
463
464<p>
465Returns the number of world transform matrices this renderable requires.
466<p>
467<dl compact><dt><b>Remarks:</b></dt><dd>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. </dd></dl>
468
469<p>
470Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa43">Ogre::Renderable</a>.
471<p>
472Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00320">320</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
473  </tr>
474</table>
475<a class="anchor" name="Ogre_1_1WireBoundingBoxa46" doxytag="Ogre::BorderRenderable::getRenderDetail" ></a><p>
476<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
477  <tr>
478    <td class="mdRow">
479      <table cellpadding="0" cellspacing="0" border="0">
480        <tr>
481          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a646">SceneDetailLevel</a> Ogre::Renderable::getRenderDetail </td>
482          <td class="md" valign="top">(&nbsp;</td>
483          <td class="mdname1" valign="top" nowrap>          </td>
484          <td class="md" valign="top">&nbsp;)&nbsp;</td>
485          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
486        </tr>
487
488      </table>
489    </td>
490  </tr>
491</table>
492<table cellspacing=5 cellpadding=0 border=0>
493  <tr>
494    <td>
495      &nbsp;
496    </td>
497    <td>
498
499<p>
500Returns the preferred rasterisation mode of this renderable.
501<p>
502
503<p>
504Reimplemented in <a class="el" href="classOgre_1_1SubEntity.html#Ogre_1_1SubEntitya15">Ogre::SubEntity</a>.
505<p>
506Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00135">135</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.
507<p>
508References <a class="el" href="OgreCommon_8h-source.html#l00148">Ogre::SceneDetailLevel</a>, and <a class="el" href="namespaceOgre.html#a646a102">Ogre::SDL_SOLID</a>.    </td>
509  </tr>
510</table>
511<a class="anchor" name="Ogre_1_1BorderRenderablea11" doxytag="Ogre::BorderRenderable::getRenderDetailOverrideable" ></a><p>
512<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
513  <tr>
514    <td class="mdRow">
515      <table cellpadding="0" cellspacing="0" border="0">
516        <tr>
517          <td class="md" nowrap valign="top"> bool Ogre::BorderRenderable::getRenderDetailOverrideable </td>
518          <td class="md" valign="top">(&nbsp;</td>
519          <td class="md" nowrap valign="top">void&nbsp;</td>
520          <td class="mdname1" valign="top" nowrap>          </td>
521          <td class="md" valign="top">&nbsp;)&nbsp;</td>
522          <td class="md" nowrap> const<code> [virtual]</code></td>
523        </tr>
524
525      </table>
526    </td>
527  </tr>
528</table>
529<table cellspacing=5 cellpadding=0 border=0>
530  <tr>
531    <td>
532      &nbsp;
533    </td>
534    <td>
535
536<p>
537Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
538<p>
539
540<p>
541Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa54">Ogre::Renderable</a>.
542<p>
543Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00330">330</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
544  </tr>
545</table>
546<a class="anchor" name="Ogre_1_1BorderRenderablea2" doxytag="Ogre::BorderRenderable::getRenderOperation" ></a><p>
547<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
548  <tr>
549    <td class="mdRow">
550      <table cellpadding="0" cellspacing="0" border="0">
551        <tr>
552          <td class="md" nowrap valign="top"> void Ogre::BorderRenderable::getRenderOperation </td>
553          <td class="md" valign="top">(&nbsp;</td>
554          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> &amp;&nbsp;</td>
555          <td class="mdname1" valign="top" nowrap> <em>op</em>          </td>
556          <td class="md" valign="top">&nbsp;)&nbsp;</td>
557          <td class="md" nowrap><code> [virtual]</code></td>
558        </tr>
559
560      </table>
561    </td>
562  </tr>
563</table>
564<table cellspacing=5 cellpadding=0 border=0>
565  <tr>
566    <td>
567      &nbsp;
568    </td>
569    <td>
570
571<p>
572Gets the render operation required to send this object to the frame buffer.
573<p>
574
575<p>
576Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea4">Ogre::Renderable</a>.
577<p>
578Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00316">316</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
579  </tr>
580</table>
581<a class="anchor" name="Ogre_1_1BorderRenderablea9" doxytag="Ogre::BorderRenderable::getSquaredViewDepth" ></a><p>
582<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
583  <tr>
584    <td class="mdRow">
585      <table cellpadding="0" cellspacing="0" border="0">
586        <tr>
587          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::BorderRenderable::getSquaredViewDepth </td>
588          <td class="md" valign="top">(&nbsp;</td>
589          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Camera.html">Camera</a> *&nbsp;</td>
590          <td class="mdname1" valign="top" nowrap> <em>cam</em>          </td>
591          <td class="md" valign="top">&nbsp;)&nbsp;</td>
592          <td class="md" nowrap> const<code> [virtual]</code></td>
593        </tr>
594
595      </table>
596    </td>
597  </tr>
598</table>
599<table cellspacing=5 cellpadding=0 border=0>
600  <tr>
601    <td>
602      &nbsp;
603    </td>
604    <td>
605
606<p>
607Returns the camera-relative squared depth of this renderable.
608<p>
609<dl compact><dt><b>Remarks:</b></dt><dd>Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.</dd></dl>
610
611<p>
612Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1SimpleRenderablea47">Ogre::Renderable</a>.
613<p>
614Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00323">323</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.
615<p>
616References <a class="el" href="OgrePrerequisites_8h-source.html#l00111">Ogre::Real</a>.    </td>
617  </tr>
618</table>
619<a class="anchor" name="Ogre_1_1WireBoundingBoxa42" doxytag="Ogre::BorderRenderable::getTechnique" ></a><p>
620<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
621  <tr>
622    <td class="mdRow">
623      <table cellpadding="0" cellspacing="0" border="0">
624        <tr>
625          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1Technique.html">Technique</a>* Ogre::Renderable::getTechnique </td>
626          <td class="md" valign="top">(&nbsp;</td>
627          <td class="md" nowrap valign="top">void&nbsp;</td>
628          <td class="mdname1" valign="top" nowrap>          </td>
629          <td class="md" valign="top">&nbsp;)&nbsp;</td>
630          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
631        </tr>
632
633      </table>
634    </td>
635  </tr>
636</table>
637<table cellspacing=5 cellpadding=0 border=0>
638  <tr>
639    <td>
640      &nbsp;
641    </td>
642    <td>
643
644<p>
645Retrieves a pointer to the <a class="el" href="classOgre_1_1Material.html">Material</a> <a class="el" href="classOgre_1_1Technique.html">Technique</a> this renderable object uses.
646<p>
647<dl compact><dt><b>Remarks:</b></dt><dd>This is to allow Renderables to use a chosen <a class="el" href="classOgre_1_1Technique.html">Technique</a> if they wish, otherwise they will use the best <a class="el" href="classOgre_1_1Technique.html">Technique</a> available for the <a class="el" href="classOgre_1_1Material.html">Material</a> they are using. </dd></dl>
648
649<p>
650Reimplemented in <a class="el" href="classOgre_1_1StaticGeometry_1_1GeometryBucket.html#Ogre_1_1StaticGeometry_1_1GeometryBucketa6">Ogre::StaticGeometry::GeometryBucket</a>, and <a class="el" href="classOgre_1_1SubEntity.html#Ogre_1_1SubEntitya6">Ogre::SubEntity</a>.
651<p>
652Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00069">69</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
653  </tr>
654</table>
655<a class="anchor" name="Ogre_1_1BorderRenderablea4" doxytag="Ogre::BorderRenderable::getWorldOrientation" ></a><p>
656<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
657  <tr>
658    <td class="mdRow">
659      <table cellpadding="0" cellspacing="0" border="0">
660        <tr>
661          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a>&amp; Ogre::BorderRenderable::getWorldOrientation </td>
662          <td class="md" valign="top">(&nbsp;</td>
663          <td class="md" nowrap valign="top">void&nbsp;</td>
664          <td class="mdname1" valign="top" nowrap>          </td>
665          <td class="md" valign="top">&nbsp;)&nbsp;</td>
666          <td class="md" nowrap> const<code> [virtual]</code></td>
667        </tr>
668
669      </table>
670    </td>
671  </tr>
672</table>
673<table cellspacing=5 cellpadding=0 border=0>
674  <tr>
675    <td>
676      &nbsp;
677    </td>
678    <td>
679
680<p>
681Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex &amp; fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
682<p>
683
684<p>
685Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea6">Ogre::Renderable</a>.
686<p>
687Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00318">318</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
688  </tr>
689</table>
690<a class="anchor" name="Ogre_1_1BorderRenderablea5" doxytag="Ogre::BorderRenderable::getWorldPosition" ></a><p>
691<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
692  <tr>
693    <td class="mdRow">
694      <table cellpadding="0" cellspacing="0" border="0">
695        <tr>
696          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>&amp; Ogre::BorderRenderable::getWorldPosition </td>
697          <td class="md" valign="top">(&nbsp;</td>
698          <td class="md" nowrap valign="top">void&nbsp;</td>
699          <td class="mdname1" valign="top" nowrap>          </td>
700          <td class="md" valign="top">&nbsp;)&nbsp;</td>
701          <td class="md" nowrap> const<code> [virtual]</code></td>
702        </tr>
703
704      </table>
705    </td>
706  </tr>
707</table>
708<table cellspacing=5 cellpadding=0 border=0>
709  <tr>
710    <td>
711      &nbsp;
712    </td>
713    <td>
714
715<p>
716Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex &amp; fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
717<p>
718
719<p>
720Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea7">Ogre::Renderable</a>.
721<p>
722Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00319">319</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
723  </tr>
724</table>
725<a class="anchor" name="Ogre_1_1BorderRenderablea3" doxytag="Ogre::BorderRenderable::getWorldTransforms" ></a><p>
726<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
727  <tr>
728    <td class="mdRow">
729      <table cellpadding="0" cellspacing="0" border="0">
730        <tr>
731          <td class="md" nowrap valign="top"> void Ogre::BorderRenderable::getWorldTransforms </td>
732          <td class="md" valign="top">(&nbsp;</td>
733          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> *&nbsp;</td>
734          <td class="mdname1" valign="top" nowrap> <em>xform</em>          </td>
735          <td class="md" valign="top">&nbsp;)&nbsp;</td>
736          <td class="md" nowrap> const<code> [virtual]</code></td>
737        </tr>
738
739      </table>
740    </td>
741  </tr>
742</table>
743<table cellspacing=5 cellpadding=0 border=0>
744  <tr>
745    <td>
746      &nbsp;
747    </td>
748    <td>
749
750<p>
751Gets the world transform matrix / matrices for this renderable object.
752<p>
753<dl compact><dt><b>Remarks:</b></dt><dd>If the object has any derived transforms, these are expected to be up to date as long as all the <a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> structures have been updated before this is called. </dd></dl>
754<dl compact><dt><b></b></dt><dd>This method will populate xform 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 getNumWorldTransforms. </dd></dl>
755
756<p>
757Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea5">Ogre::Renderable</a>.
758<p>
759Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00317">317</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
760  </tr>
761</table>
762<a class="anchor" name="Ogre_1_1WireBoundingBoxa50" doxytag="Ogre::BorderRenderable::setCustomParameter" ></a><p>
763<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
764  <tr>
765    <td class="mdRow">
766      <table cellpadding="0" cellspacing="0" border="0">
767        <tr>
768          <td class="md" nowrap valign="top"> void Ogre::Renderable::setCustomParameter </td>
769          <td class="md" valign="top">(&nbsp;</td>
770          <td class="md" nowrap valign="top">size_t&nbsp;</td>
771          <td class="mdname" nowrap> <em>index</em>, </td>
772        </tr>
773        <tr>
774          <td class="md" nowrap align="right"></td>
775          <td></td>
776          <td class="md" nowrap>const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &amp;&nbsp;</td>
777          <td class="mdname" nowrap> <em>value</em></td>
778        </tr>
779        <tr>
780          <td></td>
781          <td class="md">)&nbsp;</td>
782          <td class="md" colspan="2"><code> [inherited]</code></td>
783        </tr>
784
785      </table>
786    </td>
787  </tr>
788</table>
789<table cellspacing=5 cellpadding=0 border=0>
790  <tr>
791    <td>
792      &nbsp;
793    </td>
794    <td>
795
796<p>
797Sets a custom parameter for this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a>, which may be used to drive calculations for this specific <a class="el" href="classOgre_1_1Renderable.html">Renderable</a>, like GPU program parameters.
798<p>
799<dl compact><dt><b>Remarks:</b></dt><dd>Calling this method simply associates a numeric index with a 4-dimensional value for this specific <a class="el" href="classOgre_1_1Renderable.html">Renderable</a>. This is most useful if the material which this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> uses a vertex or fragment program, and has an ACT_CUSTOM 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. </dd></dl>
800<dl compact><dt><b>Parameters:</b></dt><dd>
801  <table border="0" cellspacing="2" cellpadding="0">
802    <tr><td valign=top><em>index</em>&nbsp;</td><td>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 GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used. </td></tr>
803    <tr><td valign=top><em>value</em>&nbsp;</td><td>The value to associate. </td></tr>
804  </table>
805</dl>
806
807<p>
808Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00171">171</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
809  </tr>
810</table>
811<a class="anchor" name="Ogre_1_1WireBoundingBoxa53" doxytag="Ogre::BorderRenderable::setRenderDetailOverrideable" ></a><p>
812<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
813  <tr>
814    <td class="mdRow">
815      <table cellpadding="0" cellspacing="0" border="0">
816        <tr>
817          <td class="md" nowrap valign="top"> virtual void Ogre::Renderable::setRenderDetailOverrideable </td>
818          <td class="md" valign="top">(&nbsp;</td>
819          <td class="md" nowrap valign="top">bool&nbsp;</td>
820          <td class="mdname1" valign="top" nowrap> <em>override</em>          </td>
821          <td class="md" valign="top">&nbsp;)&nbsp;</td>
822          <td class="md" nowrap><code> [virtual, inherited]</code></td>
823        </tr>
824
825      </table>
826    </td>
827  </tr>
828</table>
829<table cellspacing=5 cellpadding=0 border=0>
830  <tr>
831    <td>
832      &nbsp;
833    </td>
834    <td>
835
836<p>
837Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
838<p>
839<dl compact><dt><b>Parameters:</b></dt><dd>
840  <table border="0" cellspacing="2" cellpadding="0">
841    <tr><td valign=top><em>override</em>&nbsp;</td><td>true means that a lower camera detail will override this renderables detail level, false means it won't.</td></tr>
842  </table>
843</dl>
844
845<p>
846Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00235">235</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
847  </tr>
848</table>
849<a class="anchor" name="Ogre_1_1BorderRenderablea7" doxytag="Ogre::BorderRenderable::useIdentityProjection" ></a><p>
850<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
851  <tr>
852    <td class="mdRow">
853      <table cellpadding="0" cellspacing="0" border="0">
854        <tr>
855          <td class="md" nowrap valign="top"> bool Ogre::BorderRenderable::useIdentityProjection </td>
856          <td class="md" valign="top">(&nbsp;</td>
857          <td class="md" nowrap valign="top">void&nbsp;</td>
858          <td class="mdname1" valign="top" nowrap>          </td>
859          <td class="md" valign="top">&nbsp;)&nbsp;</td>
860          <td class="md" nowrap> const<code> [virtual]</code></td>
861        </tr>
862
863      </table>
864    </td>
865  </tr>
866</table>
867<table cellspacing=5 cellpadding=0 border=0>
868  <tr>
869    <td>
870      &nbsp;
871    </td>
872    <td>
873
874<p>
875Returns whether or not to use an 'identity' projection.
876<p>
877<dl compact><dt><b>Remarks:</b></dt><dd>Usually <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> 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 override this. </dd></dl>
878
879<p>
880Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa44">Ogre::Renderable</a>.
881<p>
882Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00321">321</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
883  </tr>
884</table>
885<a class="anchor" name="Ogre_1_1BorderRenderablea8" doxytag="Ogre::BorderRenderable::useIdentityView" ></a><p>
886<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
887  <tr>
888    <td class="mdRow">
889      <table cellpadding="0" cellspacing="0" border="0">
890        <tr>
891          <td class="md" nowrap valign="top"> bool Ogre::BorderRenderable::useIdentityView </td>
892          <td class="md" valign="top">(&nbsp;</td>
893          <td class="md" nowrap valign="top">void&nbsp;</td>
894          <td class="mdname1" valign="top" nowrap>          </td>
895          <td class="md" valign="top">&nbsp;)&nbsp;</td>
896          <td class="md" nowrap> const<code> [virtual]</code></td>
897        </tr>
898
899      </table>
900    </td>
901  </tr>
902</table>
903<table cellspacing=5 cellpadding=0 border=0>
904  <tr>
905    <td>
906      &nbsp;
907    </td>
908    <td>
909
910<p>
911Returns whether or not to use an 'identity' projection.
912<p>
913<dl compact><dt><b>Remarks:</b></dt><dd>Usually <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> 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 override this. </dd></dl>
914
915<p>
916Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa45">Ogre::Renderable</a>.
917<p>
918Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00322">322</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
919  </tr>
920</table>
921<hr><h2>Member Data Documentation</h2>
922<a class="anchor" name="Ogre_1_1WireBoundingBoxp20" doxytag="Ogre::BorderRenderable::mCustomParameters" ></a><p>
923<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
924  <tr>
925    <td class="mdRow">
926      <table cellpadding="0" cellspacing="0" border="0">
927        <tr>
928          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx0">CustomParameterMap</a> <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp20">Ogre::Renderable::mCustomParameters</a><code> [protected, inherited]</code>
929      </table>
930    </td>
931  </tr>
932</table>
933<table cellspacing=5 cellpadding=0 border=0>
934  <tr>
935    <td>
936      &nbsp;
937    </td>
938    <td>
939
940<p>
941
942<p>
943Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00252">252</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
944  </tr>
945</table>
946<a class="anchor" name="Ogre_1_1BorderRenderablep0" doxytag="Ogre::BorderRenderable::mParent" ></a><p>
947<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
948  <tr>
949    <td class="mdRow">
950      <table cellpadding="0" cellspacing="0" border="0">
951        <tr>
952          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a>* <a class="el" href="classOgre_1_1BorderRenderable.html#Ogre_1_1BorderRenderablep0">Ogre::BorderRenderable::mParent</a><code> [protected]</code>
953      </table>
954    </td>
955  </tr>
956</table>
957<table cellspacing=5 cellpadding=0 border=0>
958  <tr>
959    <td>
960      &nbsp;
961    </td>
962    <td>
963
964<p>
965
966<p>
967Definition at line <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html#l00311">311</a> of file <a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a>.    </td>
968  </tr>
969</table>
970<a class="anchor" name="Ogre_1_1WireBoundingBoxp21" doxytag="Ogre::BorderRenderable::mRenderDetailOverrideable" ></a><p>
971<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
972  <tr>
973    <td class="mdRow">
974      <table cellpadding="0" cellspacing="0" border="0">
975        <tr>
976          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp21">Ogre::Renderable::mRenderDetailOverrideable</a><code> [protected, inherited]</code>
977      </table>
978    </td>
979  </tr>
980</table>
981<table cellspacing=5 cellpadding=0 border=0>
982  <tr>
983    <td>
984      &nbsp;
985    </td>
986    <td>
987
988<p>
989
990<p>
991Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00253">253</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
992  </tr>
993</table>
994<a class="anchor" name="Ogre_1_1WireBoundingBoxt1" doxytag="Ogre::BorderRenderable::msDummyPlaneList" ></a><p>
995<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
996  <tr>
997    <td class="mdRow">
998      <table cellpadding="0" cellspacing="0" border="0">
999        <tr>
1000          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a410">PlaneList</a> <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxt1">Ogre::Renderable::msDummyPlaneList</a><code> [static, protected, inherited]</code>
1001      </table>
1002    </td>
1003  </tr>
1004</table>
1005<table cellspacing=5 cellpadding=0 border=0>
1006  <tr>
1007    <td>
1008      &nbsp;
1009    </td>
1010    <td>
1011
1012<p>
1013
1014<p>
1015Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00250">250</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
1016  </tr>
1017</table>
1018<hr>The documentation for this class was generated from the following file:<ul>
1019<li><a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a></ul>
1020<hr>
1021<p>
1022Copyright &copy; 2000-2005 by The OGRE Team<br />
1023<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
1024This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
1025                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
1026                <Work rdf:about="">
1027                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1028        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1029                </Work>
1030                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
1031
1032Last modified Sun Feb 12 13:00:13 2006
1033</p>
1034</body>
1035</html>
Note: See TracBrowser for help on using the repository browser.