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: OgreSceneCameraDepthRenderingRun 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>OgreSceneCameraDepthRenderingRun Class Reference</h1><!-- doxytag: class="OgreSceneCameraDepthRenderingRun" --><!-- doxytag: inherits="OgreRenderingRun,SceneCameraDepthRenderingRun" --><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 OgreSceneCameraDepthRenderingRun: |
---|
24 | <p><center><img src="class_ogre_scene_camera_depth_rendering_run.png" usemap="#OgreSceneCameraDepthRenderingRun_map" border="0" alt=""></center> |
---|
25 | <map name="OgreSceneCameraDepthRenderingRun_map"> |
---|
26 | <area href="class_ogre_rendering_run.html" alt="OgreRenderingRun" shape="rect" coords="0,56,234,80"> |
---|
27 | <area href="class_scene_camera_depth_rendering_run.html" alt="SceneCameraDepthRenderingRun" shape="rect" coords="244,56,478,80"> |
---|
28 | <area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,234,24"> |
---|
29 | <area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="244,0,478,24"> |
---|
30 | </map> |
---|
31 | <a href="class_ogre_scene_camera_depth_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_scene_camera_depth_rendering_run.html#76ae66cdb974966d62f3b0d0c8c59add">OgreSceneCameraDepthRenderingRun</a> (<a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *<a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#0f85bc4dc2b9f08615aa0694631e6d2f">sharedRuns</a>, String <a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#fb6e08f520750743e7af0b0bffb0de40">name</a>, Viewport *<a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#abab44fd2d5a68c327f3bc3359fa6890">playerView</a>)</td></tr> |
---|
35 | |
---|
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#76ae66cdb974966d62f3b0d0c8c59add"></a><br></td></tr> |
---|
37 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e352630507a53528fddbfcd01232abb8"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::getDepthTextureName" ref="e352630507a53528fddbfcd01232abb8" args="()" --> |
---|
38 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#e352630507a53528fddbfcd01232abb8">getDepthTextureName</a> ()</td></tr> |
---|
39 | |
---|
40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns the name of the camera depth texture <br></td></tr> |
---|
41 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
42 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#9b4e8dd326ada476b27ac420766bd1ed">updateFrame</a> (unsigned long frameNum)</td></tr> |
---|
43 | |
---|
44 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This function does the actual update in a frame. <a href="#9b4e8dd326ada476b27ac420766bd1ed"></a><br></td></tr> |
---|
45 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca30a8c381d86c764d09fc19118efcb2"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::createDepthMap" ref="ca30a8c381d86c764d09fc19118efcb2" args="()" --> |
---|
46 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#ca30a8c381d86c764d09fc19118efcb2">createDepthMap</a> ()</td></tr> |
---|
47 | |
---|
48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the depth map texture. <br></td></tr> |
---|
49 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="abab44fd2d5a68c327f3bc3359fa6890"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::playerView" ref="abab44fd2d5a68c327f3bc3359fa6890" args="" --> |
---|
51 | Viewport * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#abab44fd2d5a68c327f3bc3359fa6890">playerView</a></td></tr> |
---|
52 | |
---|
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the player's viewport <br></td></tr> |
---|
54 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71dc7aed4c38fa7c5dda7f33ee9e6850"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::playerCamera" ref="71dc7aed4c38fa7c5dda7f33ee9e6850" args="" --> |
---|
55 | Camera * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#71dc7aed4c38fa7c5dda7f33ee9e6850">playerCamera</a></td></tr> |
---|
56 | |
---|
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the player's camera <br></td></tr> |
---|
58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f85bc4dc2b9f08615aa0694631e6d2f"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::sharedRuns" ref="0f85bc4dc2b9f08615aa0694631e6d2f" args="" --> |
---|
59 | <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#0f85bc4dc2b9f08615aa0694631e6d2f">sharedRuns</a></td></tr> |
---|
60 | |
---|
61 | <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> |
---|
62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb6e08f520750743e7af0b0bffb0de40"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::name" ref="fb6e08f520750743e7af0b0bffb0de40" args="" --> |
---|
63 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#fb6e08f520750743e7af0b0bffb0de40">name</a></td></tr> |
---|
64 | |
---|
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the name of the depth texture that was created by this run <br></td></tr> |
---|
66 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b9a9421e733ecfa0884017520348530"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::depthTexture" ref="2b9a9421e733ecfa0884017520348530" args="" --> |
---|
67 | Texture * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_scene_camera_depth_rendering_run.html#2b9a9421e733ecfa0884017520348530">depthTexture</a></td></tr> |
---|
68 | |
---|
69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">a pointer to the scene depth texture that was created by this run <br></td></tr> |
---|
70 | </table> |
---|
71 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
72 | <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> used in an OGRE environment. |
---|
73 | <p> |
---|
74 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
75 | <a class="anchor" name="76ae66cdb974966d62f3b0d0c8c59add"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::OgreSceneCameraDepthRenderingRun" ref="76ae66cdb974966d62f3b0d0c8c59add" args="(OgreSharedRuns *sharedRuns, String name, Viewport *playerView)" --><p> |
---|
76 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
77 | <tr> |
---|
78 | <td class="mdRow"> |
---|
79 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
80 | <tr> |
---|
81 | <td class="md" nowrap valign="top">OgreSceneCameraDepthRenderingRun::OgreSceneCameraDepthRenderingRun </td> |
---|
82 | <td class="md" valign="top">( </td> |
---|
83 | <td class="md" nowrap valign="top"><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * </td> |
---|
84 | <td class="mdname" nowrap> <em>sharedRuns</em>, </td> |
---|
85 | </tr> |
---|
86 | <tr> |
---|
87 | <td class="md" nowrap align="right"></td> |
---|
88 | <td class="md"></td> |
---|
89 | <td class="md" nowrap>String </td> |
---|
90 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
91 | </tr> |
---|
92 | <tr> |
---|
93 | <td class="md" nowrap align="right"></td> |
---|
94 | <td class="md"></td> |
---|
95 | <td class="md" nowrap>Viewport * </td> |
---|
96 | <td class="mdname" nowrap> <em>playerView</em></td> |
---|
97 | </tr> |
---|
98 | <tr> |
---|
99 | <td class="md"></td> |
---|
100 | <td class="md">) </td> |
---|
101 | <td class="md" colspan="2"></td> |
---|
102 | </tr> |
---|
103 | </table> |
---|
104 | </td> |
---|
105 | </tr> |
---|
106 | </table> |
---|
107 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
108 | <tr> |
---|
109 | <td> |
---|
110 | |
---|
111 | </td> |
---|
112 | <td> |
---|
113 | |
---|
114 | <p> |
---|
115 | Constructor. |
---|
116 | <p> |
---|
117 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
118 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
119 | <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> |
---|
120 | <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the scene depth texture to be created </td></tr> |
---|
121 | <tr><td valign="top"></td><td valign="top"><em>playerView</em> </td><td>pointer to the player's viewport </td></tr> |
---|
122 | </table> |
---|
123 | </dl> |
---|
124 | </td> |
---|
125 | </tr> |
---|
126 | </table> |
---|
127 | <hr><h2>Member Function Documentation</h2> |
---|
128 | <a class="anchor" name="9b4e8dd326ada476b27ac420766bd1ed"></a><!-- doxytag: member="OgreSceneCameraDepthRenderingRun::updateFrame" ref="9b4e8dd326ada476b27ac420766bd1ed" args="(unsigned long frameNum)" --><p> |
---|
129 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
130 | <tr> |
---|
131 | <td class="mdRow"> |
---|
132 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
133 | <tr> |
---|
134 | <td class="md" nowrap valign="top">void OgreSceneCameraDepthRenderingRun::updateFrame </td> |
---|
135 | <td class="md" valign="top">( </td> |
---|
136 | <td class="md" nowrap valign="top">unsigned long </td> |
---|
137 | <td class="mdname1" valign="top" nowrap> <em>frameNum</em> </td> |
---|
138 | <td class="md" valign="top"> ) </td> |
---|
139 | <td class="md" nowrap><code> [protected, virtual]</code></td> |
---|
140 | </tr> |
---|
141 | </table> |
---|
142 | </td> |
---|
143 | </tr> |
---|
144 | </table> |
---|
145 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
146 | <tr> |
---|
147 | <td> |
---|
148 | |
---|
149 | </td> |
---|
150 | <td> |
---|
151 | |
---|
152 | <p> |
---|
153 | This function does the actual update in a frame. |
---|
154 | <p> |
---|
155 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
156 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
157 | <tr><td valign="top"></td><td valign="top"><em>frameNum</em> </td><td>current frame number </td></tr> |
---|
158 | </table> |
---|
159 | </dl> |
---|
160 | |
---|
161 | <p> |
---|
162 | Implements <a class="el" href="class_scene_camera_depth_rendering_run.html#749edabd991db542031ca91e137b5b8b">SceneCameraDepthRenderingRun</a>. </td> |
---|
163 | </tr> |
---|
164 | </table> |
---|
165 | <hr>The documentation for this class was generated from the following files:<ul> |
---|
166 | <li>OgreSceneCameraDepthRenderingRun.h<li>OgreSceneCameraDepthRenderingRun.cpp</ul> |
---|
167 | <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:42 2006 for GameTools Illumination Module by |
---|
168 | <a href="http://www.doxygen.org/index.html"> |
---|
169 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
170 | </body> |
---|
171 | </html> |
---|