Browse Source

Updated docs for HemisphereLightHelper

Lewy Blue 8 years ago
parent
commit
5a4e42e57d
1 changed files with 15 additions and 4 deletions
  1. 15 4
      docs/api/helpers/HemisphereLightHelper.html

+ 15 - 4
docs/api/helpers/HemisphereLightHelper.html

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <!DOCTYPE html>
 <html lang="en">
 <html lang="en">
 	<head>
 	<head>
-		<meta charset="utf-8" />
+		<meta charset="utf-8" />
 		<base href="../../" />
 		<base href="../../" />
 		<script src="list.js"></script>
 		<script src="list.js"></script>
 		<script src="page.js"></script>
 		<script src="page.js"></script>
@@ -29,10 +29,15 @@ scene.add( helper );
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:HemisphereLight light], [page:Number sphereSize])</h3>
+		<h3>[name]( [page:HemisphereLight light], [page:Number sphereSize], [page:Hex overrideColor] )</h3>
 		<div>
 		<div>
-		[page:HemisphereLight light] -- The light being visualized. <br />
-		[page:Number size] -- The size of the mesh used to visualize the light.
+			[page:HemisphereLight light] -- The light being visualized. <br /><br />
+
+			[page:Number size] -- The size of the mesh used to visualize the light.<br /><br />
+			
+			[page:Hex overrideColor] -- (optional) by default the helper will take the color of the light.
+				In cases where this makes the helper difficult to see 
+				(for example a white light against a white background) you can directly set the color here. 
 		</div>
 		</div>
 
 
 
 
@@ -51,6 +56,12 @@ scene.add( helper );
 			hemisphereLight's [page:Object3D.matrixWorld matrixWorld].
 			hemisphereLight's [page:Object3D.matrixWorld matrixWorld].
 		</div>
 		</div>
 
 
+		<h3>[property:hex overrideColor]</h3>
+		<div>
+			A color that overrides the default color of the helper. If this was not passed in the constructor 
+			but is set later, the helper's color will update the next time [page:.update update] is called.
+		</div>
+
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 		<div>See the base [page:Object3D] class for common methods.</div>
 		<div>See the base [page:Object3D] class for common methods.</div>