javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
							<!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:RectAreaLight light], [page:Hex overrideColor] )</h3>
		<div>
			[page:RectAreaLight light] -- The light being visualized.<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:Object3D] class for common properties.</div>

		<h3>[property:RectAreaLight light]</h3>
		<div>Reference to the RectAreaLight being visualized.</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: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>