Updated docs for PointLightHelper

e2b63bcb · Lewy Blue · 5a4e42e5 · e2b63bcb
隐藏空白更改
内联并排

Showing with 15 addition and 6 deletion

docs/api/helpers/PointLightHelper.html docs/api/helpers/PointLightHelper.html +15 -6

未找到文件。
--- a/docs/api/helpers/PointLightHelper.html
+++ b/docs/api/helpers/PointLightHelper.html
 <!DOCTYPE html>
 <html lang="en">
 	<head>
-		<meta charset="utf-8" />
+		<meta charset="utf-8" />
 		<base href="../../" />
 		<script src="list.js"></script>
 		<script src="page.js"></script>
@@ -37,12 +37,16 @@

 		<h2>Constructor</h2>

-		<h3>[name]( [page:PointLight light], [page:Float sphereSize] )</h3>
+		<h3>[name]( [page:PointLight light], [page:Float sphereSize], [page:Hex overrideColor] )</h3>
 		<div>
-		[page:PointLight light] -- The light to be visualized. <br />
-		 [page:Float sphereSize] -- (optional) The size of the sphere helper. Default is *1*.
-		</div>
+		[page:PointLight light] -- The light to be visualized. <br /><br />
+
+		[page:Float sphereSize] -- (optional) The size of the sphere helper. 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>

 		<h2>Properties</h2>
 		<div>See the base [page:Mesh] class for common properties.</div>
@@ -59,7 +63,12 @@
 			pointLight'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:Mesh] class for common methods.</div>