Browse Source

Updated light and ambientLight docs

Lewy Blue 8 years ago
parent
commit
5b521a9fbc
2 changed files with 62 additions and 28 deletions
  1. 31 13
      docs/api/lights/AmbientLight.html
  2. 31 15
      docs/api/lights/Light.html

+ 31 - 13
docs/api/lights/AmbientLight.html

@@ -13,17 +13,20 @@
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
 		<div class="desc">
 		<div class="desc">
-			This light's color gets applied to all the objects in the scene globally.
+			This light globally illuminates all objects in the scene equally. It does not have a direction
+			so can't be used to cast shadows. 
 		</div>
 		</div>
 
 
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
-		<div>[example:canvas_camera_orthographic camera / orthographic ]</div>
-		<div>[example:canvas_interactive_voxelpainter interactive / voxelpainter ]</div>
-		<div>[example:canvas_materials materials ]</div>
-		<div>[example:canvas_sandbox sandbox ]</div>
-		<div>[example:webgl_animation_cloth animation / cloth ]</div>
-		<div>[example:webgl_animation_skinning_blending animation / skinning / blending ]</div>
+		<div>
+			[example:canvas_camera_orthographic camera / orthographic ]<br />
+		  [example:canvas_interactive_voxelpainter interactive / voxelpainter ]<br />
+		  [example:canvas_materials materials ]<br />
+		  [example:canvas_sandbox sandbox ]<br />
+		  [example:webgl_animation_cloth animation / cloth ]<br />
+		  [example:webgl_animation_skinning_blending animation / skinning / blending ]
+		</div>
 
 
 <code>var light = new THREE.AmbientLight( 0x404040 ); // soft white light
 <code>var light = new THREE.AmbientLight( 0x404040 ); // soft white light
 scene.add( light );</code>
 scene.add( light );</code>
@@ -33,20 +36,35 @@ scene.add( light );</code>
 		<h3>[name]( [page:Integer color], [page:Float intensity] )</h3>
 		<h3>[name]( [page:Integer color], [page:Float intensity] )</h3>
 		<div>
 		<div>
 		[page:Integer color] — Numeric value of the RGB component of the color. <br />
 		[page:Integer color] — Numeric value of the RGB component of the color. <br />
-		[page:Float intensity] -- Numeric value of the light's strength/intensity.
+		[page:Float intensity] -- Numeric value of the light's strength/intensity.<br /><br />
+
+		Creates a new [name].
 		</div>
 		</div>
+
+		<h2>Properties</h2>
 		<div>
 		<div>
-		This creates an Ambientlight with a color and intensity.
+				See the base [page:Light Light] class for common properties.
 		</div>
 		</div>
 
 
-		<h2>Properties</h2>
+		<h3>[property:Boolean castShadow]</h3>
+		<div>
+			This is set to *undefined* in the constructor as ambient lights cannot cast shadows.
+		</div>
 
 
-		See the base [page:Light Light] class for common properties.
 
 
-		<h2>Methods</h2>
+		<h3>[property:Boolean isAmbientLight]</h3>
+		<div>
+			Used to check whether this or derived classes are ambient lights. Default is *true*.<br /><br />
+
+			You should not change this, as it used internally for optimisation.
+		</div>
 
 
-		See the base [page:Light Light] class for common methods.
 
 
+
+		<h2>Methods</h2>
+		<div>
+				See the base [page:Light Light] class for common methods.
+		</div>
 		<h2>Source</h2>
 		<h2>Source</h2>
 
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 31 - 15
docs/api/lights/Light.html

@@ -12,7 +12,10 @@
 
 
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">Abstract base class for lights.</div>
+		<div class="desc">
+			Abstract base class for lights - all other light types inherit the properties and methods
+			described here.
+		</div>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
@@ -20,37 +23,50 @@
 
 
 		<h3>[name]( [page:Integer color], [page:float intensity] )</h3>
 		<h3>[name]( [page:Integer color], [page:float intensity] )</h3>
 		<div>
 		<div>
-		[page:Integer color] — Numeric value of the RGB component of the color.<br />
-		[page:Float intensity] — Numeric value of the light's strength/intensity.
-		</div>
-		<div>
-		This creates a light with color and intensity.<br />
+		[page:Integer color] - (optional) hexadecimal color of the light. Default is 0xffffff (white).<br />
+		[page:Float intensity] - (optional) numeric value of the light's strength/intensity. Default is 1.<br /><br />
+
+		Creates a new [name]. Note that this is not intended to be called directly (use one of <thead>
+			derived classes instead).
+		</thead>)
 		</div>
 		</div>
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
-
-		See the base [page:Object3D Object3D] class for common properties.
+		<div>
+			See the base [page:Object3D Object3D] class for common properties.
+		</div>
 
 
 		<h3>[property:Color color]</h3>
 		<h3>[property:Color color]</h3>
 		<div>
 		<div>
-			Color of the light.<br />
+			Color of the light. Defaults to a new [page:Color] set to white, if not passed in the constructor.<br />
 		</div>
 		</div>
 
 
 		<h3>[property:Float intensity]</h3>
 		<h3>[property:Float intensity]</h3>
 		<div>
 		<div>
-			Light's intensity.<br />
-			In "physically correct" mode, the product of color * intensity is interpreted as luminous intensity measured in candela.<br/>
-			Default — *1.0*.
+			The light's intensity, or strength.<br />
+			In [page:WebGLRenderer.physicallyCorrectLights physically correct] mode, the product of
+			[page:.color color] * intensity is interpreted as luminous intensity measured in candela.<br />
+			Default - *1.0*.
 		</div>
 		</div>
 
 
+		<h3>[property:Boolean isLight]</h3>
+		<div>
+			Used to check whether this or derived classes are lights. Default is *true*.<br /><br />
+
+			You should not change this, as it used internally for optimisation.
+		</div>
+
+
 		<h2>Methods</h2>
 		<h2>Methods</h2>
+		<div>
+			See the base [page:Object3D Object3D] class for common methods.
+		</div>
 
 
-		See the base [page:Object3D Object3D] class for common methods.
 
 
 		<h3>[method:Light copy]( [page:Light source] )</h3>
 		<h3>[method:Light copy]( [page:Light source] )</h3>
 		<div>
 		<div>
-		<br />
-		Copies value of *source* to this Light object.
+		Copies the value of [page:.color color] and [page:.intensity intensity] from the
+		[page:Light source] light into this one.
 		</div>
 		</div>
 
 
 		<h3>[method:JSON toJSON]( [page:String meta] )</h3>
 		<h3>[method:JSON toJSON]( [page:String meta] )</h3>