diff --git a/docs/api/lights/HemisphereLight.html b/docs/api/lights/HemisphereLight.html index f6bc2acc946c2b06c2f988b223a16b1f78af6c40..0548bc498001143e41d3834c84263260ec687fa5 100644 --- a/docs/api/lights/HemisphereLight.html +++ b/docs/api/lights/HemisphereLight.html @@ -12,40 +12,73 @@

[name]

-
A light source positioned directly above the scene.
+
+ A light source positioned directly above the scene, with color fading from the sky color to the ground color. + This light cannot be used to cast shadows. +

Example

-
[example:webgl_lights_hemisphere lights / hemisphere ]
-
[example:misc_controls_pointerlock controls / pointerlock ]
-
[example:webgl_decals decals ]
-
[example:webgl_loader_collada_kinematics loader / collada / kinematics ]
-
[example:webgl_materials_lightmap materials / lightmap ]
-
[example:webgl_shaders_ocean shaders / ocean ]
+
+ [example:webgl_lights_hemisphere lights / hemisphere ]
+ [example:misc_controls_pointerlock controls / pointerlock ]
+ [example:webgl_decals decals ]
+ [example:webgl_loader_collada_kinematics loader / collada / kinematics ]
+ [example:webgl_materials_lightmap materials / lightmap ]
+ [example:webgl_shaders_ocean shaders / ocean ] +
-var light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 ); -scene.add( light ); + +var light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 ); +scene.add( light ); +

Constructor

- -

[name]( [page:Integer skyColor], [page:Integer groundColor], [page:Float intensity] )

-
- [page:Integer skyColor] — Numeric value of the RGB sky color.
- [page:Integer groundColor] — Numeric value of the RGB ground color.
- [page:Float intensity] — Numeric value of the light's strength/intensity. +
+ [page:Integer skyColor] - (optional) hexadecimal color of the sky. Default is 0xffffff.
+ [page:Integer groundColor] - (optional) hexadecimal color of the ground. Default is 0xffffff.
+ [page:Float intensity] - (optional) numeric value of the light's strength/intensity. Default is 1.

+ + Creates a new [name].

Properties

+
+ See the base [page:Light Light] class for common properties. +
+ +

[property:Boolean castShadow]

+
+ This is set to *undefined* in the constructor as hemisphere lights cannot cast shadows. +
- See the base [page:Light Light] class for common properties. + +

[property:Float color]

+
+ The light's sky color, as passed in the constructor. + Default is a new [page:Color] set to white (0xffffff). +

[property:Float groundColor]

+
+ The light's ground color, as passed in the constructor. + Default is a new [page:Color] set to white (0xffffff). +
+

[property:Boolean isHemisphereLight]

- Light's ground color.
+ Used to check whether this or derived classes are hemisphere lights. Default is *true*.

+ + You should not change this, as it used internally for optimisation.
+

[property:Vector3 position]

+
+ This is set equal to [page:Object3D.DefaultUp], so that the light shines from the top down. +
+ +

Methods

@@ -53,8 +86,8 @@ scene.add( light );

[method:HemisphereLight copy]( [page:HemisphereLight source] )

-
- Copies value of *source* to this HemisphereLight object. + Copies the value of [page:.color color], [page:.intensity intensity] and + [page:.groundColor groundColor] from the [page:Light source] light into this one.

Source