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

Revision 2910, 57.1 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: OgreIlluminationManager 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>OgreIlluminationManager Class Reference</h1><!-- doxytag: class="OgreIlluminationManager" -->Implementation of <a class="el" href="class_illumination_manager.html">IlluminationManager</a> in an OGRE environment. 
21<a href="#_details">More...</a>
22<p>
23<a href="class_ogre_illumination_manager-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
24<tr><td></td></tr>
25<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31b64fb0e7e652e3f21af135e0608b23"></a><!-- doxytag: member="OgreIlluminationManager::addRenderTechniqueFactory" ref="31b64fb0e7e652e3f21af135e0608b23" args="(RenderTechniqueFactory *factory)" -->
27void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#31b64fb0e7e652e3f21af135e0608b23">addRenderTechniqueFactory</a> (<a class="el" href="class_render_technique_factory.html">RenderTechniqueFactory</a> *factory)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">registers a <a class="el" href="class_render_technique_factory.html">RenderTechniqueFactory</a> <br></td></tr>
30<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="800ab21104e0299392d21f371e8739d7"></a><!-- doxytag: member="OgreIlluminationManager::getMaxJoinRadius" ref="800ab21104e0299392d21f371e8739d7" args="()" -->
31float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#800ab21104e0299392d21f371e8739d7">getMaxJoinRadius</a> ()</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">retirieves the maximum bounding sphere radius with two <a class="el" href="class_shared_runs.html">SharedRuns</a> can be joined. <br></td></tr>
34<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2e2bfe5a01f2cbf9ee433e41eea260b"></a><!-- doxytag: member="OgreIlluminationManager::setMaxJoinRadius" ref="f2e2bfe5a01f2cbf9ee433e41eea260b" args="(float rad)" -->
35void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#f2e2bfe5a01f2cbf9ee433e41eea260b">setMaxJoinRadius</a> (float rad)</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets the maximum bounding sphere radius with two <a class="el" href="class_shared_runs.html">SharedRuns</a> can be joined. <br></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#d4403b0018454ec16528c0c7f9a783c2">update</a> (unsigned long frameNumber, RenderTarget *rt)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The function to be called to render one frame.  <a href="#d4403b0018454ec16528c0c7f9a783c2"></a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbd6857a3752c0380c563736adc8ed14"></a><!-- doxytag: member="OgreIlluminationManager::initTechniques" ref="cbd6857a3752c0380c563736adc8ed14" args="()" -->
42void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#cbd6857a3752c0380c563736adc8ed14">initTechniques</a> ()</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">searches for RenderTechniques in materials and creates them. <br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">Camera *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#5f799104fb3dab44a7b441a5a5af006d">getMainCamera</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the player camera.  <a href="#5f799104fb3dab44a7b441a5a5af006d"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">Viewport *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#79981028b1686324f8b74ec2df82224d">getMainViewport</a> ()</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the viewport attached to the player camera.  <a href="#79981028b1686324f8b74ec2df82224d"></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_illumination_manager.html#9920b3a067c88cf20fdbabb8ffe8118d">setMainCamera</a> (Camera *camera)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the player camera.  <a href="#9920b3a067c88cf20fdbabb8ffe8118d"></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_illumination_manager.html#c6ff040c1f55cf496a4feb0196295df6">setMainViewport</a> (Viewport *viewport)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the viewport attached to the player camera.  <a href="#c6ff040c1f55cf496a4feb0196295df6"></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_illumination_manager.html#e29e802f2feceef98fd2ac9286a197e4">sharedRunSplit</a> (<a class="el" href="class_shared_runs.html">SharedRuns</a> *old, <a class="el" href="class_shared_runs.html">SharedRuns</a> *new1, <a class="el" href="class_shared_runs.html">SharedRuns</a> *new2)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The function to be called when a shared run is splitted.  <a href="#e29e802f2feceef98fd2ac9286a197e4"></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_illumination_manager.html#d29c525158107c873024321193f74939">sharedRunJoin</a> (<a class="el" href="class_shared_runs.html">SharedRuns</a> *old1, <a class="el" href="class_shared_runs.html">SharedRuns</a> *old2, <a class="el" href="class_shared_runs.html">SharedRuns</a> *newsr)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The function to be called when two shared runs are joined.  <a href="#d29c525158107c873024321193f74939"></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_illumination_manager.html#61ba920d4b3f5a1dedc072b6042c8ba4">joinSharedRuns</a> ()</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Joins shared runs if needed.  <a href="#61ba920d4b3f5a1dedc072b6042c8ba4"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#2f6b3fe9555066e7151b5a70a646a353">addSharedRuns</a> (<a class="el" href="class_shared_runs.html">SharedRuns</a> *runs)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register a shared run object.  <a href="#2f6b3fe9555066e7151b5a70a646a353"></a><br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#5c420dda0e8b1b469d9dced04814baae">getNearestCausticCasters</a> (Vector3 position, std::vector&lt; <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * &gt; *nearestcasters, unsigned int maxCount)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Searches for the nearest object groups (<a class="el" href="class_shared_runs.html">SharedRuns</a>) that are caustic casters from a given point.  <a href="#5c420dda0e8b1b469d9dced04814baae"></a><br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#6c52b1a5b3e7b964e39fc39ce835ddd3">createGlobalRun</a> (RenderingRunType runType)</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a global <a class="el" href="class_rendering_run.html">RenderingRun</a> of the given type.  <a href="#6c52b1a5b3e7b964e39fc39ce835ddd3"></a><br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#6d4c81a9db2c593271e4a14a529138bc">getGlobalRun</a> (RenderingRunType runType)</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the global RendderingRun with the given type.  <a href="#6d4c81a9db2c593271e4a14a529138bc"></a><br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#84eb8f2dbfa089578f78dff97f885c6c">updateGlobalRun</a> (RenderingRunType runType, unsigned long frameNum)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates a global <a class="el" href="class_rendering_run.html">RenderingRun</a> with the given type.  <a href="#84eb8f2dbfa089578f78dff97f885c6c"></a><br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#05dba755bb0e40be78e76dc018dc530a">createPerLightRun</a> (String lightName, RenderingRunType runType)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a <a class="el" href="class_rendering_run.html">RenderingRun</a> attached to a lightsource with the given type.  <a href="#05dba755bb0e40be78e76dc018dc530a"></a><br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#e84160b69a4e7910e9e4d2e7485519b2">getPerLightRun</a> (String lightName, RenderingRunType runType)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retuns a <a class="el" href="class_rendering_run.html">RenderingRun</a> attached to a lightsource with the given type.  <a href="#e84160b69a4e7910e9e4d2e7485519b2"></a><br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#9266be7879eabe1fc63fca8c394bbb33">updatePerLightRun</a> (String lightName, RenderingRunType runType, unsigned long frameNum)</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates a <a class="el" href="class_rendering_run.html">RenderingRun</a> attached to a lightsource with the given type.  <a href="#9266be7879eabe1fc63fca8c394bbb33"></a><br></td></tr>
90<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0daae2ba5257e6c8f8043c7a454bb1e"></a><!-- doxytag: member="OgreIlluminationManager::getSingleton" ref="b0daae2ba5257e6c8f8043c7a454bb1e" args="()" -->
92static <a class="el" href="class_ogre_illumination_manager.html">OgreIlluminationManager</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#b0daae2ba5257e6c8f8043c7a454bb1e">getSingleton</a> ()</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the one and only <a class="el" href="class_ogre_illumination_manager.html">OgreIlluminationManager</a> instance. <br></td></tr>
95<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6620d132dcb0b7086a1db6eb309971cd"></a><!-- doxytag: member="OgreIlluminationManager::OgreIlluminationManager" ref="6620d132dcb0b7086a1db6eb309971cd" args="()" -->
97&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#6620d132dcb0b7086a1db6eb309971cd">OgreIlluminationManager</a> ()</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected constructor (<a class="el" href="class_ogre_illumination_manager.html">OgreIlluminationManager</a> is a singleton). <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="807fd8ac2c90089a28635e02bda199ce"></a><!-- doxytag: member="OgreIlluminationManager::~OgreIlluminationManager" ref="807fd8ac2c90089a28635e02bda199ce" args="()" -->
101virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#807fd8ac2c90089a28635e02bda199ce">~OgreIlluminationManager</a> ()</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected destructor. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#ce07792e6807db6db0c148aae508ef36">fillVisibleList</a> (RenderQueue *rq)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Searches for visible renderables with valid TechniqueGroups in a renderqueue.  <a href="#ce07792e6807db6db0c148aae508ef36"></a><br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#a6d26d9fbf945c750d83a13f23aa4a5b">createTechnique</a> (IllumTechniqueParams *params, Pass *pass, <a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *rend, <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *sRuns)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">creates a specific type of <a class="el" href="class_render_technique.html">RenderTechnique</a> for a Renderable's pass.  <a href="#a6d26d9fbf945c750d83a13f23aa4a5b"></a><br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top">BillboardSet *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#3b488dfcca7cd39b0925d8482ff44e8b">findRenderableInParticleSystem</a> (ParticleSystem *system)</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A helper function to find the renderable object attached to a particle system (ONLY BILLBOARDSETS ARE SUPPORTED).  <a href="#3b488dfcca7cd39b0925d8482ff44e8b"></a><br></td></tr>
113<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f886a55245293c8ecc71c87db5c0322c"></a><!-- doxytag: member="OgreIlluminationManager::techniqueFactories" ref="f886a55245293c8ecc71c87db5c0322c" args="" -->
115std::list&lt; <a class="el" href="class_render_technique_factory.html">RenderTechniqueFactory</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#f886a55245293c8ecc71c87db5c0322c">techniqueFactories</a></td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">registered RenderTechniqueFactories <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#e11931c8f8d7ebf19e86d500308b6ccc">maxRad</a></td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum bounding sphere radius that groupped objects ( see <a class="el" href="class_shared_runs.html">SharedRuns</a> class ) can have.  <a href="#e11931c8f8d7ebf19e86d500308b6ccc"></a><br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e5cac53ccca55eb626a6574a81964edb"></a><!-- doxytag: member="OgreIlluminationManager::mainCamera" ref="e5cac53ccca55eb626a6574a81964edb" args="" -->
122Camera *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#e5cac53ccca55eb626a6574a81964edb">mainCamera</a></td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The camera attached to the player. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71f16a054a1d4b4cd9e0fdee0ba8566a"></a><!-- doxytag: member="OgreIlluminationManager::mainViewport" ref="71f16a054a1d4b4cd9e0fdee0ba8566a" args="" -->
126Viewport *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#71f16a054a1d4b4cd9e0fdee0ba8566a">mainViewport</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The viewport of the player camera. <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top">VisibleFinderVisitor *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#dd9a1f5132328932635ef148db7a731d">visitor</a></td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">VisibleFinderVisitor instance.  <a href="#dd9a1f5132328932635ef148db7a731d"></a><br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="116fc59d2fd034daf032981787c6f081"></a><!-- doxytag: member="OgreIlluminationManager::visibleObjects" ref="116fc59d2fd034daf032981787c6f081" args="" -->
133std::vector&lt; const Renderable * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#116fc59d2fd034daf032981787c6f081">visibleObjects</a></td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector containing visible renderables with valid TechniqueGroups that must be refreshed. <br></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top">std::list&lt; <a class="el" href="class_shared_runs.html">SharedRuns</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#0c7aa7be545a60da06255fde01fbd4f4">sharedRunRoots</a></td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List containing <a class="el" href="class_shared_runs.html">SharedRuns</a> roots.  <a href="#0c7aa7be545a60da06255fde01fbd4f4"></a><br></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#075faeb66ecf7f5980955b9eba7a1c45">globalSharedRuns</a></td></tr>
140
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Group of RenderingRuns that are used globaly.  <a href="#075faeb66ecf7f5980955b9eba7a1c45"></a><br></td></tr>
142<tr><td class="memItemLeft" nowrap align="right" valign="top">std::map&lt; String, <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#8206e106d1d305203c7bc4c3103badba">perLightRuns</a></td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stores groups of RenderingRuns that are attached to individual light sources.  <a href="#8206e106d1d305203c7bc4c3103badba"></a><br></td></tr>
145<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17870714a9f3e85eccfd51873a17adac"></a><!-- doxytag: member="OgreIlluminationManager::instance" ref="17870714a9f3e85eccfd51873a17adac" args="" -->
147static <a class="el" href="class_ogre_illumination_manager.html">OgreIlluminationManager</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_illumination_manager.html#17870714a9f3e85eccfd51873a17adac">instance</a> = NULL</td></tr>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The one and only <a class="el" href="class_ogre_illumination_manager.html">OgreIlluminationManager</a> instance. <br></td></tr>
150</table>
151<hr><a name="_details"></a><h2>Detailed Description</h2>
152Implementation of <a class="el" href="class_illumination_manager.html">IlluminationManager</a> in an OGRE environment.
153<p>
154<hr><h2>Member Function Documentation</h2>
155<a class="anchor" name="2f6b3fe9555066e7151b5a70a646a353"></a><!-- doxytag: member="OgreIlluminationManager::addSharedRuns" ref="2f6b3fe9555066e7151b5a70a646a353" args="(SharedRuns *runs)" --><p>
156<table class="mdTable" cellpadding="2" cellspacing="0">
157  <tr>
158    <td class="mdRow">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top">void OgreIlluminationManager::addSharedRuns           </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="md" nowrap valign="top"><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
164          <td class="mdname1" valign="top" nowrap> <em>runs</em>          </td>
165          <td class="md" valign="top">&nbsp;)&nbsp;</td>
166          <td class="md" nowrap></td>
167        </tr>
168      </table>
169    </td>
170  </tr>
171</table>
172<table cellspacing="5" cellpadding="0" border="0">
173  <tr>
174    <td>
175      &nbsp;
176    </td>
177    <td>
178
179<p>
180Register a shared run object.
181<p>
182Only called when new techniques are created.<p>
183<dl compact><dt><b>Parameters:</b></dt><dd>
184  <table border="0" cellspacing="2" cellpadding="0">
185    <tr><td valign="top"></td><td valign="top"><em>runs</em>&nbsp;</td><td>pointer to the <a class="el" href="class_shared_runs.html">SharedRuns</a> instance to add </td></tr>
186  </table>
187</dl>
188    </td>
189  </tr>
190</table>
191<a class="anchor" name="6c52b1a5b3e7b964e39fc39ce835ddd3"></a><!-- doxytag: member="OgreIlluminationManager::createGlobalRun" ref="6c52b1a5b3e7b964e39fc39ce835ddd3" args="(RenderingRunType runType)" --><p>
192<table class="mdTable" cellpadding="2" cellspacing="0">
193  <tr>
194    <td class="mdRow">
195      <table cellpadding="0" cellspacing="0" border="0">
196        <tr>
197          <td class="md" nowrap valign="top">void OgreIlluminationManager::createGlobalRun           </td>
198          <td class="md" valign="top">(&nbsp;</td>
199          <td class="md" nowrap valign="top">RenderingRunType&nbsp;</td>
200          <td class="mdname1" valign="top" nowrap> <em>runType</em>          </td>
201          <td class="md" valign="top">&nbsp;)&nbsp;</td>
202          <td class="md" nowrap></td>
203        </tr>
204      </table>
205    </td>
206  </tr>
207</table>
208<table cellspacing="5" cellpadding="0" border="0">
209  <tr>
210    <td>
211      &nbsp;
212    </td>
213    <td>
214
215<p>
216Creates a global <a class="el" href="class_rendering_run.html">RenderingRun</a> of the given type.
217<p>
218If a <a class="el" href="class_rendering_run.html">RenderingRun</a> with the given type already exist there is nothing to do.<p>
219<dl compact><dt><b>Parameters:</b></dt><dd>
220  <table border="0" cellspacing="2" cellpadding="0">
221    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>type enum of the <a class="el" href="class_rendering_run.html">RenderingRun</a> to create </td></tr>
222  </table>
223</dl>
224    </td>
225  </tr>
226</table>
227<a class="anchor" name="05dba755bb0e40be78e76dc018dc530a"></a><!-- doxytag: member="OgreIlluminationManager::createPerLightRun" ref="05dba755bb0e40be78e76dc018dc530a" args="(String lightName, RenderingRunType runType)" --><p>
228<table class="mdTable" cellpadding="2" cellspacing="0">
229  <tr>
230    <td class="mdRow">
231      <table cellpadding="0" cellspacing="0" border="0">
232        <tr>
233          <td class="md" nowrap valign="top">void OgreIlluminationManager::createPerLightRun           </td>
234          <td class="md" valign="top">(&nbsp;</td>
235          <td class="md" nowrap valign="top">String&nbsp;</td>
236          <td class="mdname" nowrap> <em>lightName</em>, </td>
237        </tr>
238        <tr>
239          <td class="md" nowrap align="right"></td>
240          <td class="md"></td>
241          <td class="md" nowrap>RenderingRunType&nbsp;</td>
242          <td class="mdname" nowrap> <em>runType</em></td>
243        </tr>
244        <tr>
245          <td class="md"></td>
246          <td class="md">)&nbsp;</td>
247          <td class="md" colspan="2"></td>
248        </tr>
249      </table>
250    </td>
251  </tr>
252</table>
253<table cellspacing="5" cellpadding="0" border="0">
254  <tr>
255    <td>
256      &nbsp;
257    </td>
258    <td>
259
260<p>
261Creates a <a class="el" href="class_rendering_run.html">RenderingRun</a> attached to a lightsource with the given type.
262<p>
263<dl compact><dt><b>Parameters:</b></dt><dd>
264  <table border="0" cellspacing="2" cellpadding="0">
265    <tr><td valign="top"></td><td valign="top"><em>lightName</em>&nbsp;</td><td>name of the lightsource </td></tr>
266    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>type enum of the <a class="el" href="class_rendering_run.html">RenderingRun</a> to create </td></tr>
267  </table>
268</dl>
269    </td>
270  </tr>
271</table>
272<a class="anchor" name="a6d26d9fbf945c750d83a13f23aa4a5b"></a><!-- doxytag: member="OgreIlluminationManager::createTechnique" ref="a6d26d9fbf945c750d83a13f23aa4a5b" args="(IllumTechniqueParams *params, Pass *pass, OgreRenderable *rend, OgreSharedRuns *sRuns)" --><p>
273<table class="mdTable" cellpadding="2" cellspacing="0">
274  <tr>
275    <td class="mdRow">
276      <table cellpadding="0" cellspacing="0" border="0">
277        <tr>
278          <td class="md" nowrap valign="top">void OgreIlluminationManager::createTechnique           </td>
279          <td class="md" valign="top">(&nbsp;</td>
280          <td class="md" nowrap valign="top">IllumTechniqueParams *&nbsp;</td>
281          <td class="mdname" nowrap> <em>params</em>, </td>
282        </tr>
283        <tr>
284          <td class="md" nowrap align="right"></td>
285          <td class="md"></td>
286          <td class="md" nowrap>Pass *&nbsp;</td>
287          <td class="mdname" nowrap> <em>pass</em>, </td>
288        </tr>
289        <tr>
290          <td class="md" nowrap align="right"></td>
291          <td class="md"></td>
292          <td class="md" nowrap><a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *&nbsp;</td>
293          <td class="mdname" nowrap> <em>rend</em>, </td>
294        </tr>
295        <tr>
296          <td class="md" nowrap align="right"></td>
297          <td class="md"></td>
298          <td class="md" nowrap><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *&nbsp;</td>
299          <td class="mdname" nowrap> <em>sRuns</em></td>
300        </tr>
301        <tr>
302          <td class="md"></td>
303          <td class="md">)&nbsp;</td>
304          <td class="md" colspan="2"><code> [protected]</code></td>
305        </tr>
306      </table>
307    </td>
308  </tr>
309</table>
310<table cellspacing="5" cellpadding="0" border="0">
311  <tr>
312    <td>
313      &nbsp;
314    </td>
315    <td>
316
317<p>
318creates a specific type of <a class="el" href="class_render_technique.html">RenderTechnique</a> for a Renderable's pass.
319<p>
320It searches all registered RenderTechniqueFactories.     </td>
321  </tr>
322</table>
323<a class="anchor" name="ce07792e6807db6db0c148aae508ef36"></a><!-- doxytag: member="OgreIlluminationManager::fillVisibleList" ref="ce07792e6807db6db0c148aae508ef36" args="(RenderQueue *rq)" --><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 OgreIlluminationManager::fillVisibleList           </td>
330          <td class="md" valign="top">(&nbsp;</td>
331          <td class="md" nowrap valign="top">RenderQueue *&nbsp;</td>
332          <td class="mdname1" valign="top" nowrap> <em>rq</em>          </td>
333          <td class="md" valign="top">&nbsp;)&nbsp;</td>
334          <td class="md" nowrap><code> [protected]</code></td>
335        </tr>
336      </table>
337    </td>
338  </tr>
339</table>
340<table cellspacing="5" cellpadding="0" border="0">
341  <tr>
342    <td>
343      &nbsp;
344    </td>
345    <td>
346
347<p>
348Searches for visible renderables with valid TechniqueGroups in a renderqueue.
349<p>
350<dl compact><dt><b>Parameters:</b></dt><dd>
351  <table border="0" cellspacing="2" cellpadding="0">
352    <tr><td valign="top"></td><td valign="top"><em>rq</em>&nbsp;</td><td>pointer to the RenderQueue instance to search in </td></tr>
353  </table>
354</dl>
355    </td>
356  </tr>
357</table>
358<a class="anchor" name="3b488dfcca7cd39b0925d8482ff44e8b"></a><!-- doxytag: member="OgreIlluminationManager::findRenderableInParticleSystem" ref="3b488dfcca7cd39b0925d8482ff44e8b" args="(ParticleSystem *system)" --><p>
359<table class="mdTable" cellpadding="2" cellspacing="0">
360  <tr>
361    <td class="mdRow">
362      <table cellpadding="0" cellspacing="0" border="0">
363        <tr>
364          <td class="md" nowrap valign="top">BillboardSet * OgreIlluminationManager::findRenderableInParticleSystem           </td>
365          <td class="md" valign="top">(&nbsp;</td>
366          <td class="md" nowrap valign="top">ParticleSystem *&nbsp;</td>
367          <td class="mdname1" valign="top" nowrap> <em>system</em>          </td>
368          <td class="md" valign="top">&nbsp;)&nbsp;</td>
369          <td class="md" nowrap><code> [protected]</code></td>
370        </tr>
371      </table>
372    </td>
373  </tr>
374</table>
375<table cellspacing="5" cellpadding="0" border="0">
376  <tr>
377    <td>
378      &nbsp;
379    </td>
380    <td>
381
382<p>
383A helper function to find the renderable object attached to a particle system (ONLY BILLBOARDSETS ARE SUPPORTED).
384<p>
385<dl compact><dt><b>Parameters:</b></dt><dd>
386  <table border="0" cellspacing="2" cellpadding="0">
387    <tr><td valign="top"></td><td valign="top"><em>system</em>&nbsp;</td><td>pointer to the ParticleSystem instance to search in </td></tr>
388  </table>
389</dl>
390<dl compact><dt><b>Returns:</b></dt><dd>pointer the connected BillboardSet instance </dd></dl>
391    </td>
392  </tr>
393</table>
394<a class="anchor" name="6d4c81a9db2c593271e4a14a529138bc"></a><!-- doxytag: member="OgreIlluminationManager::getGlobalRun" ref="6d4c81a9db2c593271e4a14a529138bc" args="(RenderingRunType runType)" --><p>
395<table class="mdTable" cellpadding="2" cellspacing="0">
396  <tr>
397    <td class="mdRow">
398      <table cellpadding="0" cellspacing="0" border="0">
399        <tr>
400          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> * OgreIlluminationManager::getGlobalRun           </td>
401          <td class="md" valign="top">(&nbsp;</td>
402          <td class="md" nowrap valign="top">RenderingRunType&nbsp;</td>
403          <td class="mdname1" valign="top" nowrap> <em>runType</em>          </td>
404          <td class="md" valign="top">&nbsp;)&nbsp;</td>
405          <td class="md" nowrap></td>
406        </tr>
407      </table>
408    </td>
409  </tr>
410</table>
411<table cellspacing="5" cellpadding="0" border="0">
412  <tr>
413    <td>
414      &nbsp;
415    </td>
416    <td>
417
418<p>
419Returns the global RendderingRun with the given type.
420<p>
421<dl compact><dt><b>Parameters:</b></dt><dd>
422  <table border="0" cellspacing="2" cellpadding="0">
423    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>type enum of the <a class="el" href="class_rendering_run.html">RenderingRun</a> to retrieve</td></tr>
424  </table>
425</dl>
426<dl compact><dt><b>Returns:</b></dt><dd>pointer to the <a class="el" href="class_rendering_run.html">RenderingRun</a>, NULL if no <a class="el" href="class_rendering_run.html">RenderingRun</a> with the given type exists </dd></dl>
427    </td>
428  </tr>
429</table>
430<a class="anchor" name="5f799104fb3dab44a7b441a5a5af006d"></a><!-- doxytag: member="OgreIlluminationManager::getMainCamera" ref="5f799104fb3dab44a7b441a5a5af006d" args="()" --><p>
431<table class="mdTable" cellpadding="2" cellspacing="0">
432  <tr>
433    <td class="mdRow">
434      <table cellpadding="0" cellspacing="0" border="0">
435        <tr>
436          <td class="md" nowrap valign="top">Camera* OgreIlluminationManager::getMainCamera           </td>
437          <td class="md" valign="top">(&nbsp;</td>
438          <td class="mdname1" valign="top" nowrap>          </td>
439          <td class="md" valign="top">&nbsp;)&nbsp;</td>
440          <td class="md" nowrap><code> [inline]</code></td>
441        </tr>
442      </table>
443    </td>
444  </tr>
445</table>
446<table cellspacing="5" cellpadding="0" border="0">
447  <tr>
448    <td>
449      &nbsp;
450    </td>
451    <td>
452
453<p>
454Returns a pointer to the player camera.
455<p>
456<dl compact><dt><b>Returns:</b></dt><dd>pointer to the main player camera. Needed by <a class="el" href="class_render_technique.html">RenderTechnique</a> and <a class="el" href="class_rendering_run.html">RenderingRun</a> classes. </dd></dl>
457    </td>
458  </tr>
459</table>
460<a class="anchor" name="79981028b1686324f8b74ec2df82224d"></a><!-- doxytag: member="OgreIlluminationManager::getMainViewport" ref="79981028b1686324f8b74ec2df82224d" args="()" --><p>
461<table class="mdTable" cellpadding="2" cellspacing="0">
462  <tr>
463    <td class="mdRow">
464      <table cellpadding="0" cellspacing="0" border="0">
465        <tr>
466          <td class="md" nowrap valign="top">Viewport* OgreIlluminationManager::getMainViewport           </td>
467          <td class="md" valign="top">(&nbsp;</td>
468          <td class="mdname1" valign="top" nowrap>          </td>
469          <td class="md" valign="top">&nbsp;)&nbsp;</td>
470          <td class="md" nowrap><code> [inline]</code></td>
471        </tr>
472      </table>
473    </td>
474  </tr>
475</table>
476<table cellspacing="5" cellpadding="0" border="0">
477  <tr>
478    <td>
479      &nbsp;
480    </td>
481    <td>
482
483<p>
484Returns a pointer to the viewport attached to the player camera.
485<p>
486<dl compact><dt><b>Returns:</b></dt><dd>pointer to the viewport. Needed by <a class="el" href="class_render_technique.html">RenderTechnique</a> and <a class="el" href="class_rendering_run.html">RenderingRun</a> classes. </dd></dl>
487    </td>
488  </tr>
489</table>
490<a class="anchor" name="5c420dda0e8b1b469d9dced04814baae"></a><!-- doxytag: member="OgreIlluminationManager::getNearestCausticCasters" ref="5c420dda0e8b1b469d9dced04814baae" args="(Vector3 position, std::vector&lt; OgreSharedRuns * &gt; *nearestcasters, unsigned int maxCount)" --><p>
491<table class="mdTable" cellpadding="2" cellspacing="0">
492  <tr>
493    <td class="mdRow">
494      <table cellpadding="0" cellspacing="0" border="0">
495        <tr>
496          <td class="md" nowrap valign="top">void OgreIlluminationManager::getNearestCausticCasters           </td>
497          <td class="md" valign="top">(&nbsp;</td>
498          <td class="md" nowrap valign="top">Vector3&nbsp;</td>
499          <td class="mdname" nowrap> <em>position</em>, </td>
500        </tr>
501        <tr>
502          <td class="md" nowrap align="right"></td>
503          <td class="md"></td>
504          <td class="md" nowrap>std::vector&lt; <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * &gt; *&nbsp;</td>
505          <td class="mdname" nowrap> <em>nearestcasters</em>, </td>
506        </tr>
507        <tr>
508          <td class="md" nowrap align="right"></td>
509          <td class="md"></td>
510          <td class="md" nowrap>unsigned int&nbsp;</td>
511          <td class="mdname" nowrap> <em>maxCount</em></td>
512        </tr>
513        <tr>
514          <td class="md"></td>
515          <td class="md">)&nbsp;</td>
516          <td class="md" colspan="2"></td>
517        </tr>
518      </table>
519    </td>
520  </tr>
521</table>
522<table cellspacing="5" cellpadding="0" border="0">
523  <tr>
524    <td>
525      &nbsp;
526    </td>
527    <td>
528
529<p>
530Searches for the nearest object groups (<a class="el" href="class_shared_runs.html">SharedRuns</a>) that are caustic casters from a given point.
531<p>
532<dl compact><dt><b>Parameters:</b></dt><dd>
533  <table border="0" cellspacing="2" cellpadding="0">
534    <tr><td valign="top"></td><td valign="top"><em>position</em>&nbsp;</td><td>the point to obtain distances from </td></tr>
535    <tr><td valign="top"></td><td valign="top"><em>nearestcasters</em>&nbsp;</td><td>vector to put the nearest caustic caster <a class="el" href="class_shared_runs.html">SharedRuns</a> to </td></tr>
536    <tr><td valign="top"></td><td valign="top"><em>maxCount</em>&nbsp;</td><td>the maximum number of nearest casters to search for </td></tr>
537  </table>
538</dl>
539    </td>
540  </tr>
541</table>
542<a class="anchor" name="e84160b69a4e7910e9e4d2e7485519b2"></a><!-- doxytag: member="OgreIlluminationManager::getPerLightRun" ref="e84160b69a4e7910e9e4d2e7485519b2" args="(String lightName, RenderingRunType runType)" --><p>
543<table class="mdTable" cellpadding="2" cellspacing="0">
544  <tr>
545    <td class="mdRow">
546      <table cellpadding="0" cellspacing="0" border="0">
547        <tr>
548          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> * OgreIlluminationManager::getPerLightRun           </td>
549          <td class="md" valign="top">(&nbsp;</td>
550          <td class="md" nowrap valign="top">String&nbsp;</td>
551          <td class="mdname" nowrap> <em>lightName</em>, </td>
552        </tr>
553        <tr>
554          <td class="md" nowrap align="right"></td>
555          <td class="md"></td>
556          <td class="md" nowrap>RenderingRunType&nbsp;</td>
557          <td class="mdname" nowrap> <em>runType</em></td>
558        </tr>
559        <tr>
560          <td class="md"></td>
561          <td class="md">)&nbsp;</td>
562          <td class="md" colspan="2"></td>
563        </tr>
564      </table>
565    </td>
566  </tr>
567</table>
568<table cellspacing="5" cellpadding="0" border="0">
569  <tr>
570    <td>
571      &nbsp;
572    </td>
573    <td>
574
575<p>
576Retuns a <a class="el" href="class_rendering_run.html">RenderingRun</a> attached to a lightsource with the given type.
577<p>
578<dl compact><dt><b>Parameters:</b></dt><dd>
579  <table border="0" cellspacing="2" cellpadding="0">
580    <tr><td valign="top"></td><td valign="top"><em>lightName</em>&nbsp;</td><td>name of the lightsource </td></tr>
581    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>type enum of the <a class="el" href="class_rendering_run.html">RenderingRun</a> to return</td></tr>
582  </table>
583</dl>
584<dl compact><dt><b>Returns:</b></dt><dd>pointer to the <a class="el" href="class_rendering_run.html">RenderingRun</a>, NULL if no <a class="el" href="class_rendering_run.html">RenderingRun</a> with the given type exists </dd></dl>
585    </td>
586  </tr>
587</table>
588<a class="anchor" name="61ba920d4b3f5a1dedc072b6042c8ba4"></a><!-- doxytag: member="OgreIlluminationManager::joinSharedRuns" ref="61ba920d4b3f5a1dedc072b6042c8ba4" args="()" --><p>
589<table class="mdTable" cellpadding="2" cellspacing="0">
590  <tr>
591    <td class="mdRow">
592      <table cellpadding="0" cellspacing="0" border="0">
593        <tr>
594          <td class="md" nowrap valign="top">void OgreIlluminationManager::joinSharedRuns           </td>
595          <td class="md" valign="top">(&nbsp;</td>
596          <td class="mdname1" valign="top" nowrap>          </td>
597          <td class="md" valign="top">&nbsp;)&nbsp;</td>
598          <td class="md" nowrap></td>
599        </tr>
600      </table>
601    </td>
602  </tr>
603</table>
604<table cellspacing="5" cellpadding="0" border="0">
605  <tr>
606    <td>
607      &nbsp;
608    </td>
609    <td>
610
611<p>
612Joins shared runs if needed.
613<p>
614Searches the registered shared run roots and join them if necessary (they are close enough).     </td>
615  </tr>
616</table>
617<a class="anchor" name="9920b3a067c88cf20fdbabb8ffe8118d"></a><!-- doxytag: member="OgreIlluminationManager::setMainCamera" ref="9920b3a067c88cf20fdbabb8ffe8118d" args="(Camera *camera)" --><p>
618<table class="mdTable" cellpadding="2" cellspacing="0">
619  <tr>
620    <td class="mdRow">
621      <table cellpadding="0" cellspacing="0" border="0">
622        <tr>
623          <td class="md" nowrap valign="top">void OgreIlluminationManager::setMainCamera           </td>
624          <td class="md" valign="top">(&nbsp;</td>
625          <td class="md" nowrap valign="top">Camera *&nbsp;</td>
626          <td class="mdname1" valign="top" nowrap> <em>camera</em>          </td>
627          <td class="md" valign="top">&nbsp;)&nbsp;</td>
628          <td class="md" nowrap><code> [inline]</code></td>
629        </tr>
630      </table>
631    </td>
632  </tr>
633</table>
634<table cellspacing="5" cellpadding="0" border="0">
635  <tr>
636    <td>
637      &nbsp;
638    </td>
639    <td>
640
641<p>
642Sets the player camera.
643<p>
644<dl compact><dt><b>Parameters:</b></dt><dd>
645  <table border="0" cellspacing="2" cellpadding="0">
646    <tr><td valign="top"></td><td valign="top"><em>camera</em>&nbsp;</td><td>pointer to the main player camera </td></tr>
647  </table>
648</dl>
649    </td>
650  </tr>
651</table>
652<a class="anchor" name="c6ff040c1f55cf496a4feb0196295df6"></a><!-- doxytag: member="OgreIlluminationManager::setMainViewport" ref="c6ff040c1f55cf496a4feb0196295df6" args="(Viewport *viewport)" --><p>
653<table class="mdTable" cellpadding="2" cellspacing="0">
654  <tr>
655    <td class="mdRow">
656      <table cellpadding="0" cellspacing="0" border="0">
657        <tr>
658          <td class="md" nowrap valign="top">void OgreIlluminationManager::setMainViewport           </td>
659          <td class="md" valign="top">(&nbsp;</td>
660          <td class="md" nowrap valign="top">Viewport *&nbsp;</td>
661          <td class="mdname1" valign="top" nowrap> <em>viewport</em>          </td>
662          <td class="md" valign="top">&nbsp;)&nbsp;</td>
663          <td class="md" nowrap><code> [inline]</code></td>
664        </tr>
665      </table>
666    </td>
667  </tr>
668</table>
669<table cellspacing="5" cellpadding="0" border="0">
670  <tr>
671    <td>
672      &nbsp;
673    </td>
674    <td>
675
676<p>
677Sets the viewport attached to the player camera.
678<p>
679<dl compact><dt><b>Parameters:</b></dt><dd>
680  <table border="0" cellspacing="2" cellpadding="0">
681    <tr><td valign="top"></td><td valign="top"><em>viewport</em>&nbsp;</td><td>pointer to the viewport </td></tr>
682  </table>
683</dl>
684    </td>
685  </tr>
686</table>
687<a class="anchor" name="d29c525158107c873024321193f74939"></a><!-- doxytag: member="OgreIlluminationManager::sharedRunJoin" ref="d29c525158107c873024321193f74939" args="(SharedRuns *old1, SharedRuns *old2, SharedRuns *newsr)" --><p>
688<table class="mdTable" cellpadding="2" cellspacing="0">
689  <tr>
690    <td class="mdRow">
691      <table cellpadding="0" cellspacing="0" border="0">
692        <tr>
693          <td class="md" nowrap valign="top">void OgreIlluminationManager::sharedRunJoin           </td>
694          <td class="md" valign="top">(&nbsp;</td>
695          <td class="md" nowrap valign="top"><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
696          <td class="mdname" nowrap> <em>old1</em>, </td>
697        </tr>
698        <tr>
699          <td class="md" nowrap align="right"></td>
700          <td class="md"></td>
701          <td class="md" nowrap><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
702          <td class="mdname" nowrap> <em>old2</em>, </td>
703        </tr>
704        <tr>
705          <td class="md" nowrap align="right"></td>
706          <td class="md"></td>
707          <td class="md" nowrap><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
708          <td class="mdname" nowrap> <em>newsr</em></td>
709        </tr>
710        <tr>
711          <td class="md"></td>
712          <td class="md">)&nbsp;</td>
713          <td class="md" colspan="2"></td>
714        </tr>
715      </table>
716    </td>
717  </tr>
718</table>
719<table cellspacing="5" cellpadding="0" border="0">
720  <tr>
721    <td>
722      &nbsp;
723    </td>
724    <td>
725
726<p>
727The function to be called when two shared runs are joined.
728<p>
729<dl compact><dt><b>Parameters:</b></dt><dd>
730  <table border="0" cellspacing="2" cellpadding="0">
731    <tr><td valign="top"></td><td valign="top"><em>old1</em>&nbsp;</td><td>pointer to one of the <a class="el" href="class_shared_runs.html">SharedRuns</a> instance that are joined </td></tr>
732    <tr><td valign="top"></td><td valign="top"><em>old2</em>&nbsp;</td><td>pointer to the other <a class="el" href="class_shared_runs.html">SharedRuns</a> instance that are joined </td></tr>
733    <tr><td valign="top"></td><td valign="top"><em>newsr</em>&nbsp;</td><td>pointer to the resulting parent <a class="el" href="class_shared_runs.html">SharedRuns</a> instance </td></tr>
734  </table>
735</dl>
736    </td>
737  </tr>
738</table>
739<a class="anchor" name="e29e802f2feceef98fd2ac9286a197e4"></a><!-- doxytag: member="OgreIlluminationManager::sharedRunSplit" ref="e29e802f2feceef98fd2ac9286a197e4" args="(SharedRuns *old, SharedRuns *new1, SharedRuns *new2)" --><p>
740<table class="mdTable" cellpadding="2" cellspacing="0">
741  <tr>
742    <td class="mdRow">
743      <table cellpadding="0" cellspacing="0" border="0">
744        <tr>
745          <td class="md" nowrap valign="top">void OgreIlluminationManager::sharedRunSplit           </td>
746          <td class="md" valign="top">(&nbsp;</td>
747          <td class="md" nowrap valign="top"><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
748          <td class="mdname" nowrap> <em>old</em>, </td>
749        </tr>
750        <tr>
751          <td class="md" nowrap align="right"></td>
752          <td class="md"></td>
753          <td class="md" nowrap><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
754          <td class="mdname" nowrap> <em>new1</em>, </td>
755        </tr>
756        <tr>
757          <td class="md" nowrap align="right"></td>
758          <td class="md"></td>
759          <td class="md" nowrap><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
760          <td class="mdname" nowrap> <em>new2</em></td>
761        </tr>
762        <tr>
763          <td class="md"></td>
764          <td class="md">)&nbsp;</td>
765          <td class="md" colspan="2"></td>
766        </tr>
767      </table>
768    </td>
769  </tr>
770</table>
771<table cellspacing="5" cellpadding="0" border="0">
772  <tr>
773    <td>
774      &nbsp;
775    </td>
776    <td>
777
778<p>
779The function to be called when a shared run is splitted.
780<p>
781<dl compact><dt><b>Parameters:</b></dt><dd>
782  <table border="0" cellspacing="2" cellpadding="0">
783    <tr><td valign="top"></td><td valign="top"><em>old</em>&nbsp;</td><td>pointer to the <a class="el" href="class_shared_runs.html">SharedRuns</a> instance that is split </td></tr>
784    <tr><td valign="top"></td><td valign="top"><em>new1</em>&nbsp;</td><td>pointer to one of the <a class="el" href="class_shared_runs.html">SharedRuns</a> instance that remain after split </td></tr>
785    <tr><td valign="top"></td><td valign="top"><em>new2</em>&nbsp;</td><td>pointer to the other <a class="el" href="class_shared_runs.html">SharedRuns</a> instance that remain after split </td></tr>
786  </table>
787</dl>
788    </td>
789  </tr>
790</table>
791<a class="anchor" name="d4403b0018454ec16528c0c7f9a783c2"></a><!-- doxytag: member="OgreIlluminationManager::update" ref="d4403b0018454ec16528c0c7f9a783c2" args="(unsigned long frameNumber, RenderTarget *rt)" --><p>
792<table class="mdTable" cellpadding="2" cellspacing="0">
793  <tr>
794    <td class="mdRow">
795      <table cellpadding="0" cellspacing="0" border="0">
796        <tr>
797          <td class="md" nowrap valign="top">void OgreIlluminationManager::update           </td>
798          <td class="md" valign="top">(&nbsp;</td>
799          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
800          <td class="mdname" nowrap> <em>frameNumber</em>, </td>
801        </tr>
802        <tr>
803          <td class="md" nowrap align="right"></td>
804          <td class="md"></td>
805          <td class="md" nowrap>RenderTarget *&nbsp;</td>
806          <td class="mdname" nowrap> <em>rt</em></td>
807        </tr>
808        <tr>
809          <td class="md"></td>
810          <td class="md">)&nbsp;</td>
811          <td class="md" colspan="2"></td>
812        </tr>
813      </table>
814    </td>
815  </tr>
816</table>
817<table cellspacing="5" cellpadding="0" border="0">
818  <tr>
819    <td>
820      &nbsp;
821    </td>
822    <td>
823
824<p>
825The function to be called to render one frame.
826<p>
827This is the main refreshing function. It seasrches for visible objects, manages shared runs, updates render techniques and finally renders the scene to framebuffer.<p>
828<dl compact><dt><b>Parameters:</b></dt><dd>
829  <table border="0" cellspacing="2" cellpadding="0">
830    <tr><td valign="top"></td><td valign="top"><em>frameNumber</em>&nbsp;</td><td>current framenumber </td></tr>
831    <tr><td valign="top"></td><td valign="top"><em>rt</em>&nbsp;</td><td>the rendertarget window. Needed to find the viewports that need to be refresh. </td></tr>
832  </table>
833</dl>
834    </td>
835  </tr>
836</table>
837<a class="anchor" name="84eb8f2dbfa089578f78dff97f885c6c"></a><!-- doxytag: member="OgreIlluminationManager::updateGlobalRun" ref="84eb8f2dbfa089578f78dff97f885c6c" args="(RenderingRunType runType, unsigned long frameNum)" --><p>
838<table class="mdTable" cellpadding="2" cellspacing="0">
839  <tr>
840    <td class="mdRow">
841      <table cellpadding="0" cellspacing="0" border="0">
842        <tr>
843          <td class="md" nowrap valign="top">void OgreIlluminationManager::updateGlobalRun           </td>
844          <td class="md" valign="top">(&nbsp;</td>
845          <td class="md" nowrap valign="top">RenderingRunType&nbsp;</td>
846          <td class="mdname" nowrap> <em>runType</em>, </td>
847        </tr>
848        <tr>
849          <td class="md" nowrap align="right"></td>
850          <td class="md"></td>
851          <td class="md" nowrap>unsigned long&nbsp;</td>
852          <td class="mdname" nowrap> <em>frameNum</em></td>
853        </tr>
854        <tr>
855          <td class="md"></td>
856          <td class="md">)&nbsp;</td>
857          <td class="md" colspan="2"></td>
858        </tr>
859      </table>
860    </td>
861  </tr>
862</table>
863<table cellspacing="5" cellpadding="0" border="0">
864  <tr>
865    <td>
866      &nbsp;
867    </td>
868    <td>
869
870<p>
871Updates a global <a class="el" href="class_rendering_run.html">RenderingRun</a> with the given type.
872<p>
873<dl compact><dt><b>Parameters:</b></dt><dd>
874  <table border="0" cellspacing="2" cellpadding="0">
875    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>type enum of the <a class="el" href="class_rendering_run.html">RenderingRun</a> to update </td></tr>
876    <tr><td valign="top"></td><td valign="top"><em>frameNum</em>&nbsp;</td><td>current framenumber </td></tr>
877  </table>
878</dl>
879    </td>
880  </tr>
881</table>
882<a class="anchor" name="9266be7879eabe1fc63fca8c394bbb33"></a><!-- doxytag: member="OgreIlluminationManager::updatePerLightRun" ref="9266be7879eabe1fc63fca8c394bbb33" args="(String lightName, RenderingRunType runType, unsigned long frameNum)" --><p>
883<table class="mdTable" cellpadding="2" cellspacing="0">
884  <tr>
885    <td class="mdRow">
886      <table cellpadding="0" cellspacing="0" border="0">
887        <tr>
888          <td class="md" nowrap valign="top">void OgreIlluminationManager::updatePerLightRun           </td>
889          <td class="md" valign="top">(&nbsp;</td>
890          <td class="md" nowrap valign="top">String&nbsp;</td>
891          <td class="mdname" nowrap> <em>lightName</em>, </td>
892        </tr>
893        <tr>
894          <td class="md" nowrap align="right"></td>
895          <td class="md"></td>
896          <td class="md" nowrap>RenderingRunType&nbsp;</td>
897          <td class="mdname" nowrap> <em>runType</em>, </td>
898        </tr>
899        <tr>
900          <td class="md" nowrap align="right"></td>
901          <td class="md"></td>
902          <td class="md" nowrap>unsigned long&nbsp;</td>
903          <td class="mdname" nowrap> <em>frameNum</em></td>
904        </tr>
905        <tr>
906          <td class="md"></td>
907          <td class="md">)&nbsp;</td>
908          <td class="md" colspan="2"></td>
909        </tr>
910      </table>
911    </td>
912  </tr>
913</table>
914<table cellspacing="5" cellpadding="0" border="0">
915  <tr>
916    <td>
917      &nbsp;
918    </td>
919    <td>
920
921<p>
922Updates a <a class="el" href="class_rendering_run.html">RenderingRun</a> attached to a lightsource with the given type.
923<p>
924<dl compact><dt><b>Parameters:</b></dt><dd>
925  <table border="0" cellspacing="2" cellpadding="0">
926    <tr><td valign="top"></td><td valign="top"><em>lightName</em>&nbsp;</td><td>name of the lightsource </td></tr>
927    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>type enum of the <a class="el" href="class_rendering_run.html">RenderingRun</a> to update </td></tr>
928    <tr><td valign="top"></td><td valign="top"><em>frameNum</em>&nbsp;</td><td>current framenumber </td></tr>
929  </table>
930</dl>
931    </td>
932  </tr>
933</table>
934<hr><h2>Member Data Documentation</h2>
935<a class="anchor" name="075faeb66ecf7f5980955b9eba7a1c45"></a><!-- doxytag: member="OgreIlluminationManager::globalSharedRuns" ref="075faeb66ecf7f5980955b9eba7a1c45" args="" --><p>
936<table class="mdTable" cellpadding="2" cellspacing="0">
937  <tr>
938    <td class="mdRow">
939      <table cellpadding="0" cellspacing="0" border="0">
940        <tr>
941          <td class="md" nowrap valign="top"><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> <a class="el" href="class_ogre_illumination_manager.html#075faeb66ecf7f5980955b9eba7a1c45">OgreIlluminationManager::globalSharedRuns</a><code> [protected]</code>          </td>
942        </tr>
943      </table>
944    </td>
945  </tr>
946</table>
947<table cellspacing="5" cellpadding="0" border="0">
948  <tr>
949    <td>
950      &nbsp;
951    </td>
952    <td>
953
954<p>
955Group of RenderingRuns that are used globaly.
956<p>
957Some RenderingRuns have only one instance per application (for example scene depth map). These resources are shared between all RenderTechniques.     </td>
958  </tr>
959</table>
960<a class="anchor" name="e11931c8f8d7ebf19e86d500308b6ccc"></a><!-- doxytag: member="OgreIlluminationManager::maxRad" ref="e11931c8f8d7ebf19e86d500308b6ccc" args="" --><p>
961<table class="mdTable" cellpadding="2" cellspacing="0">
962  <tr>
963    <td class="mdRow">
964      <table cellpadding="0" cellspacing="0" border="0">
965        <tr>
966          <td class="md" nowrap valign="top">float <a class="el" href="class_ogre_illumination_manager.html#e11931c8f8d7ebf19e86d500308b6ccc">OgreIlluminationManager::maxRad</a><code> [protected]</code>          </td>
967        </tr>
968      </table>
969    </td>
970  </tr>
971</table>
972<table cellspacing="5" cellpadding="0" border="0">
973  <tr>
974    <td>
975      &nbsp;
976    </td>
977    <td>
978
979<p>
980The maximum bounding sphere radius that groupped objects ( see <a class="el" href="class_shared_runs.html">SharedRuns</a> class ) can have.
981<p>
982<dl compact><dt><b>See also:</b></dt><dd>canJoin <p>
983joinRuns </dd></dl>
984    </td>
985  </tr>
986</table>
987<a class="anchor" name="8206e106d1d305203c7bc4c3103badba"></a><!-- doxytag: member="OgreIlluminationManager::perLightRuns" ref="8206e106d1d305203c7bc4c3103badba" args="" --><p>
988<table class="mdTable" cellpadding="2" cellspacing="0">
989  <tr>
990    <td class="mdRow">
991      <table cellpadding="0" cellspacing="0" border="0">
992        <tr>
993          <td class="md" nowrap valign="top">std::map&lt;String, <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a>*&gt; <a class="el" href="class_ogre_illumination_manager.html#8206e106d1d305203c7bc4c3103badba">OgreIlluminationManager::perLightRuns</a><code> [protected]</code>          </td>
994        </tr>
995      </table>
996    </td>
997  </tr>
998</table>
999<table cellspacing="5" cellpadding="0" border="0">
1000  <tr>
1001    <td>
1002      &nbsp;
1003    </td>
1004    <td>
1005
1006<p>
1007Stores groups of RenderingRuns that are attached to individual light sources.
1008<p>
1009These resources need separate instances for each lightsource ( for example depth shadow maps). They are grouped by the name of the lightsource.     </td>
1010  </tr>
1011</table>
1012<a class="anchor" name="0c7aa7be545a60da06255fde01fbd4f4"></a><!-- doxytag: member="OgreIlluminationManager::sharedRunRoots" ref="0c7aa7be545a60da06255fde01fbd4f4" args="" --><p>
1013<table class="mdTable" cellpadding="2" cellspacing="0">
1014  <tr>
1015    <td class="mdRow">
1016      <table cellpadding="0" cellspacing="0" border="0">
1017        <tr>
1018          <td class="md" nowrap valign="top">std::list&lt;<a class="el" href="class_shared_runs.html">SharedRuns</a>*&gt; <a class="el" href="class_ogre_illumination_manager.html#0c7aa7be545a60da06255fde01fbd4f4">OgreIlluminationManager::sharedRunRoots</a><code> [protected]</code>          </td>
1019        </tr>
1020      </table>
1021    </td>
1022  </tr>
1023</table>
1024<table cellspacing="5" cellpadding="0" border="0">
1025  <tr>
1026    <td>
1027      &nbsp;
1028    </td>
1029    <td>
1030
1031<p>
1032List containing <a class="el" href="class_shared_runs.html">SharedRuns</a> roots.
1033<p>
1034It is the IlluminationManager's task to find the <a class="el" href="class_shared_runs.html">SharedRuns</a> which can be joined. Only the root <a class="el" href="class_shared_runs.html">SharedRuns</a> needs to be checked.     </td>
1035  </tr>
1036</table>
1037<a class="anchor" name="dd9a1f5132328932635ef148db7a731d"></a><!-- doxytag: member="OgreIlluminationManager::visitor" ref="dd9a1f5132328932635ef148db7a731d" args="" --><p>
1038<table class="mdTable" cellpadding="2" cellspacing="0">
1039  <tr>
1040    <td class="mdRow">
1041      <table cellpadding="0" cellspacing="0" border="0">
1042        <tr>
1043          <td class="md" nowrap valign="top">class VisibleFinderVisitor* <a class="el" href="class_ogre_illumination_manager.html#dd9a1f5132328932635ef148db7a731d">OgreIlluminationManager::visitor</a><code> [protected]</code>          </td>
1044        </tr>
1045      </table>
1046    </td>
1047  </tr>
1048</table>
1049<table cellspacing="5" cellpadding="0" border="0">
1050  <tr>
1051    <td>
1052      &nbsp;
1053    </td>
1054    <td>
1055
1056<p>
1057VisibleFinderVisitor instance.
1058<p>
1059Used for adding visible renderables with valid TechniqueGroups to the visibleObjects vector.     </td>
1060  </tr>
1061</table>
1062<hr>The documentation for this class was generated from the following files:<ul>
1063<li>OgreIlluminationManager.h<li>OgreIlluminationManager.cpp</ul>
1064<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:40 2006 for GameTools Illumination Module by&nbsp;
1065<a href="http://www.doxygen.org/index.html">
1066<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
1067</body>
1068</html>
Note: See TracBrowser for help on using the repository browser.