LineDashedMaterial.html 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:Material] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">A material for drawing wireframe-style geometries with dashed lines.</p>
  14. <h2>Examples</h2>
  15. <p>
  16. [example:webgl_lines_dashed WebGL / lines / dashed]<br />
  17. </p>
  18. <code>
  19. var material = new THREE.LineDashedMaterial( {
  20. color: 0xffffff,
  21. linewidth: 1,
  22. scale: 1,
  23. dashSize: 3,
  24. gapSize: 1,
  25. } );
  26. </code>
  27. <h2>Constructor</h2>
  28. <h3>[name]( [param:Object parameters] )</h3>
  29. <p>
  30. [page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
  31. Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />
  32. The exception is the property [page:Hexadecimal color], which can be passed i as a hexadecimal
  33. string and is *0xffffff* (white) by default. [page:Color.set]( color ) is called internally.
  34. </p>
  35. <h2>Properties</h2>
  36. <p>See the base [page:Material] class for common properties.</p>
  37. <h3>[property:Color color]</h3>
  38. <p>[page:Color] of the material, by default set to white (0xffffff).</p>
  39. <h3>[property:number dashSize]</h3>
  40. <p>The size of the dash. This is both the gap with the stroke. Default is *3*.</p>
  41. <h3>[property:number gapSize]</h3>
  42. <p>The size of the gap. Default is *1*.</p>
  43. <h3>[property:Boolean isLineDashedMaterial]</h3>
  44. <p>
  45. Used to check whether this or derived classes are line dashed materials. Default is *true*.<br /><br />
  46. You should not change this, as it used internally for optimisation.
  47. </p>
  48. <h3>[property:Boolean lights]</h3>
  49. <p>Whether the material is affected by lights. Default is *false*.</p>
  50. <h3>[property:Float linewidth]</h3>
  51. <p>
  52. Controls line thickness. Default is *1*.<br /><br />
  53. Due to limitations of the [link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
  54. with the [page:WebGLRenderer WebGL] renderer on most platforms linewidth will
  55. always be 1 regardless of the set value.
  56. </p>
  57. <h3>[property:number scale]</h3>
  58. <p>The scale of the dashed part of a line. Default is *1*.</p>
  59. <h2>Methods</h2>
  60. <p>See the base [page:Material] class for common methods.</p>
  61. <h2>Source</h2>
  62. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  63. </body>
  64. </html>