Object3D → Line →

RectAreaLightHelper

Creates a visual aid for a RectAreaLight.

Code Example


    const light = new v3d.RectAreaLight(0xffffbb, 1.0, 5, 5);
    const helper = new RectAreaLightHelper(light);
    light.add(helper); // helper must be added as a child of the light

Constructor

RectAreaLightHelper(light : RectAreaLight, color : Color | Integer | String)

light — The light being visualized.
color — (optional) if this is not the set the helper will take the color of the light.

Properties

See the base Object3D class for common properties.

# .light : RectAreaLight

Reference to the RectAreaLight being visualized.

# .color : Color

The color parameter passed in the constructor. Default is undefined. If this is changed, the helper's color will update the next time update is called.

Methods

See the base Line class for common methods.

# .dispose()

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Source

For more info on how to obtain the source code of this module see this page.