| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <title>EdgesHelper - 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">EdgesHelper</h1>
|
| 32 |
|
| 33 |
|
| 34 |
|
| 35 |
|
| 36 |
|
| 37 |
|
| 38 |
|
| 39 | <section>
|
| 40 |
|
| 41 | <header>
|
| 42 |
|
| 43 | <h2>
|
| 44 | EdgesHelper
|
| 45 | </h2>
|
| 46 |
|
| 47 |
|
| 48 | </header>
|
| 49 |
|
| 50 | <article>
|
| 51 | <div class="container-overview">
|
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
|
| 56 |
|
| 57 | <h4 class="name" id="EdgesHelper"><span class="type-signature"></span>new EdgesHelper<span class="signature">(model)</span><span class="type-signature"></span></h4>
|
| 58 |
|
| 59 |
|
| 60 |
|
| 61 |
|
| 62 |
|
| 63 | <div class="description">
|
| 64 | Create an object to render a mesh as edges
|
| 65 | </div>
|
| 66 |
|
| 67 |
|
| 68 |
|
| 69 |
|
| 70 |
|
| 71 |
|
| 72 |
|
| 73 |
|
| 74 |
|
| 75 | <h5>Parameters:</h5>
|
| 76 |
|
| 77 |
|
| 78 | <table class="params">
|
| 79 | <thead>
|
| 80 | <tr>
|
| 81 |
|
| 82 | <th>Name</th>
|
| 83 |
|
| 84 |
|
| 85 | <th>Type</th>
|
| 86 |
|
| 87 |
|
| 88 |
|
| 89 |
|
| 90 |
|
| 91 | <th class="last">Description</th>
|
| 92 | </tr>
|
| 93 | </thead>
|
| 94 |
|
| 95 | <tbody>
|
| 96 |
|
| 97 |
|
| 98 | <tr>
|
| 99 |
|
| 100 | <td class="name"><code>model</code></td>
|
| 101 |
|
| 102 |
|
| 103 | <td class="type">
|
| 104 |
|
| 105 |
|
| 106 | <span class="param-type">Three.Object3D</span>
|
| 107 |
|
| 108 |
|
| 109 |
|
| 110 | </td>
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 | <td class="description last">The mesh</td>
|
| 117 | </tr>
|
| 118 |
|
| 119 |
|
| 120 | </tbody>
|
| 121 | </table>
|
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 | <dl class="details">
|
| 129 |
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 |
|
| 136 |
|
| 137 |
|
| 138 |
|
| 139 |
|
| 140 |
|
| 141 |
|
| 142 |
|
| 143 |
|
| 144 |
|
| 145 |
|
| 146 |
|
| 147 |
|
| 148 |
|
| 149 |
|
| 150 |
|
| 151 |
|
| 152 |
|
| 153 |
|
| 154 |
|
| 155 | <dt class="tag-source">Source:</dt>
|
| 156 | <dd class="tag-source"><ul class="dummy"><li>
|
| 157 | <a href="EdgesHelper.js.html">EdgesHelper.js</a>, <a href="EdgesHelper.js.html#line31">line 31</a>
|
| 158 | </li></ul></dd>
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
|
| 165 |
|
| 166 | </dl>
|
| 167 |
|
| 168 |
|
| 169 |
|
| 170 |
|
| 171 |
|
| 172 |
|
| 173 |
|
| 174 |
|
| 175 |
|
| 176 |
|
| 177 |
|
| 178 |
|
| 179 |
|
| 180 |
|
| 181 |
|
| 182 |
|
| 183 |
|
| 184 | </div>
|
| 185 |
|
| 186 |
|
| 187 |
|
| 188 |
|
| 189 |
|
| 190 |
|
| 191 |
|
| 192 |
|
| 193 |
|
| 194 |
|
| 195 |
|
| 196 |
|
| 197 | <h3 class="subsection-title">Members</h3>
|
| 198 |
|
| 199 |
|
| 200 |
|
| 201 | <h4 class="name" id=".EDGES_MODES"><span class="type-signature">(static) </span>EDGES_MODES<span class="type-signature"></span></h4>
|
| 202 |
|
| 203 |
|
| 204 |
|
| 205 |
|
| 206 | <div class="description">
|
| 207 | Whether to draw edges on front and back faces.
|
| 208 | Values are NONE, FRONT, BACK, BOTH.
|
| 209 | </div>
|
| 210 |
|
| 211 |
|
| 212 |
|
| 213 |
|
| 214 |
|
| 215 |
|
| 216 |
|
| 217 | <dl class="details">
|
| 218 |
|
| 219 |
|
| 220 |
|
| 221 |
|
| 222 |
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 |
|
| 234 |
|
| 235 |
|
| 236 |
|
| 237 |
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 |
|
| 244 | <dt class="tag-source">Source:</dt>
|
| 245 | <dd class="tag-source"><ul class="dummy"><li>
|
| 246 | <a href="EdgesHelper.js.html">EdgesHelper.js</a>, <a href="EdgesHelper.js.html#line9">line 9</a>
|
| 247 | </li></ul></dd>
|
| 248 |
|
| 249 |
|
| 250 |
|
| 251 |
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 | </dl>
|
| 256 |
|
| 257 |
|
| 258 |
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
| 263 |
|
| 264 |
|
| 265 |
|
| 266 | <h3 class="subsection-title">Methods</h3>
|
| 267 |
|
| 268 |
|
| 269 |
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 | <h4 class="name" id=".AddEdges"><span class="type-signature">(static) </span>AddEdges<span class="signature">(newModel, edgesMode)</span><span class="type-signature"> → {<a href="EdgesHelper.html">EdgesHelper</a>}</span></h4>
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 |
|
| 278 |
|
| 279 | <div class="description">
|
| 280 | Create the edges geometry for a model
|
| 281 | </div>
|
| 282 |
|
| 283 |
|
| 284 |
|
| 285 |
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
|
| 291 | <h5>Parameters:</h5>
|
| 292 |
|
| 293 |
|
| 294 | <table class="params">
|
| 295 | <thead>
|
| 296 | <tr>
|
| 297 |
|
| 298 | <th>Name</th>
|
| 299 |
|
| 300 |
|
| 301 | <th>Type</th>
|
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 | <th class="last">Description</th>
|
| 308 | </tr>
|
| 309 | </thead>
|
| 310 |
|
| 311 | <tbody>
|
| 312 |
|
| 313 |
|
| 314 | <tr>
|
| 315 |
|
| 316 | <td class="name"><code>newModel</code></td>
|
| 317 |
|
| 318 |
|
| 319 | <td class="type">
|
| 320 |
|
| 321 |
|
| 322 | <span class="param-type">THREE.Object3D</span>
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 | </td>
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 | <td class="description last">The model with edges</td>
|
| 333 | </tr>
|
| 334 |
|
| 335 |
|
| 336 |
|
| 337 | <tr>
|
| 338 |
|
| 339 | <td class="name"><code>edgesMode</code></td>
|
| 340 |
|
| 341 |
|
| 342 | <td class="type">
|
| 343 |
|
| 344 |
|
| 345 | <span class="param-type"><a href="EdgesHelper.html#.EDGES_MODES">EdgesHelper.EDGES_MODES</a></span>
|
| 346 |
|
| 347 |
|
| 348 |
|
| 349 | </td>
|
| 350 |
|
| 351 |
|
| 352 |
|
| 353 |
|
| 354 |
|
| 355 | <td class="description last">Whether to draw edges enumeration</td>
|
| 356 | </tr>
|
| 357 |
|
| 358 |
|
| 359 | </tbody>
|
| 360 | </table>
|
| 361 |
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 |
|
| 367 | <dl class="details">
|
| 368 |
|
| 369 |
|
| 370 |
|
| 371 |
|
| 372 |
|
| 373 |
|
| 374 |
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 |
|
| 379 |
|
| 380 |
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
|
| 389 |
|
| 390 |
|
| 391 |
|
| 392 |
|
| 393 |
|
| 394 | <dt class="tag-source">Source:</dt>
|
| 395 | <dd class="tag-source"><ul class="dummy"><li>
|
| 396 | <a href="EdgesHelper.js.html">EdgesHelper.js</a>, <a href="EdgesHelper.js.html#line71">line 71</a>
|
| 397 | </li></ul></dd>
|
| 398 |
|
| 399 |
|
| 400 |
|
| 401 |
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 | </dl>
|
| 406 |
|
| 407 |
|
| 408 |
|
| 409 |
|
| 410 |
|
| 411 |
|
| 412 |
|
| 413 |
|
| 414 |
|
| 415 |
|
| 416 |
|
| 417 |
|
| 418 |
|
| 419 | <h5>Returns:</h5>
|
| 420 |
|
| 421 |
|
| 422 | <div class="param-desc">
|
| 423 | The edges object
|
| 424 | </div>
|
| 425 |
|
| 426 |
|
| 427 |
|
| 428 | <dl class="param-type">
|
| 429 | <dt>
|
| 430 | Type
|
| 431 | </dt>
|
| 432 | <dd>
|
| 433 |
|
| 434 | <span class="param-type"><a href="EdgesHelper.html">EdgesHelper</a></span>
|
| 435 |
|
| 436 |
|
| 437 | </dd>
|
| 438 | </dl>
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
|
| 445 |
|
| 446 |
|
| 447 |
|
| 448 |
|
| 449 |
|
| 450 | </article>
|
| 451 |
|
| 452 | </section>
|
| 453 |
|
| 454 |
|
| 455 |
|
| 456 |
|
| 457 | </div>
|
| 458 |
|
| 459 | <br class="clear">
|
| 460 |
|
| 461 | <footer>
|
| 462 | 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.
|
| 463 | </footer>
|
| 464 |
|
| 465 | <script>prettyPrint();</script>
|
| 466 | <script src="scripts/linenumber.js"></script>
|
| 467 | </body>
|
| 468 | </html> |
| \ | No newline at end of file |