Skip to main content

Object3D

Light

Abstract base class for lights - all other light types inherit the properties and methods described here.

Constructor

Light

function Light( color: Integer, intensity: Float ): void;  

color - (optional) hexadecimal color of the light. Default is 0xffffff (white).
intensity - (optional) numeric value of the light's strength/intensity. Default is 1.

Creates a new Light. Note that this is not intended to be called directly (use one of derived classes instead).

Properties

See the base Object3D class for common properties.

color

color: Color;  

Color of the light. Defaults to a new Color set to white, if not passed in the constructor.

intensity

intensity: Float;  

The light's intensity, or strength.
When legacy lighting mode is disabled, the units of intensity depend on the type of light.
Default - 1.0.

isLight

isLight: Boolean;  

Read-only flag to check if a given object is of type Light.

Methods

See the base Object3D class for common methods.

dispose

function dispose( ): undefined;  

Abstract dispose method for classes that extend this class; implemented by subclasses that have disposable GPU-related resources.

copy

function copy( source: Light ): this;  

Copies the value of .color and .intensity from the .ight light into this one.

toJSON

function toJSON( meta: Object ): Object;  

meta -- object containing metadata such as materials, textures for objects.
Convert the light to three.js JSON Object/Scene format.

Source

src/lights/Light.js