MeshStandardNodeMaterial.html 7.8 KB

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