source: GTP/trunk/Lib/Illum/IllumModule/doc/html/class_scene_camera_depth_rendering_run.html @ 894

Revision 894, 5.6 KB checked in by szirmay, 18 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: SceneCameraDepthRenderingRun 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>SceneCameraDepthRenderingRun Class Reference</h1><!-- doxytag: class="SceneCameraDepthRenderingRun" --><!-- doxytag: inherits="RenderingRun" -->Base abstract class that defines a rendering process that creates depth map. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for SceneCameraDepthRenderingRun:
24<p><center><img src="class_scene_camera_depth_rendering_run.png" usemap="#SceneCameraDepthRenderingRun_map" border="0" alt=""></center>
25<map name="SceneCameraDepthRenderingRun_map">
26<area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,234,24">
27<area href="class_ogre_scene_camera_depth_rendering_run.html" alt="OgreSceneCameraDepthRenderingRun" shape="rect" coords="0,112,234,136">
28</map>
29<a href="class_scene_camera_depth_rendering_run-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
30<tr><td></td></tr>
31<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
32<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff0c966e82dd52620b6c7715f0970b13"></a><!-- doxytag: member="SceneCameraDepthRenderingRun::SceneCameraDepthRenderingRun" ref="ff0c966e82dd52620b6c7715f0970b13" args="()" -->
33&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_scene_camera_depth_rendering_run.html#ff0c966e82dd52620b6c7715f0970b13">SceneCameraDepthRenderingRun</a> ()</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
36<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05828230af3178c0d1dc738b53f02120"></a><!-- doxytag: member="SceneCameraDepthRenderingRun::createDepthMap" ref="05828230af3178c0d1dc738b53f02120" args="()=0" -->
38virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_scene_camera_depth_rendering_run.html#05828230af3178c0d1dc738b53f02120">createDepthMap</a> ()=0</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates the depth map texture. <br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_scene_camera_depth_rendering_run.html#749edabd991db542031ca91e137b5b8b">updateFrame</a> (unsigned long frameNum)=0</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function does the actual update in a frame.  <a href="#749edabd991db542031ca91e137b5b8b"></a><br></td></tr>
44</table>
45<hr><a name="_details"></a><h2>Detailed Description</h2>
46Base abstract class that defines a rendering process that creates depth map.
47<p>
48The depth map stores the scene's camera space z coordinates (rendered from the player's view).
49<p>
50<hr><h2>Member Function Documentation</h2>
51<a class="anchor" name="749edabd991db542031ca91e137b5b8b"></a><!-- doxytag: member="SceneCameraDepthRenderingRun::updateFrame" ref="749edabd991db542031ca91e137b5b8b" args="(unsigned long frameNum)=0" --><p>
52<table class="mdTable" cellpadding="2" cellspacing="0">
53  <tr>
54    <td class="mdRow">
55      <table cellpadding="0" cellspacing="0" border="0">
56        <tr>
57          <td class="md" nowrap valign="top">virtual void SceneCameraDepthRenderingRun::updateFrame           </td>
58          <td class="md" valign="top">(&nbsp;</td>
59          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
60          <td class="mdname1" valign="top" nowrap> <em>frameNum</em>          </td>
61          <td class="md" valign="top">&nbsp;)&nbsp;</td>
62          <td class="md" nowrap><code> [protected, pure virtual]</code></td>
63        </tr>
64      </table>
65    </td>
66  </tr>
67</table>
68<table cellspacing="5" cellpadding="0" border="0">
69  <tr>
70    <td>
71      &nbsp;
72    </td>
73    <td>
74
75<p>
76This function does the actual update in a frame.
77<p>
78<dl compact><dt><b>Parameters:</b></dt><dd>
79  <table border="0" cellspacing="2" cellpadding="0">
80    <tr><td valign="top"></td><td valign="top"><em>frameNum</em>&nbsp;</td><td>current frame number </td></tr>
81  </table>
82</dl>
83
84<p>
85Reimplemented from <a class="el" href="class_rendering_run.html#043309cb823ebddcbe2bae2c61892235">RenderingRun</a>.
86<p>
87Implemented in <a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#9b4e8dd326ada476b27ac420766bd1ed">OgreSceneCameraDepthRenderingRun</a>.    </td>
88  </tr>
89</table>
90<hr>The documentation for this class was generated from the following file:<ul>
91<li>SceneCameraDepthRenderingRun.h</ul>
92<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:43 2006 for GameTools Illumination Module by&nbsp;
93<a href="http://www.doxygen.org/index.html">
94<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
95</body>
96</html>
Note: See TracBrowser for help on using the repository browser.