Object3D → Mesh →

PointLightHelper

This displays a helper object consisting of a spherical Mesh for visualizing a PointLight.

Code Example


    const pointLight = new v3d.PointLight(0xff0000, 1, 100);
    pointLight.position.set(10, 10, 10);
    app.scene.add(pointLight);

    const sphereSize = 1;
    const pointLightHelper = new v3d.PointLightHelper(pointLight, sphereSize);
    app.scene.add(pointLightHelper);

Constructor

PointLightHelper(light : PointLight, sphereSize : Float, color : Color | Integer | String)

light — The light to be visualized.
sphereSize — (optional) The size of the sphere helper. Default is 1.
color — (optional) if this is not the set the helper will take the color of the light.

Properties

See the base Mesh class for common properties.

# .light : PointLight

The PointLight that is being visualized.

# .matrix : Object

Reference to the pointLight's matrixWorld.

# .matrixAutoUpdate : Object

See Object3D.matrixAutoUpdate. Set to false here as the helper is using the pointLight's matrixWorld.

# .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 Mesh 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.

# .update()

Updates the helper to match the position of the .light.

Source

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