SpotLightHelper - Verge3D User Manual - Soft8Soft
Description: Learn how to use SpotLightHelper in your interactive 3D apps made with Verge3D

Object3D →

# SpotLightHelper

This displays a cone shaped helper object for a SpotLight.

## Code Example

`const spotLight = new v3d.SpotLight(0xffffff); spotLight.position.set(10, 10, 10); app.scene.add(spotLight); const spotLightHelper = new v3d.SpotLightHelper(spotLight); app.scene.add(spotLightHelper);`

## Constructor

### SpotLightHelper(light : SpotLight, color : Color | Integer | String)

- light — the SpotLight to be 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 inherited properties.

### # .cone : LineSegments

LineSegments used to visualize the light.

### # .light : SpotLight

Reference to the SpotLight being visualized.

### # .matrix : Object

Reference to the spotLight's matrixWorld.

### # .matrixAutoUpdate : Object

See Object3D.matrixAutoUpdate. Set to `false` here as the helper is using the spotLight'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 Object3D class for inherited 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 light helper.

## Source

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