aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_light_manager.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_light_manager.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_light_manager.html307
1 files changed, 307 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_light_manager.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_light_manager.html
new file mode 100644
index 0000000..fa62290
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_light_manager.html
@@ -0,0 +1,307 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::scene::ILightManager Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1scene_1_1_i_light_manager.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> </div>
89 <div class="headertitle">
90<div class="title">irr::scene::ILightManager Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::scene::ILightManager" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p><a class="el" href="classirr_1_1scene_1_1_i_light_manager.html" title="ILightManager provides an interface for user applications to manipulate the list of lights in the sce...">ILightManager</a> provides an interface for user applications to manipulate the list of lights in the scene.
95 <a href="classirr_1_1scene_1_1_i_light_manager.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_light_manager_8h_source.html">ILightManager.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::scene::ILightManager:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1scene_1_1_i_light_manager.png" usemap="#irr::scene::ILightManager_map" alt=""/>
105 <map id="irr::scene::ILightManager_map" name="irr::scene::ILightManager_map">
106<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,152,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1scene_1_1_i_light_manager-members.html">List of all members.</a></p>
111<h2><a name="pub-methods"></a>
112Public Member Functions</h2>
113<ul>
114<li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#aa9e6195a3a783a97f440a4b947090ab0">OnNodePostRender</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *node)=0
115<dl class="el"><dd class="mdescRight">Called after the the node specified in <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a23ae7bdf54613e6dd41d4138cb6f5edc" title="Called before the given scene node is rendered.">OnNodePreRender()</a> has been rendered. <a href="#aa9e6195a3a783a97f440a4b947090ab0"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a23ae7bdf54613e6dd41d4138cb6f5edc">OnNodePreRender</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *node)=0
116<dl class="el"><dd class="mdescRight">Called before the given scene node is rendered. <a href="#a23ae7bdf54613e6dd41d4138cb6f5edc"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#ac8f92f0fbd43ba9cb01b47647125a1a3">OnPostRender</a> (void)=0
117<dl class="el"><dd class="mdescRight">Called after the last scene node is rendered. <a href="#ac8f92f0fbd43ba9cb01b47647125a1a3"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a060badf09dc2f8ba8ddb148034c27817">OnPreRender</a> (<a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> * &gt; &amp;lightList)=0
118<dl class="el"><dd class="mdescRight">Called after the scene's light list has been built, but before rendering has begun. <a href="#a060badf09dc2f8ba8ddb148034c27817"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a189edbf3a16ebb3c82e5d9f93dd2b41b">OnRenderPassPostRender</a> (<a class="el" href="namespaceirr_1_1scene.html#a7862269bd1abc123929d4dbb8200d67f">E_SCENE_NODE_RENDER_PASS</a> renderPass)=0
119<dl class="el"><dd class="mdescRight">Called after the render pass specified in <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a56eaec6a697659f40b4f29b681fbdfad" title="Called before a render pass begins.">OnRenderPassPreRender()</a> ends. <a href="#a189edbf3a16ebb3c82e5d9f93dd2b41b"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a56eaec6a697659f40b4f29b681fbdfad">OnRenderPassPreRender</a> (<a class="el" href="namespaceirr_1_1scene.html#a7862269bd1abc123929d4dbb8200d67f">E_SCENE_NODE_RENDER_PASS</a> renderPass)=0
120<dl class="el"><dd class="mdescRight">Called before a render pass begins. <a href="#a56eaec6a697659f40b4f29b681fbdfad"></a><br/></dl></ul>
121<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
122<div class="textblock"><p><a class="el" href="classirr_1_1scene_1_1_i_light_manager.html" title="ILightManager provides an interface for user applications to manipulate the list of lights in the sce...">ILightManager</a> provides an interface for user applications to manipulate the list of lights in the scene. </p>
123<p>The light list can be trimmed or re-ordered before device/ hardware lights are created, and/or individual lights can be switched on and off before or after each scene node is rendered. It is assumed that the <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html" title="ILightManager provides an interface for user applications to manipulate the list of lights in the sce...">ILightManager</a> implementation will store any data that it wishes to retain, i.e. the <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html" title="The Scene Manager manages scene nodes, mesh recources, cameras and all the other stuff.">ISceneManager</a> to which it is assigned, the lightList, the current render pass, and the current scene node. </p>
124
125<p>Definition at line <a class="el" href="_i_light_manager_8h_source.html#l00025">25</a> of file <a class="el" href="_i_light_manager_8h_source.html">ILightManager.h</a>.</p>
126</div><hr/><h2>Member Function Documentation</h2>
127<a class="anchor" id="aa9e6195a3a783a97f440a4b947090ab0"></a><!-- doxytag: member="irr::scene::ILightManager::OnNodePostRender" ref="aa9e6195a3a783a97f440a4b947090ab0" args="(ISceneNode *node)=0" -->
128<div class="memitem">
129<div class="memproto">
130 <table class="memname">
131 <tr>
132 <td class="memname">virtual void irr::scene::ILightManager::OnNodePostRender </td>
133 <td>(</td>
134 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *&#160;</td>
135 <td class="paramname"><em>node</em></td><td>)</td>
136 <td><code> [pure virtual]</code></td>
137 </tr>
138 </table>
139</div>
140<div class="memdoc">
141
142<p>Called after the the node specified in <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a23ae7bdf54613e6dd41d4138cb6f5edc" title="Called before the given scene node is rendered.">OnNodePreRender()</a> has been rendered. </p>
143<dl><dt><b>Parameters:</b></dt><dd>
144 <table class="params">
145 <tr><td class="paramdir">[in]</td><td class="paramname">node,:</td><td>the scene node that has just been rendered </td></tr>
146 </table>
147 </dd>
148</dl>
149
150</div>
151</div>
152<a class="anchor" id="a23ae7bdf54613e6dd41d4138cb6f5edc"></a><!-- doxytag: member="irr::scene::ILightManager::OnNodePreRender" ref="a23ae7bdf54613e6dd41d4138cb6f5edc" args="(ISceneNode *node)=0" -->
153<div class="memitem">
154<div class="memproto">
155 <table class="memname">
156 <tr>
157 <td class="memname">virtual void irr::scene::ILightManager::OnNodePreRender </td>
158 <td>(</td>
159 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *&#160;</td>
160 <td class="paramname"><em>node</em></td><td>)</td>
161 <td><code> [pure virtual]</code></td>
162 </tr>
163 </table>
164</div>
165<div class="memdoc">
166
167<p>Called before the given scene node is rendered. </p>
168<dl><dt><b>Parameters:</b></dt><dd>
169 <table class="params">
170 <tr><td class="paramdir">[in]</td><td class="paramname">node,:</td><td>the scene node that's about to be rendered </td></tr>
171 </table>
172 </dd>
173</dl>
174
175</div>
176</div>
177<a class="anchor" id="ac8f92f0fbd43ba9cb01b47647125a1a3"></a><!-- doxytag: member="irr::scene::ILightManager::OnPostRender" ref="ac8f92f0fbd43ba9cb01b47647125a1a3" args="(void)=0" -->
178<div class="memitem">
179<div class="memproto">
180 <table class="memname">
181 <tr>
182 <td class="memname">virtual void irr::scene::ILightManager::OnPostRender </td>
183 <td>(</td>
184 <td class="paramtype">void&#160;</td>
185 <td class="paramname"></td><td>)</td>
186 <td><code> [pure virtual]</code></td>
187 </tr>
188 </table>
189</div>
190<div class="memdoc">
191
192<p>Called after the last scene node is rendered. </p>
193<p>After this call returns, the lightList passed to <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a060badf09dc2f8ba8ddb148034c27817" title="Called after the scene&#39;s light list has been built, but before rendering has begun.">OnPreRender()</a> becomes invalid. </p>
194
195</div>
196</div>
197<a class="anchor" id="a060badf09dc2f8ba8ddb148034c27817"></a><!-- doxytag: member="irr::scene::ILightManager::OnPreRender" ref="a060badf09dc2f8ba8ddb148034c27817" args="(core::array&lt; ISceneNode * &gt; &amp;lightList)=0" -->
198<div class="memitem">
199<div class="memproto">
200 <table class="memname">
201 <tr>
202 <td class="memname">virtual void irr::scene::ILightManager::OnPreRender </td>
203 <td>(</td>
204 <td class="paramtype"><a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> * &gt; &amp;&#160;</td>
205 <td class="paramname"><em>lightList</em></td><td>)</td>
206 <td><code> [pure virtual]</code></td>
207 </tr>
208 </table>
209</div>
210<div class="memdoc">
211
212<p>Called after the scene's light list has been built, but before rendering has begun. </p>
213<p>As actual device/hardware lights are not created until the ESNRP_LIGHT render pass, this provides an opportunity for the light manager to trim or re-order the light list, before any device/hardware lights have actually been created. </p>
214<dl><dt><b>Parameters:</b></dt><dd>
215 <table class="params">
216 <tr><td class="paramname">lightList,:</td><td>the Scene Manager's light list, which the light manager may modify. This reference will remain valid until <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#ac8f92f0fbd43ba9cb01b47647125a1a3" title="Called after the last scene node is rendered.">OnPostRender()</a>. </td></tr>
217 </table>
218 </dd>
219</dl>
220
221</div>
222</div>
223<a class="anchor" id="a189edbf3a16ebb3c82e5d9f93dd2b41b"></a><!-- doxytag: member="irr::scene::ILightManager::OnRenderPassPostRender" ref="a189edbf3a16ebb3c82e5d9f93dd2b41b" args="(E_SCENE_NODE_RENDER_PASS renderPass)=0" -->
224<div class="memitem">
225<div class="memproto">
226 <table class="memname">
227 <tr>
228 <td class="memname">virtual void irr::scene::ILightManager::OnRenderPassPostRender </td>
229 <td>(</td>
230 <td class="paramtype"><a class="el" href="namespaceirr_1_1scene.html#a7862269bd1abc123929d4dbb8200d67f">E_SCENE_NODE_RENDER_PASS</a>&#160;</td>
231 <td class="paramname"><em>renderPass</em></td><td>)</td>
232 <td><code> [pure virtual]</code></td>
233 </tr>
234 </table>
235</div>
236<div class="memdoc">
237
238<p>Called after the render pass specified in <a class="el" href="classirr_1_1scene_1_1_i_light_manager.html#a56eaec6a697659f40b4f29b681fbdfad" title="Called before a render pass begins.">OnRenderPassPreRender()</a> ends. </p>
239<dl><dt><b>Parameters:</b></dt><dd>
240 <table class="params">
241 <tr><td class="paramdir">[in]</td><td class="paramname">renderPass,:</td><td>the render pass that has finished </td></tr>
242 </table>
243 </dd>
244</dl>
245
246</div>
247</div>
248<a class="anchor" id="a56eaec6a697659f40b4f29b681fbdfad"></a><!-- doxytag: member="irr::scene::ILightManager::OnRenderPassPreRender" ref="a56eaec6a697659f40b4f29b681fbdfad" args="(E_SCENE_NODE_RENDER_PASS renderPass)=0" -->
249<div class="memitem">
250<div class="memproto">
251 <table class="memname">
252 <tr>
253 <td class="memname">virtual void irr::scene::ILightManager::OnRenderPassPreRender </td>
254 <td>(</td>
255 <td class="paramtype"><a class="el" href="namespaceirr_1_1scene.html#a7862269bd1abc123929d4dbb8200d67f">E_SCENE_NODE_RENDER_PASS</a>&#160;</td>
256 <td class="paramname"><em>renderPass</em></td><td>)</td>
257 <td><code> [pure virtual]</code></td>
258 </tr>
259 </table>
260</div>
261<div class="memdoc">
262
263<p>Called before a render pass begins. </p>
264<dl><dt><b>Parameters:</b></dt><dd>
265 <table class="params">
266 <tr><td class="paramname">renderPass,:</td><td>the render pass that's about to begin </td></tr>
267 </table>
268 </dd>
269</dl>
270
271</div>
272</div>
273<hr/>The documentation for this class was generated from the following file:<ul>
274<li><a class="el" href="_i_light_manager_8h_source.html">ILightManager.h</a></li>
275</ul>
276</div>
277</div>
278 <div id="nav-path" class="navpath">
279 <ul>
280 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
281 <li class="navelem"><a class="el" href="namespaceirr_1_1scene.html">scene</a> </li>
282 <li class="navelem"><a class="el" href="classirr_1_1scene_1_1_i_light_manager.html">ILightManager</a> </li>
283<!-- window showing the filter options -->
284<div id="MSearchSelectWindow"
285 onmouseover="return searchBox.OnSearchSelectShow()"
286 onmouseout="return searchBox.OnSearchSelectHide()"
287 onkeydown="return searchBox.OnSearchSelectKey(event)">
288<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
289
290<!-- iframe showing the search results (closed by default) -->
291<div id="MSearchResultsWindow">
292<iframe src="javascript:void(0)" frameborder="0"
293 name="MSearchResults" id="MSearchResults">
294</iframe>
295</div>
296
297
298 <li class="footer">
299<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
300Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:46 for Irrlicht 3D Engine by
301<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
302 </ul>
303 </div>
304
305
306</body>
307</html>
generated by cgit v1.1 at 2024-06-27 09:39:32 +0000