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: OgreDepthShadowMapRenderingRun 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 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 List</span></a></li> |
---|
17 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
18 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
19 | </ul></div> |
---|
20 | <h1>OgreDepthShadowMapRenderingRun Class Reference</h1><!-- doxytag: class="OgreDepthShadowMapRenderingRun" --><!-- doxytag: inherits="OgreRenderingRun,DepthShadowMapRenderingRun" --><a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> used in an OGRE environment. |
---|
21 | <a href="#_details">More...</a> |
---|
22 | <p> |
---|
23 | <p>Inheritance diagram for OgreDepthShadowMapRenderingRun: |
---|
24 | <p><center><img src="class_ogre_depth_shadow_map_rendering_run.png" usemap="#OgreDepthShadowMapRenderingRun_map" border="0" alt=""></center> |
---|
25 | <map name="OgreDepthShadowMapRenderingRun_map"> |
---|
26 | <area href="class_ogre_rendering_run.html" alt="OgreRenderingRun" shape="rect" coords="0,56,224,80"> |
---|
27 | <area href="class_depth_shadow_map_rendering_run.html" alt="DepthShadowMapRenderingRun" shape="rect" coords="234,56,458,80"> |
---|
28 | <area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,224,24"> |
---|
29 | <area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="234,0,458,24"> |
---|
30 | </map> |
---|
31 | <a href="class_ogre_depth_shadow_map_rendering_run-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
32 | <tr><td></td></tr> |
---|
33 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#0cd3998c6c5335091df478865a146278">OgreDepthShadowMapRenderingRun</a> (<a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *<a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#1c4560274bb8e2f5cb5cfb0b475f6260">sharedRuns</a>, String <a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#4f9a7de0fdcaf45bb323b8f00df9932f">name</a>, Light *<a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#374cdcfdc8fd03c204edaa476d37f07f">light</a>, unsigned int <a class="el" href="class_depth_shadow_map_rendering_run.html#2bc80fd744492e862d9f29ec7b0d0143">resolutionX</a>, unsigned int <a class="el" href="class_depth_shadow_map_rendering_run.html#cb8eb97aeeaaa9087972b7ddbaf438f4">resolutionY</a>, String <a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#3dc170922e5353d56737b062143519c0">materialName</a>)</td></tr> |
---|
35 | |
---|
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#0cd3998c6c5335091df478865a146278"></a><br></td></tr> |
---|
37 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e315a7d9f8cbc4c681f304637e21f53e"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::getDepthMapTextureName" ref="e315a7d9f8cbc4c681f304637e21f53e" args="()" --> |
---|
38 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#e315a7d9f8cbc4c681f304637e21f53e">getDepthMapTextureName</a> ()</td></tr> |
---|
39 | |
---|
40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns the depth shadow map texture created by this run <br></td></tr> |
---|
41 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71aa39faa17a2e5ca0be4428a924a3fa"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::refreshLight" ref="71aa39faa17a2e5ca0be4428a924a3fa" args="()" --> |
---|
42 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#71aa39faa17a2e5ca0be4428a924a3fa">refreshLight</a> ()</td></tr> |
---|
43 | |
---|
44 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Refreshes light camera matrices, called in each update. <br></td></tr> |
---|
45 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8bcfd4eceba0e8165b854589039fc7b8"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::getLightViewMatrix" ref="8bcfd4eceba0e8165b854589039fc7b8" args="()" --> |
---|
46 | Matrix4 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#8bcfd4eceba0e8165b854589039fc7b8">getLightViewMatrix</a> ()</td></tr> |
---|
47 | |
---|
48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">retuns the view matrix of the camera from which the depth shadow map was created <br></td></tr> |
---|
49 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f62ac5632a72ba2d0cd9ca4580b837fd"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::getLightViewProjMatrix" ref="f62ac5632a72ba2d0cd9ca4580b837fd" args="()" --> |
---|
50 | Matrix4 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#f62ac5632a72ba2d0cd9ca4580b837fd">getLightViewProjMatrix</a> ()</td></tr> |
---|
51 | |
---|
52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">retuns the concatenation of the view and projection matrices of the camera from which the depth shadow map was created <br></td></tr> |
---|
53 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
54 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#5953011948f5584f1a22c9318232edb7">updateFrame</a> (unsigned long frameNum)</td></tr> |
---|
55 | |
---|
56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This function does the actual update in a frame. <a href="#5953011948f5584f1a22c9318232edb7"></a><br></td></tr> |
---|
57 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ceff859f928812f66f4832be74d5d384"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::createDepthMap" ref="ceff859f928812f66f4832be74d5d384" args="()" --> |
---|
58 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#ceff859f928812f66f4832be74d5d384">createDepthMap</a> ()</td></tr> |
---|
59 | |
---|
60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the depth map texture (2D or CUBE according to light type). <br></td></tr> |
---|
61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#d41e92b1cc465d3c4eaadc9a6dcc9249">updateDepthCubeFace</a> (int facenum)</td></tr> |
---|
62 | |
---|
63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates one face of the depth cubemap (used only in case of point lights). <a href="#d41e92b1cc465d3c4eaadc9a6dcc9249"></a><br></td></tr> |
---|
64 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="341463b550be9b60befacf2b931b811d"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::updateDepthMap" ref="341463b550be9b60befacf2b931b811d" args="()" --> |
---|
65 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#341463b550be9b60befacf2b931b811d">updateDepthMap</a> ()</td></tr> |
---|
66 | |
---|
67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates the depth map (in case of directional and spot lights). <br></td></tr> |
---|
68 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
69 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="374cdcfdc8fd03c204edaa476d37f07f"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::light" ref="374cdcfdc8fd03c204edaa476d37f07f" args="" --> |
---|
70 | Light * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#374cdcfdc8fd03c204edaa476d37f07f">light</a></td></tr> |
---|
71 | |
---|
72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the light source this depth shadow map belongs to <br></td></tr> |
---|
73 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b504261ae3c08241a5850efd1f079193"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::depthMapCamera" ref="b504261ae3c08241a5850efd1f079193" args="" --> |
---|
74 | Camera * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#b504261ae3c08241a5850efd1f079193">depthMapCamera</a></td></tr> |
---|
75 | |
---|
76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the camera of the lightsource <br></td></tr> |
---|
77 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3dc170922e5353d56737b062143519c0"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::materialName" ref="3dc170922e5353d56737b062143519c0" args="" --> |
---|
78 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#3dc170922e5353d56737b062143519c0">materialName</a></td></tr> |
---|
79 | |
---|
80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the name of the material to be used when rendering the depth shadow map <br></td></tr> |
---|
81 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c4560274bb8e2f5cb5cfb0b475f6260"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::sharedRuns" ref="1c4560274bb8e2f5cb5cfb0b475f6260" args="" --> |
---|
82 | <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#1c4560274bb8e2f5cb5cfb0b475f6260">sharedRuns</a></td></tr> |
---|
83 | |
---|
84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">a pointer to the <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> this run belongs to <br></td></tr> |
---|
85 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f9a7de0fdcaf45bb323b8f00df9932f"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::name" ref="4f9a7de0fdcaf45bb323b8f00df9932f" args="" --> |
---|
86 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#4f9a7de0fdcaf45bb323b8f00df9932f">name</a></td></tr> |
---|
87 | |
---|
88 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the name of the depth shadow map texture that was created by this run <br></td></tr> |
---|
89 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f0a8bbc4c59def4e16bfa6acecb8a7d"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::depthMapTexture" ref="7f0a8bbc4c59def4e16bfa6acecb8a7d" args="" --> |
---|
90 | Texture * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_depth_shadow_map_rendering_run.html#7f0a8bbc4c59def4e16bfa6acecb8a7d">depthMapTexture</a></td></tr> |
---|
91 | |
---|
92 | <tr><td class="mdescLeft"> </td><td class="mdescRight">a pointer to the depth shadow texture that was created by this run <br></td></tr> |
---|
93 | </table> |
---|
94 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
95 | <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> used in an OGRE environment. |
---|
96 | <p> |
---|
97 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
98 | <a class="anchor" name="0cd3998c6c5335091df478865a146278"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::OgreDepthShadowMapRenderingRun" ref="0cd3998c6c5335091df478865a146278" args="(OgreSharedRuns *sharedRuns, String name, Light *light, unsigned int resolutionX, unsigned int resolutionY, String materialName)" --><p> |
---|
99 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
100 | <tr> |
---|
101 | <td class="mdRow"> |
---|
102 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
103 | <tr> |
---|
104 | <td class="md" nowrap valign="top">OgreDepthShadowMapRenderingRun::OgreDepthShadowMapRenderingRun </td> |
---|
105 | <td class="md" valign="top">( </td> |
---|
106 | <td class="md" nowrap valign="top"><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * </td> |
---|
107 | <td class="mdname" nowrap> <em>sharedRuns</em>, </td> |
---|
108 | </tr> |
---|
109 | <tr> |
---|
110 | <td class="md" nowrap align="right"></td> |
---|
111 | <td class="md"></td> |
---|
112 | <td class="md" nowrap>String </td> |
---|
113 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
114 | </tr> |
---|
115 | <tr> |
---|
116 | <td class="md" nowrap align="right"></td> |
---|
117 | <td class="md"></td> |
---|
118 | <td class="md" nowrap>Light * </td> |
---|
119 | <td class="mdname" nowrap> <em>light</em>, </td> |
---|
120 | </tr> |
---|
121 | <tr> |
---|
122 | <td class="md" nowrap align="right"></td> |
---|
123 | <td class="md"></td> |
---|
124 | <td class="md" nowrap>unsigned int </td> |
---|
125 | <td class="mdname" nowrap> <em>resolutionX</em>, </td> |
---|
126 | </tr> |
---|
127 | <tr> |
---|
128 | <td class="md" nowrap align="right"></td> |
---|
129 | <td class="md"></td> |
---|
130 | <td class="md" nowrap>unsigned int </td> |
---|
131 | <td class="mdname" nowrap> <em>resolutionY</em>, </td> |
---|
132 | </tr> |
---|
133 | <tr> |
---|
134 | <td class="md" nowrap align="right"></td> |
---|
135 | <td class="md"></td> |
---|
136 | <td class="md" nowrap>String </td> |
---|
137 | <td class="mdname" nowrap> <em>materialName</em></td> |
---|
138 | </tr> |
---|
139 | <tr> |
---|
140 | <td class="md"></td> |
---|
141 | <td class="md">) </td> |
---|
142 | <td class="md" colspan="2"></td> |
---|
143 | </tr> |
---|
144 | </table> |
---|
145 | </td> |
---|
146 | </tr> |
---|
147 | </table> |
---|
148 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
149 | <tr> |
---|
150 | <td> |
---|
151 | |
---|
152 | </td> |
---|
153 | <td> |
---|
154 | |
---|
155 | <p> |
---|
156 | Constructor. |
---|
157 | <p> |
---|
158 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
159 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
160 | <tr><td valign="top"></td><td valign="top"><em>sharedRuns</em> </td><td>a pointer to the <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> this run belongs to </td></tr> |
---|
161 | <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the depth map texture to be created </td></tr> |
---|
162 | <tr><td valign="top"></td><td valign="top"><em>light</em> </td><td>the light source this depth shadow map belongs to </td></tr> |
---|
163 | <tr><td valign="top"></td><td valign="top"><em>resolutionX</em> </td><td>the resolution width of the depth shadow map </td></tr> |
---|
164 | <tr><td valign="top"></td><td valign="top"><em>resolutionY</em> </td><td>the resolution height of the depth shadow map </td></tr> |
---|
165 | <tr><td valign="top"></td><td valign="top"><em>materialName</em> </td><td>the name of the material to be used when rendering the depth shadow map </td></tr> |
---|
166 | </table> |
---|
167 | </dl> |
---|
168 | </td> |
---|
169 | </tr> |
---|
170 | </table> |
---|
171 | <hr><h2>Member Function Documentation</h2> |
---|
172 | <a class="anchor" name="d41e92b1cc465d3c4eaadc9a6dcc9249"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::updateDepthCubeFace" ref="d41e92b1cc465d3c4eaadc9a6dcc9249" args="(int facenum)" --><p> |
---|
173 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
174 | <tr> |
---|
175 | <td class="mdRow"> |
---|
176 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
177 | <tr> |
---|
178 | <td class="md" nowrap valign="top">void OgreDepthShadowMapRenderingRun::updateDepthCubeFace </td> |
---|
179 | <td class="md" valign="top">( </td> |
---|
180 | <td class="md" nowrap valign="top">int </td> |
---|
181 | <td class="mdname1" valign="top" nowrap> <em>facenum</em> </td> |
---|
182 | <td class="md" valign="top"> ) </td> |
---|
183 | <td class="md" nowrap><code> [protected, virtual]</code></td> |
---|
184 | </tr> |
---|
185 | </table> |
---|
186 | </td> |
---|
187 | </tr> |
---|
188 | </table> |
---|
189 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
190 | <tr> |
---|
191 | <td> |
---|
192 | |
---|
193 | </td> |
---|
194 | <td> |
---|
195 | |
---|
196 | <p> |
---|
197 | Updates one face of the depth cubemap (used only in case of point lights). |
---|
198 | <p> |
---|
199 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
200 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
201 | <tr><td valign="top"></td><td valign="top"><em>facenum</em> </td><td>the number of the face to be updated </td></tr> |
---|
202 | </table> |
---|
203 | </dl> |
---|
204 | |
---|
205 | <p> |
---|
206 | Implements <a class="el" href="class_depth_shadow_map_rendering_run.html#957f2ab9c82ca93d8cb6e6969cfc371e">DepthShadowMapRenderingRun</a>. </td> |
---|
207 | </tr> |
---|
208 | </table> |
---|
209 | <a class="anchor" name="5953011948f5584f1a22c9318232edb7"></a><!-- doxytag: member="OgreDepthShadowMapRenderingRun::updateFrame" ref="5953011948f5584f1a22c9318232edb7" args="(unsigned long frameNum)" --><p> |
---|
210 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
211 | <tr> |
---|
212 | <td class="mdRow"> |
---|
213 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
214 | <tr> |
---|
215 | <td class="md" nowrap valign="top">void OgreDepthShadowMapRenderingRun::updateFrame </td> |
---|
216 | <td class="md" valign="top">( </td> |
---|
217 | <td class="md" nowrap valign="top">unsigned long </td> |
---|
218 | <td class="mdname1" valign="top" nowrap> <em>frameNum</em> </td> |
---|
219 | <td class="md" valign="top"> ) </td> |
---|
220 | <td class="md" nowrap><code> [protected, virtual]</code></td> |
---|
221 | </tr> |
---|
222 | </table> |
---|
223 | </td> |
---|
224 | </tr> |
---|
225 | </table> |
---|
226 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
227 | <tr> |
---|
228 | <td> |
---|
229 | |
---|
230 | </td> |
---|
231 | <td> |
---|
232 | |
---|
233 | <p> |
---|
234 | This function does the actual update in a frame. |
---|
235 | <p> |
---|
236 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
237 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
238 | <tr><td valign="top"></td><td valign="top"><em>frameNum</em> </td><td>current frame number </td></tr> |
---|
239 | </table> |
---|
240 | </dl> |
---|
241 | |
---|
242 | <p> |
---|
243 | Implements <a class="el" href="class_depth_shadow_map_rendering_run.html#de3c9eb12ebec3d57ea8fc46b809000d">DepthShadowMapRenderingRun</a>. </td> |
---|
244 | </tr> |
---|
245 | </table> |
---|
246 | <hr>The documentation for this class was generated from the following files:<ul> |
---|
247 | <li>OgreDepthShadowMapRenderingRun.h<li>OgreDepthShadowMapRenderingRun.cpp</ul> |
---|
248 | <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:40 2006 for GameTools Illumination Module by |
---|
249 | <a href="http://www.doxygen.org/index.html"> |
---|
250 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
251 | </body> |
---|
252 | </html> |
---|