PointLightHelper.html.md 1.4 KB
Inheritance: EventDispatcher → Object3D → Mesh →
PointLightHelper
This displays a helper object consisting of a spherical mesh for visualizing an instance of PointLight.
Code Example
const pointLight = new THREE.PointLight( 0xff0000, 1, 100 );
pointLight.position.set( 10, 10, 10 );
scene.add( pointLight );
const sphereSize = 1;
const pointLightHelper = new THREE.PointLightHelper( pointLight, sphereSize );
scene.add( pointLightHelper );
Constructor
new PointLightHelper( light : PointLight, sphereSize : number, color : number | Color | string )
Constructs a new point light helper.
light
The light to be visualized.
sphereSize
The size of the sphere helper.
Default is 1.
color
The helper's color. If not set, the helper will take the color of the light.
Properties
.color : number | Color | string
The color parameter passed in the constructor. If not set, the helper will take the color of the light.
.light : PointLight
The light being visualized.
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 being visualized.