source: Documentation/D5.3 Stand-alone computation package for illumination algorithms/appendix/IlluminationModule/html/class_ogre_rendering_run.html @ 2910

Revision 2910, 34.0 KB checked in by hbeneit, 16 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>GameTools Illumination Module: OgreRenderingRun Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
13  </ul></div>
14<div class="tabs">
15  <ul>
16    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
17    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
18    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
19  </ul></div>
20<h1>OgreRenderingRun Class Reference</h1><!-- doxytag: class="OgreRenderingRun" --><!-- doxytag: inherits="RenderingRun" -->Base class of a <a class="el" href="class_rendering_run.html">RenderingRun</a> in an OGRE environment. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for OgreRenderingRun:
24<p><center><img src="class_ogre_rendering_run.png" usemap="#OgreRenderingRun_map" border="0" alt=""></center>
25<map name="OgreRenderingRun_map">
26<area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="732,0,966,24">
27<area href="class_ogre_caustic_cube_map_rendering_run.html" alt="OgreCausticCubeMapRenderingRun" shape="rect" coords="0,112,234,136">
28<area href="class_ogre_color_cube_map_rendering_run.html" alt="OgreColorCubeMapRenderingRun" shape="rect" coords="244,112,478,136">
29<area href="class_ogre_depth_shadow_map_rendering_run.html" alt="OgreDepthShadowMapRenderingRun" shape="rect" coords="488,112,722,136">
30<area href="class_ogre_distance_cube_map_rendering_run.html" alt="OgreDistanceCubeMapRenderingRun" shape="rect" coords="732,112,966,136">
31<area href="class_ogre_photon_map_rendering_run.html" alt="OgrePhotonMapRenderingRun" shape="rect" coords="976,112,1210,136">
32<area href="class_ogre_reduced_cube_map_rendering_run.html" alt="OgreReducedCubeMapRenderingRun" shape="rect" coords="1220,112,1454,136">
33<area href="class_ogre_scene_camera_depth_rendering_run.html" alt="OgreSceneCameraDepthRenderingRun" shape="rect" coords="1464,112,1698,136">
34</map>
35<a href="class_ogre_rendering_run-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
36<tr><td></td></tr>
37<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#98222e26f1bf028418276b30de455dd6">OgreRenderingRun</a> (unsigned long <a class="el" href="class_rendering_run.html#cb0a9e0eec1217206a14f7d387487443">startFrame</a>, unsigned long <a class="el" href="class_rendering_run.html#7196160c7f2effe7235b710a12f1b262">updateInterval</a>)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#98222e26f1bf028418276b30de455dd6"></a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_ogre_rendering_run.html">OgreRenderingRun</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#e60b4569fb13979b6ffd3c445e4fe8d7">asOgreRenderingRun</a> ()</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion to OgreRenderRun.  <a href="#e60b4569fb13979b6ffd3c445e4fe8d7"></a><br></td></tr>
44<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">Vector3&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#8c4ac23e459e6920932bcfed3fc84066">getCubeMapFaceDirection</a> (unsigned char faceId)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a direction for a cubemap face id.  <a href="#8c4ac23e459e6920932bcfed3fc84066"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">Texture *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#22fab5beff488d1ec81dc91d6a57c3db">createCubeRenderTexture</a> (String name, const Vector3 position, unsigned int resolution=512, PixelFormat format=PF_FLOAT16_RGBA, int numMips=0, ColourValue clearColor=ColourValue::Black)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a cubemap texture.  <a href="#22fab5beff488d1ec81dc91d6a57c3db"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#ce87ad15f63c1d0342fef57f292c72d5">setMaterialForRenderables</a> (String &amp;materialName, RenderQueue *rq)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the given material for each Renderable in a RenderQueue.  <a href="#ce87ad15f63c1d0342fef57f292c72d5"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#d5293bf02c9eaf10432327b7ec4725c9">setMaterialForVisibles</a> (String &amp;materialName, Camera *cam, bool shadowcastersonly=false)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the given material for each Renderable visible from a given camera.  <a href="#d5293bf02c9eaf10432327b7ec4725c9"></a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#6e8e10ac9a6e54c22d23acbceaba00d2">restoreMaterials</a> ()</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Restores previously stored materials.  <a href="#6e8e10ac9a6e54c22d23acbceaba00d2"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#31132167654aaf63150441a7c4434f30">renderFullscreenQuad</a> (String materialName, RenderTarget *target)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Renderes a full screen quad on a given RendderTarget with a given material.  <a href="#31132167654aaf63150441a7c4434f30"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#96125ade38c507267da4668b80e40f1a">renderPixelSprites</a> (String &amp;materialName, RenderTarget *rt, int width, int height)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Renderes sprites to pixels of the screen on a given RendderTarget with a given material.  <a href="#96125ade38c507267da4668b80e40f1a"></a><br></td></tr>
66<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">std::map&lt; Renderable *, String &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#21ff568dfa6da8cb3aeb4e50b3e7ccbf">visibleObjects</a></td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">map of Renderables which will be rendered with a given material  <a href="#21ff568dfa6da8cb3aeb4e50b3e7ccbf"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">SpriteSet *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#0b2e8d3dd77970d8ae80062428c3436b">pixelSprites</a></td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">SpriteSet used in pixel sprite rendering.  <a href="#0b2e8d3dd77970d8ae80062428c3436b"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top">String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#8c9a1a0414b30a6dc91e7cca8f28bc16">spriteSetName</a></td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">unique name of the SpriteSet used in pixel sprite rendering  <a href="#8c9a1a0414b30a6dc91e7cca8f28bc16"></a><br></td></tr>
76<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">static MovablePlane *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#69fe7ff3c1d6d403459ca4cd339e111d">fullScreenQuad</a> = NULL</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">fulls screen quad plane used in full screen quad rendering  <a href="#69fe7ff3c1d6d403459ca4cd339e111d"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">static Entity *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#9f972ef6e9811232140d5b12d8f3e7dd">fullScreenQuadEntity</a> = NULL</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">fulls screen quad Entity used in full screen quad rendering  <a href="#9f972ef6e9811232140d5b12d8f3e7dd"></a><br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">static SceneNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_rendering_run.html#1e2f40da4a87c8df0af0061f5dd68053">fullScreenQuadNode</a> = NULL</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">fulls screen quad SceneNode used in full screen quad rendering  <a href="#1e2f40da4a87c8df0af0061f5dd68053"></a><br></td></tr>
86</table>
87<hr><a name="_details"></a><h2>Detailed Description</h2>
88Base class of a <a class="el" href="class_rendering_run.html">RenderingRun</a> in an OGRE environment.
89<p>
90<hr><h2>Constructor &amp; Destructor Documentation</h2>
91<a class="anchor" name="98222e26f1bf028418276b30de455dd6"></a><!-- doxytag: member="OgreRenderingRun::OgreRenderingRun" ref="98222e26f1bf028418276b30de455dd6" args="(unsigned long startFrame, unsigned long updateInterval)" --><p>
92<table class="mdTable" cellpadding="2" cellspacing="0">
93  <tr>
94    <td class="mdRow">
95      <table cellpadding="0" cellspacing="0" border="0">
96        <tr>
97          <td class="md" nowrap valign="top">OgreRenderingRun::OgreRenderingRun           </td>
98          <td class="md" valign="top">(&nbsp;</td>
99          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
100          <td class="mdname" nowrap> <em>startFrame</em>, </td>
101        </tr>
102        <tr>
103          <td class="md" nowrap align="right"></td>
104          <td class="md"></td>
105          <td class="md" nowrap>unsigned long&nbsp;</td>
106          <td class="mdname" nowrap> <em>updateInterval</em></td>
107        </tr>
108        <tr>
109          <td class="md"></td>
110          <td class="md">)&nbsp;</td>
111          <td class="md" colspan="2"><code> [inline]</code></td>
112        </tr>
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>
125Constructor.
126<p>
127<dl compact><dt><b>Parameters:</b></dt><dd>
128  <table border="0" cellspacing="2" cellpadding="0">
129    <tr><td valign="top"></td><td valign="top"><em>startFrame</em>&nbsp;</td><td>adds an offset to the current frame number to help evenly distribute updates between frames </td></tr>
130    <tr><td valign="top"></td><td valign="top"><em>updateInterval</em>&nbsp;</td><td>photon map update frequency </td></tr>
131  </table>
132</dl>
133    </td>
134  </tr>
135</table>
136<hr><h2>Member Function Documentation</h2>
137<a class="anchor" name="e60b4569fb13979b6ffd3c445e4fe8d7"></a><!-- doxytag: member="OgreRenderingRun::asOgreRenderingRun" ref="e60b4569fb13979b6ffd3c445e4fe8d7" args="()" --><p>
138<table class="mdTable" cellpadding="2" cellspacing="0">
139  <tr>
140    <td class="mdRow">
141      <table cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td class="md" nowrap valign="top"><a class="el" href="class_ogre_rendering_run.html">OgreRenderingRun</a>* OgreRenderingRun::asOgreRenderingRun           </td>
144          <td class="md" valign="top">(&nbsp;</td>
145          <td class="mdname1" valign="top" nowrap>          </td>
146          <td class="md" valign="top">&nbsp;)&nbsp;</td>
147          <td class="md" nowrap><code> [inline, virtual]</code></td>
148        </tr>
149      </table>
150    </td>
151  </tr>
152</table>
153<table cellspacing="5" cellpadding="0" border="0">
154  <tr>
155    <td>
156      &nbsp;
157    </td>
158    <td>
159
160<p>
161Conversion to OgreRenderRun.
162<p>
163This function is needed because of virtual inheritance.
164<p>
165Reimplemented from <a class="el" href="class_rendering_run.html#7aa3ced3a6f0c81967e995a8a7c44ca2">RenderingRun</a>.    </td>
166  </tr>
167</table>
168<a class="anchor" name="22fab5beff488d1ec81dc91d6a57c3db"></a><!-- doxytag: member="OgreRenderingRun::createCubeRenderTexture" ref="22fab5beff488d1ec81dc91d6a57c3db" args="(String name, const Vector3 position, unsigned int resolution=512, PixelFormat format=PF_FLOAT16_RGBA, int numMips=0, ColourValue clearColor=ColourValue::Black)" --><p>
169<table class="mdTable" 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">Texture * OgreRenderingRun::createCubeRenderTexture           </td>
175          <td class="md" valign="top">(&nbsp;</td>
176          <td class="md" nowrap valign="top">String&nbsp;</td>
177          <td class="mdname" nowrap> <em>name</em>, </td>
178        </tr>
179        <tr>
180          <td class="md" nowrap align="right"></td>
181          <td class="md"></td>
182          <td class="md" nowrap>const Vector3&nbsp;</td>
183          <td class="mdname" nowrap> <em>position</em>, </td>
184        </tr>
185        <tr>
186          <td class="md" nowrap align="right"></td>
187          <td class="md"></td>
188          <td class="md" nowrap>unsigned int&nbsp;</td>
189          <td class="mdname" nowrap> <em>resolution</em> = <code>512</code>, </td>
190        </tr>
191        <tr>
192          <td class="md" nowrap align="right"></td>
193          <td class="md"></td>
194          <td class="md" nowrap>PixelFormat&nbsp;</td>
195          <td class="mdname" nowrap> <em>format</em> = <code>PF_FLOAT16_RGBA</code>, </td>
196        </tr>
197        <tr>
198          <td class="md" nowrap align="right"></td>
199          <td class="md"></td>
200          <td class="md" nowrap>int&nbsp;</td>
201          <td class="mdname" nowrap> <em>numMips</em> = <code>0</code>, </td>
202        </tr>
203        <tr>
204          <td class="md" nowrap align="right"></td>
205          <td class="md"></td>
206          <td class="md" nowrap>ColourValue&nbsp;</td>
207          <td class="mdname" nowrap> <em>clearColor</em> = <code>ColourValue::Black</code></td>
208        </tr>
209        <tr>
210          <td class="md"></td>
211          <td class="md">)&nbsp;</td>
212          <td class="md" colspan="2"><code> [protected]</code></td>
213        </tr>
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing="5" cellpadding="0" border="0">
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226Creates a cubemap texture.
227<p>
228This is a helper function to easily create a cubemap texture and automaticly attach viewports to each face so it can be used as a rendertarget.<p>
229<dl compact><dt><b>Parameters:</b></dt><dd>
230  <table border="0" cellspacing="2" cellpadding="0">
231    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>the name of the texture to be created </td></tr>
232    <tr><td valign="top"></td><td valign="top"><em>position</em>&nbsp;</td><td>the initial position of the cubemap </td></tr>
233    <tr><td valign="top"></td><td valign="top"><em>resolution</em>&nbsp;</td><td>the resolution of one cubemapface </td></tr>
234    <tr><td valign="top"></td><td valign="top"><em>format</em>&nbsp;</td><td>the pixel format of the cubemap </td></tr>
235    <tr><td valign="top"></td><td valign="top"><em>numMips</em>&nbsp;</td><td>the number of mipmap levels </td></tr>
236    <tr><td valign="top"></td><td valign="top"><em>clearColor</em>&nbsp;</td><td>initial color </td></tr>
237  </table>
238</dl>
239    </td>
240  </tr>
241</table>
242<a class="anchor" name="8c4ac23e459e6920932bcfed3fc84066"></a><!-- doxytag: member="OgreRenderingRun::getCubeMapFaceDirection" ref="8c4ac23e459e6920932bcfed3fc84066" args="(unsigned char faceId)" --><p>
243<table class="mdTable" cellpadding="2" cellspacing="0">
244  <tr>
245    <td class="mdRow">
246      <table cellpadding="0" cellspacing="0" border="0">
247        <tr>
248          <td class="md" nowrap valign="top">Vector3 OgreRenderingRun::getCubeMapFaceDirection           </td>
249          <td class="md" valign="top">(&nbsp;</td>
250          <td class="md" nowrap valign="top">unsigned char&nbsp;</td>
251          <td class="mdname1" valign="top" nowrap> <em>faceId</em>          </td>
252          <td class="md" valign="top">&nbsp;)&nbsp;</td>
253          <td class="md" nowrap><code> [protected]</code></td>
254        </tr>
255      </table>
256    </td>
257  </tr>
258</table>
259<table cellspacing="5" cellpadding="0" border="0">
260  <tr>
261    <td>
262      &nbsp;
263    </td>
264    <td>
265
266<p>
267Returns a direction for a cubemap face id.
268<p>
269This is a helper function to retrieve the normal direction of a given cubemap face.<p>
270<dl compact><dt><b>Parameters:</b></dt><dd>
271  <table border="0" cellspacing="2" cellpadding="0">
272    <tr><td valign="top"></td><td valign="top"><em>faceId</em>&nbsp;</td><td>the number of the face </td></tr>
273  </table>
274</dl>
275    </td>
276  </tr>
277</table>
278<a class="anchor" name="31132167654aaf63150441a7c4434f30"></a><!-- doxytag: member="OgreRenderingRun::renderFullscreenQuad" ref="31132167654aaf63150441a7c4434f30" args="(String materialName, RenderTarget *target)" --><p>
279<table class="mdTable" cellpadding="2" cellspacing="0">
280  <tr>
281    <td class="mdRow">
282      <table cellpadding="0" cellspacing="0" border="0">
283        <tr>
284          <td class="md" nowrap valign="top">void OgreRenderingRun::renderFullscreenQuad           </td>
285          <td class="md" valign="top">(&nbsp;</td>
286          <td class="md" nowrap valign="top">String&nbsp;</td>
287          <td class="mdname" nowrap> <em>materialName</em>, </td>
288        </tr>
289        <tr>
290          <td class="md" nowrap align="right"></td>
291          <td class="md"></td>
292          <td class="md" nowrap>RenderTarget *&nbsp;</td>
293          <td class="mdname" nowrap> <em>target</em></td>
294        </tr>
295        <tr>
296          <td class="md"></td>
297          <td class="md">)&nbsp;</td>
298          <td class="md" colspan="2"><code> [protected]</code></td>
299        </tr>
300      </table>
301    </td>
302  </tr>
303</table>
304<table cellspacing="5" cellpadding="0" border="0">
305  <tr>
306    <td>
307      &nbsp;
308    </td>
309    <td>
310
311<p>
312Renderes a full screen quad on a given RendderTarget with a given material.
313<p>
314<dl compact><dt><b>Parameters:</b></dt><dd>
315  <table border="0" cellspacing="2" cellpadding="0">
316    <tr><td valign="top"></td><td valign="top"><em>materialName</em>&nbsp;</td><td>the name of the material bind to the quad </td></tr>
317    <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>the RenderTarget the quad should be rendered on </td></tr>
318  </table>
319</dl>
320    </td>
321  </tr>
322</table>
323<a class="anchor" name="96125ade38c507267da4668b80e40f1a"></a><!-- doxytag: member="OgreRenderingRun::renderPixelSprites" ref="96125ade38c507267da4668b80e40f1a" args="(String &amp;materialName, RenderTarget *rt, int width, int height)" --><p>
324<table class="mdTable" cellpadding="2" cellspacing="0">
325  <tr>
326    <td class="mdRow">
327      <table cellpadding="0" cellspacing="0" border="0">
328        <tr>
329          <td class="md" nowrap valign="top">void OgreRenderingRun::renderPixelSprites           </td>
330          <td class="md" valign="top">(&nbsp;</td>
331          <td class="md" nowrap valign="top">String &amp;&nbsp;</td>
332          <td class="mdname" nowrap> <em>materialName</em>, </td>
333        </tr>
334        <tr>
335          <td class="md" nowrap align="right"></td>
336          <td class="md"></td>
337          <td class="md" nowrap>RenderTarget *&nbsp;</td>
338          <td class="mdname" nowrap> <em>rt</em>, </td>
339        </tr>
340        <tr>
341          <td class="md" nowrap align="right"></td>
342          <td class="md"></td>
343          <td class="md" nowrap>int&nbsp;</td>
344          <td class="mdname" nowrap> <em>width</em>, </td>
345        </tr>
346        <tr>
347          <td class="md" nowrap align="right"></td>
348          <td class="md"></td>
349          <td class="md" nowrap>int&nbsp;</td>
350          <td class="mdname" nowrap> <em>height</em></td>
351        </tr>
352        <tr>
353          <td class="md"></td>
354          <td class="md">)&nbsp;</td>
355          <td class="md" colspan="2"><code> [protected]</code></td>
356        </tr>
357      </table>
358    </td>
359  </tr>
360</table>
361<table cellspacing="5" cellpadding="0" border="0">
362  <tr>
363    <td>
364      &nbsp;
365    </td>
366    <td>
367
368<p>
369Renderes sprites to pixels of the screen on a given RendderTarget with a given material.
370<p>
371Pixel sprites are pixel sized quads, placed on each pixel of the RenderTarget. The number of sprites not necessary corresponds to the resolution of the rendertarget. The pixel quads will evenly fill the rendertarget's area with sizes corresponding to the given resolution. We can render fewer or more pixel quads than the number of pixels the rendertarget has (eg.: in case of caustic cubemap generation).<p>
372<dl compact><dt><b>Parameters:</b></dt><dd>
373  <table border="0" cellspacing="2" cellpadding="0">
374    <tr><td valign="top"></td><td valign="top"><em>materialName</em>&nbsp;</td><td>the name of the material bind to the pixel sprites </td></tr>
375    <tr><td valign="top"></td><td valign="top"><em>rt</em>&nbsp;</td><td>the RenderTarget the quads should be rendered on </td></tr>
376    <tr><td valign="top"></td><td valign="top"><em>width</em>&nbsp;</td><td>the desired resolution width of the sprites </td></tr>
377    <tr><td valign="top"></td><td valign="top"><em>height</em>&nbsp;</td><td>the desired resolution height of the sprites </td></tr>
378  </table>
379</dl>
380    </td>
381  </tr>
382</table>
383<a class="anchor" name="6e8e10ac9a6e54c22d23acbceaba00d2"></a><!-- doxytag: member="OgreRenderingRun::restoreMaterials" ref="6e8e10ac9a6e54c22d23acbceaba00d2" args="()" --><p>
384<table class="mdTable" cellpadding="2" cellspacing="0">
385  <tr>
386    <td class="mdRow">
387      <table cellpadding="0" cellspacing="0" border="0">
388        <tr>
389          <td class="md" nowrap valign="top">void OgreRenderingRun::restoreMaterials           </td>
390          <td class="md" valign="top">(&nbsp;</td>
391          <td class="mdname1" valign="top" nowrap>          </td>
392          <td class="md" valign="top">&nbsp;)&nbsp;</td>
393          <td class="md" nowrap><code> [protected]</code></td>
394        </tr>
395      </table>
396    </td>
397  </tr>
398</table>
399<table cellspacing="5" cellpadding="0" border="0">
400  <tr>
401    <td>
402      &nbsp;
403    </td>
404    <td>
405
406<p>
407Restores previously stored materials.
408<p>
409This helper function is typically used after a setMaterialForRenderables or setMaterialForVisibles call and a rendering process to restore the original material settings. The function also tells the current SceneManager to search for visible objects, as this is the default behaviour of SceneManager.     </td>
410  </tr>
411</table>
412<a class="anchor" name="ce87ad15f63c1d0342fef57f292c72d5"></a><!-- doxytag: member="OgreRenderingRun::setMaterialForRenderables" ref="ce87ad15f63c1d0342fef57f292c72d5" args="(String &amp;materialName, RenderQueue *rq)" --><p>
413<table class="mdTable" cellpadding="2" cellspacing="0">
414  <tr>
415    <td class="mdRow">
416      <table cellpadding="0" cellspacing="0" border="0">
417        <tr>
418          <td class="md" nowrap valign="top">void OgreRenderingRun::setMaterialForRenderables           </td>
419          <td class="md" valign="top">(&nbsp;</td>
420          <td class="md" nowrap valign="top">String &amp;&nbsp;</td>
421          <td class="mdname" nowrap> <em>materialName</em>, </td>
422        </tr>
423        <tr>
424          <td class="md" nowrap align="right"></td>
425          <td class="md"></td>
426          <td class="md" nowrap>RenderQueue *&nbsp;</td>
427          <td class="mdname" nowrap> <em>rq</em></td>
428        </tr>
429        <tr>
430          <td class="md"></td>
431          <td class="md">)&nbsp;</td>
432          <td class="md" colspan="2"><code> [protected]</code></td>
433        </tr>
434      </table>
435    </td>
436  </tr>
437</table>
438<table cellspacing="5" cellpadding="0" border="0">
439  <tr>
440    <td>
441      &nbsp;
442    </td>
443    <td>
444
445<p>
446Sets the given material for each Renderable in a RenderQueue.
447<p>
448This is a helper function to set a material to each element of a previously filled Renderque. The orginal material of the Renderables are stored so they can be restored later. The function also tells the current SceneManager not to search for visible objects, as we are going to use the given RenderQueue during the next rendering.<p>
449<dl compact><dt><b>Parameters:</b></dt><dd>
450  <table border="0" cellspacing="2" cellpadding="0">
451    <tr><td valign="top"></td><td valign="top"><em>materialName</em>&nbsp;</td><td>the name of the material to set for the Renderables </td></tr>
452    <tr><td valign="top"></td><td valign="top"><em>rq</em>&nbsp;</td><td>pointer to the filled Renderqueue instance to set material for </td></tr>
453  </table>
454</dl>
455    </td>
456  </tr>
457</table>
458<a class="anchor" name="d5293bf02c9eaf10432327b7ec4725c9"></a><!-- doxytag: member="OgreRenderingRun::setMaterialForVisibles" ref="d5293bf02c9eaf10432327b7ec4725c9" args="(String &amp;materialName, Camera *cam, bool shadowcastersonly=false)" --><p>
459<table class="mdTable" cellpadding="2" cellspacing="0">
460  <tr>
461    <td class="mdRow">
462      <table cellpadding="0" cellspacing="0" border="0">
463        <tr>
464          <td class="md" nowrap valign="top">void OgreRenderingRun::setMaterialForVisibles           </td>
465          <td class="md" valign="top">(&nbsp;</td>
466          <td class="md" nowrap valign="top">String &amp;&nbsp;</td>
467          <td class="mdname" nowrap> <em>materialName</em>, </td>
468        </tr>
469        <tr>
470          <td class="md" nowrap align="right"></td>
471          <td class="md"></td>
472          <td class="md" nowrap>Camera *&nbsp;</td>
473          <td class="mdname" nowrap> <em>cam</em>, </td>
474        </tr>
475        <tr>
476          <td class="md" nowrap align="right"></td>
477          <td class="md"></td>
478          <td class="md" nowrap>bool&nbsp;</td>
479          <td class="mdname" nowrap> <em>shadowcastersonly</em> = <code>false</code></td>
480        </tr>
481        <tr>
482          <td class="md"></td>
483          <td class="md">)&nbsp;</td>
484          <td class="md" colspan="2"><code> [protected]</code></td>
485        </tr>
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>
498Sets the given material for each Renderable visible from a given camera.
499<p>
500This helper function is similar to setMaterialForRenderables but it is also responsible for filling the RenderQueue. First the RenderQueue of the current SceneManager fill be filled with the visible objects seen from the given camera. Then the required material will be set for each element of the RenderQueue. The orginal material of the Renderables are stored so they can be restored later. The function also tells the current SceneManager not to search for visible objects, as we are going to use the filled RenderQueue during the next rendering.<p>
501<dl compact><dt><b>Parameters:</b></dt><dd>
502  <table border="0" cellspacing="2" cellpadding="0">
503    <tr><td valign="top"></td><td valign="top"><em>materialName</em>&nbsp;</td><td>the name of the material to set for the Renderables </td></tr>
504    <tr><td valign="top"></td><td valign="top"><em>cam</em>&nbsp;</td><td>pointer to the camera from which visible objects should be searched </td></tr>
505    <tr><td valign="top"></td><td valign="top"><em>shadowcastersonly</em>&nbsp;</td><td>flag to search for only shadow casters </td></tr>
506  </table>
507</dl>
508    </td>
509  </tr>
510</table>
511<hr><h2>Member Data Documentation</h2>
512<a class="anchor" name="69fe7ff3c1d6d403459ca4cd339e111d"></a><!-- doxytag: member="OgreRenderingRun::fullScreenQuad" ref="69fe7ff3c1d6d403459ca4cd339e111d" args="" --><p>
513<table class="mdTable" cellpadding="2" cellspacing="0">
514  <tr>
515    <td class="mdRow">
516      <table cellpadding="0" cellspacing="0" border="0">
517        <tr>
518          <td class="md" nowrap valign="top">MovablePlane * <a class="el" href="class_ogre_rendering_run.html#69fe7ff3c1d6d403459ca4cd339e111d">OgreRenderingRun::fullScreenQuad</a> = NULL<code> [static, protected]</code>          </td>
519        </tr>
520      </table>
521    </td>
522  </tr>
523</table>
524<table cellspacing="5" cellpadding="0" border="0">
525  <tr>
526    <td>
527      &nbsp;
528    </td>
529    <td>
530
531<p>
532fulls screen quad plane used in full screen quad rendering
533<p>
534<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_ogre_rendering_run.html#31132167654aaf63150441a7c4434f30">renderFullscreenQuad</a> </dd></dl>
535    </td>
536  </tr>
537</table>
538<a class="anchor" name="9f972ef6e9811232140d5b12d8f3e7dd"></a><!-- doxytag: member="OgreRenderingRun::fullScreenQuadEntity" ref="9f972ef6e9811232140d5b12d8f3e7dd" args="" --><p>
539<table class="mdTable" cellpadding="2" cellspacing="0">
540  <tr>
541    <td class="mdRow">
542      <table cellpadding="0" cellspacing="0" border="0">
543        <tr>
544          <td class="md" nowrap valign="top">Entity * <a class="el" href="class_ogre_rendering_run.html#9f972ef6e9811232140d5b12d8f3e7dd">OgreRenderingRun::fullScreenQuadEntity</a> = NULL<code> [static, protected]</code>          </td>
545        </tr>
546      </table>
547    </td>
548  </tr>
549</table>
550<table cellspacing="5" cellpadding="0" border="0">
551  <tr>
552    <td>
553      &nbsp;
554    </td>
555    <td>
556
557<p>
558fulls screen quad Entity used in full screen quad rendering
559<p>
560<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_ogre_rendering_run.html#31132167654aaf63150441a7c4434f30">renderFullscreenQuad</a> </dd></dl>
561    </td>
562  </tr>
563</table>
564<a class="anchor" name="1e2f40da4a87c8df0af0061f5dd68053"></a><!-- doxytag: member="OgreRenderingRun::fullScreenQuadNode" ref="1e2f40da4a87c8df0af0061f5dd68053" args="" --><p>
565<table class="mdTable" cellpadding="2" cellspacing="0">
566  <tr>
567    <td class="mdRow">
568      <table cellpadding="0" cellspacing="0" border="0">
569        <tr>
570          <td class="md" nowrap valign="top">SceneNode * <a class="el" href="class_ogre_rendering_run.html#1e2f40da4a87c8df0af0061f5dd68053">OgreRenderingRun::fullScreenQuadNode</a> = NULL<code> [static, protected]</code>          </td>
571        </tr>
572      </table>
573    </td>
574  </tr>
575</table>
576<table cellspacing="5" cellpadding="0" border="0">
577  <tr>
578    <td>
579      &nbsp;
580    </td>
581    <td>
582
583<p>
584fulls screen quad SceneNode used in full screen quad rendering
585<p>
586<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_ogre_rendering_run.html#31132167654aaf63150441a7c4434f30">renderFullscreenQuad</a> </dd></dl>
587    </td>
588  </tr>
589</table>
590<a class="anchor" name="0b2e8d3dd77970d8ae80062428c3436b"></a><!-- doxytag: member="OgreRenderingRun::pixelSprites" ref="0b2e8d3dd77970d8ae80062428c3436b" args="" --><p>
591<table class="mdTable" cellpadding="2" cellspacing="0">
592  <tr>
593    <td class="mdRow">
594      <table cellpadding="0" cellspacing="0" border="0">
595        <tr>
596          <td class="md" nowrap valign="top">SpriteSet* <a class="el" href="class_ogre_rendering_run.html#0b2e8d3dd77970d8ae80062428c3436b">OgreRenderingRun::pixelSprites</a><code> [protected]</code>          </td>
597        </tr>
598      </table>
599    </td>
600  </tr>
601</table>
602<table cellspacing="5" cellpadding="0" border="0">
603  <tr>
604    <td>
605      &nbsp;
606    </td>
607    <td>
608
609<p>
610SpriteSet used in pixel sprite rendering.
611<p>
612<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_ogre_rendering_run.html#96125ade38c507267da4668b80e40f1a">renderPixelSprites</a> </dd></dl>
613    </td>
614  </tr>
615</table>
616<a class="anchor" name="8c9a1a0414b30a6dc91e7cca8f28bc16"></a><!-- doxytag: member="OgreRenderingRun::spriteSetName" ref="8c9a1a0414b30a6dc91e7cca8f28bc16" args="" --><p>
617<table class="mdTable" 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">String <a class="el" href="class_ogre_rendering_run.html#8c9a1a0414b30a6dc91e7cca8f28bc16">OgreRenderingRun::spriteSetName</a><code> [protected]</code>          </td>
623        </tr>
624      </table>
625    </td>
626  </tr>
627</table>
628<table cellspacing="5" cellpadding="0" border="0">
629  <tr>
630    <td>
631      &nbsp;
632    </td>
633    <td>
634
635<p>
636unique name of the SpriteSet used in pixel sprite rendering
637<p>
638<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_ogre_rendering_run.html#96125ade38c507267da4668b80e40f1a">renderPixelSprites</a> </dd></dl>
639    </td>
640  </tr>
641</table>
642<a class="anchor" name="21ff568dfa6da8cb3aeb4e50b3e7ccbf"></a><!-- doxytag: member="OgreRenderingRun::visibleObjects" ref="21ff568dfa6da8cb3aeb4e50b3e7ccbf" args="" --><p>
643<table class="mdTable" cellpadding="2" cellspacing="0">
644  <tr>
645    <td class="mdRow">
646      <table cellpadding="0" cellspacing="0" border="0">
647        <tr>
648          <td class="md" nowrap valign="top">std::map&lt;Renderable*, String&gt; <a class="el" href="class_ogre_rendering_run.html#21ff568dfa6da8cb3aeb4e50b3e7ccbf">OgreRenderingRun::visibleObjects</a><code> [protected]</code>          </td>
649        </tr>
650      </table>
651    </td>
652  </tr>
653</table>
654<table cellspacing="5" cellpadding="0" border="0">
655  <tr>
656    <td>
657      &nbsp;
658    </td>
659    <td>
660
661<p>
662map of Renderables which will be rendered with a given material
663<p>
664The String stores the original material name that will be restored after rendering.<p>
665<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_ogre_rendering_run.html#d5293bf02c9eaf10432327b7ec4725c9">setMaterialForVisibles</a> <p>
666<a class="el" href="class_ogre_rendering_run.html#ce87ad15f63c1d0342fef57f292c72d5">setMaterialForRenderables</a> <p>
667<a class="el" href="class_ogre_rendering_run.html#6e8e10ac9a6e54c22d23acbceaba00d2">restoreMaterials</a> </dd></dl>
668    </td>
669  </tr>
670</table>
671<hr>The documentation for this class was generated from the following files:<ul>
672<li>OgreRenderingRun.h<li>OgreRenderingRun.cpp</ul>
673<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:41 2006 for GameTools Illumination Module by&nbsp;
674<a href="http://www.doxygen.org/index.html">
675<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
676</body>
677</html>
Note: See TracBrowser for help on using the repository browser.