Created doc for RectAreaLightHelper

31749976 · looeee · 5954064b · 31749976 · 31749976
隐藏空白更改
内联并排

Showing with 74 addition and 0 deletion

docs/api/extras/helpers/RectAreaLightHelper.html docs/api/extras/helpers/RectAreaLightHelper.html +73 -0

docs/list.js docs/list.js +1 -0

未找到文件。
--- a/docs/api/extras/helpers/RectAreaLightHelper.html
+++ b/docs/api/extras/helpers/RectAreaLightHelper.html
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<base href="../../../" />
+		<script src="list.js"></script>
+		<script src="page.js"></script>
+		<link type="text/css" rel="stylesheet" href="page.css" />
+	</head>
+	<body>
+		[page:Object3D] &rarr;
+
+		<h1>[name]</h1>
+
+		<div class="desc">
+			Creates a visual aid for a [page:RectAreaLight].
+		</div>
+
+		<h3>Example</h3>
+
+		<code>
+var light = new THREE.RectAreaLight( 0xffffbb, 1.0, 5, 5 );
+
+var helper = new THREE.RectAreaLightHelper( light );
+
+scene.add( helper );
+		</code>
+
+
+		<h2>Constructor</h2>
+
+		<h3>[name]( [page:HemisphereLight light] )</h3>
+		<div>[page:HemisphereLight light] -- The light being visualized.</div>
+
+
+		<h2>Properties</h2>
+		<div>See the base [page:Object3D] class for common properties.</div>
+
+		<h3>[property:HemisphereLight light]</h3>
+		<div>Reference to the RectAreaLight being visualized.</div>
+
+		<h3>[property:Mesh lightMat]</h3>
+		<div>[page:MeshBasicMaterial] used to visualize the light. This be be rendered the same color as the [page:.light]</div>
+
+		<h3>[property:Mesh lightMesh]</h3>
+		<div>[page:Mesh] used to visualize the light. Used to show the front (light-emitting side) of the light.</div>
+
+		<h3>[property:Mesh lightShape]</h3>
+		<div>[page:ShapeGeometry] used to create the mesh's that visualize the light.</div>
+
+		<h3>[property:Mesh lightWireMat]</h3>
+		<div>[page:MeshBasicMaterial] used to visualize the light's outline. This be be rendered the same color as the [page:.light]</div>
+
+		<h3>[property:Mesh lightWireMesh]</h3>
+		<div>[page:Mesh] used to visualize the light's outline. Used to show the back (non light-emitting side) of the light.</div>
+
+
+
+		<h2>Methods</h2>
+		<div>See the base [page:Object3D] class for common methods.</div>
+
+		<h3>[method:null dispose]()</h3>
+		<div>Dispose of the rectAreaLightHelper.</div>
+
+		<h3>[method:null update]()</h3>
+		<div>Updates the helper to match the position and direction of the [page:.light].</div>
+
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
--- 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" ]
 		],