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

Revision 894, 7.4 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: PhotonMapRenderingRun 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>PhotonMapRenderingRun Class Reference</h1><!-- doxytag: class="PhotonMapRenderingRun" --><!-- doxytag: inherits="RenderingRun" -->Base abstract class that defines a rendering process of a photon hit map. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for PhotonMapRenderingRun:
24<p><center><img src="class_photon_map_rendering_run.png" usemap="#PhotonMapRenderingRun_map" border="0" alt=""></center>
25<map name="PhotonMapRenderingRun_map">
26<area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,185,24">
27<area href="class_ogre_photon_map_rendering_run.html" alt="OgrePhotonMapRenderingRun" shape="rect" coords="0,112,185,136">
28</map>
29<a href="class_photon_map_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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_photon_map_rendering_run.html#196208d5d067d3588759d0f99f2d7d2f">PhotonMapRenderingRun</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>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#196208d5d067d3588759d0f99f2d7d2f"></a><br></td></tr>
35<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_photon_map_rendering_run.html#bf26e2ba9976a6260ba64f0f8b957afb">updateFrame</a> (unsigned long frameNum)=0</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function does the actual update in a frame.  <a href="#bf26e2ba9976a6260ba64f0f8b957afb"></a><br></td></tr>
39<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="00defa7dbc31757ef87dfba6507fa9d5"></a><!-- doxytag: member="PhotonMapRenderingRun::createPhotonMap" ref="00defa7dbc31757ef87dfba6507fa9d5" args="()=0" -->
40virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_photon_map_rendering_run.html#00defa7dbc31757ef87dfba6507fa9d5">createPhotonMap</a> ()=0</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a photon hit map. <br></td></tr>
43</table>
44<hr><a name="_details"></a><h2>Detailed Description</h2>
45Base abstract class that defines a rendering process of a photon hit map.
46<p>
47A photon hit map stores the directions where the incoming photons are refracted by a caustic emitter object. One pixel of the photon map represents one photon hit, hte direction is encoded in the RGB channels. If the alpha channel has zero value, the hit is invalid.
48<p>
49<hr><h2>Constructor &amp; Destructor Documentation</h2>
50<a class="anchor" name="196208d5d067d3588759d0f99f2d7d2f"></a><!-- doxytag: member="PhotonMapRenderingRun::PhotonMapRenderingRun" ref="196208d5d067d3588759d0f99f2d7d2f" args="(unsigned long startFrame, unsigned long updateInterval)" --><p>
51<table class="mdTable" cellpadding="2" cellspacing="0">
52  <tr>
53    <td class="mdRow">
54      <table cellpadding="0" cellspacing="0" border="0">
55        <tr>
56          <td class="md" nowrap valign="top">PhotonMapRenderingRun::PhotonMapRenderingRun           </td>
57          <td class="md" valign="top">(&nbsp;</td>
58          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
59          <td class="mdname" nowrap> <em>startFrame</em>, </td>
60        </tr>
61        <tr>
62          <td class="md" nowrap align="right"></td>
63          <td class="md"></td>
64          <td class="md" nowrap>unsigned long&nbsp;</td>
65          <td class="mdname" nowrap> <em>updateInterval</em></td>
66        </tr>
67        <tr>
68          <td class="md"></td>
69          <td class="md">)&nbsp;</td>
70          <td class="md" colspan="2"><code> [inline]</code></td>
71        </tr>
72      </table>
73    </td>
74  </tr>
75</table>
76<table cellspacing="5" cellpadding="0" border="0">
77  <tr>
78    <td>
79      &nbsp;
80    </td>
81    <td>
82
83<p>
84Constructor.
85<p>
86<dl compact><dt><b>Parameters:</b></dt><dd>
87  <table border="0" cellspacing="2" cellpadding="0">
88    <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>
89    <tr><td valign="top"></td><td valign="top"><em>updateInterval</em>&nbsp;</td><td>update frequency </td></tr>
90  </table>
91</dl>
92    </td>
93  </tr>
94</table>
95<hr><h2>Member Function Documentation</h2>
96<a class="anchor" name="bf26e2ba9976a6260ba64f0f8b957afb"></a><!-- doxytag: member="PhotonMapRenderingRun::updateFrame" ref="bf26e2ba9976a6260ba64f0f8b957afb" args="(unsigned long frameNum)=0" --><p>
97<table class="mdTable" cellpadding="2" cellspacing="0">
98  <tr>
99    <td class="mdRow">
100      <table cellpadding="0" cellspacing="0" border="0">
101        <tr>
102          <td class="md" nowrap valign="top">virtual void PhotonMapRenderingRun::updateFrame           </td>
103          <td class="md" valign="top">(&nbsp;</td>
104          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
105          <td class="mdname1" valign="top" nowrap> <em>frameNum</em>          </td>
106          <td class="md" valign="top">&nbsp;)&nbsp;</td>
107          <td class="md" nowrap><code> [protected, pure virtual]</code></td>
108        </tr>
109      </table>
110    </td>
111  </tr>
112</table>
113<table cellspacing="5" cellpadding="0" border="0">
114  <tr>
115    <td>
116      &nbsp;
117    </td>
118    <td>
119
120<p>
121This function does the actual update in a frame.
122<p>
123<dl compact><dt><b>Parameters:</b></dt><dd>
124  <table border="0" cellspacing="2" cellpadding="0">
125    <tr><td valign="top"></td><td valign="top"><em>frameNum</em>&nbsp;</td><td>current frame number </td></tr>
126  </table>
127</dl>
128
129<p>
130Reimplemented from <a class="el" href="class_rendering_run.html#043309cb823ebddcbe2bae2c61892235">RenderingRun</a>.
131<p>
132Implemented in <a class="el" href="class_ogre_photon_map_rendering_run.html#963a3e60a34ce8cec8a542d2f22db10a">OgrePhotonMapRenderingRun</a>.    </td>
133  </tr>
134</table>
135<hr>The documentation for this class was generated from the following file:<ul>
136<li>PhotonMapRenderingRun.h</ul>
137<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:42 2006 for GameTools Illumination Module by&nbsp;
138<a href="http://www.doxygen.org/index.html">
139<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
140</body>
141</html>
Note: See TracBrowser for help on using the repository browser.