Line2NodeMaterial.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Line2NodeMaterial - 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">Line2NodeMaterial</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>This node material can be used to render lines with a size larger than one
  17. by representing them as instanced meshes.</p></div>
  18. </header>
  19. <article>
  20. <div class="container-overview">
  21. <h2>Constructor</h2>
  22. <h3 class="name name-method" id="Line2NodeMaterial" translate="no">new <a href="#Line2NodeMaterial">Line2NodeMaterial</a><span class="signature">( parameters : <span class="param-type">Object</span> )</span> </h3>
  23. <div class="method">
  24. <div class="description">
  25. <p>Constructs a new node material for wide line rendering.</p>
  26. </div>
  27. <table class="params">
  28. <tbody>
  29. <tr>
  30. <td class="name"><code>parameters</code></td>
  31. <td class="description last"><p>The configuration parameter.<br/>Default is <code>{}</code>.</p></td>
  32. </tr>
  33. </tbody>
  34. </table>
  35. </div>
  36. </div>
  37. <h2 class="subsection-title">Properties</h2>
  38. <div class="member">
  39. <h3 class="name" id="alphaToCoverage" translate="no">.<a href="#alphaToCoverage">alphaToCoverage</a><span class="type-signature"> : boolean</span> </h3>
  40. <div class="description">
  41. <p>Whether alpha to coverage should be used or not.<br/>Default is <code>true</code>.</p>
  42. </div>
  43. <dl class="details">
  44. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#alphaToCoverage">NodeMaterial#alphaToCoverage</a></dt>
  45. </dl>
  46. </div>
  47. <div class="member">
  48. <h3 class="name" id="blending" translate="no">.<a href="#blending">blending</a><span class="type-signature"> : number</span> </h3>
  49. <div class="description">
  50. <p>Blending is set to <code>NoBlending</code> since transparency
  51. is not supported, yet.<br/>Default is <code>0</code>.</p>
  52. </div>
  53. <dl class="details">
  54. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#blending">NodeMaterial#blending</a></dt>
  55. </dl>
  56. </div>
  57. <div class="member">
  58. <h3 class="name" id="dashOffset" translate="no">.<a href="#dashOffset">dashOffset</a><span class="type-signature"> : number</span> </h3>
  59. <div class="description">
  60. <p>The dash offset.<br/>Default is <code>0</code>.</p>
  61. </div>
  62. </div>
  63. <div class="member">
  64. <h3 class="name" id="dashScaleNode" translate="no">.<a href="#dashScaleNode">dashScaleNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  65. <div class="description">
  66. <p>Defines the dash scale.<br/>Default is <code>null</code>.</p>
  67. </div>
  68. </div>
  69. <div class="member">
  70. <h3 class="name" id="dashSizeNode" translate="no">.<a href="#dashSizeNode">dashSizeNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  71. <div class="description">
  72. <p>Defines the dash size.<br/>Default is <code>null</code>.</p>
  73. </div>
  74. </div>
  75. <div class="member">
  76. <h3 class="name" id="dashed" translate="no">.<a href="#dashed">dashed</a><span class="type-signature"> : boolean</span> </h3>
  77. <div class="description">
  78. <p>Whether the lines should be dashed or not.<br/>Default is <code>false</code>.</p>
  79. </div>
  80. </div>
  81. <div class="member">
  82. <h3 class="name" id="gapSizeNode" translate="no">.<a href="#gapSizeNode">gapSizeNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  83. <div class="description">
  84. <p>Defines the gap size.<br/>Default is <code>null</code>.</p>
  85. </div>
  86. </div>
  87. <div class="member">
  88. <h3 class="name" id="isLine2NodeMaterial" translate="no">.<a href="#isLine2NodeMaterial">isLine2NodeMaterial</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  89. <div class="description">
  90. <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
  91. </div>
  92. </div>
  93. <div class="member">
  94. <h3 class="name" id="lineColorNode" translate="no">.<a href="#lineColorNode">lineColorNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec3></span> </h3>
  95. <div class="description">
  96. <p>Defines the lines color.<br/>Default is <code>null</code>.</p>
  97. </div>
  98. </div>
  99. <div class="member">
  100. <h3 class="name" id="offsetNode" translate="no">.<a href="#offsetNode">offsetNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  101. <div class="description">
  102. <p>Defines the offset.<br/>Default is <code>null</code>.</p>
  103. </div>
  104. </div>
  105. <div class="member">
  106. <h3 class="name" id="useColor" translate="no">.<a href="#useColor">useColor</a><span class="type-signature"> : boolean</span> </h3>
  107. <div class="description">
  108. <p>Whether vertex colors should be used or not.<br/>Default is <code>false</code>.</p>
  109. </div>
  110. </div>
  111. <div class="member">
  112. <h3 class="name" id="worldUnits" translate="no">.<a href="#worldUnits">worldUnits</a><span class="type-signature"> : boolean</span> </h3>
  113. <div class="description">
  114. <p>Whether the lines should sized in world units or not.
  115. When set to <code>false</code> the unit is pixel.<br/>Default is <code>false</code>.</p>
  116. </div>
  117. </div>
  118. <h2 class="subsection-title">Methods</h2>
  119. <h3 class="name name-method" id="setup" translate="no">.<a href="#setup">setup</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  120. <div class="method">
  121. <div class="description">
  122. <p>Setups the vertex and fragment stage of this node material.</p>
  123. </div>
  124. <table class="params">
  125. <tbody>
  126. <tr>
  127. <td class="name"><code>builder</code></td>
  128. <td class="description last"><p>The current node builder.</p></td>
  129. </tr>
  130. </tbody>
  131. </table>
  132. <dl class="details">
  133. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#setup">NodeMaterial#setup</a></dt>
  134. </dl>
  135. </div>
  136. <h2 class="subsection-title">Source</h2>
  137. <p>
  138. <a href="https://github.com/mrdoob/three.js/blob/master/src/materials/nodes/Line2NodeMaterial.js" target="_blank" rel="noopener" translate="no">src/materials/nodes/Line2NodeMaterial.js</a>
  139. </p>
  140. </article>
  141. </section>
  142. <script src="../scripts/linenumber.js"></script>
  143. <script src="../scripts/page.js"></script>
  144. </body>
  145. </html>
粤ICP备19079148号