瀏覽代碼

Updated docs for SpotLightHelper

Lewy Blue 8 年之前
父節點
當前提交
b9d5838adf
共有 1 個文件被更改,包括 13 次插入3 次删除
  1. 13 3
      docs/api/helpers/SpotLightHelper.html

+ 13 - 3
docs/api/helpers/SpotLightHelper.html

@@ -35,8 +35,14 @@
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:SpotLight light])</h3>
-		<div>light -- The [page:SpotLight] to be visualized.</div>
+		<h3>[name]( [page:SpotLight light], [page:Hex overrideColor] )</h3>
+		<div>
+			[page:SpotLight light] -- The [page:SpotLight] to be 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>
@@ -45,7 +51,6 @@
 		<h3>[property:LineSegments cone]</h3>
 		<div>[page:LineSegments] used to visualize the light.</div>
 
-
 		<h3>[property:SpotLight light]</h3>
 		<div>Reference to the [page:SpotLight] being visualized.</div>
 
@@ -58,6 +63,11 @@
 			spotLight's [page:Object3D.matrixWorld matrixWorld].
 		</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>