12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667 |
- <!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] →
- <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 color] )</h3>
- <div>
- [page:RectAreaLight light] -- The light being visualized.<br /><br />
- [page:Hex color] -- (optional) if this is not the set the helper will take the color of the light.
- </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 color]</h3>
- <div>
- The color parameter passed in the constructor. Default is *undefined*. If this is changed, 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>
|