DirectionalLight.html 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <script src="../../list.js"></script>
  6. <script src="../../page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="../../page.css" />
  8. </head>
  9. <body>
  10. [page:Object3D] &rarr; [page:Light] &rarr;
  11. <h1>[name]</h1>
  12. <div class="desc">
  13. Affects objects using [page:MeshLambertMaterial] or [page:MeshPhongMaterial].
  14. </div>
  15. <h2>Example</h2>
  16. <code>// White directional light at half intensity shining from the top.
  17. var directionalLight = new THREE.DirectionalLight( 0xffffff, 0.5 );
  18. directionalLight.position.set( 0, 1, 0 );
  19. scene.add( directionalLight );</code>
  20. <h2>Constructor</h2>
  21. <h3>[name]( [page:Float hex], [page:Float intensity], [page:Float distance] )</h3>
  22. <h2>Properties</h2>
  23. <h3>.[page:Vector3 position]</h3>
  24. <div>
  25. Direction of the light is normalized vector from *position* to *(0,0,0)*.<br />
  26. Default — *new THREE.Vector3()*.
  27. </div>
  28. <h3>.[page:Object3D target]</h3>
  29. <div>
  30. Target used for shadow camera orientation.
  31. </div>
  32. <h3>.[page:Float intensity]</h3>
  33. <div>
  34. Light's intensity.<br />
  35. Default — *1.0*.
  36. </div>
  37. <h3>.[page:Float distance]</h3>
  38. <div>
  39. If non-zero, light will attenuate linearly from maximum intensity at light *position* down to zero at *distance*.<br />
  40. Default — *0.0*.
  41. </div>
  42. <h3>.[page:Boolean castShadow]</h3>
  43. <div>
  44. If set to *true* light will cast dynamic shadows. *Warning*: This is expensive and requires tweaking to get shadows looking right.<br />
  45. Default — *false*.
  46. </div>
  47. <h3>.[page:Boolean onlyShadow]</h3>
  48. <div>
  49. If set to *true* light will only cast shadow but not contribute any lighting (as if *intensity* was 0 but cheaper to compute).<br />
  50. Default — *false*.
  51. </div>
  52. <h3>.[page:Float shadowCameraNear]</h3>
  53. <div>
  54. Orthographic shadow camera frustum parameter.<br />
  55. Default — *50*.
  56. </div>
  57. <h3>.[page:Float shadowCameraFar]</h3>
  58. <div>
  59. Orthographic shadow camera frustum parameter.<br />
  60. Default — *5000*.
  61. </div>
  62. <h3>.[page:Float shadowCameraLeft]</h3>
  63. <div>
  64. Orthographic shadow camera frustum parameter.<br />
  65. Default — *-500*.
  66. </div>
  67. <h3>.[page:Float shadowCameraRight]</h3>
  68. <div>
  69. Orthographic shadow camera frustum parameter.<br />
  70. Default — *500*.
  71. </div>
  72. <h3>.[page:Float shadowCameraTop]</h3>
  73. <div>
  74. Orthographic shadow camera frustum parameter.<br />
  75. Default — *500*.
  76. </div>
  77. <h3>.[page:Float shadowCameraBottom]</h3>
  78. <div>
  79. Orthographic shadow camera frustum parameter.<br />
  80. Default — *-500*.
  81. </div>
  82. <h3>.[page:Boolean shadowCameraVisible]</h3>
  83. <div>
  84. Show debug shadow camera frustum.<br />
  85. Default — *false*.
  86. </div>
  87. <h3>.[page:Float shadowBias]</h3>
  88. <div>
  89. Shadow map bias.<br />
  90. Default — *0*.
  91. </div>
  92. <h3>.[page:Float shadowDarkness]</h3>
  93. <div>
  94. Darkness of shadow casted by this light (from *0* to *1*).<br />
  95. Default — *0.5*.
  96. </div>
  97. <h3>.[page:Integer shadowMapWidth]</h3>
  98. <div>
  99. Shadow map texture width in pixels.<br />
  100. Default — *512*.
  101. </div>
  102. <h3>.[page:Integer shadowMapHeight]</h3>
  103. <div>
  104. Shadow map texture height in pixels.<br />
  105. Default — *512*.
  106. </div>
  107. <h3>.[page:Boolean shadowCascade]</h3>
  108. <h3>.[page:Vector3 shadowCascadeOffset]</h3>
  109. <h3>.[page:Integer shadowCascadeCount]</h3>
  110. <h3>.[page:Array shadowCascadeBias]</h3>
  111. <h3>.[page:Array shadowCascadeWidth]</h3>
  112. <h3>.[page:Array shadowCascadeHeight]</h3>
  113. <h3>.[page:Array shadowCascadeNearZ]</h3>
  114. <h3>.[page:Array shadowCascadeFarZ]</h3>
  115. <h3>.[page:Array shadowCascadeArray]</h3>
  116. <h3>.[page:RenderTarget shadowMap]</h3>
  117. <h3>.[page:Integer shadowMapSize]</h3>
  118. <h3>.[page:Camera shadowCamera]</h3>
  119. <h3>.[page:Matrix shadowMatrix]</h3>
  120. <h2>Source</h2>
  121. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  122. </body>
  123. </html>