1
0

ShadowBaseNode.html 4.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>ShadowBaseNode - 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="Node.html">Node</a> → </p>
  13. <h1 translate="no">ShadowBaseNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Base class for all shadow nodes.</p>
  17. <p>Shadow nodes encapsulate shadow related logic and are always coupled to lighting nodes.
  18. Lighting nodes might share the same shadow node type or use specific ones depending on
  19. their requirements.</p></div>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h2>Constructor</h2>
  24. <h3 class="name name-method" id="ShadowBaseNode" translate="no">new <a href="#ShadowBaseNode">ShadowBaseNode</a><span class="signature">( light : <span class="param-type"><a href="Light.html">Light</a></span> )</span> </h3>
  25. <div class="method">
  26. <div class="description">
  27. <p>Constructs a new shadow base node.</p>
  28. </div>
  29. <table class="params">
  30. <tbody>
  31. <tr>
  32. <td class="name">
  33. <strong>light</strong>
  34. </td>
  35. <td class="description last">
  36. <p>The shadow casting light.</p>
  37. </td>
  38. </tr>
  39. </tbody>
  40. </table>
  41. </div>
  42. </div>
  43. <h2 class="subsection-title">Properties</h2>
  44. <div class="member">
  45. <h3 class="name" id="isShadowBaseNode" translate="no">.<a href="#isShadowBaseNode">isShadowBaseNode</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  46. <div class="description">
  47. <p>This flag can be used for type testing.</p>
  48. <p>Default is <code>true</code>.</p>
  49. </div>
  50. </div>
  51. <div class="member">
  52. <h3 class="name" id="light" translate="no">.<a href="#light">light</a><span class="type-signature"> : <a href="Light.html">Light</a></span> </h3>
  53. <div class="description">
  54. <p>The shadow casting light.</p>
  55. </div>
  56. </div>
  57. <div class="member">
  58. <h3 class="name" id="updateBeforeType" translate="no">.<a href="#updateBeforeType">updateBeforeType</a><span class="type-signature"> : string</span> </h3>
  59. <div class="description">
  60. <p>Overwritten since shadows are updated by default per render.</p>
  61. <p>Default is <code>'render'</code>.</p>
  62. </div>
  63. <dl class="details">
  64. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#updateBeforeType">Node#updateBeforeType</a></dt>
  65. </dl>
  66. </div>
  67. <h2 class="subsection-title">Methods</h2>
  68. <h3 class="name name-method" id="setupShadowPosition" translate="no">.<a href="#setupShadowPosition">setupShadowPosition</a><span class="signature">( object : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> </h3>
  69. <div class="method">
  70. <div class="description">
  71. <p>Setups the shadow position node which is by default the predefined TSL node object <code>shadowPositionWorld</code>.</p>
  72. </div>
  73. <table class="params">
  74. <tbody>
  75. <tr>
  76. <td class="name">
  77. <strong>object</strong>
  78. </td>
  79. <td class="description last">
  80. <p>A configuration object that must at least hold a material reference.</p>
  81. </td>
  82. </tr>
  83. </tbody>
  84. </table>
  85. </div>
  86. <h2 class="subsection-title">Source</h2>
  87. <p>
  88. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/lighting/ShadowBaseNode.js" translate="no" target="_blank" rel="noopener">src/nodes/lighting/ShadowBaseNode.js</a>
  89. </p>
  90. </article>
  91. </section>
  92. <script src="../scripts/linenumber.js"></script>
  93. <script src="../scripts/page.js"></script>
  94. </body>
  95. </html>
粤ICP备19079148号