Browse Source

Updated docs for RectAreaLightHelper

Lewy Blue 8 years ago
parent
commit
fb34fbc5e6
1 changed files with 14 additions and 2 deletions
  1. 14 2
      docs/api/helpers/RectAreaLightHelper.html

+ 14 - 2
docs/api/helpers/RectAreaLightHelper.html

@@ -29,8 +29,14 @@ scene.add( helper );
 
 		<h2>Constructor</h2>
 
-		<h3>[name]( [page:RectAreaLight light] )</h3>
-		<div>[page:RectAreaLight light] -- The light being visualized.</div>
+		<h3>[name]( [page:RectAreaLight light], [page:Hex overrideColor] )</h3>
+		<div>
+			[page:RectAreaLight light] -- The light being visualized.<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>
 
 
 		<h2>Properties</h2>
@@ -39,6 +45,12 @@ scene.add( helper );
 		<h3>[property:RectAreaLight light]</h3>
 		<div>Reference to the RectAreaLight being visualized.</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>
 		<div>See the base [page:Object3D] class for common methods.</div>