Browse Source

Updated docs for DirectionalLightHelper

Lewy Blue 8 years ago
parent
commit
663c01cd11
1 changed files with 14 additions and 4 deletions
  1. 14 4
      docs/api/helpers/DirectionalLightHelper.html

+ 14 - 4
docs/api/helpers/DirectionalLightHelper.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>
@@ -32,10 +32,15 @@
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
 
 
-		<h3>[name]( [page:DirectionalLight light], [page:Number size] )</h3>
+		<h3>[name]( [page:DirectionalLight light], [page:Number size], [page:Hex overrideColor] )</h3>
 		<div>
 		<div>
-		[page:DirectionalLight light]-- The light to be visualized. <br />
-		[page:Number size] -- (optional) dimensions of the plane. Default is *1*.<br /><br />
+			[page:DirectionalLight light]-- The light to be visualized. <br /><br />
+
+			[page:Number size] -- (optional) dimensions of the plane. Default is *1*.<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>
 
 
 
 
@@ -58,6 +63,11 @@
 			light's [page:Object3D.matrixWorld matrixWorld].
 			light'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>