MeshBasicMaterial.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:Material] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. A material for drawing geometries in a simple shaded (flat or wireframe) way.<br /><br />
  14. This material is not affected by lights.
  15. </p>
  16. <iframe id="scene" src="scenes/material-browser.html#MeshBasicMaterial"></iframe>
  17. <script>
  18. // iOS iframe auto-resize workaround
  19. if ( /(iPad|iPhone|iPod)/g.test( navigator.userAgent ) ) {
  20. const scene = document.getElementById( 'scene' );
  21. scene.style.width = getComputedStyle( scene ).width;
  22. scene.style.height = getComputedStyle( scene ).height;
  23. scene.setAttribute( 'scrolling', 'no' );
  24. }
  25. </script>
  26. <h2>Constructor</h2>
  27. <h3>[name]( [param:Object parameters] )</h3>
  28. <p>
  29. [page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
  30. Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />
  31. The exception is the property [page:Hexadecimal color], which can be passed in as a hexadecimal
  32. string and is *0xffffff* (white) by default. [page:Color.set]( color ) is called internally.
  33. </p>
  34. <h2>Properties</h2>
  35. <p>See the base [page:Material] class for common properties.</p>
  36. <h3>[property:Texture alphaMap]</h3>
  37. <p>The alpha map is a grayscale texture that controls the opacity across the surface
  38. (black: fully transparent; white: fully opaque). Default is null.<br /><br />
  39. Only the color of the texture is used, ignoring the alpha channel if one exists.
  40. For RGB and RGBA textures, the [page:WebGLRenderer WebGL] renderer will use the
  41. green channel when sampling this texture due to the extra bit of precision provided
  42. for green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  43. luminance/alpha textures will also still work as expected.
  44. </p>
  45. <h3>[property:Texture aoMap]</h3>
  46. <p>The red channel of this texture is used as the ambient occlusion map. Default is null.
  47. The aoMap requires a second set of UVs.</p>
  48. <h3>[property:Float aoMapIntensity]</h3>
  49. <p>Intensity of the ambient occlusion effect. Default is 1. Zero is no occlusion effect.</p>
  50. <h3>[property:Color color]</h3>
  51. <p>[page:Color] of the material, by default set to white (0xffffff).</p>
  52. <h3>[property:Integer combine]</h3>
  53. <p>
  54. How to combine the result of the surface's color with the environment map, if any.<br /><br />
  55. Options are [page:Materials THREE.Multiply] (default), [page:Materials THREE.MixOperation],
  56. [page:Materials THREE.AddOperation]. If mix is chosen, the [page:.reflectivity] is used to
  57. blend between the two colors.
  58. </p>
  59. <h3>[property:Texture envMap]</h3>
  60. <p>The environment map. Default is null.</p>
  61. <h3>[property:Texture lightMap]</h3>
  62. <p>The light map. Default is null. The lightMap requires a second set of UVs.</p>
  63. <h3>[property:Float lightMapIntensity]</h3>
  64. <p>Intensity of the baked light. Default is 1.</p>
  65. <h3>[property:Texture map]</h3>
  66. <p>The color map. Default is null.</p>
  67. <h3>[property:Boolean morphTargets]</h3>
  68. <p>Define whether the material uses morphTargets. Default is false.</p>
  69. <h3>[property:Float reflectivity]</h3>
  70. <p>
  71. How much the environment map affects the surface; also see [page:.combine].
  72. The default value is 1 and the valid range is between 0 (no reflections) and 1 (full reflections).
  73. </p>
  74. <h3>[property:Float refractionRatio]</h3>
  75. <p>
  76. The index of refraction (IOR) of air (approximately 1) divided by the index of refraction of the material.
  77. It is used with environment mapping modes [page:Textures THREE.CubeRefractionMapping] and [page:Textures THREE.EquirectangularRefractionMapping].
  78. The refraction ratio should not exceed 1. Default is *0.98*.
  79. </p>
  80. <h3>[property:Texture specularMap]</h3>
  81. <p>Specular map used by the material. Default is null.</p>
  82. <h3>[property:Boolean wireframe]</h3>
  83. <p>Render geometry as wireframe. Default is *false* (i.e. render as flat polygons).</p>
  84. <h3>[property:String wireframeLinecap]</h3>
  85. <p>
  86. Define appearance of line ends. Possible values are "butt", "round" and "square". Default is 'round'.<br /><br />
  87. This corresponds to the [link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap]
  88. property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
  89. </p>
  90. <h3>[property:String wireframeLinejoin]</h3>
  91. <p>
  92. Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.<br /><br />
  93. This corresponds to the [link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin]
  94. property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
  95. </p>
  96. <h3>[property:Float wireframeLinewidth]</h3>
  97. <p>Controls wireframe thickness. Default is 1.<br /><br />
  98. Due to limitations of the [link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
  99. with the [page:WebGLRenderer WebGL] renderer on most platforms linewidth will
  100. always be 1 regardless of the set value.
  101. </p>
  102. <h2>Methods</h2>
  103. <p>See the base [page:Material] class for common methods.</p>
  104. <h2>Source</h2>
  105. <p>
  106. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  107. </p>
  108. </body>
  109. </html>