UNPKG

10.3 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>Global - Documentation</title>
6
7 <script src="scripts/prettify/prettify.js"></script>
8 <script src="scripts/prettify/lang-css.js"></script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
13 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
14 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
15</head>
16<body>
17
18<input type="checkbox" id="nav-trigger" class="nav-trigger" />
19<label for="nav-trigger" class="navicon-button x">
20 <div class="navicon"></div>
21</label>
22
23<label for="nav-trigger" class="overlay"></label>
24
25<nav>
26 <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EdgesHelper.html">EdgesHelper</a><ul class='methods'><li data-type='method'><a href="EdgesHelper.html#.AddEdges">AddEdges</a></li></ul></li><li><a href="FluxCameras.html">FluxCameras</a><ul class='methods'><li data-type='method'><a href="FluxCameras.html#.cameraFromJSON">cameraFromJSON</a></li><li data-type='method'><a href="FluxCameras.html#.cameraToJSON">cameraToJSON</a></li><li data-type='method'><a href="FluxCameras.html#fromJSON">fromJSON</a></li><li data-type='method'><a href="FluxCameras.html#getCamera">getCamera</a></li><li data-type='method'><a href="FluxCameras.html#setView">setView</a></li><li data-type='method'><a href="FluxCameras.html#toJSON">toJSON</a></li><li data-type='method'><a href="FluxCameras.html#updateCamera">updateCamera</a></li></ul></li><li><a href="FluxRenderContext.html">FluxRenderContext</a><ul class='methods'><li data-type='method'><a href="FluxRenderContext.html#.getNextContext">getNextContext</a></li></ul></li><li><a href="FluxRenderer.html">FluxRenderer</a><ul class='methods'><li data-type='method'><a href="FluxRenderer.html#addControls">addControls</a></li><li data-type='method'><a href="FluxRenderer.html#anyValidPrims">anyValidPrims</a></li><li data-type='method'><a href="FluxRenderer.html#detach">detach</a></li><li data-type='method'><a href="FluxRenderer.html#doRender">doRender</a></li><li data-type='method'><a href="FluxRenderer.html#focus">focus</a></li><li data-type='method'><a href="FluxRenderer.html#fromJSON">fromJSON</a></li><li data-type='method'><a href="FluxRenderer.html#getGlCanvas">getGlCanvas</a></li><li data-type='method'><a href="FluxRenderer.html#getSelection">getSelection</a></li><li data-type='method'><a href="FluxRenderer.html#homeCamera">homeCamera</a></li><li data-type='method'><a href="FluxRenderer.html#setClearColor">setClearColor</a></li><li data-type='method'><a href="FluxRenderer.html#setEdgesMode">setEdgesMode</a></li><li data-type='method'><a href="FluxRenderer.html#setHelpersVisible">setHelpersVisible</a></li><li data-type='method'><a href="FluxRenderer.html#setLights">setLights</a></li><li data-type='method'><a href="FluxRenderer.html#setModel">setModel</a></li><li data-type='method'><a href="FluxRenderer.html#setSelection">setSelection</a></li><li data-type='method'><a href="FluxRenderer.html#setSelectionMaterial">setSelectionMaterial</a></li><li data-type='method'><a href="FluxRenderer.html#setSize">setSize</a></li><li data-type='method'><a href="FluxRenderer.html#setView">setView</a></li><li data-type='method'><a href="FluxRenderer.html#toJSON">toJSON</a></li></ul></li><li><a href="FluxViewport.html">FluxViewport</a><ul class='methods'><li data-type='method'><a href="FluxViewport.html#.getChangeEvent">getChangeEvent</a></li><li data-type='method'><a href="FluxViewport.html#.getEdgesModes">getEdgesModes</a></li><li data-type='method'><a href="FluxViewport.html#.getEvents">getEvents</a></li><li data-type='method'><a href="FluxViewport.html#.getSelectionModes">getSelectionModes</a></li><li data-type='method'><a href="FluxViewport.html#.getViews">getViews</a></li><li data-type='method'><a href="FluxViewport.html#.isKnownGeom">isKnownGeom</a></li><li data-type='method'><a href="FluxViewport.html#activateShadows">activateShadows</a></li><li data-type='method'><a href="FluxViewport.html#addControls">addControls</a></li><li data-type='method'><a href="FluxViewport.html#downloadState">downloadState</a></li><li data-type='method'><a href="FluxViewport.html#focus">focus</a></li><li data-type='method'><a href="FluxViewport.html#fromJSON">fromJSON</a></li><li data-type='method'><a href="FluxViewport.html#getAutoFocus">getAutoFocus</a></li><li data-type='method'><a href="FluxViewport.html#getGlCanvas">getGlCanvas</a></li><li data-type='method'><a href="FluxViewport.html#getJson">getJson</a></li><li data-type='method'><a href="FluxViewport.html#getObjectMap">getObjectMap</a></li><li data-type='method'><a href="FluxViewport.html#getSelection">getSelection</a></li><li data-type='method'><a href="FluxViewport.html#homeCamera">homeCamera</a></li><li data-type='method'><a href="FluxViewport.html#render">render</a></li><li data-type='method'><a href="FluxViewport.html#setAutoFocus">setAutoFocus</a></li><li data-type='method'><a href="FluxViewport.html#setClearColor">setClearColor</a></li><li data-type='method'><a href="FluxViewport.html#setEdgesMode">setEdgesMode</a></li><li data-type='method'><a href="FluxViewport.html#setFogDensity">setFogDensity</a></li><li data-type='method'><a href="FluxViewport.html#setGeometryEntity">setGeometryEntity</a></li><li data-type='method'><a href="FluxViewport.html#setGeometryJson">setGeometryJson</a></li><li data-type='method'><a href="FluxViewport.html#setHelpersVisible">setHelpersVisible</a></li><li data-type='method'><a href="FluxViewport.html#setSelection">setSelection</a></li><li data-type='method'><a href="FluxViewport.html#setSelectionMaterial">setSelectionMaterial</a></li><li data-type='method'><a href="FluxViewport.html#setSize">setSize</a></li><li data-type='method'><a href="FluxViewport.html#setTessUrl">setTessUrl</a></li><li data-type='method'><a href="FluxViewport.html#setupDefaultLighting">setupDefaultLighting</a></li><li data-type='method'><a href="FluxViewport.html#setView">setView</a></li><li data-type='method'><a href="FluxViewport.html#toJSON">toJSON</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#_deleteFromScene">_deleteFromScene</a></li><li><a href="global.html#_removeGeometries">_removeGeometries</a></li></ul>
27</nav>
28
29<div id="main">
30
31 <h1 class="page-title">Global</h1>
32
33
34
35
36
37
38
39<section>
40
41<header>
42
43 <h2>
44
45 </h2>
46
47
48</header>
49
50<article>
51 <div class="container-overview">
52
53
54
55
56
57
58<dl class="details">
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91</dl>
92
93
94
95
96 </div>
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111 <h3 class="subsection-title">Methods</h3>
112
113
114
115
116
117
118 <h4 class="name" id="_deleteFromScene"><span class="type-signature"></span>_deleteFromScene<span class="signature">(scene, model)</span><span class="type-signature"></span></h4>
119
120
121
122
123
124<div class="description">
125 Remove an object from the scene and clean up memory
126</div>
127
128
129
130
131
132
133
134
135
136 <h5>Parameters:</h5>
137
138
139<table class="params">
140 <thead>
141 <tr>
142
143 <th>Name</th>
144
145
146 <th>Type</th>
147
148
149
150
151
152 <th class="last">Description</th>
153 </tr>
154 </thead>
155
156 <tbody>
157
158
159 <tr>
160
161 <td class="name"><code>scene</code></td>
162
163
164 <td class="type">
165
166
167<span class="param-type">THREE.Scene</span>
168
169
170
171 </td>
172
173
174
175
176
177 <td class="description last">Scene containing the model</td>
178 </tr>
179
180
181
182 <tr>
183
184 <td class="name"><code>model</code></td>
185
186
187 <td class="type">
188
189
190<span class="param-type">THREE.Object3D</span>
191
192
193
194 </td>
195
196
197
198
199
200 <td class="description last">The geometry to remove</td>
201 </tr>
202
203
204 </tbody>
205</table>
206
207
208
209
210
211
212<dl class="details">
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239 <dt class="tag-source">Source:</dt>
240 <dd class="tag-source"><ul class="dummy"><li>
241 <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line105">line 105</a>
242 </li></ul></dd>
243
244
245
246
247
248
249
250</dl>
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272 <h4 class="name" id="_removeGeometries"><span class="type-signature"></span>_removeGeometries<span class="signature">(obj)</span><span class="type-signature"></span></h4>
273
274
275
276
277
278<div class="description">
279 Remove the geometry objects from the THREE registry so they can be garbage collected
280</div>
281
282
283
284
285
286
287
288
289
290 <h5>Parameters:</h5>
291
292
293<table class="params">
294 <thead>
295 <tr>
296
297 <th>Name</th>
298
299
300 <th>Type</th>
301
302
303
304
305
306 <th class="last">Description</th>
307 </tr>
308 </thead>
309
310 <tbody>
311
312
313 <tr>
314
315 <td class="name"><code>obj</code></td>
316
317
318 <td class="type">
319
320
321<span class="param-type">THREE.Object3D</span>
322
323
324
325 </td>
326
327
328
329
330
331 <td class="description last">The object being removed</td>
332 </tr>
333
334
335 </tbody>
336</table>
337
338
339
340
341
342
343<dl class="details">
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370 <dt class="tag-source">Source:</dt>
371 <dd class="tag-source"><ul class="dummy"><li>
372 <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line94">line 94</a>
373 </li></ul></dd>
374
375
376
377
378
379
380
381</dl>
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404</article>
405
406</section>
407
408
409
410
411</div>
412
413<br class="clear">
414
415<footer>
416 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 05 2017 16:26:56 GMT-0800 (PST) using the Minami theme.
417</footer>
418
419<script>prettyPrint();</script>
420<script src="scripts/linenumber.js"></script>
421</body>
422</html>
\No newline at end of file