1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <title>FluxRenderer - Documentation</title>
|
6 |
|
7 | <script src="scripts/prettify/prettify.js"></script>
|
8 | <script src="scripts/prettify/lang-css.js"></script>
|
9 | |
10 |
|
11 |
|
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">FluxRenderer</h1>
|
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 |
|
38 |
|
39 | <section>
|
40 |
|
41 | <header>
|
42 |
|
43 | <h2>
|
44 | FluxRenderer
|
45 | </h2>
|
46 |
|
47 |
|
48 | </header>
|
49 |
|
50 | <article>
|
51 | <div class="container-overview">
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 | <h4 class="name" id="FluxRenderer"><span class="type-signature"></span>new FluxRenderer<span class="signature">(domParent, width, height, selection)</span><span class="type-signature"></span></h4>
|
58 |
|
59 |
|
60 |
|
61 |
|
62 |
|
63 | <div class="description">
|
64 | Class wrapping the three.js renderer with more build in functionality.
|
65 | Context swapping lets a single OpenGL context and canvas be used for multiple renderers.
|
66 | </div>
|
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 |
|
74 |
|
75 |
|
76 | <h5>Parameters:</h5>
|
77 |
|
78 |
|
79 | <table class="params">
|
80 | <thead>
|
81 | <tr>
|
82 |
|
83 | <th>Name</th>
|
84 |
|
85 |
|
86 | <th>Type</th>
|
87 |
|
88 |
|
89 |
|
90 |
|
91 |
|
92 | <th class="last">Description</th>
|
93 | </tr>
|
94 | </thead>
|
95 |
|
96 | <tbody>
|
97 |
|
98 |
|
99 | <tr>
|
100 |
|
101 | <td class="name"><code>domParent</code></td>
|
102 |
|
103 |
|
104 | <td class="type">
|
105 |
|
106 |
|
107 | <span class="param-type">Element</span>
|
108 |
|
109 |
|
110 |
|
111 | </td>
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 | <td class="description last">The div container for the canvas</td>
|
118 | </tr>
|
119 |
|
120 |
|
121 |
|
122 | <tr>
|
123 |
|
124 | <td class="name"><code>width</code></td>
|
125 |
|
126 |
|
127 | <td class="type">
|
128 |
|
129 |
|
130 | <span class="param-type">Number</span>
|
131 |
|
132 |
|
133 |
|
134 | </td>
|
135 |
|
136 |
|
137 |
|
138 |
|
139 |
|
140 | <td class="description last">The width of the canvas</td>
|
141 | </tr>
|
142 |
|
143 |
|
144 |
|
145 | <tr>
|
146 |
|
147 | <td class="name"><code>height</code></td>
|
148 |
|
149 |
|
150 | <td class="type">
|
151 |
|
152 |
|
153 | <span class="param-type">Number</span>
|
154 |
|
155 |
|
156 |
|
157 | </td>
|
158 |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 | <td class="description last">The height of the canvas</td>
|
164 | </tr>
|
165 |
|
166 |
|
167 |
|
168 | <tr>
|
169 |
|
170 | <td class="name"><code>selection</code></td>
|
171 |
|
172 |
|
173 | <td class="type">
|
174 |
|
175 |
|
176 | <span class="param-type">Enumeration</span>
|
177 |
|
178 |
|
179 |
|
180 | </td>
|
181 |
|
182 |
|
183 |
|
184 |
|
185 |
|
186 | <td class="description last">Whether to enable user selection</td>
|
187 | </tr>
|
188 |
|
189 |
|
190 | </tbody>
|
191 | </table>
|
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 | <dl class="details">
|
199 |
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 | <dt class="tag-source">Source:</dt>
|
226 | <dd class="tag-source"><ul class="dummy"><li>
|
227 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line12">line 12</a>
|
228 | </li></ul></dd>
|
229 |
|
230 |
|
231 |
|
232 |
|
233 |
|
234 |
|
235 |
|
236 | </dl>
|
237 |
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 |
|
254 | </div>
|
255 |
|
256 |
|
257 |
|
258 |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 | <h3 class="subsection-title">Methods</h3>
|
270 |
|
271 |
|
272 |
|
273 |
|
274 |
|
275 |
|
276 | <h4 class="name" id="addControls"><span class="type-signature"></span>addControls<span class="signature">(CustomControls)</span><span class="type-signature"> → {CustomControls}</span></h4>
|
277 |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 | <div class="description">
|
283 | Add a new plugin for user interaction controls.
|
284 | See ViewportControls.js for more information.
|
285 | </div>
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 | <h5>Parameters:</h5>
|
296 |
|
297 |
|
298 | <table class="params">
|
299 | <thead>
|
300 | <tr>
|
301 |
|
302 | <th>Name</th>
|
303 |
|
304 |
|
305 | <th>Type</th>
|
306 |
|
307 |
|
308 |
|
309 |
|
310 |
|
311 | <th class="last">Description</th>
|
312 | </tr>
|
313 | </thead>
|
314 |
|
315 | <tbody>
|
316 |
|
317 |
|
318 | <tr>
|
319 |
|
320 | <td class="name"><code>CustomControls</code></td>
|
321 |
|
322 |
|
323 | <td class="type">
|
324 |
|
325 |
|
326 | <span class="param-type">ViewportControls</span>
|
327 |
|
328 |
|
329 |
|
330 | </td>
|
331 |
|
332 |
|
333 |
|
334 |
|
335 |
|
336 | <td class="description last">A constructor that implements the controls interface.</td>
|
337 | </tr>
|
338 |
|
339 |
|
340 | </tbody>
|
341 | </table>
|
342 |
|
343 |
|
344 |
|
345 |
|
346 |
|
347 |
|
348 | <dl class="details">
|
349 |
|
350 |
|
351 |
|
352 |
|
353 |
|
354 |
|
355 |
|
356 |
|
357 |
|
358 |
|
359 |
|
360 |
|
361 |
|
362 |
|
363 |
|
364 |
|
365 |
|
366 |
|
367 |
|
368 |
|
369 |
|
370 |
|
371 |
|
372 |
|
373 |
|
374 |
|
375 | <dt class="tag-source">Source:</dt>
|
376 | <dd class="tag-source"><ul class="dummy"><li>
|
377 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line117">line 117</a>
|
378 | </li></ul></dd>
|
379 |
|
380 |
|
381 |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 | </dl>
|
387 |
|
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 | <h5>Returns:</h5>
|
401 |
|
402 |
|
403 | <div class="param-desc">
|
404 | The new instance
|
405 | </div>
|
406 |
|
407 |
|
408 |
|
409 | <dl class="param-type">
|
410 | <dt>
|
411 | Type
|
412 | </dt>
|
413 | <dd>
|
414 |
|
415 | <span class="param-type">CustomControls</span>
|
416 |
|
417 |
|
418 | </dd>
|
419 | </dl>
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 |
|
430 | <h4 class="name" id="anyValidPrims"><span class="type-signature"></span>anyValidPrims<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
|
431 |
|
432 |
|
433 |
|
434 |
|
435 |
|
436 | <div class="description">
|
437 | Say whether there are any objects to render in the model
|
438 | </div>
|
439 |
|
440 |
|
441 |
|
442 |
|
443 |
|
444 |
|
445 |
|
446 |
|
447 |
|
448 |
|
449 |
|
450 |
|
451 |
|
452 | <dl class="details">
|
453 |
|
454 |
|
455 |
|
456 |
|
457 |
|
458 |
|
459 |
|
460 |
|
461 |
|
462 |
|
463 |
|
464 |
|
465 |
|
466 |
|
467 |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 |
|
473 |
|
474 |
|
475 |
|
476 |
|
477 |
|
478 |
|
479 | <dt class="tag-source">Source:</dt>
|
480 | <dd class="tag-source"><ul class="dummy"><li>
|
481 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line305">line 305</a>
|
482 | </li></ul></dd>
|
483 |
|
484 |
|
485 |
|
486 |
|
487 |
|
488 |
|
489 |
|
490 | </dl>
|
491 |
|
492 |
|
493 |
|
494 |
|
495 |
|
496 |
|
497 |
|
498 |
|
499 |
|
500 |
|
501 |
|
502 |
|
503 |
|
504 | <h5>Returns:</h5>
|
505 |
|
506 |
|
507 | <div class="param-desc">
|
508 | True if there are objects to render
|
509 | </div>
|
510 |
|
511 |
|
512 |
|
513 | <dl class="param-type">
|
514 | <dt>
|
515 | Type
|
516 | </dt>
|
517 | <dd>
|
518 |
|
519 | <span class="param-type">Boolean</span>
|
520 |
|
521 |
|
522 | </dd>
|
523 | </dl>
|
524 |
|
525 |
|
526 |
|
527 |
|
528 |
|
529 |
|
530 |
|
531 |
|
532 |
|
533 |
|
534 | <h4 class="name" id="detach"><span class="type-signature"></span>detach<span class="signature">()</span><span class="type-signature"></span></h4>
|
535 |
|
536 |
|
537 |
|
538 |
|
539 |
|
540 | <div class="description">
|
541 | Destructor to prevent future rendering after being unloaded
|
542 | </div>
|
543 |
|
544 |
|
545 |
|
546 |
|
547 |
|
548 |
|
549 |
|
550 |
|
551 |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 | <dl class="details">
|
557 |
|
558 |
|
559 |
|
560 |
|
561 |
|
562 |
|
563 |
|
564 |
|
565 |
|
566 |
|
567 |
|
568 |
|
569 |
|
570 |
|
571 |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 |
|
577 |
|
578 |
|
579 |
|
580 |
|
581 |
|
582 |
|
583 | <dt class="tag-source">Source:</dt>
|
584 | <dd class="tag-source"><ul class="dummy"><li>
|
585 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line249">line 249</a>
|
586 | </li></ul></dd>
|
587 |
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 | </dl>
|
595 |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 |
|
601 |
|
602 |
|
603 |
|
604 |
|
605 |
|
606 |
|
607 |
|
608 |
|
609 |
|
610 |
|
611 |
|
612 |
|
613 |
|
614 |
|
615 |
|
616 | <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span class="signature">()</span><span class="type-signature"></span></h4>
|
617 |
|
618 |
|
619 |
|
620 |
|
621 |
|
622 | <div class="description">
|
623 | Render the scene with its geometry.
|
624 | </div>
|
625 |
|
626 |
|
627 |
|
628 |
|
629 |
|
630 |
|
631 |
|
632 |
|
633 |
|
634 |
|
635 |
|
636 |
|
637 |
|
638 | <dl class="details">
|
639 |
|
640 |
|
641 |
|
642 |
|
643 |
|
644 |
|
645 |
|
646 |
|
647 |
|
648 |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 |
|
654 |
|
655 |
|
656 |
|
657 |
|
658 |
|
659 |
|
660 |
|
661 |
|
662 |
|
663 |
|
664 |
|
665 | <dt class="tag-source">Source:</dt>
|
666 | <dd class="tag-source"><ul class="dummy"><li>
|
667 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line292">line 292</a>
|
668 | </li></ul></dd>
|
669 |
|
670 |
|
671 |
|
672 |
|
673 |
|
674 |
|
675 |
|
676 | </dl>
|
677 |
|
678 |
|
679 |
|
680 |
|
681 |
|
682 |
|
683 |
|
684 |
|
685 |
|
686 |
|
687 |
|
688 |
|
689 |
|
690 |
|
691 |
|
692 |
|
693 |
|
694 |
|
695 |
|
696 |
|
697 |
|
698 | <h4 class="name" id="focus"><span class="type-signature"></span>focus<span class="signature">(obj<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
699 |
|
700 |
|
701 |
|
702 |
|
703 |
|
704 | <div class="description">
|
705 | Focus the controls' current camera on an object.
|
706 | This function will focus on the union of object and all of it's visible children.
|
707 | </div>
|
708 |
|
709 |
|
710 |
|
711 |
|
712 |
|
713 |
|
714 |
|
715 |
|
716 |
|
717 | <h5>Parameters:</h5>
|
718 |
|
719 |
|
720 | <table class="params">
|
721 | <thead>
|
722 | <tr>
|
723 |
|
724 | <th>Name</th>
|
725 |
|
726 |
|
727 | <th>Type</th>
|
728 |
|
729 |
|
730 | <th>Attributes</th>
|
731 |
|
732 |
|
733 |
|
734 |
|
735 | <th class="last">Description</th>
|
736 | </tr>
|
737 | </thead>
|
738 |
|
739 | <tbody>
|
740 |
|
741 |
|
742 | <tr>
|
743 |
|
744 | <td class="name"><code>obj</code></td>
|
745 |
|
746 |
|
747 | <td class="type">
|
748 |
|
749 |
|
750 | <span class="param-type">THREE.Object3D</span>
|
751 |
|
752 |
|
753 |
|
754 | </td>
|
755 |
|
756 |
|
757 | <td class="attributes">
|
758 |
|
759 | <optional><br>
|
760 |
|
761 |
|
762 |
|
763 |
|
764 |
|
765 | </td>
|
766 |
|
767 |
|
768 |
|
769 |
|
770 | <td class="description last">The scene object to focus on.</td>
|
771 | </tr>
|
772 |
|
773 |
|
774 | </tbody>
|
775 | </table>
|
776 |
|
777 |
|
778 |
|
779 |
|
780 |
|
781 |
|
782 | <dl class="details">
|
783 |
|
784 |
|
785 |
|
786 |
|
787 |
|
788 |
|
789 |
|
790 |
|
791 |
|
792 |
|
793 |
|
794 |
|
795 |
|
796 |
|
797 |
|
798 |
|
799 |
|
800 |
|
801 |
|
802 |
|
803 |
|
804 |
|
805 |
|
806 |
|
807 |
|
808 |
|
809 | <dt class="tag-source">Source:</dt>
|
810 | <dd class="tag-source"><ul class="dummy"><li>
|
811 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line190">line 190</a>
|
812 | </li></ul></dd>
|
813 |
|
814 |
|
815 |
|
816 |
|
817 |
|
818 |
|
819 |
|
820 | </dl>
|
821 |
|
822 |
|
823 |
|
824 |
|
825 |
|
826 |
|
827 |
|
828 |
|
829 |
|
830 |
|
831 |
|
832 |
|
833 |
|
834 |
|
835 |
|
836 |
|
837 |
|
838 |
|
839 |
|
840 |
|
841 |
|
842 | <h4 class="name" id="fromJSON"><span class="type-signature"></span>fromJSON<span class="signature">(state)</span><span class="type-signature"></span></h4>
|
843 |
|
844 |
|
845 |
|
846 |
|
847 |
|
848 | <div class="description">
|
849 | Take a data object and use it to update the internal state
|
850 | </div>
|
851 |
|
852 |
|
853 |
|
854 |
|
855 |
|
856 |
|
857 |
|
858 |
|
859 |
|
860 | <h5>Parameters:</h5>
|
861 |
|
862 |
|
863 | <table class="params">
|
864 | <thead>
|
865 | <tr>
|
866 |
|
867 | <th>Name</th>
|
868 |
|
869 |
|
870 | <th>Type</th>
|
871 |
|
872 |
|
873 |
|
874 |
|
875 |
|
876 | <th class="last">Description</th>
|
877 | </tr>
|
878 | </thead>
|
879 |
|
880 | <tbody>
|
881 |
|
882 |
|
883 | <tr>
|
884 |
|
885 | <td class="name"><code>state</code></td>
|
886 |
|
887 |
|
888 | <td class="type">
|
889 |
|
890 |
|
891 | <span class="param-type">Object</span>
|
892 |
|
893 |
|
894 |
|
895 | </td>
|
896 |
|
897 |
|
898 |
|
899 |
|
900 |
|
901 | <td class="description last">The properties to set</td>
|
902 | </tr>
|
903 |
|
904 |
|
905 | </tbody>
|
906 | </table>
|
907 |
|
908 |
|
909 |
|
910 |
|
911 |
|
912 |
|
913 | <dl class="details">
|
914 |
|
915 |
|
916 |
|
917 |
|
918 |
|
919 |
|
920 |
|
921 |
|
922 |
|
923 |
|
924 |
|
925 |
|
926 |
|
927 |
|
928 |
|
929 |
|
930 |
|
931 |
|
932 |
|
933 |
|
934 |
|
935 |
|
936 |
|
937 |
|
938 |
|
939 |
|
940 | <dt class="tag-source">Source:</dt>
|
941 | <dd class="tag-source"><ul class="dummy"><li>
|
942 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line395">line 395</a>
|
943 | </li></ul></dd>
|
944 |
|
945 |
|
946 |
|
947 |
|
948 |
|
949 |
|
950 |
|
951 | </dl>
|
952 |
|
953 |
|
954 |
|
955 |
|
956 |
|
957 |
|
958 |
|
959 |
|
960 |
|
961 |
|
962 |
|
963 |
|
964 |
|
965 |
|
966 |
|
967 |
|
968 |
|
969 |
|
970 |
|
971 |
|
972 |
|
973 | <h4 class="name" id="getGlCanvas"><span class="type-signature"></span>getGlCanvas<span class="signature">()</span><span class="type-signature"> → {Canvas}</span></h4>
|
974 |
|
975 |
|
976 |
|
977 |
|
978 |
|
979 | <div class="description">
|
980 | Get the canvas for use in QA scripts
|
981 | </div>
|
982 |
|
983 |
|
984 |
|
985 |
|
986 |
|
987 |
|
988 |
|
989 |
|
990 |
|
991 |
|
992 |
|
993 |
|
994 |
|
995 | <dl class="details">
|
996 |
|
997 |
|
998 |
|
999 |
|
1000 |
|
1001 |
|
1002 |
|
1003 |
|
1004 |
|
1005 |
|
1006 |
|
1007 |
|
1008 |
|
1009 |
|
1010 |
|
1011 |
|
1012 |
|
1013 |
|
1014 |
|
1015 |
|
1016 |
|
1017 |
|
1018 |
|
1019 |
|
1020 |
|
1021 |
|
1022 | <dt class="tag-source">Source:</dt>
|
1023 | <dd class="tag-source"><ul class="dummy"><li>
|
1024 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line324">line 324</a>
|
1025 | </li></ul></dd>
|
1026 |
|
1027 |
|
1028 |
|
1029 |
|
1030 |
|
1031 |
|
1032 |
|
1033 | </dl>
|
1034 |
|
1035 |
|
1036 |
|
1037 |
|
1038 |
|
1039 |
|
1040 |
|
1041 |
|
1042 |
|
1043 |
|
1044 |
|
1045 |
|
1046 |
|
1047 | <h5>Returns:</h5>
|
1048 |
|
1049 |
|
1050 | <div class="param-desc">
|
1051 | WebGL canvas dom element
|
1052 | </div>
|
1053 |
|
1054 |
|
1055 |
|
1056 | <dl class="param-type">
|
1057 | <dt>
|
1058 | Type
|
1059 | </dt>
|
1060 | <dd>
|
1061 |
|
1062 | <span class="param-type">Canvas</span>
|
1063 |
|
1064 |
|
1065 | </dd>
|
1066 | </dl>
|
1067 |
|
1068 |
|
1069 |
|
1070 |
|
1071 |
|
1072 |
|
1073 |
|
1074 |
|
1075 |
|
1076 |
|
1077 | <h4 class="name" id="getSelection"><span class="type-signature"></span>getSelection<span class="signature">()</span><span class="type-signature"> → {THREE.Object3D}</span></h4>
|
1078 |
|
1079 |
|
1080 |
|
1081 |
|
1082 |
|
1083 | <div class="description">
|
1084 | Get the currently selected geometry
|
1085 | </div>
|
1086 |
|
1087 |
|
1088 |
|
1089 |
|
1090 |
|
1091 |
|
1092 |
|
1093 |
|
1094 |
|
1095 |
|
1096 |
|
1097 |
|
1098 |
|
1099 | <dl class="details">
|
1100 |
|
1101 |
|
1102 |
|
1103 |
|
1104 |
|
1105 |
|
1106 |
|
1107 |
|
1108 |
|
1109 |
|
1110 |
|
1111 |
|
1112 |
|
1113 |
|
1114 |
|
1115 |
|
1116 |
|
1117 |
|
1118 |
|
1119 |
|
1120 |
|
1121 |
|
1122 |
|
1123 |
|
1124 |
|
1125 |
|
1126 | <dt class="tag-source">Source:</dt>
|
1127 | <dd class="tag-source"><ul class="dummy"><li>
|
1128 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line139">line 139</a>
|
1129 | </li></ul></dd>
|
1130 |
|
1131 |
|
1132 |
|
1133 |
|
1134 |
|
1135 |
|
1136 |
|
1137 | </dl>
|
1138 |
|
1139 |
|
1140 |
|
1141 |
|
1142 |
|
1143 |
|
1144 |
|
1145 |
|
1146 |
|
1147 |
|
1148 |
|
1149 |
|
1150 |
|
1151 | <h5>Returns:</h5>
|
1152 |
|
1153 |
|
1154 | <div class="param-desc">
|
1155 | Current selection
|
1156 | </div>
|
1157 |
|
1158 |
|
1159 |
|
1160 | <dl class="param-type">
|
1161 | <dt>
|
1162 | Type
|
1163 | </dt>
|
1164 | <dd>
|
1165 |
|
1166 | <span class="param-type">THREE.Object3D</span>
|
1167 |
|
1168 |
|
1169 | </dd>
|
1170 | </dl>
|
1171 |
|
1172 |
|
1173 |
|
1174 |
|
1175 |
|
1176 |
|
1177 |
|
1178 |
|
1179 |
|
1180 |
|
1181 | <h4 class="name" id="homeCamera"><span class="type-signature"></span>homeCamera<span class="signature">()</span><span class="type-signature"></span></h4>
|
1182 |
|
1183 |
|
1184 |
|
1185 |
|
1186 |
|
1187 | <div class="description">
|
1188 | Restore the camera to a default location
|
1189 | </div>
|
1190 |
|
1191 |
|
1192 |
|
1193 |
|
1194 |
|
1195 |
|
1196 |
|
1197 |
|
1198 |
|
1199 |
|
1200 |
|
1201 |
|
1202 |
|
1203 | <dl class="details">
|
1204 |
|
1205 |
|
1206 |
|
1207 |
|
1208 |
|
1209 |
|
1210 |
|
1211 |
|
1212 |
|
1213 |
|
1214 |
|
1215 |
|
1216 |
|
1217 |
|
1218 |
|
1219 |
|
1220 |
|
1221 |
|
1222 |
|
1223 |
|
1224 |
|
1225 |
|
1226 |
|
1227 |
|
1228 |
|
1229 |
|
1230 | <dt class="tag-source">Source:</dt>
|
1231 | <dd class="tag-source"><ul class="dummy"><li>
|
1232 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line181">line 181</a>
|
1233 | </li></ul></dd>
|
1234 |
|
1235 |
|
1236 |
|
1237 |
|
1238 |
|
1239 |
|
1240 |
|
1241 | </dl>
|
1242 |
|
1243 |
|
1244 |
|
1245 |
|
1246 |
|
1247 |
|
1248 |
|
1249 |
|
1250 |
|
1251 |
|
1252 |
|
1253 |
|
1254 |
|
1255 |
|
1256 |
|
1257 |
|
1258 |
|
1259 |
|
1260 |
|
1261 |
|
1262 |
|
1263 | <h4 class="name" id="setClearColor"><span class="type-signature"></span>setClearColor<span class="signature">(color, alpha)</span><span class="type-signature"></span></h4>
|
1264 |
|
1265 |
|
1266 |
|
1267 |
|
1268 |
|
1269 | <div class="description">
|
1270 | Set the clear color (background) for WebGL canvas
|
1271 | </div>
|
1272 |
|
1273 |
|
1274 |
|
1275 |
|
1276 |
|
1277 |
|
1278 |
|
1279 |
|
1280 |
|
1281 | <h5>Parameters:</h5>
|
1282 |
|
1283 |
|
1284 | <table class="params">
|
1285 | <thead>
|
1286 | <tr>
|
1287 |
|
1288 | <th>Name</th>
|
1289 |
|
1290 |
|
1291 | <th>Type</th>
|
1292 |
|
1293 |
|
1294 |
|
1295 |
|
1296 |
|
1297 | <th class="last">Description</th>
|
1298 | </tr>
|
1299 | </thead>
|
1300 |
|
1301 | <tbody>
|
1302 |
|
1303 |
|
1304 | <tr>
|
1305 |
|
1306 | <td class="name"><code>color</code></td>
|
1307 |
|
1308 |
|
1309 | <td class="type">
|
1310 |
|
1311 |
|
1312 | <span class="param-type">String</span>
|
1313 | |
|
1314 |
|
1315 | <span class="param-type">Number</span>
|
1316 |
|
1317 |
|
1318 |
|
1319 | </td>
|
1320 |
|
1321 |
|
1322 |
|
1323 |
|
1324 |
|
1325 | <td class="description last">Hexadecimal or a CSS-style string</td>
|
1326 | </tr>
|
1327 |
|
1328 |
|
1329 |
|
1330 | <tr>
|
1331 |
|
1332 | <td class="name"><code>alpha</code></td>
|
1333 |
|
1334 |
|
1335 | <td class="type">
|
1336 |
|
1337 |
|
1338 | <span class="param-type">Number</span>
|
1339 |
|
1340 |
|
1341 |
|
1342 | </td>
|
1343 |
|
1344 |
|
1345 |
|
1346 |
|
1347 |
|
1348 | <td class="description last">Opacity</td>
|
1349 | </tr>
|
1350 |
|
1351 |
|
1352 | </tbody>
|
1353 | </table>
|
1354 |
|
1355 |
|
1356 |
|
1357 |
|
1358 |
|
1359 |
|
1360 | <dl class="details">
|
1361 |
|
1362 |
|
1363 |
|
1364 |
|
1365 |
|
1366 |
|
1367 |
|
1368 |
|
1369 |
|
1370 |
|
1371 |
|
1372 |
|
1373 |
|
1374 |
|
1375 |
|
1376 |
|
1377 |
|
1378 |
|
1379 |
|
1380 |
|
1381 |
|
1382 |
|
1383 |
|
1384 |
|
1385 |
|
1386 |
|
1387 | <dt class="tag-source">Source:</dt>
|
1388 | <dd class="tag-source"><ul class="dummy"><li>
|
1389 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line210">line 210</a>
|
1390 | </li></ul></dd>
|
1391 |
|
1392 |
|
1393 |
|
1394 |
|
1395 |
|
1396 |
|
1397 |
|
1398 | </dl>
|
1399 |
|
1400 |
|
1401 |
|
1402 |
|
1403 |
|
1404 |
|
1405 |
|
1406 |
|
1407 |
|
1408 |
|
1409 |
|
1410 |
|
1411 |
|
1412 |
|
1413 |
|
1414 |
|
1415 |
|
1416 |
|
1417 |
|
1418 |
|
1419 |
|
1420 | <h4 class="name" id="setEdgesMode"><span class="type-signature"></span>setEdgesMode<span class="signature">(mode)</span><span class="type-signature"></span></h4>
|
1421 |
|
1422 |
|
1423 |
|
1424 |
|
1425 |
|
1426 | <div class="description">
|
1427 | Set the edges rendering mode for hidden line rendering
|
1428 | </div>
|
1429 |
|
1430 |
|
1431 |
|
1432 |
|
1433 |
|
1434 |
|
1435 |
|
1436 |
|
1437 |
|
1438 | <h5>Parameters:</h5>
|
1439 |
|
1440 |
|
1441 | <table class="params">
|
1442 | <thead>
|
1443 | <tr>
|
1444 |
|
1445 | <th>Name</th>
|
1446 |
|
1447 |
|
1448 | <th>Type</th>
|
1449 |
|
1450 |
|
1451 |
|
1452 |
|
1453 |
|
1454 | <th class="last">Description</th>
|
1455 | </tr>
|
1456 | </thead>
|
1457 |
|
1458 | <tbody>
|
1459 |
|
1460 |
|
1461 | <tr>
|
1462 |
|
1463 | <td class="name"><code>mode</code></td>
|
1464 |
|
1465 |
|
1466 | <td class="type">
|
1467 |
|
1468 |
|
1469 | <span class="param-type"><a href="EdgesHelper.html#.EDGES_MODES">EdgesHelper.EDGES_MODES</a></span>
|
1470 |
|
1471 |
|
1472 |
|
1473 | </td>
|
1474 |
|
1475 |
|
1476 |
|
1477 |
|
1478 |
|
1479 | <td class="description last">Whether to render front, back, both or none</td>
|
1480 | </tr>
|
1481 |
|
1482 |
|
1483 | </tbody>
|
1484 | </table>
|
1485 |
|
1486 |
|
1487 |
|
1488 |
|
1489 |
|
1490 |
|
1491 | <dl class="details">
|
1492 |
|
1493 |
|
1494 |
|
1495 |
|
1496 |
|
1497 |
|
1498 |
|
1499 |
|
1500 |
|
1501 |
|
1502 |
|
1503 |
|
1504 |
|
1505 |
|
1506 |
|
1507 |
|
1508 |
|
1509 |
|
1510 |
|
1511 |
|
1512 |
|
1513 |
|
1514 |
|
1515 |
|
1516 |
|
1517 |
|
1518 | <dt class="tag-source">Source:</dt>
|
1519 | <dd class="tag-source"><ul class="dummy"><li>
|
1520 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line174">line 174</a>
|
1521 | </li></ul></dd>
|
1522 |
|
1523 |
|
1524 |
|
1525 |
|
1526 |
|
1527 |
|
1528 |
|
1529 | </dl>
|
1530 |
|
1531 |
|
1532 |
|
1533 |
|
1534 |
|
1535 |
|
1536 |
|
1537 |
|
1538 |
|
1539 |
|
1540 |
|
1541 |
|
1542 |
|
1543 |
|
1544 |
|
1545 |
|
1546 |
|
1547 |
|
1548 |
|
1549 |
|
1550 |
|
1551 | <h4 class="name" id="setHelpersVisible"><span class="type-signature"></span>setHelpersVisible<span class="signature">(visible)</span><span class="type-signature"></span></h4>
|
1552 |
|
1553 |
|
1554 |
|
1555 |
|
1556 |
|
1557 | <div class="description">
|
1558 | Whether to draw helpers (axis and grid)
|
1559 | </div>
|
1560 |
|
1561 |
|
1562 |
|
1563 |
|
1564 |
|
1565 |
|
1566 |
|
1567 |
|
1568 |
|
1569 | <h5>Parameters:</h5>
|
1570 |
|
1571 |
|
1572 | <table class="params">
|
1573 | <thead>
|
1574 | <tr>
|
1575 |
|
1576 | <th>Name</th>
|
1577 |
|
1578 |
|
1579 | <th>Type</th>
|
1580 |
|
1581 |
|
1582 |
|
1583 |
|
1584 |
|
1585 | <th class="last">Description</th>
|
1586 | </tr>
|
1587 | </thead>
|
1588 |
|
1589 | <tbody>
|
1590 |
|
1591 |
|
1592 | <tr>
|
1593 |
|
1594 | <td class="name"><code>visible</code></td>
|
1595 |
|
1596 |
|
1597 | <td class="type">
|
1598 |
|
1599 |
|
1600 | <span class="param-type">Boolean</span>
|
1601 |
|
1602 |
|
1603 |
|
1604 | </td>
|
1605 |
|
1606 |
|
1607 |
|
1608 |
|
1609 |
|
1610 | <td class="description last">False to hide them</td>
|
1611 | </tr>
|
1612 |
|
1613 |
|
1614 | </tbody>
|
1615 | </table>
|
1616 |
|
1617 |
|
1618 |
|
1619 |
|
1620 |
|
1621 |
|
1622 | <dl class="details">
|
1623 |
|
1624 |
|
1625 |
|
1626 |
|
1627 |
|
1628 |
|
1629 |
|
1630 |
|
1631 |
|
1632 |
|
1633 |
|
1634 |
|
1635 |
|
1636 |
|
1637 |
|
1638 |
|
1639 |
|
1640 |
|
1641 |
|
1642 |
|
1643 |
|
1644 |
|
1645 |
|
1646 |
|
1647 |
|
1648 |
|
1649 | <dt class="tag-source">Source:</dt>
|
1650 | <dd class="tag-source"><ul class="dummy"><li>
|
1651 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line220">line 220</a>
|
1652 | </li></ul></dd>
|
1653 |
|
1654 |
|
1655 |
|
1656 |
|
1657 |
|
1658 |
|
1659 |
|
1660 | </dl>
|
1661 |
|
1662 |
|
1663 |
|
1664 |
|
1665 |
|
1666 |
|
1667 |
|
1668 |
|
1669 |
|
1670 |
|
1671 |
|
1672 |
|
1673 |
|
1674 |
|
1675 |
|
1676 |
|
1677 |
|
1678 |
|
1679 |
|
1680 |
|
1681 |
|
1682 | <h4 class="name" id="setLights"><span class="type-signature"></span>setLights<span class="signature">(lights)</span><span class="type-signature"></span></h4>
|
1683 |
|
1684 |
|
1685 |
|
1686 |
|
1687 |
|
1688 | <div class="description">
|
1689 | Set the lights used to illuminate the scene.
|
1690 | </div>
|
1691 |
|
1692 |
|
1693 |
|
1694 |
|
1695 |
|
1696 |
|
1697 |
|
1698 |
|
1699 |
|
1700 | <h5>Parameters:</h5>
|
1701 |
|
1702 |
|
1703 | <table class="params">
|
1704 | <thead>
|
1705 | <tr>
|
1706 |
|
1707 | <th>Name</th>
|
1708 |
|
1709 |
|
1710 | <th>Type</th>
|
1711 |
|
1712 |
|
1713 |
|
1714 |
|
1715 |
|
1716 | <th class="last">Description</th>
|
1717 | </tr>
|
1718 | </thead>
|
1719 |
|
1720 | <tbody>
|
1721 |
|
1722 |
|
1723 | <tr>
|
1724 |
|
1725 | <td class="name"><code>lights</code></td>
|
1726 |
|
1727 |
|
1728 | <td class="type">
|
1729 |
|
1730 |
|
1731 | <span class="param-type">THREE.Object3D</span>
|
1732 |
|
1733 |
|
1734 |
|
1735 | </td>
|
1736 |
|
1737 |
|
1738 |
|
1739 |
|
1740 |
|
1741 | <td class="description last">Object with lights as children</td>
|
1742 | </tr>
|
1743 |
|
1744 |
|
1745 | </tbody>
|
1746 | </table>
|
1747 |
|
1748 |
|
1749 |
|
1750 |
|
1751 |
|
1752 |
|
1753 | <dl class="details">
|
1754 |
|
1755 |
|
1756 |
|
1757 |
|
1758 |
|
1759 |
|
1760 |
|
1761 |
|
1762 |
|
1763 |
|
1764 |
|
1765 |
|
1766 |
|
1767 |
|
1768 |
|
1769 |
|
1770 |
|
1771 |
|
1772 |
|
1773 |
|
1774 |
|
1775 |
|
1776 |
|
1777 |
|
1778 |
|
1779 |
|
1780 | <dt class="tag-source">Source:</dt>
|
1781 | <dd class="tag-source"><ul class="dummy"><li>
|
1782 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line82">line 82</a>
|
1783 | </li></ul></dd>
|
1784 |
|
1785 |
|
1786 |
|
1787 |
|
1788 |
|
1789 |
|
1790 |
|
1791 | </dl>
|
1792 |
|
1793 |
|
1794 |
|
1795 |
|
1796 |
|
1797 |
|
1798 |
|
1799 |
|
1800 |
|
1801 |
|
1802 |
|
1803 |
|
1804 |
|
1805 |
|
1806 |
|
1807 |
|
1808 |
|
1809 |
|
1810 |
|
1811 |
|
1812 |
|
1813 | <h4 class="name" id="setModel"><span class="type-signature"></span>setModel<span class="signature">(model)</span><span class="type-signature"></span></h4>
|
1814 |
|
1815 |
|
1816 |
|
1817 |
|
1818 |
|
1819 | <div class="description">
|
1820 | Set the object to render
|
1821 | Replaces old render contents
|
1822 | </div>
|
1823 |
|
1824 |
|
1825 |
|
1826 |
|
1827 |
|
1828 |
|
1829 |
|
1830 |
|
1831 |
|
1832 | <h5>Parameters:</h5>
|
1833 |
|
1834 |
|
1835 | <table class="params">
|
1836 | <thead>
|
1837 | <tr>
|
1838 |
|
1839 | <th>Name</th>
|
1840 |
|
1841 |
|
1842 | <th>Type</th>
|
1843 |
|
1844 |
|
1845 |
|
1846 |
|
1847 |
|
1848 | <th class="last">Description</th>
|
1849 | </tr>
|
1850 | </thead>
|
1851 |
|
1852 | <tbody>
|
1853 |
|
1854 |
|
1855 | <tr>
|
1856 |
|
1857 | <td class="name"><code>model</code></td>
|
1858 |
|
1859 |
|
1860 | <td class="type">
|
1861 |
|
1862 |
|
1863 | <span class="param-type">THREE.Object3D</span>
|
1864 |
|
1865 |
|
1866 |
|
1867 | </td>
|
1868 |
|
1869 |
|
1870 |
|
1871 |
|
1872 |
|
1873 | <td class="description last">What to render</td>
|
1874 | </tr>
|
1875 |
|
1876 |
|
1877 | </tbody>
|
1878 | </table>
|
1879 |
|
1880 |
|
1881 |
|
1882 |
|
1883 |
|
1884 |
|
1885 | <dl class="details">
|
1886 |
|
1887 |
|
1888 |
|
1889 |
|
1890 |
|
1891 |
|
1892 |
|
1893 |
|
1894 |
|
1895 |
|
1896 |
|
1897 |
|
1898 |
|
1899 |
|
1900 |
|
1901 |
|
1902 |
|
1903 |
|
1904 |
|
1905 |
|
1906 |
|
1907 |
|
1908 |
|
1909 |
|
1910 |
|
1911 |
|
1912 | <dt class="tag-source">Source:</dt>
|
1913 | <dd class="tag-source"><ul class="dummy"><li>
|
1914 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line156">line 156</a>
|
1915 | </li></ul></dd>
|
1916 |
|
1917 |
|
1918 |
|
1919 |
|
1920 |
|
1921 |
|
1922 |
|
1923 | </dl>
|
1924 |
|
1925 |
|
1926 |
|
1927 |
|
1928 |
|
1929 |
|
1930 |
|
1931 |
|
1932 |
|
1933 |
|
1934 |
|
1935 |
|
1936 |
|
1937 |
|
1938 |
|
1939 |
|
1940 |
|
1941 |
|
1942 |
|
1943 |
|
1944 |
|
1945 | <h4 class="name" id="setSelection"><span class="type-signature"></span>setSelection<span class="signature">(object)</span><span class="type-signature"></span></h4>
|
1946 |
|
1947 |
|
1948 |
|
1949 |
|
1950 |
|
1951 | <div class="description">
|
1952 | set the currently selected geometry
|
1953 | </div>
|
1954 |
|
1955 |
|
1956 |
|
1957 |
|
1958 |
|
1959 |
|
1960 |
|
1961 |
|
1962 |
|
1963 | <h5>Parameters:</h5>
|
1964 |
|
1965 |
|
1966 | <table class="params">
|
1967 | <thead>
|
1968 | <tr>
|
1969 |
|
1970 | <th>Name</th>
|
1971 |
|
1972 |
|
1973 | <th>Type</th>
|
1974 |
|
1975 |
|
1976 |
|
1977 |
|
1978 |
|
1979 | <th class="last">Description</th>
|
1980 | </tr>
|
1981 | </thead>
|
1982 |
|
1983 | <tbody>
|
1984 |
|
1985 |
|
1986 | <tr>
|
1987 |
|
1988 | <td class="name"><code>object</code></td>
|
1989 |
|
1990 |
|
1991 | <td class="type">
|
1992 |
|
1993 |
|
1994 | <span class="param-type">THREE.Object3D</span>
|
1995 |
|
1996 |
|
1997 |
|
1998 | </td>
|
1999 |
|
2000 |
|
2001 |
|
2002 |
|
2003 |
|
2004 | <td class="description last">New selection</td>
|
2005 | </tr>
|
2006 |
|
2007 |
|
2008 | </tbody>
|
2009 | </table>
|
2010 |
|
2011 |
|
2012 |
|
2013 |
|
2014 |
|
2015 |
|
2016 | <dl class="details">
|
2017 |
|
2018 |
|
2019 |
|
2020 |
|
2021 |
|
2022 |
|
2023 |
|
2024 |
|
2025 |
|
2026 |
|
2027 |
|
2028 |
|
2029 |
|
2030 |
|
2031 |
|
2032 |
|
2033 |
|
2034 |
|
2035 |
|
2036 |
|
2037 |
|
2038 |
|
2039 |
|
2040 |
|
2041 |
|
2042 |
|
2043 | <dt class="tag-source">Source:</dt>
|
2044 | <dd class="tag-source"><ul class="dummy"><li>
|
2045 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line147">line 147</a>
|
2046 | </li></ul></dd>
|
2047 |
|
2048 |
|
2049 |
|
2050 |
|
2051 |
|
2052 |
|
2053 |
|
2054 | </dl>
|
2055 |
|
2056 |
|
2057 |
|
2058 |
|
2059 |
|
2060 |
|
2061 |
|
2062 |
|
2063 |
|
2064 |
|
2065 |
|
2066 |
|
2067 |
|
2068 |
|
2069 |
|
2070 |
|
2071 |
|
2072 |
|
2073 |
|
2074 |
|
2075 |
|
2076 | <h4 class="name" id="setSelectionMaterial"><span class="type-signature"></span>setSelectionMaterial<span class="signature">(data)</span><span class="type-signature"></span></h4>
|
2077 |
|
2078 |
|
2079 |
|
2080 |
|
2081 |
|
2082 | <div class="description">
|
2083 | Define the material that is applied on selected objects
|
2084 | </div>
|
2085 |
|
2086 |
|
2087 |
|
2088 |
|
2089 |
|
2090 |
|
2091 |
|
2092 |
|
2093 |
|
2094 | <h5>Parameters:</h5>
|
2095 |
|
2096 |
|
2097 | <table class="params">
|
2098 | <thead>
|
2099 | <tr>
|
2100 |
|
2101 | <th>Name</th>
|
2102 |
|
2103 |
|
2104 | <th>Type</th>
|
2105 |
|
2106 |
|
2107 |
|
2108 |
|
2109 |
|
2110 | <th class="last">Description</th>
|
2111 | </tr>
|
2112 | </thead>
|
2113 |
|
2114 | <tbody>
|
2115 |
|
2116 |
|
2117 | <tr>
|
2118 |
|
2119 | <td class="name"><code>data</code></td>
|
2120 |
|
2121 |
|
2122 | <td class="type">
|
2123 |
|
2124 |
|
2125 | <span class="param-type">Object</span>
|
2126 |
|
2127 |
|
2128 |
|
2129 | </td>
|
2130 |
|
2131 |
|
2132 |
|
2133 |
|
2134 |
|
2135 | <td class="description last">Flux json description of a material</td>
|
2136 | </tr>
|
2137 |
|
2138 |
|
2139 | </tbody>
|
2140 | </table>
|
2141 |
|
2142 |
|
2143 |
|
2144 |
|
2145 |
|
2146 |
|
2147 | <dl class="details">
|
2148 |
|
2149 |
|
2150 |
|
2151 |
|
2152 |
|
2153 |
|
2154 |
|
2155 |
|
2156 |
|
2157 |
|
2158 |
|
2159 |
|
2160 |
|
2161 |
|
2162 |
|
2163 |
|
2164 |
|
2165 |
|
2166 |
|
2167 |
|
2168 |
|
2169 |
|
2170 |
|
2171 |
|
2172 |
|
2173 |
|
2174 | <dt class="tag-source">Source:</dt>
|
2175 | <dd class="tag-source"><ul class="dummy"><li>
|
2176 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line131">line 131</a>
|
2177 | </li></ul></dd>
|
2178 |
|
2179 |
|
2180 |
|
2181 |
|
2182 |
|
2183 |
|
2184 |
|
2185 | </dl>
|
2186 |
|
2187 |
|
2188 |
|
2189 |
|
2190 |
|
2191 |
|
2192 |
|
2193 |
|
2194 |
|
2195 |
|
2196 |
|
2197 |
|
2198 |
|
2199 |
|
2200 |
|
2201 |
|
2202 |
|
2203 |
|
2204 |
|
2205 |
|
2206 |
|
2207 | <h4 class="name" id="setSize"><span class="type-signature"></span>setSize<span class="signature">(width, height)</span><span class="type-signature"></span></h4>
|
2208 |
|
2209 |
|
2210 |
|
2211 |
|
2212 |
|
2213 | <div class="description">
|
2214 | Set the size of things that are per viewport.
|
2215 | </div>
|
2216 |
|
2217 |
|
2218 |
|
2219 |
|
2220 |
|
2221 |
|
2222 |
|
2223 |
|
2224 |
|
2225 | <h5>Parameters:</h5>
|
2226 |
|
2227 |
|
2228 | <table class="params">
|
2229 | <thead>
|
2230 | <tr>
|
2231 |
|
2232 | <th>Name</th>
|
2233 |
|
2234 |
|
2235 | <th>Type</th>
|
2236 |
|
2237 |
|
2238 |
|
2239 |
|
2240 |
|
2241 | <th class="last">Description</th>
|
2242 | </tr>
|
2243 | </thead>
|
2244 |
|
2245 | <tbody>
|
2246 |
|
2247 |
|
2248 | <tr>
|
2249 |
|
2250 | <td class="name"><code>width</code></td>
|
2251 |
|
2252 |
|
2253 | <td class="type">
|
2254 |
|
2255 |
|
2256 | <span class="param-type">Number</span>
|
2257 |
|
2258 |
|
2259 |
|
2260 | </td>
|
2261 |
|
2262 |
|
2263 |
|
2264 |
|
2265 |
|
2266 | <td class="description last">The canvas width in pixels</td>
|
2267 | </tr>
|
2268 |
|
2269 |
|
2270 |
|
2271 | <tr>
|
2272 |
|
2273 | <td class="name"><code>height</code></td>
|
2274 |
|
2275 |
|
2276 | <td class="type">
|
2277 |
|
2278 |
|
2279 | <span class="param-type">Number</span>
|
2280 |
|
2281 |
|
2282 |
|
2283 | </td>
|
2284 |
|
2285 |
|
2286 |
|
2287 |
|
2288 |
|
2289 | <td class="description last">The canvas height in pixels</td>
|
2290 | </tr>
|
2291 |
|
2292 |
|
2293 | </tbody>
|
2294 | </table>
|
2295 |
|
2296 |
|
2297 |
|
2298 |
|
2299 |
|
2300 |
|
2301 | <dl class="details">
|
2302 |
|
2303 |
|
2304 |
|
2305 |
|
2306 |
|
2307 |
|
2308 |
|
2309 |
|
2310 |
|
2311 |
|
2312 |
|
2313 |
|
2314 |
|
2315 |
|
2316 |
|
2317 |
|
2318 |
|
2319 |
|
2320 |
|
2321 |
|
2322 |
|
2323 |
|
2324 |
|
2325 |
|
2326 |
|
2327 |
|
2328 | <dt class="tag-source">Source:</dt>
|
2329 | <dd class="tag-source"><ul class="dummy"><li>
|
2330 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line363">line 363</a>
|
2331 | </li></ul></dd>
|
2332 |
|
2333 |
|
2334 |
|
2335 |
|
2336 |
|
2337 |
|
2338 |
|
2339 | </dl>
|
2340 |
|
2341 |
|
2342 |
|
2343 |
|
2344 |
|
2345 |
|
2346 |
|
2347 |
|
2348 |
|
2349 |
|
2350 |
|
2351 |
|
2352 |
|
2353 |
|
2354 |
|
2355 |
|
2356 |
|
2357 |
|
2358 |
|
2359 |
|
2360 |
|
2361 | <h4 class="name" id="setView"><span class="type-signature"></span>setView<span class="signature">(view)</span><span class="type-signature"></span></h4>
|
2362 |
|
2363 |
|
2364 |
|
2365 |
|
2366 |
|
2367 | <div class="description">
|
2368 | Set which camera view to use (ex perspective, top etc.).
|
2369 | </div>
|
2370 |
|
2371 |
|
2372 |
|
2373 |
|
2374 |
|
2375 |
|
2376 |
|
2377 |
|
2378 |
|
2379 | <h5>Parameters:</h5>
|
2380 |
|
2381 |
|
2382 | <table class="params">
|
2383 | <thead>
|
2384 | <tr>
|
2385 |
|
2386 | <th>Name</th>
|
2387 |
|
2388 |
|
2389 | <th>Type</th>
|
2390 |
|
2391 |
|
2392 |
|
2393 |
|
2394 |
|
2395 | <th class="last">Description</th>
|
2396 | </tr>
|
2397 | </thead>
|
2398 |
|
2399 | <tbody>
|
2400 |
|
2401 |
|
2402 | <tr>
|
2403 |
|
2404 | <td class="name"><code>view</code></td>
|
2405 |
|
2406 |
|
2407 | <td class="type">
|
2408 |
|
2409 |
|
2410 | <span class="param-type"><a href="FluxCameras.html#.VIEWS">FluxCameras.VIEWS</a></span>
|
2411 |
|
2412 |
|
2413 |
|
2414 | </td>
|
2415 |
|
2416 |
|
2417 |
|
2418 |
|
2419 |
|
2420 | <td class="description last">The new view mode</td>
|
2421 | </tr>
|
2422 |
|
2423 |
|
2424 | </tbody>
|
2425 | </table>
|
2426 |
|
2427 |
|
2428 |
|
2429 |
|
2430 |
|
2431 |
|
2432 | <dl class="details">
|
2433 |
|
2434 |
|
2435 |
|
2436 |
|
2437 |
|
2438 |
|
2439 |
|
2440 |
|
2441 |
|
2442 |
|
2443 |
|
2444 |
|
2445 |
|
2446 |
|
2447 |
|
2448 |
|
2449 |
|
2450 |
|
2451 |
|
2452 |
|
2453 |
|
2454 |
|
2455 |
|
2456 |
|
2457 |
|
2458 |
|
2459 | <dt class="tag-source">Source:</dt>
|
2460 | <dd class="tag-source"><ul class="dummy"><li>
|
2461 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line259">line 259</a>
|
2462 | </li></ul></dd>
|
2463 |
|
2464 |
|
2465 |
|
2466 |
|
2467 |
|
2468 |
|
2469 |
|
2470 | </dl>
|
2471 |
|
2472 |
|
2473 |
|
2474 |
|
2475 |
|
2476 |
|
2477 |
|
2478 |
|
2479 |
|
2480 |
|
2481 |
|
2482 |
|
2483 |
|
2484 |
|
2485 |
|
2486 |
|
2487 |
|
2488 |
|
2489 |
|
2490 |
|
2491 |
|
2492 | <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
|
2493 |
|
2494 |
|
2495 |
|
2496 |
|
2497 |
|
2498 | <div class="description">
|
2499 | Make serializable by pruning all references and building an object property tree
|
2500 | </div>
|
2501 |
|
2502 |
|
2503 |
|
2504 |
|
2505 |
|
2506 |
|
2507 |
|
2508 |
|
2509 |
|
2510 |
|
2511 |
|
2512 |
|
2513 |
|
2514 | <dl class="details">
|
2515 |
|
2516 |
|
2517 |
|
2518 |
|
2519 |
|
2520 |
|
2521 |
|
2522 |
|
2523 |
|
2524 |
|
2525 |
|
2526 |
|
2527 |
|
2528 |
|
2529 |
|
2530 |
|
2531 |
|
2532 |
|
2533 |
|
2534 |
|
2535 |
|
2536 |
|
2537 |
|
2538 |
|
2539 |
|
2540 |
|
2541 | <dt class="tag-source">Source:</dt>
|
2542 | <dd class="tag-source"><ul class="dummy"><li>
|
2543 | <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line382">line 382</a>
|
2544 | </li></ul></dd>
|
2545 |
|
2546 |
|
2547 |
|
2548 |
|
2549 |
|
2550 |
|
2551 |
|
2552 | </dl>
|
2553 |
|
2554 |
|
2555 |
|
2556 |
|
2557 |
|
2558 |
|
2559 |
|
2560 |
|
2561 |
|
2562 |
|
2563 |
|
2564 |
|
2565 |
|
2566 | <h5>Returns:</h5>
|
2567 |
|
2568 |
|
2569 | <div class="param-desc">
|
2570 | Data to stringify
|
2571 | </div>
|
2572 |
|
2573 |
|
2574 |
|
2575 | <dl class="param-type">
|
2576 | <dt>
|
2577 | Type
|
2578 | </dt>
|
2579 | <dd>
|
2580 |
|
2581 | <span class="param-type">Object</span>
|
2582 |
|
2583 |
|
2584 | </dd>
|
2585 | </dl>
|
2586 |
|
2587 |
|
2588 |
|
2589 |
|
2590 |
|
2591 |
|
2592 |
|
2593 |
|
2594 |
|
2595 |
|
2596 |
|
2597 | </article>
|
2598 |
|
2599 | </section>
|
2600 |
|
2601 |
|
2602 |
|
2603 |
|
2604 | </div>
|
2605 |
|
2606 | <br class="clear">
|
2607 |
|
2608 | <footer>
|
2609 | 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.
|
2610 | </footer>
|
2611 |
|
2612 | <script>prettyPrint();</script>
|
2613 | <script src="scripts/linenumber.js"></script>
|
2614 | </body>
|
2615 | </html> |
\ | No newline at end of file |