LineDashedMaterial.html 2.6 KB

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