MeshStandardNodeMaterial.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>MeshStandardNodeMaterial - 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="Material.html">Material</a> → <a href="NodeMaterial.html">NodeMaterial</a> → </p>
  13. <h1 translate="no">MeshStandardNodeMaterial</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Node material version of <a href="MeshStandardMaterial.html">MeshStandardMaterial</a>.</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="MeshStandardNodeMaterial" translate="no">new <a href="#MeshStandardNodeMaterial">MeshStandardNodeMaterial</a><span class="signature">( parameters : <span class="param-type">Object</span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new mesh standard node material.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name">
  30. <strong>parameters</strong>
  31. </td>
  32. <td class="description last">
  33. <p>The configuration parameter.</p>
  34. </td>
  35. </tr>
  36. </tbody>
  37. </table>
  38. </div>
  39. </div>
  40. <h2 class="subsection-title">Properties</h2>
  41. <div class="member">
  42. <h3 class="name" id="emissiveNode" translate="no">.<a href="#emissiveNode">emissiveNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec3></span> </h3>
  43. <div class="description">
  44. <p>The emissive color of standard materials is by default inferred from the <code>emissive</code>,
  45. <code>emissiveIntensity</code> and <code>emissiveMap</code> properties. This node property allows to
  46. overwrite the default and define the emissive color with a node instead.</p>
  47. <p>If you don't want to overwrite the emissive color but modify the existing
  48. value instead, use <a href="TSL.html#materialEmissive">materialEmissive</a>.</p>
  49. <p>Default is <code>null</code>.</p>
  50. </div>
  51. </div>
  52. <div class="member">
  53. <h3 class="name" id="isMeshStandardNodeMaterial" translate="no">.<a href="#isMeshStandardNodeMaterial">isMeshStandardNodeMaterial</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  54. <div class="description">
  55. <p>This flag can be used for type testing.</p>
  56. <p>Default is <code>true</code>.</p>
  57. </div>
  58. </div>
  59. <div class="member">
  60. <h3 class="name" id="lights" translate="no">.<a href="#lights">lights</a><span class="type-signature"> : boolean</span> </h3>
  61. <div class="description">
  62. <p>Set to <code>true</code> because standard materials react on lights.</p>
  63. <p>Default is <code>true</code>.</p>
  64. </div>
  65. <dl class="details">
  66. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#lights">NodeMaterial#lights</a></dt>
  67. </dl>
  68. </div>
  69. <div class="member">
  70. <h3 class="name" id="metalnessNode" translate="no">.<a href="#metalnessNode">metalnessNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  71. <div class="description">
  72. <p>The metalness of standard materials is by default inferred from the <code>metalness</code>,
  73. and <code>metalnessMap</code> properties. This node property allows to
  74. overwrite the default and define the metalness with a node instead.</p>
  75. <p>If you don't want to overwrite the metalness but modify the existing
  76. value instead, use <a href="TSL.html#materialMetalness">materialMetalness</a>.</p>
  77. <p>Default is <code>null</code>.</p>
  78. </div>
  79. </div>
  80. <div class="member">
  81. <h3 class="name" id="roughnessNode" translate="no">.<a href="#roughnessNode">roughnessNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  82. <div class="description">
  83. <p>The roughness of standard materials is by default inferred from the <code>roughness</code>,
  84. and <code>roughnessMap</code> properties. This node property allows to
  85. overwrite the default and define the roughness with a node instead.</p>
  86. <p>If you don't want to overwrite the roughness but modify the existing
  87. value instead, use <a href="TSL.html#materialRoughness">materialRoughness</a>.</p>
  88. <p>Default is <code>null</code>.</p>
  89. </div>
  90. </div>
  91. <h2 class="subsection-title">Methods</h2>
  92. <h3 class="name name-method" id="setupEnvironment" translate="no">.<a href="#setupEnvironment">setupEnvironment</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span><span class="type-signature"> : <a href="EnvironmentNode.html">EnvironmentNode</a>.&lt;vec3></span> </h3>
  93. <div class="method">
  94. <div class="description">
  95. <p>Overwritten since this type of material uses <a href="EnvironmentNode.html">EnvironmentNode</a>
  96. to implement the PBR (PMREM based) environment mapping. Besides, the
  97. method honors <code>Scene.environment</code>.</p>
  98. </div>
  99. <table class="params">
  100. <tbody>
  101. <tr>
  102. <td class="name">
  103. <strong>builder</strong>
  104. </td>
  105. <td class="description last">
  106. <p>The current node builder.</p>
  107. </td>
  108. </tr>
  109. </tbody>
  110. </table>
  111. <dl class="details">
  112. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#setupEnvironment">NodeMaterial#setupEnvironment</a></dt>
  113. </dl>
  114. <dl class="details">
  115. <dt class="tag-returns"><strong>Returns:</strong> The environment node.</dt>
  116. </dl>
  117. </div>
  118. <h3 class="name name-method" id="setupLightingModel" translate="no">.<a href="#setupLightingModel">setupLightingModel</a><span class="signature">()</span><span class="type-signature"> : <a href="PhysicalLightingModel.html">PhysicalLightingModel</a></span> </h3>
  119. <div class="method">
  120. <div class="description">
  121. <p>Setups the lighting model.</p>
  122. </div>
  123. <dl class="details">
  124. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#setupLightingModel">NodeMaterial#setupLightingModel</a></dt>
  125. </dl>
  126. <dl class="details">
  127. <dt class="tag-returns"><strong>Returns:</strong> The lighting model.</dt>
  128. </dl>
  129. </div>
  130. <h3 class="name name-method" id="setupSpecular" translate="no">.<a href="#setupSpecular">setupSpecular</a><span class="signature">()</span> </h3>
  131. <div class="method">
  132. <div class="description">
  133. <p>Setups the specular related node variables.</p>
  134. </div>
  135. </div>
  136. <h3 class="name name-method" id="setupVariants" translate="no">.<a href="#setupVariants">setupVariants</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> </h3>
  137. <div class="method">
  138. <div class="description">
  139. <p>Setups the standard specific node variables.</p>
  140. </div>
  141. <table class="params">
  142. <tbody>
  143. <tr>
  144. <td class="name">
  145. <strong>builder</strong>
  146. </td>
  147. <td class="description last">
  148. <p>The current node builder.</p>
  149. </td>
  150. </tr>
  151. </tbody>
  152. </table>
  153. <dl class="details">
  154. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#setupVariants">NodeMaterial#setupVariants</a></dt>
  155. </dl>
  156. </div>
  157. <h2 class="subsection-title">Source</h2>
  158. <p>
  159. <a href="https://github.com/mrdoob/three.js/blob/master/src/materials/nodes/MeshStandardNodeMaterial.js" translate="no" target="_blank" rel="noopener">src/materials/nodes/MeshStandardNodeMaterial.js</a>
  160. </p>
  161. </article>
  162. </section>
  163. <script src="../scripts/linenumber.js"></script>
  164. <script src="../scripts/page.js"></script>
  165. </body>
  166. </html>
粤ICP备19079148号