Explorar o código

Minor updates to HemisphereLightHelper doc

looeee %!s(int64=8) %!d(string=hai) anos
pai
achega
034e9d8da4
Modificáronse 1 ficheiros con 31 adicións e 14 borrados
  1. 31 14
      docs/api/extras/helpers/HemisphereLightHelper.html

+ 31 - 14
docs/api/extras/helpers/HemisphereLightHelper.html

@@ -12,40 +12,57 @@
 
 
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">Creates a visual aid for a [page:HemisphereLight HemisphereLight].</div>
+		<div class="desc">
+			Creates a visual aid for a [page:HemisphereLight HemisphereLight].
+		</div>
+
+		<h3>Example</h3>
+
+		<code>
+			var light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
+
+			var helper = new THREE.HemisphereLightHelper( light, 5 );
+
+			scene.add( helper );
+		</code>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
 		<h3>[name]([page:HemisphereLight light], [page:Number sphereSize])</h3>
 		<h3>[name]([page:HemisphereLight light], [page:Number sphereSize])</h3>
 		<div>
 		<div>
-		light -- The HemisphereLight. <br />
-		sphereSize -- The size of the sphere that shows the location.
-		</div>
-		<div>
-		Creates an helper for the hemispherelight.
+		[page:HemisphereLight light] -- The light being visualized. <br />
+		[page:Number sphereSize] -- The size of the sphere used to visualize te light.
 		</div>
 		</div>
 
 
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
+		<div>See the base [page:Object3D] class for common properties.</div>
+
+		<h3>[property:HemisphereLight light]</h3>
+		<div>Reference to the HemisphereLight being visualized.</div>
 
 
 		<h3>[property:Mesh lightSphere]</h3>
 		<h3>[property:Mesh lightSphere]</h3>
-		<div>
-		The sphere mesh that shows the location of the hemispherelight.
-		</div>
+		<div>The sphere mesh that shows the location of the hemispherelight.</div>
 
 
-		<h3>[property:HemisphereLight light]</h3>
+		<h3>[property:object matrix]</h3>
+		<div>Reference to the hemisphereLight's [page:Object3D.matrixWorld matrixWorld].</div>
+
+		<h3>[property:object matrixAutoUpdate]</h3>
 		<div>
 		<div>
-		Contains the HemisphereLight.
+			See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
+			hemisphereLight's [page:Object3D.matrixWorld matrixWorld].
 		</div>
 		</div>
 
 
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
+		<div>See the base [page:Object3D] class for common methods.</div>
+
+		<h3>[method:null dispose]()</h3>
+		<div>Dispose of the hemisphereLightHelper.</div>
 
 
 		<h3>[method:null update]()</h3>
 		<h3>[method:null update]()</h3>
-		<div>
-		Updates the helper to match the position and direction of the [page:.light].
-		</div>
+		<div>Updates the helper to match the position and direction of the [page:.light].</div>
 
 
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>