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

Revision 692, 54.4 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
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#a465">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#a73">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">getPolygonModeOverrideable</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_1WireBoundingBoxa56">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_1WireBoundingBoxa56"></a><br><br></td></tr>
62<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_1WireBoundingBoxa60">getNormaliseNormals</a> (void) const </td></tr>
63
64<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_1WireBoundingBoxa60"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="namespaceOgre.html#a453">PlaneList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa61">getClipPlanes</a> () const </td></tr>
66
67<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_1WireBoundingBoxa62">getCastsShadows</a> (void) const </td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method which reports whether this renderable would normally cast a shadow.  <a href="#Ogre_1_1WireBoundingBoxa62"></a><br><br></td></tr>
70<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_1WireBoundingBoxa63">setCustomParameter</a> (size_t index, const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &amp;value)</td></tr>
71
72<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_1WireBoundingBoxa63"></a><br><br></td></tr>
73<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_1WireBoundingBoxa64">getCustomParameter</a> (size_t index) const </td></tr>
74
75<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_1WireBoundingBoxa64"></a><br><br></td></tr>
76<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_1WireBoundingBoxa65">_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> *params) const </td></tr>
77
78<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_1WireBoundingBoxa65"></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_1WireBoundingBoxa66">setPolygonModeOverrideable</a> (bool override)</td></tr>
80
81<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_1WireBoundingBoxa66"></a><br><br></td></tr>
82<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; size_t,<br>
84 <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_1WireBoundingBoxx1">CustomParameterMap</a></td></tr>
85
86<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
87<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>
88
89<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx1">CustomParameterMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp26">mCustomParameters</a></td></tr>
90
91<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_1WireBoundingBoxp27">mPolygonModeOverrideable</a></td></tr>
92
93<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
94<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a453">PlaneList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxt4">msDummyPlaneList</a></td></tr>
95
96</table>
97<hr><a name="_details"></a><h2>Detailed Description</h2>
98Class for rendering the border of a <a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a>.
99<p>
100<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>
101
102<p>
103
104<p>
105Definition 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>
106<a class="anchor" name="Ogre_1_1WireBoundingBoxx1" doxytag="Ogre::BorderRenderable::CustomParameterMap" ></a><p>
107<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
108  <tr>
109    <td class="mdRow">
110      <table cellpadding="0" cellspacing="0" border="0">
111        <tr>
112          <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_1WireBoundingBoxx1">Ogre::Renderable::CustomParameterMap</a><code> [protected, inherited]</code>
113      </table>
114    </td>
115  </tr>
116</table>
117<table cellspacing=5 cellpadding=0 border=0>
118  <tr>
119    <td>
120      &nbsp;
121    </td>
122    <td>
123
124<p>
125
126<p>
127Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00247">247</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
128  </tr>
129</table>
130<hr><h2>Constructor &amp; Destructor Documentation</h2>
131<a class="anchor" name="Ogre_1_1BorderRenderablea0" doxytag="Ogre::BorderRenderable::BorderRenderable" ></a><p>
132<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
133  <tr>
134    <td class="mdRow">
135      <table cellpadding="0" cellspacing="0" border="0">
136        <tr>
137          <td class="md" nowrap valign="top"> Ogre::BorderRenderable::BorderRenderable </td>
138          <td class="md" valign="top">(&nbsp;</td>
139          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1BorderPanelOverlayElement.html">BorderPanelOverlayElement</a> *&nbsp;</td>
140          <td class="mdname1" valign="top" nowrap> <em>parent</em>          </td>
141          <td class="md" valign="top">&nbsp;)&nbsp;</td>
142          <td class="md" nowrap></td>
143        </tr>
144
145      </table>
146    </td>
147  </tr>
148</table>
149<table cellspacing=5 cellpadding=0 border=0>
150  <tr>
151    <td>
152      &nbsp;
153    </td>
154    <td>
155
156<p>
157Constructed with pointers to parent.
158<p>
159
160<p>
161Definition 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>
162  </tr>
163</table>
164<hr><h2>Member Function Documentation</h2>
165<a class="anchor" name="Ogre_1_1WireBoundingBoxa65" doxytag="Ogre::BorderRenderable::_updateCustomGpuParameter" ></a><p>
166<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
167  <tr>
168    <td class="mdRow">
169      <table cellpadding="0" cellspacing="0" border="0">
170        <tr>
171          <td class="md" nowrap valign="top"> virtual void Ogre::Renderable::_updateCustomGpuParameter </td>
172          <td class="md" valign="top">(&nbsp;</td>
173          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1GpuProgramParameters_1_1AutoConstantEntry.html">GpuProgramParameters::AutoConstantEntry</a> &amp;&nbsp;</td>
174          <td class="mdname" nowrap> <em>constantEntry</em>, </td>
175        </tr>
176        <tr>
177          <td class="md" nowrap align="right"></td>
178          <td></td>
179          <td class="md" nowrap><a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> *&nbsp;</td>
180          <td class="mdname" nowrap> <em>params</em></td>
181        </tr>
182        <tr>
183          <td></td>
184          <td class="md">)&nbsp;</td>
185          <td class="md" colspan="2"> const<code> [virtual, inherited]</code></td>
186        </tr>
187
188      </table>
189    </td>
190  </tr>
191</table>
192<table cellspacing=5 cellpadding=0 border=0>
193  <tr>
194    <td>
195      &nbsp;
196    </td>
197    <td>
198
199<p>
200Update 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.
201<p>
202<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>
203<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>
204<dl compact><dt><b>Parameters:</b></dt><dd>
205  <table border="0" cellspacing="2" cellpadding="0">
206    <tr><td valign=top><em>constantEntry</em>&nbsp;</td><td>The auto constant entry referring to the parameter being updated </td></tr>
207    <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>
208  </table>
209</dl>
210
211<p>
212Reimplemented in <a class="el" href="classOgre_1_1SubEntity.html#Ogre_1_1SubEntitya26">Ogre::SubEntity</a>, and <a class="el" href="classOgre_1_1TerrainRenderable.html#Ogre_1_1TerrainRenderablea26">Ogre::TerrainRenderable</a>.
213<p>
214Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00215">215</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.
215<p>
216References <a class="el" href="OgreGpuProgram_8h-source.html#l00376">Ogre::GpuProgramParameters::AutoConstantEntry::data</a>, <a class="el" href="OgreGpuProgram_8h-source.html#l00373">Ogre::GpuProgramParameters::AutoConstantEntry::index</a>, and <a class="el" href="classOgre_1_1GpuProgramParameters.html#Ogre_1_1GpuProgramParametersa4">Ogre::GpuProgramParameters::setConstant()</a>.    </td>
217  </tr>
218</table>
219<a class="anchor" name="Ogre_1_1WireBoundingBoxa62" doxytag="Ogre::BorderRenderable::getCastsShadows" ></a><p>
220<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
221  <tr>
222    <td class="mdRow">
223      <table cellpadding="0" cellspacing="0" border="0">
224        <tr>
225          <td class="md" nowrap valign="top"> virtual bool Ogre::Renderable::getCastsShadows </td>
226          <td class="md" valign="top">(&nbsp;</td>
227          <td class="md" nowrap valign="top">void&nbsp;</td>
228          <td class="mdname1" valign="top" nowrap>          </td>
229          <td class="md" valign="top">&nbsp;)&nbsp;</td>
230          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
231        </tr>
232
233      </table>
234    </td>
235  </tr>
236</table>
237<table cellspacing=5 cellpadding=0 border=0>
238  <tr>
239    <td>
240      &nbsp;
241    </td>
242    <td>
243
244<p>
245Method which reports whether this renderable would normally cast a shadow.
246<p>
247<dl compact><dt><b>Remarks:</b></dt><dd>Subclasses should override this if they could have been used to generate a shadow. </dd></dl>
248
249<p>
250Reimplemented 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_1SubEntitya15">Ogre::SubEntity</a>.
251<p>
252Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00150">150</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
253  </tr>
254</table>
255<a class="anchor" name="Ogre_1_1WireBoundingBoxa61" doxytag="Ogre::BorderRenderable::getClipPlanes" ></a><p>
256<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
257  <tr>
258    <td class="mdRow">
259      <table cellpadding="0" cellspacing="0" border="0">
260        <tr>
261          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a453">PlaneList</a>&amp; Ogre::Renderable::getClipPlanes </td>
262          <td class="md" valign="top">(&nbsp;</td>
263          <td class="mdname1" valign="top" nowrap>          </td>
264          <td class="md" valign="top">&nbsp;)&nbsp;</td>
265          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
266        </tr>
267
268      </table>
269    </td>
270  </tr>
271</table>
272<table cellspacing=5 cellpadding=0 border=0>
273  <tr>
274    <td>
275      &nbsp;
276    </td>
277    <td>
278
279<p>
280
281<p>
282Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00142">142</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.
283<p>
284References <a class="el" href="OgrePlane_8h-source.html#l00109">Ogre::PlaneList</a>.    </td>
285  </tr>
286</table>
287<a class="anchor" name="Ogre_1_1WireBoundingBoxa64" doxytag="Ogre::BorderRenderable::getCustomParameter" ></a><p>
288<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a>&amp; Ogre::Renderable::getCustomParameter </td>
294          <td class="md" valign="top">(&nbsp;</td>
295          <td class="md" nowrap valign="top">size_t&nbsp;</td>
296          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
297          <td class="md" valign="top">&nbsp;)&nbsp;</td>
298          <td class="md" nowrap> const<code> [inherited]</code></td>
299        </tr>
300
301      </table>
302    </td>
303  </tr>
304</table>
305<table cellspacing=5 cellpadding=0 border=0>
306  <tr>
307    <td>
308      &nbsp;
309    </td>
310    <td>
311
312<p>
313Gets the custom value associated with this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> at the given index.
314<p>
315<dl compact><dt><b>Parameters:</b></dt><dd>
316  <table border="0" cellspacing="2" cellpadding="0">
317    <tr><td valign=top><em>@see</em>&nbsp;</td><td>setCustomParaemter for full details. </td></tr>
318  </table>
319</dl>
320
321<p>
322Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00176">176</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.
323<p>
324References <a class="el" href="OgreException_8h-source.html#l00033">OGRE_EXCEPT</a>.    </td>
325  </tr>
326</table>
327<a class="anchor" name="Ogre_1_1BorderRenderablea10" doxytag="Ogre::BorderRenderable::getLights" ></a><p>
328<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
329  <tr>
330    <td class="mdRow">
331      <table cellpadding="0" cellspacing="0" border="0">
332        <tr>
333          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a73">LightList</a>&amp; Ogre::BorderRenderable::getLights </td>
334          <td class="md" valign="top">(&nbsp;</td>
335          <td class="md" nowrap valign="top">void&nbsp;</td>
336          <td class="mdname1" valign="top" nowrap>          </td>
337          <td class="md" valign="top">&nbsp;)&nbsp;</td>
338          <td class="md" nowrap> const<code> [virtual]</code></td>
339        </tr>
340
341      </table>
342    </td>
343  </tr>
344</table>
345<table cellspacing=5 cellpadding=0 border=0>
346  <tr>
347    <td>
348      &nbsp;
349    </td>
350    <td>
351
352<p>
353Gets a list of lights, ordered relative to how close they are to this renderable.
354<p>
355<dl compact><dt><b>Remarks:</b></dt><dd>Directional lights, which have no position, will always be first on this list. </dd></dl>
356
357<p>
358Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea13">Ogre::Renderable</a>.
359<p>
360Definition 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>.
361<p>
362References <a class="el" href="OgreCommon_8h-source.html#l00238">Ogre::LightList</a>.    </td>
363  </tr>
364</table>
365<a class="anchor" name="Ogre_1_1BorderRenderablea1" doxytag="Ogre::BorderRenderable::getMaterial" ></a><p>
366<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
367  <tr>
368    <td class="mdRow">
369      <table cellpadding="0" cellspacing="0" border="0">
370        <tr>
371          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a>&amp; Ogre::BorderRenderable::getMaterial </td>
372          <td class="md" valign="top">(&nbsp;</td>
373          <td class="md" nowrap valign="top">void&nbsp;</td>
374          <td class="mdname1" valign="top" nowrap>          </td>
375          <td class="md" valign="top">&nbsp;)&nbsp;</td>
376          <td class="md" nowrap> const<code> [virtual]</code></td>
377        </tr>
378
379      </table>
380    </td>
381  </tr>
382</table>
383<table cellspacing=5 cellpadding=0 border=0>
384  <tr>
385    <td>
386      &nbsp;
387    </td>
388    <td>
389
390<p>
391Retrieves a weak reference to the material this renderable object uses.
392<p>
393<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>
394
395<p>
396Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea2">Ogre::Renderable</a>.
397<p>
398Definition 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>
399  </tr>
400</table>
401<a class="anchor" name="Ogre_1_1WireBoundingBoxa60" doxytag="Ogre::BorderRenderable::getNormaliseNormals" ></a><p>
402<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
403  <tr>
404    <td class="mdRow">
405      <table cellpadding="0" cellspacing="0" border="0">
406        <tr>
407          <td class="md" nowrap valign="top"> virtual bool Ogre::Renderable::getNormaliseNormals </td>
408          <td class="md" valign="top">(&nbsp;</td>
409          <td class="md" nowrap valign="top">void&nbsp;</td>
410          <td class="mdname1" valign="top" nowrap>          </td>
411          <td class="md" valign="top">&nbsp;)&nbsp;</td>
412          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
413        </tr>
414
415      </table>
416    </td>
417  </tr>
418</table>
419<table cellspacing=5 cellpadding=0 border=0>
420  <tr>
421    <td>
422      &nbsp;
423    </td>
424    <td>
425
426<p>
427Returns whether or not this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> wishes the hardware to normalise normals.
428<p>
429
430<p>
431Reimplemented in <a class="el" href="classOgre_1_1SubEntity.html#Ogre_1_1SubEntitya11">Ogre::SubEntity</a>.
432<p>
433Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00134">134</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
434  </tr>
435</table>
436<a class="anchor" name="Ogre_1_1BorderRenderablea6" doxytag="Ogre::BorderRenderable::getNumWorldTransforms" ></a><p>
437<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
438  <tr>
439    <td class="mdRow">
440      <table cellpadding="0" cellspacing="0" border="0">
441        <tr>
442          <td class="md" nowrap valign="top"> unsigned short Ogre::BorderRenderable::getNumWorldTransforms </td>
443          <td class="md" valign="top">(&nbsp;</td>
444          <td class="md" nowrap valign="top">void&nbsp;</td>
445          <td class="mdname1" valign="top" nowrap>          </td>
446          <td class="md" valign="top">&nbsp;)&nbsp;</td>
447          <td class="md" nowrap> const<code> [virtual]</code></td>
448        </tr>
449
450      </table>
451    </td>
452  </tr>
453</table>
454<table cellspacing=5 cellpadding=0 border=0>
455  <tr>
456    <td>
457      &nbsp;
458    </td>
459    <td>
460
461<p>
462Returns the number of world transform matrices this renderable requires.
463<p>
464<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>
465
466<p>
467Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa57">Ogre::Renderable</a>.
468<p>
469Definition 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>
470  </tr>
471</table>
472<a class="anchor" name="Ogre_1_1BorderRenderablea11" doxytag="Ogre::BorderRenderable::getPolygonModeOverrideable" ></a><p>
473<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
474  <tr>
475    <td class="mdRow">
476      <table cellpadding="0" cellspacing="0" border="0">
477        <tr>
478          <td class="md" nowrap valign="top"> bool Ogre::BorderRenderable::getPolygonModeOverrideable </td>
479          <td class="md" valign="top">(&nbsp;</td>
480          <td class="md" nowrap valign="top">void&nbsp;</td>
481          <td class="mdname1" valign="top" nowrap>          </td>
482          <td class="md" valign="top">&nbsp;)&nbsp;</td>
483          <td class="md" nowrap> const<code> [virtual]</code></td>
484        </tr>
485
486      </table>
487    </td>
488  </tr>
489</table>
490<table cellspacing=5 cellpadding=0 border=0>
491  <tr>
492    <td>
493      &nbsp;
494    </td>
495    <td>
496
497<p>
498Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
499<p>
500
501<p>
502Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa67">Ogre::Renderable</a>.
503<p>
504Definition 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>
505  </tr>
506</table>
507<a class="anchor" name="Ogre_1_1BorderRenderablea2" doxytag="Ogre::BorderRenderable::getRenderOperation" ></a><p>
508<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
509  <tr>
510    <td class="mdRow">
511      <table cellpadding="0" cellspacing="0" border="0">
512        <tr>
513          <td class="md" nowrap valign="top"> void Ogre::BorderRenderable::getRenderOperation </td>
514          <td class="md" valign="top">(&nbsp;</td>
515          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> &amp;&nbsp;</td>
516          <td class="mdname1" valign="top" nowrap> <em>op</em>          </td>
517          <td class="md" valign="top">&nbsp;)&nbsp;</td>
518          <td class="md" nowrap><code> [virtual]</code></td>
519        </tr>
520
521      </table>
522    </td>
523  </tr>
524</table>
525<table cellspacing=5 cellpadding=0 border=0>
526  <tr>
527    <td>
528      &nbsp;
529    </td>
530    <td>
531
532<p>
533Gets the render operation required to send this object to the frame buffer.
534<p>
535
536<p>
537Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea4">Ogre::Renderable</a>.
538<p>
539Definition 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>
540  </tr>
541</table>
542<a class="anchor" name="Ogre_1_1BorderRenderablea9" doxytag="Ogre::BorderRenderable::getSquaredViewDepth" ></a><p>
543<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
544  <tr>
545    <td class="mdRow">
546      <table cellpadding="0" cellspacing="0" border="0">
547        <tr>
548          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::BorderRenderable::getSquaredViewDepth </td>
549          <td class="md" valign="top">(&nbsp;</td>
550          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Camera.html">Camera</a> *&nbsp;</td>
551          <td class="mdname1" valign="top" nowrap> <em>cam</em>          </td>
552          <td class="md" valign="top">&nbsp;)&nbsp;</td>
553          <td class="md" nowrap> const<code> [virtual]</code></td>
554        </tr>
555
556      </table>
557    </td>
558  </tr>
559</table>
560<table cellspacing=5 cellpadding=0 border=0>
561  <tr>
562    <td>
563      &nbsp;
564    </td>
565    <td>
566
567<p>
568Returns the camera-relative squared depth of this renderable.
569<p>
570<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>
571
572<p>
573Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1SimpleRenderablea61">Ogre::Renderable</a>.
574<p>
575Definition 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>.
576<p>
577References <a class="el" href="OgrePrerequisites_8h-source.html#l00113">Ogre::Real</a>.    </td>
578  </tr>
579</table>
580<a class="anchor" name="Ogre_1_1WireBoundingBoxa56" doxytag="Ogre::BorderRenderable::getTechnique" ></a><p>
581<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
582  <tr>
583    <td class="mdRow">
584      <table cellpadding="0" cellspacing="0" border="0">
585        <tr>
586          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1Technique.html">Technique</a>* Ogre::Renderable::getTechnique </td>
587          <td class="md" valign="top">(&nbsp;</td>
588          <td class="md" nowrap valign="top">void&nbsp;</td>
589          <td class="mdname1" valign="top" nowrap>          </td>
590          <td class="md" valign="top">&nbsp;)&nbsp;</td>
591          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
592        </tr>
593
594      </table>
595    </td>
596  </tr>
597</table>
598<table cellspacing=5 cellpadding=0 border=0>
599  <tr>
600    <td>
601      &nbsp;
602    </td>
603    <td>
604
605<p>
606Retrieves 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.
607<p>
608<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>
609
610<p>
611Reimplemented 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>.
612<p>
613Definition 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>
614  </tr>
615</table>
616<a class="anchor" name="Ogre_1_1BorderRenderablea4" doxytag="Ogre::BorderRenderable::getWorldOrientation" ></a><p>
617<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
618  <tr>
619    <td class="mdRow">
620      <table cellpadding="0" cellspacing="0" border="0">
621        <tr>
622          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a>&amp; Ogre::BorderRenderable::getWorldOrientation </td>
623          <td class="md" valign="top">(&nbsp;</td>
624          <td class="md" nowrap valign="top">void&nbsp;</td>
625          <td class="mdname1" valign="top" nowrap>          </td>
626          <td class="md" valign="top">&nbsp;)&nbsp;</td>
627          <td class="md" nowrap> const<code> [virtual]</code></td>
628        </tr>
629
630      </table>
631    </td>
632  </tr>
633</table>
634<table cellspacing=5 cellpadding=0 border=0>
635  <tr>
636    <td>
637      &nbsp;
638    </td>
639    <td>
640
641<p>
642Gets 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.
643<p>
644
645<p>
646Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea6">Ogre::Renderable</a>.
647<p>
648Definition 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>
649  </tr>
650</table>
651<a class="anchor" name="Ogre_1_1BorderRenderablea5" doxytag="Ogre::BorderRenderable::getWorldPosition" ></a><p>
652<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
653  <tr>
654    <td class="mdRow">
655      <table cellpadding="0" cellspacing="0" border="0">
656        <tr>
657          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>&amp; Ogre::BorderRenderable::getWorldPosition </td>
658          <td class="md" valign="top">(&nbsp;</td>
659          <td class="md" nowrap valign="top">void&nbsp;</td>
660          <td class="mdname1" valign="top" nowrap>          </td>
661          <td class="md" valign="top">&nbsp;)&nbsp;</td>
662          <td class="md" nowrap> const<code> [virtual]</code></td>
663        </tr>
664
665      </table>
666    </td>
667  </tr>
668</table>
669<table cellspacing=5 cellpadding=0 border=0>
670  <tr>
671    <td>
672      &nbsp;
673    </td>
674    <td>
675
676<p>
677Gets 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.
678<p>
679
680<p>
681Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea7">Ogre::Renderable</a>.
682<p>
683Definition 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>
684  </tr>
685</table>
686<a class="anchor" name="Ogre_1_1BorderRenderablea3" doxytag="Ogre::BorderRenderable::getWorldTransforms" ></a><p>
687<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
688  <tr>
689    <td class="mdRow">
690      <table cellpadding="0" cellspacing="0" border="0">
691        <tr>
692          <td class="md" nowrap valign="top"> void Ogre::BorderRenderable::getWorldTransforms </td>
693          <td class="md" valign="top">(&nbsp;</td>
694          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> *&nbsp;</td>
695          <td class="mdname1" valign="top" nowrap> <em>xform</em>          </td>
696          <td class="md" valign="top">&nbsp;)&nbsp;</td>
697          <td class="md" nowrap> const<code> [virtual]</code></td>
698        </tr>
699
700      </table>
701    </td>
702  </tr>
703</table>
704<table cellspacing=5 cellpadding=0 border=0>
705  <tr>
706    <td>
707      &nbsp;
708    </td>
709    <td>
710
711<p>
712Gets the world transform matrix / matrices for this renderable object.
713<p>
714<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>
715<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>
716
717<p>
718Implements <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea5">Ogre::Renderable</a>.
719<p>
720Definition 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>
721  </tr>
722</table>
723<a class="anchor" name="Ogre_1_1WireBoundingBoxa63" doxytag="Ogre::BorderRenderable::setCustomParameter" ></a><p>
724<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
725  <tr>
726    <td class="mdRow">
727      <table cellpadding="0" cellspacing="0" border="0">
728        <tr>
729          <td class="md" nowrap valign="top"> void Ogre::Renderable::setCustomParameter </td>
730          <td class="md" valign="top">(&nbsp;</td>
731          <td class="md" nowrap valign="top">size_t&nbsp;</td>
732          <td class="mdname" nowrap> <em>index</em>, </td>
733        </tr>
734        <tr>
735          <td class="md" nowrap align="right"></td>
736          <td></td>
737          <td class="md" nowrap>const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &amp;&nbsp;</td>
738          <td class="mdname" nowrap> <em>value</em></td>
739        </tr>
740        <tr>
741          <td></td>
742          <td class="md">)&nbsp;</td>
743          <td class="md" colspan="2"><code> [inherited]</code></td>
744        </tr>
745
746      </table>
747    </td>
748  </tr>
749</table>
750<table cellspacing=5 cellpadding=0 border=0>
751  <tr>
752    <td>
753      &nbsp;
754    </td>
755    <td>
756
757<p>
758Sets 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.
759<p>
760<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>
761<dl compact><dt><b>Parameters:</b></dt><dd>
762  <table border="0" cellspacing="2" cellpadding="0">
763    <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>
764    <tr><td valign=top><em>value</em>&nbsp;</td><td>The value to associate. </td></tr>
765  </table>
766</dl>
767
768<p>
769Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00167">167</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
770  </tr>
771</table>
772<a class="anchor" name="Ogre_1_1WireBoundingBoxa66" doxytag="Ogre::BorderRenderable::setPolygonModeOverrideable" ></a><p>
773<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
774  <tr>
775    <td class="mdRow">
776      <table cellpadding="0" cellspacing="0" border="0">
777        <tr>
778          <td class="md" nowrap valign="top"> virtual void Ogre::Renderable::setPolygonModeOverrideable </td>
779          <td class="md" valign="top">(&nbsp;</td>
780          <td class="md" nowrap valign="top">bool&nbsp;</td>
781          <td class="mdname1" valign="top" nowrap> <em>override</em>          </td>
782          <td class="md" valign="top">&nbsp;)&nbsp;</td>
783          <td class="md" nowrap><code> [virtual, inherited]</code></td>
784        </tr>
785
786      </table>
787    </td>
788  </tr>
789</table>
790<table cellspacing=5 cellpadding=0 border=0>
791  <tr>
792    <td>
793      &nbsp;
794    </td>
795    <td>
796
797<p>
798Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
799<p>
800<dl compact><dt><b>Parameters:</b></dt><dd>
801  <table border="0" cellspacing="2" cellpadding="0">
802    <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>
803  </table>
804</dl>
805
806<p>
807Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00231">231</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
808  </tr>
809</table>
810<a class="anchor" name="Ogre_1_1BorderRenderablea7" doxytag="Ogre::BorderRenderable::useIdentityProjection" ></a><p>
811<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
812  <tr>
813    <td class="mdRow">
814      <table cellpadding="0" cellspacing="0" border="0">
815        <tr>
816          <td class="md" nowrap valign="top"> bool Ogre::BorderRenderable::useIdentityProjection </td>
817          <td class="md" valign="top">(&nbsp;</td>
818          <td class="md" nowrap valign="top">void&nbsp;</td>
819          <td class="mdname1" valign="top" nowrap>          </td>
820          <td class="md" valign="top">&nbsp;)&nbsp;</td>
821          <td class="md" nowrap> const<code> [virtual]</code></td>
822        </tr>
823
824      </table>
825    </td>
826  </tr>
827</table>
828<table cellspacing=5 cellpadding=0 border=0>
829  <tr>
830    <td>
831      &nbsp;
832    </td>
833    <td>
834
835<p>
836Returns whether or not to use an 'identity' projection.
837<p>
838<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>
839
840<p>
841Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa58">Ogre::Renderable</a>.
842<p>
843Definition 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>
844  </tr>
845</table>
846<a class="anchor" name="Ogre_1_1BorderRenderablea8" doxytag="Ogre::BorderRenderable::useIdentityView" ></a><p>
847<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
848  <tr>
849    <td class="mdRow">
850      <table cellpadding="0" cellspacing="0" border="0">
851        <tr>
852          <td class="md" nowrap valign="top"> bool Ogre::BorderRenderable::useIdentityView </td>
853          <td class="md" valign="top">(&nbsp;</td>
854          <td class="md" nowrap valign="top">void&nbsp;</td>
855          <td class="mdname1" valign="top" nowrap>          </td>
856          <td class="md" valign="top">&nbsp;)&nbsp;</td>
857          <td class="md" nowrap> const<code> [virtual]</code></td>
858        </tr>
859
860      </table>
861    </td>
862  </tr>
863</table>
864<table cellspacing=5 cellpadding=0 border=0>
865  <tr>
866    <td>
867      &nbsp;
868    </td>
869    <td>
870
871<p>
872Returns whether or not to use an 'identity' projection.
873<p>
874<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>
875
876<p>
877Reimplemented from <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa59">Ogre::Renderable</a>.
878<p>
879Definition 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>
880  </tr>
881</table>
882<hr><h2>Member Data Documentation</h2>
883<a class="anchor" name="Ogre_1_1WireBoundingBoxp26" doxytag="Ogre::BorderRenderable::mCustomParameters" ></a><p>
884<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
885  <tr>
886    <td class="mdRow">
887      <table cellpadding="0" cellspacing="0" border="0">
888        <tr>
889          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx1">CustomParameterMap</a> <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp26">Ogre::Renderable::mCustomParameters</a><code> [protected, inherited]</code>
890      </table>
891    </td>
892  </tr>
893</table>
894<table cellspacing=5 cellpadding=0 border=0>
895  <tr>
896    <td>
897      &nbsp;
898    </td>
899    <td>
900
901<p>
902
903<p>
904Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00248">248</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
905  </tr>
906</table>
907<a class="anchor" name="Ogre_1_1BorderRenderablep0" doxytag="Ogre::BorderRenderable::mParent" ></a><p>
908<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
909  <tr>
910    <td class="mdRow">
911      <table cellpadding="0" cellspacing="0" border="0">
912        <tr>
913          <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>
914      </table>
915    </td>
916  </tr>
917</table>
918<table cellspacing=5 cellpadding=0 border=0>
919  <tr>
920    <td>
921      &nbsp;
922    </td>
923    <td>
924
925<p>
926
927<p>
928Definition 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>
929  </tr>
930</table>
931<a class="anchor" name="Ogre_1_1WireBoundingBoxp27" doxytag="Ogre::BorderRenderable::mPolygonModeOverrideable" ></a><p>
932<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
933  <tr>
934    <td class="mdRow">
935      <table cellpadding="0" cellspacing="0" border="0">
936        <tr>
937          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp27">Ogre::Renderable::mPolygonModeOverrideable</a><code> [protected, inherited]</code>
938      </table>
939    </td>
940  </tr>
941</table>
942<table cellspacing=5 cellpadding=0 border=0>
943  <tr>
944    <td>
945      &nbsp;
946    </td>
947    <td>
948
949<p>
950
951<p>
952Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00249">249</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
953  </tr>
954</table>
955<a class="anchor" name="Ogre_1_1WireBoundingBoxt4" doxytag="Ogre::BorderRenderable::msDummyPlaneList" ></a><p>
956<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
957  <tr>
958    <td class="mdRow">
959      <table cellpadding="0" cellspacing="0" border="0">
960        <tr>
961          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a453">PlaneList</a> <a class="el" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxt4">Ogre::Renderable::msDummyPlaneList</a><code> [static, protected, inherited]</code>
962      </table>
963    </td>
964  </tr>
965</table>
966<table cellspacing=5 cellpadding=0 border=0>
967  <tr>
968    <td>
969      &nbsp;
970    </td>
971    <td>
972
973<p>
974
975<p>
976Definition at line <a class="el" href="OgreRenderable_8h-source.html#l00246">246</a> of file <a class="el" href="OgreRenderable_8h-source.html">OgreRenderable.h</a>.    </td>
977  </tr>
978</table>
979<hr>The documentation for this class was generated from the following file:<ul>
980<li><a class="el" href="OgreBorderPanelOverlayElement_8h-source.html">OgreBorderPanelOverlayElement.h</a></ul>
981<hr>
982<p>
983Copyright &copy; 2000-2005 by The OGRE Team<br />
984<!--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/>
985This 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/>
986                <!--/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#">
987                <Work rdf:about="">
988                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
989        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
990                </Work>
991                <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> -->
992
993Last modified Sun Mar 12 14:38:19 2006
994</p>
995</body>
996</html>
Note: See TracBrowser for help on using the repository browser.