[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:RectAreaLight light], [page:Hex overrideColor] )

[page:RectAreaLight light] -- The light being visualized.

[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.

Properties

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

[property:RectAreaLight light]

Reference to the RectAreaLight being visualized.

[property:hex overrideColor]

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.

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]