123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8" />
- <base href="../../../" />
- <script src="page.js"></script>
- <link type="text/css" rel="stylesheet" href="page.css" />
- </head>
- <body>
- [page:Object3D] → [page:Line] →
- <h1>[name]</h1>
- <p class="desc">
- Creates a visual aid for a [page:RectAreaLight].
- </p>
- <h2>Import</h2>
- <p>
- [name] is an add-on, and must be imported explicitly.
- See [link:#manual/introduction/Installation Installation / Addons].
- </p>
- <code>
- import { RectAreaLightHelper } from 'three/addons/helpers/RectAreaLightHelper.js';
- </code>
- <h2>Code Example</h2>
- <code>
- const light = new THREE.RectAreaLight( 0xffffbb, 1.0, 5, 5 );
- const helper = new RectAreaLightHelper( light );
- light.add( helper ); // helper must be added as a child of the light
- </code>
- <h2>Constructor</h2>
- <h3>[name]( [param:RectAreaLight light], [param:Hex color] )</h3>
- <p>
- [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.
- </p>
- <h2>Properties</h2>
- <p>See the base [page:Object3D] class for common properties.</p>
- <h3>[property:RectAreaLight light]</h3>
- <p>Reference to the RectAreaLight being visualized.</p>
- <h3>[property:hex color]</h3>
- <p>
- 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.
- </p>
- <h2>Methods</h2>
- <p>See the base [page:Line] class for common methods.</p>
- <h3>[method:undefined dispose]()</h3>
- <p>
- Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
- </p>
- <h2>Source</h2>
- <p>
- [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/RectAreaLightHelper.js examples/jsm/helpers/RectAreaLightHelper.js]
- </p>
- </body>
- </html>
|