TileShadowNodeHelper.html 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>TileShadowNodeHelper - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → <a href="Group.html">Group</a> → </p>
  13. <h1 translate="no">TileShadowNodeHelper</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Helper class to manage and display debug visuals for TileShadowNode.</p></div>
  17. </header>
  18. <article>
  19. <h2 class="subsection-title">Import</h2>
  20. <p><span translate="no">TileShadowNodeHelper</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
  21. <pre><code class="language-js">import { TileShadowNodeHelper } from 'three/addons/tsl/shadows/TileShadowNodeHelper.js';</code></pre>
  22. <div class="container-overview">
  23. <h2>Constructor</h2>
  24. <h3 class="name name-method" id="TileShadowNodeHelper" translate="no">new <a href="#TileShadowNodeHelper">TileShadowNodeHelper</a><span class="signature">( tileShadowNode : <span class="param-type">TileShadowNode</span> )</span> </h3>
  25. <div class="method">
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name"><code>tileShadowNode</code></td>
  30. <td class="description last"><p>The TileShadowNode instance to debug.</p></td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. </div>
  36. <h2 class="subsection-title">Methods</h2>
  37. <h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
  38. <div class="method">
  39. <div class="description">
  40. <p>Removes all debug objects (planes and helpers) from the scene.</p>
  41. </div>
  42. </div>
  43. <h3 class="name name-method" id="init" translate="no">.<a href="#init">init</a><span class="signature">()</span> </h3>
  44. <div class="method">
  45. <div class="description">
  46. <p>Initializes the debug displays (planes and camera helpers).
  47. Should be called after TileShadowNode has initialized its lights and shadow nodes.</p>
  48. </div>
  49. </div>
  50. <h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">()</span> </h3>
  51. <div class="method">
  52. <div class="description">
  53. <p>Updates the debug visuals (specifically camera helpers).
  54. Should be called within TileShadowNode's update method.</p>
  55. </div>
  56. </div>
  57. <h2 class="subsection-title">Source</h2>
  58. <p>
  59. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/tsl/shadows/TileShadowNodeHelper.js" target="_blank" rel="noopener" translate="no">examples/jsm/tsl/shadows/TileShadowNodeHelper.js</a>
  60. </p>
  61. </article>
  62. </section>
  63. <script src="../scripts/linenumber.js"></script>
  64. <script src="../scripts/page.js"></script>
  65. </body>
  66. </html>
粤ICP备19079148号