From 3174997690266d0532105e1668fa0b32dfc27929 Mon Sep 17 00:00:00 2001 From: looeee Date: Thu, 17 Nov 2016 14:37:04 +0000 Subject: [PATCH] Created doc for RectAreaLightHelper --- .../extras/helpers/RectAreaLightHelper.html | 73 +++++++++++++++++++ docs/list.js | 1 + 2 files changed, 74 insertions(+) create mode 100644 docs/api/extras/helpers/RectAreaLightHelper.html diff --git a/docs/api/extras/helpers/RectAreaLightHelper.html b/docs/api/extras/helpers/RectAreaLightHelper.html new file mode 100644 index 0000000000..2eb611aae1 --- /dev/null +++ b/docs/api/extras/helpers/RectAreaLightHelper.html @@ -0,0 +1,73 @@ + + + + + + + + + + + [page:Object3D] → + +

[name]

+ +
+ Creates a visual aid for a [page:RectAreaLight]. +
+ +

Example

+ + +var light = new THREE.RectAreaLight( 0xffffbb, 1.0, 5, 5 ); + +var helper = new THREE.RectAreaLightHelper( light ); + +scene.add( helper ); + + + +

Constructor

+ +

[name]( [page:HemisphereLight light] )

+
[page:HemisphereLight light] -- The light being visualized.
+ + +

Properties

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

[property:HemisphereLight light]

+
Reference to the RectAreaLight being visualized.
+ +

[property:Mesh lightMat]

+
[page:MeshBasicMaterial] used to visualize the light. This be be rendered the same color as the [page:.light]
+ +

[property:Mesh lightMesh]

+
[page:Mesh] used to visualize the light. Used to show the front (light-emitting side) of the light.
+ +

[property:Mesh lightShape]

+
[page:ShapeGeometry] used to create the mesh's that visualize the light.
+ +

[property:Mesh lightWireMat]

+
[page:MeshBasicMaterial] used to visualize the light's outline. This be be rendered the same color as the [page:.light]
+ +

[property:Mesh lightWireMesh]

+
[page:Mesh] used to visualize the light's outline. Used to show the back (non light-emitting side) of the light.
+ + + +

Methods

+
See the base [page:Object3D] class for common methods.
+ +

[method:null dispose]()

+
Dispose of the rectAreaLightHelper.
+ +

[method:null update]()

+
Updates the helper to match the position and direction of the [page:.light].
+ + +

Source

+ + [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] + + diff --git a/docs/list.js b/docs/list.js index c62337a631..388126b39f 100644 --- a/docs/list.js +++ b/docs/list.js @@ -119,6 +119,7 @@ var list = { [ "HemisphereLightHelper", "api/extras/helpers/HemisphereLightHelper" ], [ "PointLightHelper", "api/extras/helpers/PointLightHelper" ], [ "SkeletonHelper", "api/extras/helpers/SkeletonHelper" ], + [ "RectAreaLightHelper", "api/extras/helpers/RectAreaLightHelper" ], [ "SpotLightHelper", "api/extras/helpers/SpotLightHelper" ], [ "VertexNormalsHelper", "api/extras/helpers/VertexNormalsHelper" ] ], -- GitLab