瀏覽代碼

Updated description of DirectionalLightHelper doc

looeee 8 年之前
父節點
當前提交
bf4ec128ab
共有 1 個文件被更改,包括 12 次插入10 次删除
  1. 12 10
      docs/api/extras/helpers/DirectionalLightHelper.html

+ 12 - 10
docs/api/extras/helpers/DirectionalLightHelper.html

@@ -12,14 +12,18 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">Helper object to assist with visualizing a [page:DirectionalLight]'s effect on the scene.</div>
+		<div class="desc">
+			Helper object to assist with visualizing a [page:DirectionalLight]'s effect on the scene.
+
+			This consists of plane and a line representing the light's position and direction.
+		</div>
 
 		<h2>Example</h2>
 
 		<code>
 		var light = new THREE.DirectionalLight( 0xFFFFFF );
 
-		var helper = new THREE.DirectionalLightHelper( light );
+		var helper = new THREE.DirectionalLightHelper( light, 5 );
 
 		scene.add( helper );
 		</code>
@@ -30,10 +34,8 @@
 
 		<h3>[name]( [page:DirectionalLight light], [page:Number size] )</h3>
 		<div>
-		[page:DirectionalLight light]-- Light to visualize. <br />
+		[page:DirectionalLight light]-- The light to be visualized. <br />
 		[page:Number size] -- (optional) dimensions of the plane. Default is *1*.<br /><br />
-
-		Creates a line and plane to visualize the light's position and direction.
 		</div>
 
 
@@ -45,10 +47,10 @@
 		<div>Contains the line mesh showing the location of the directional light.</div>
 
 		<h3>[property:DirectionalLight light]</h3>
-		<div>Contains the directionalLight.</div>
+		<div>Reference to the [page:DirectionalLight directionalLight] being visualized.</div>
 
 		<h3>[property:object matrix]</h3>
-		<div>Reference to the [page:Object3D.matrixWorld light.matrixWorld].</div>
+		<div>Reference to the light's [page:Object3D.matrixWorld matrixWorld].</div>
 
 		<h3>[property:object matrixAutoUpdate]</h3>
 		<div>
@@ -61,12 +63,12 @@
 		<h2>Methods</h2>
 		<div>See the base [page:Object3D] class for common properties.</div>
 
-		<h3>.[method:null dispose]()</h3>
+		<h3>[method:null dispose]()</h3>
 		<div>Dispose of the directionalLightHelper.</div>
 
 
-		<h3>.[method:null update]()</h3>
-		<div>Updates the helper to match the position and direction of the [page:.light].</div>
+		<h3>[method:null update]()</h3>
+		<div>Updates the helper to match the position and direction of the [page:.light directionalLight] being visualized.</div>
 
 		<h2>Source</h2>