1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48    <title>nw::gfx::SceneContext</title>
49  </head>
50  <body>
51    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/gfx/Overview.html">gfx</a>::SceneContext</CODE> Class</h1>
52    <h2>Syntax</h2>
53    <div class="section">
54      <pre class="definition">class SceneContext : public <a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a></pre>
55    </div>
56    <h2>Description</h2>
57    <div class="section">
58      <p>Class for storing content during a scene analysis.</p>
59    </div>
60    <a name="class" id="class">
61      <h2>Classes</h2>
62      <div class="section">
63        <table class="members">
64          <tr>
65            <th>
66              <a href="../../../nw/gfx/SceneContext/Builder/Overview.html"><CODE>nw::gfx::SceneContext::Builder</CODE></a>
67            </th>
68            <td>Class for building scene context classes.</td>
69          </tr> </table>
70      </div>
71    </a> <a name="function" id="function">
72      <h2>Member Functions</h2>
73      <div class="section">
74        <table class="members">
75          <tr>
76            <th class="category" colspan="3">Update</th>
77          </tr>
78          <tr>
79            <td width="100">  </td>
80            <th>
81              <a href="../../../nw/gfx/SceneContext/Clear.html"><CODE>Clear</CODE></a>
82            </th>
83            <td>Clears the scene analysis results.</td>
84          </tr>
85          <tr>
86            <th class="category" colspan="3">Set/Get</th>
87          </tr>
88          <tr>
89            <td width="100">  </td>
90            <th>
91              <a href="../../../nw/gfx/SceneContext/PushSceneNode.html"><CODE>PushSceneNode</CODE></a>
92            </th>
93            <td>Adds a serialized scene node.</td>
94          </tr>
95          <tr>
96            <td width="100">  </td>
97            <th>
98              <a href="../../../nw/gfx/SceneContext/TryPushSceneNode.html">TryPushSceneNode</a>
99            </th>
100            <td>Adds a serialized scene node.</td>
101          </tr>
102          <tr>
103            <td width="100">  </td>
104            <th>
105              <a href="../../../nw/gfx/SceneContext/GetSceneNodesBegin.html"><CODE>GetSceneNodesBegin</CODE></a>
106            </th>
107            <td>Gets the iterator pointing to the start of the serialized scene nodes.</td>
108          </tr>
109          <tr>
110            <td width="100">  </td>
111            <th>
112              <a href="../../../nw/gfx/SceneContext/GetSceneNodesEnd.html"><CODE>GetSceneNodesEnd</CODE></a>
113            </th>
114            <td>Gets the iterator pointing to the end of the serialized scene nodes.</td>
115          </tr>
116          <tr>
117            <td width="100">  </td>
118            <th>
119              <a href="../../../nw/gfx/SceneContext/GetSceneNodes.html"><CODE>GetSceneNodes</CODE></a>
120            </th>
121            <td>Gets the iterators pointing to the start and end of the serialized scene nodes.</td>
122          </tr>
123          <tr>
124            <th class="category" colspan="3">UserRenderNode Related</th>
125          </tr>
126          <tr>
127            <td width="100">  </td>
128            <th>
129              <a href="../../../nw/gfx/SceneContext/PushUserRenderNode.html">PushUserRenderNode</a>
130            </th>
131            <td>Adds a serialized user-defined render node.</td>
132          </tr>
133          <tr>
134            <td width="100">  </td>
135            <th>
136              <a href="../../../nw/gfx/SceneContext/TryPushUserRenderNode.html">TryPushUserRenderNode</a>
137            </th>
138            <td>Adds a serialized user-defined render node.</td>
139          </tr>
140          <tr>
141            <td width="100">  </td>
142            <th>
143              <a href="../../../nw/gfx/SceneContext/GetUserRenderNodesBegin.html">GetUserRenderNodesBegin</a>
144            </th>
145            <td>This iterator points to the first user-defined render node.</td>
146          </tr>
147          <tr>
148            <td width="100">  </td>
149            <th>
150              <a href="../../../nw/gfx/SceneContext/GetUserRenderNodesEnd.html">GetUserRenderNodesEnd</a>
151            </th>
152            <td>This iterator points to the last user-defined render node.</td>
153          </tr>
154          <tr>
155            <td width="100">  </td>
156            <th>
157              <a href="../../../nw/gfx/SceneContext/GetUserRenderNodes.html">GetUserRenderNodes</a>
158            </th>
159            <td>This iterator points to the first and last user-defined render nodes.</td>
160          </tr>
161          <tr>
162            <th class="category" colspan="3">Model-related</th>
163          </tr>
164          <tr>
165            <td width="100">  </td>
166            <th>
167              <a href="../../../nw/gfx/SceneContext/PushModel.html">PushModel</a>
168            </th>
169            <td>Adds a model. Here, the term &quot;model&quot; includes the derived class (i.e., <CODE>SkeletalModel</CODE>, etc.)</td>
170          </tr>
171          <tr>
172            <td width="100">  </td>
173            <th>
174              <a href="../../../nw/gfx/SceneContext/TryPushModel.html">TryPushModel</a>
175            </th>
176            <td>Adds a model. Here, the term &quot;model&quot; includes the derived class (i.e., <CODE>SkeletalModel</CODE>, etc.)</td>
177          </tr>
178          <tr>
179            <td width="100">  </td>
180            <th>
181              <a href="../../../nw/gfx/SceneContext/GetModelsBegin.html">GetModelsBegin</a>
182            </th>
183            <td>Gets the iterator pointing to the start of the model.</td>
184          </tr>
185          <tr>
186            <td width="100">  </td>
187            <th>
188              <a href="../../../nw/gfx/SceneContext/GetModelsEnd.html">GetModelsEnd</a>
189            </th>
190            <td>Gets the iterator pointing to the end of the model.</td>
191          </tr>
192          <tr>
193            <td width="100">  </td>
194            <th>
195              <a href="../../../nw/gfx/SceneContext/PushSkeletalModel.html">PushSkeletalModel</a>
196            </th>
197            <td>Adds a skeletal model.</td>
198          </tr>
199          <tr>
200            <td width="100">  </td>
201            <th>
202              <a href="../../../nw/gfx/SceneContext/TryPushSkeletalModel.html">TryPushSkeletalModel</a>
203            </th>
204            <td>Adds a skeletal model.</td>
205          </tr>
206          <tr>
207            <td width="100">  </td>
208            <th>
209              <a href="../../../nw/gfx/SceneContext/GetSkeletalModelsBegin.html">GetSkeletalModelsBegin</a>
210            </th>
211            <td>Gets the iterator pointing to the start of the skeletal model.</td>
212          </tr>
213          <tr>
214            <td width="100">  </td>
215            <th>
216              <a href="../../../nw/gfx/SceneContext/GetSkeletalModelsEnd.html">GetSkeletalModelsEnd</a>
217            </th>
218            <td>Gets the iterator pointing to the end of the skeletal model.</td>
219          </tr>
220          <tr>
221            <th class="category" colspan="3">Light-Related</th>
222          </tr>
223          <tr>
224            <td width="100">  </td>
225            <th>
226              <a href="../../../nw/gfx/SceneContext/PushLight.html">PushLight</a>
227            </th>
228            <td>Adds a light. Here, the term &quot;light&quot; includes derived classes (i.e., FragmentLight, etc.)</td>
229          </tr>
230          <tr>
231            <td width="100">  </td>
232            <th>
233              <a href="../../../nw/gfx/SceneContext/TryPushLight.html">TryPushLight</a>
234            </th>
235            <td>Adds a light. Here, the term &quot;light&quot; includes derived classes (i.e., FragmentLight, etc.)</td>
236          </tr>
237          <tr>
238            <td width="100">  </td>
239            <th>
240              <a href="../../../nw/gfx/SceneContext/GetLightsBegin.html">GetLightsBegin</a>
241            </th>
242            <td>Gets the iterator pointing to the start of the light.</td>
243          </tr>
244          <tr>
245            <td width="100">  </td>
246            <th>
247              <a href="../../../nw/gfx/SceneContext/GetLightsEnd.html">GetLightsEnd</a>
248            </th>
249            <td>Gets the iterator pointing to the end of the light.</td>
250          </tr>
251          <tr>
252            <td width="100">  </td>
253            <th>
254              <a href="../../../nw/gfx/SceneContext/PushFragmentLight.html"><CODE>PushFragmentLight</CODE></a>
255            </th>
256            <td>Adds a fragment light.</td>
257          </tr>
258          <tr>
259            <td width="100">  </td>
260            <th>
261              <a href="../../../nw/gfx/SceneContext/TryPushFragmentLight.html">TryPushFragmentLight</a>
262            </th>
263            <td>Adds a fragment light.</td>
264          </tr>
265          <tr>
266            <td width="100">  </td>
267            <th>
268              <a href="../../../nw/gfx/SceneContext/GetFragmentLightsBegin.html"><CODE>GetFragmentLightsBegin</CODE></a>
269            </th>
270            <td>Gets the iterator pointing to the start of the fragment light.</td>
271          </tr>
272          <tr>
273            <td width="100">  </td>
274            <th>
275              <a href="../../../nw/gfx/SceneContext/GetFragmentLightsEnd.html"><CODE>GetFragmentLightsEnd</CODE></a>
276            </th>
277            <td>Gets the iterator pointing to the end of the fragment light.</td>
278          </tr>
279          <tr>
280            <td width="100">  </td>
281            <th>
282              <a href="../../../nw/gfx/SceneContext/PushVertexLight.html"><CODE>PushVertexLight</CODE></a>
283            </th>
284            <td>Adds a vertex light.</td>
285          </tr>
286          <tr>
287            <td width="100">  </td>
288            <th>
289              <a href="../../../nw/gfx/SceneContext/TryPushVertexLight.html">TryPushVertexLight</a>
290            </th>
291            <td>Adds a vertex light.</td>
292          </tr>
293          <tr>
294            <td width="100">  </td>
295            <th>
296              <a href="../../../nw/gfx/SceneContext/GetVertexLightsBegin.html"><CODE>GetVertexLightsBegin</CODE></a>
297            </th>
298            <td>Gets the iterator pointing to the start of the vertex light.</td>
299          </tr>
300          <tr>
301            <td width="100">  </td>
302            <th>
303              <a href="../../../nw/gfx/SceneContext/GetVertexLightsEnd.html"><CODE>GetVertexLightsEnd</CODE></a>
304            </th>
305            <td>Gets the iterator pointing to the end of the vertex light.</td>
306          </tr>
307          <tr>
308            <td width="100">  </td>
309            <th>
310              <a href="../../../nw/gfx/SceneContext/PushHemiSphereLight.html"><CODE>PushHemiSphereLight</CODE></a>
311            </th>
312            <td>Adds a hemispherical light.</td>
313          </tr>
314          <tr>
315            <td width="100">  </td>
316            <th>
317              <a href="../../../nw/gfx/SceneContext/TryPushHemiSphereLight.html">TryPushHemiSphereLight</a>
318            </th>
319            <td>Adds a hemispherical light.</td>
320          </tr>
321          <tr>
322            <td width="100">  </td>
323            <th>
324              <a href="../../../nw/gfx/SceneContext/GetHemiSphereLightsBegin.html"><CODE>GetHemiSphereLightsBegin</CODE></a>
325            </th>
326            <td>Gets the iterator pointing to the start of the hemispherical light.</td>
327          </tr>
328          <tr>
329            <td width="100">  </td>
330            <th>
331              <a href="../../../nw/gfx/SceneContext/GetHemiSphereLightsEnd.html"><CODE>GetHemiSphereLightsEnd</CODE></a>
332            </th>
333            <td>Gets the iterator pointing to the end of the hemispherical light.</td>
334          </tr>
335          <tr>
336            <td width="100">  </td>
337            <th>
338              <a href="../../../nw/gfx/SceneContext/PushAmbientLight.html"><CODE>PushAmbientLight</CODE></a>
339            </th>
340            <td>Adds an ambient light.</td>
341          </tr>
342          <tr>
343            <td width="100">  </td>
344            <th>
345              <a href="../../../nw/gfx/SceneContext/TryPushAmbientLight.html">TryPushAmbientLight</a>
346            </th>
347            <td>Adds an ambient light.</td>
348          </tr>
349          <tr>
350            <td width="100">  </td>
351            <th>
352              <a href="../../../nw/gfx/SceneContext/GetAmbientLightsBegin.html"><CODE>GetAmbientLightsBegin</CODE></a>
353            </th>
354            <td>Gets the iterator pointing to the start of the ambient light.</td>
355          </tr>
356          <tr>
357            <td width="100">  </td>
358            <th>
359              <a href="../../../nw/gfx/SceneContext/GetAmbientLightsEnd.html"><CODE>GetAmbientLightsEnd</CODE></a>
360            </th>
361            <td>Gets the iterator pointing to the end of the ambient light.</td>
362          </tr>
363          <tr>
364            <th class="category" colspan="3">Camera-Related</th>
365          </tr>
366          <tr>
367            <td width="100">  </td>
368            <th>
369              <a href="../../../nw/gfx/SceneContext/PushCamera.html"><CODE>PushCamera</CODE></a>
370            </th>
371            <td>Adds a camera.</td>
372          </tr>
373          <tr>
374            <td width="100">  </td>
375            <th>
376              <a href="../../../nw/gfx/SceneContext/TryPushCamera.html">TryPushCamera</a>
377            </th>
378            <td>Adds a camera.</td>
379          </tr>
380          <tr>
381            <td width="100">  </td>
382            <th>
383              <a href="../../../nw/gfx/SceneContext/GetCameraBegin.html"><CODE>GetCameraBegin</CODE></a>
384            </th>
385            <td>Gets the iterator pointing to the start of the camera.</td>
386          </tr>
387          <tr>
388            <td width="100">  </td>
389            <th>
390              <a href="../../../nw/gfx/SceneContext/GetCameraEnd.html"><CODE>GetCameraEnd</CODE></a>
391            </th>
392            <td>Gets the iterator pointing to the end of the camera.</td>
393          </tr>
394          <tr>
395            <th class="category" colspan="3">Fog-Related</th>
396          </tr>
397          <tr>
398            <td width="100">  </td>
399            <th>
400              <a href="../../../nw/gfx/SceneContext/PushFog.html"><CODE>PushFog</CODE></a>
401            </th>
402            <td>Adds a fog object.</td>
403          </tr>
404          <tr>
405            <td width="100">  </td>
406            <th>
407              <a href="../../../nw/gfx/SceneContext/TryPushFog.html">TryPushFog</a>
408            </th>
409            <td>Adds a fog object.</td>
410          </tr>
411          <tr>
412            <td width="100">  </td>
413            <th>
414              <a href="../../../nw/gfx/SceneContext/GetFogBegin.html"><CODE>GetFogBegin</CODE></a>
415            </th>
416            <td>Gets the iterator pointing to the start of the fog.</td>
417          </tr>
418          <tr>
419            <td width="100">  </td>
420            <th>
421              <a href="../../../nw/gfx/SceneContext/GetFogEnd.html"><CODE>GetFogEnd</CODE></a>
422            </th>
423            <td>Gets the iterator pointing to the end of the fog.</td>
424          </tr>
425          <tr>
426            <th class="category" colspan="3">Particle Set-Related</th>
427          </tr>
428          <tr>
429            <td width="100">  </td>
430            <th>
431              <a href="../../../nw/gfx/SceneContext/PushParticleSet.html"><CODE>PushParticleSet</CODE></a>
432            </th>
433            <td>Adds a particle set.</td>
434          </tr>
435          <tr>
436            <td width="100">  </td>
437            <th>
438              <a href="../../../nw/gfx/SceneContext/TryPushParticleSet.html">TryPushParticleSet</a>
439            </th>
440            <td>Adds a particle set.</td>
441          </tr>
442          <tr>
443            <td width="100">  </td>
444            <th>
445              <a href="../../../nw/gfx/SceneContext/GetParticleSetBegin.html"><CODE>GetParticleSetBegin</CODE></a>
446            </th>
447            <td>Gets the iterator pointing to the start of the particle set.</td>
448          </tr>
449          <tr>
450            <td width="100">  </td>
451            <th>
452              <a href="../../../nw/gfx/SceneContext/GetParticleSetEnd.html"><CODE>GetParticleSetEnd</CODE></a>
453            </th>
454            <td>Gets the iterator pointing to the end of the particle set.</td>
455          </tr>
456          <tr>
457            <th class="category" colspan="3">Particle emitter-related</th>
458          </tr>
459          <tr>
460            <td width="100">  </td>
461            <th>
462              <a href="../../../nw/gfx/SceneContext/PushParticleEmitter.html">PushParticleEmitter</a>
463            </th>
464            <td>Adds a particle emitter.</td>
465          </tr>
466          <tr>
467            <td width="100">  </td>
468            <th>
469              <a href="../../../nw/gfx/SceneContext/TryPushParticleEmitter.html">TryPushParticleEmitter</a>
470            </th>
471            <td>Adds a particle emitter.</td>
472          </tr>
473          <tr>
474            <td width="100">  </td>
475            <th>
476              <a href="../../../nw/gfx/SceneContext/GetParticleEmitterBegin.html">GetParticleEmitterBegin</a>
477            </th>
478            <td>Gets the iterator pointing to the start of the particle emitter.</td>
479          </tr>
480          <tr>
481            <td width="100">  </td>
482            <th>
483              <a href="../../../nw/gfx/SceneContext/GetParticleEmitterEnd.html">GetParticleEmitterEnd</a>
484            </th>
485            <td>Gets the iterator pointing to the end of the particle emitter.</td>
486          </tr>
487          <tr>
488            <th class="category" colspan="3">Particle model-related</th>
489          </tr>
490          <tr>
491            <td width="100">  </td>
492            <th>
493              <a href="../../../nw/gfx/SceneContext/PushParticleModel.html">PushParticleModel</a>
494            </th>
495            <td>Adds a particle model.</td>
496          </tr>
497          <tr>
498            <td width="100">  </td>
499            <th>
500              <a href="../../../nw/gfx/SceneContext/TryPushParticleModel.html">TryPushParticleModel</a>
501            </th>
502            <td>Adds a particle model.</td>
503          </tr>
504          <tr>
505            <td width="100">  </td>
506            <th>
507              <a href="../../../nw/gfx/SceneContext/GetParticleModelBegin.html">GetParticleModelBegin</a>
508            </th>
509            <td>Gets the iterator pointing to the start of the particle model.</td>
510          </tr>
511          <tr>
512            <td width="100">  </td>
513            <th>
514              <a href="../../../nw/gfx/SceneContext/GetParticleModelEnd.html">GetParticleModelEnd</a>
515            </th>
516            <td>Gets the iterator pointing to the end of the particle emitter.</td>
517          </tr>
518          <tr>
519            <th class="category" colspan="3">Animation-related</th>
520          </tr>
521          <tr>
522            <td width="100">  </td>
523            <th>
524              <a href="../../../nw/gfx/SceneContext/PushAnimatableNode.html">PushAnimatableNode</a>
525            </th>
526            <td>Adds a node to be animated.</td>
527          </tr>
528          <tr>
529            <td width="100">  </td>
530            <th>
531              <a href="../../../nw/gfx/SceneContext/TryPushAnimatableNode.html">TryPushAnimatableNode</a>
532            </th>
533            <td>Adds a node to be animated.</td>
534          </tr>
535          <tr>
536            <td width="100">  </td>
537            <th>
538              <a href="../../../nw/gfx/SceneContext/GetAnimatableNodesBegin.html">GetAnimatableNodesBegin</a>
539            </th>
540            <td>Gets an iterator pointing to the start of the node to be animated.</td>
541          </tr>
542          <tr>
543            <td width="100">  </td>
544            <th>
545              <a href="../../../nw/gfx/SceneContext/GetAnimatableNodesEnd.html">GetAnimatableNodesEnd</a>
546            </th>
547            <td>Gets an iterator pointing to the end of the node to be animated.</td>
548          </tr>
549          <tr>
550            <th class="category" colspan="3">Create/Destroy</th>
551          </tr>
552          <tr>
553            <td width="100">  </td>
554            <th>
555              <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a>
556            </th>
557            <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.)</td>
558          </tr> </table>
559      </div>
560    </a>
561    <h2>Class Hierarchy</h2>
562    <div class="section">
563      <p class="hierarchy"><a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a><br />  <b>nw::gfx::SceneContext</b>
564      </p>
565    </div>
566  <hr><p>CONFIDENTIAL</p></body>
567</html>
568