[page:Mesh] →
[name]
This displays a helper object consisting of a spherical [page:Mesh] for visualizing
a [page:PointLight].
Example
[example:webgl_helpers WebGL / helpers]
var pointLight = new v3d.PointLight(0xff0000, 1, 100);
pointLight.position.set(10, 10, 10);
scene.add(pointLight);
var sphereSize = 1;
var pointLightHelper = new v3d.PointLightHelper(pointLight, sphereSize);
scene.add(pointLightHelper);
Constructor
[name]([page:PointLight light], [page:Float sphereSize], [page:Hex color])
[page:PointLight light] -- The light to be visualized.
[page:Float sphereSize] -- (optional) The size of the sphere helper. Default is *1*.
[page:Hex color] -- (optional) if this is not the set the helper will take the color of the light.
Properties
See the base [page:Mesh] class for common properties.
[property:PointLight light]
The [page:PointLight] that is being visualized.
[property:object matrix]
Reference to the pointLight's [page:Object3D.matrixWorld matrixWorld].
[property:object matrixAutoUpdate]
See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
pointLight's [page:Object3D.matrixWorld matrixWorld].
[property:hex color]
The color parameter passed in the constructor. Default is *undefined*. If this is changed, the helper's color will update
the next time [page:.update update] is called.
Methods
See the base [page:Mesh] class for common methods.
[method:null dispose]()
Dispose of the pointLightHelper.
[method:null update]()
Updates the helper to match the position of the [page:.light].
[sourceHint]