Reference Source
public class | source

DirLight

Extends:

ComponentLight → DirLight

A directional light source that illuminates all Meshes equally from a given direction.

Usage

In the example below we'll replace the Scene's default light sources with three View-space DirLights.

[Run this example]

import {Viewer} from "../src/viewer/Viewer.js";
import {Mesh} from "../src/scene/mesh/Mesh.js";
import {buildSphereGeometry} from "../src/scene/geometry/builders/buildSphereGeometry.js";
import {buildPlaneGeometry} from "../src/scene/geometry/builders/buildPlaneGeometry.js";
import {ReadableGeometry} from "../src/scene/geometry/ReadableGeometry.js";
import {PhongMaterial} from "../src/scene/materials/PhongMaterial.js";
import {Texture} from "../src/scene/materials/Texture.js";
import {DirLight} from "../src/scene/lights/DirLight.js";

// Create a Viewer and arrange the camera

const viewer = new Viewer({
     canvasId: "myCanvas"
});

viewer.scene.camera.eye = [0, 0, 5];
viewer.scene.camera.look = [0, 0, 0];
viewer.scene.camera.up = [0, 1, 0];

// Replace the Scene's default lights with three custom view-space DirLights

viewer.scene.clearLights();

new DirLight(viewer.scene, {
     id: "keyLight",
     dir: [0.8, -0.6, -0.8],
     color: [1.0, 0.3, 0.3],
     intensity: 1.0,
     space: "view"
});

new DirLight(viewer.scene, {
     id: "fillLight",
     dir: [-0.8, -0.4, -0.4],
     color: [0.3, 1.0, 0.3],
     intensity: 1.0,
     space: "view"
});

new DirLight(viewer.scene, {
     id: "rimLight",
     dir: [0.2, -0.8, 0.8],
     color: [0.6, 0.6, 0.6],
     intensity: 1.0,
     space: "view"
});


// Create a sphere and ground plane

new Mesh(viewer.scene, {
     geometry: new ReadableGeometry(viewer.scene, buildSphereGeometry({
         radius: 2.0
     }),
     material: new PhongMaterial(viewer.scene, {
         diffuse: [0.7, 0.7, 0.7],
         specular: [1.0, 1.0, 1.0],
         emissive: [0, 0, 0],
         alpha: 1.0,
         ambient: [1, 1, 0],
         diffuseMap: new Texture(viewer.scene, {
             src: "textures/diffuse/uvGrid2.jpg"
         })
     })
 });

new Mesh(viewer.scene, {
     geometry: buildPlaneGeometry(ReadableGeometry, viewer.scene, {
         xSize: 30,
         zSize: 30
     }),
     material: new PhongMaterial(viewer.scene, {
         diffuseMap: new Texture(viewer.scene, {
             src: "textures/diffuse/uvGrid2.jpg"
         }),
         backfaces: true
     }),
     position: [0, -2.1, 0]
});

Constructor Summary

Public Constructor
public

constructor(owner: Component, cfg: *)

Member Summary

Public Members
public set

castsShadow(castsShadow: Boolean)

Sets if this DirLight casts a shadow.

public get

Gets if this DirLight casts a shadow.

public set

color(color: Number[])

Sets the RGB color of this DirLight.

public get

color: Number[]: *

Gets the RGB color of this DirLight.

public set

dir(value: Number[])

Sets the direction in which the DirLight is shining.

public get

dir: Number[]: *

Gets the direction in which the DirLight is shining.

public set

intensity(intensity: Number)

Sets the intensity of this DirLight.

public get

Gets the intensity of this DirLight.

Method Summary

Public Methods
public

Destroys this DirLight.

Inherited Summary

From class Component
public get

The Component that owns the lifecycle of this Component, if any.

public

True as soon as this Component has been destroyed

public

ID of this Component, unique within the Scene.

public

meta: *

Arbitrary, user-defined metadata on this component.

public

The parent Scene that contains this Component.

public

viewer: *

public

clear()

Destroys all Components that are owned by this.

public

Destroys this component.

public

error(message: String)

Logs an error for this component to the JavaScript console.

public

fire(event: String, value: Object, forget: Boolean)

Fires an event on this component.

public

Returns true if there are any subscribers to the given event on this component.

public

isType(type: *): *: Boolean

Tests if this component is of the given type, or is a subclass of the given type.

public

log(message: String)

Logs a console debugging message for this component.

public

off(subId: String)

Cancels an event subscription that was previously made with Component#on or Component#once.

public

on(event: String, callback: Function, scope: Object): String

Subscribes to an event on this component.

public

once(event: String, callback: Function, scope: Object)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.

public

warn(message: String)

Logs a warning for this component to the JavaScript console.

Public Constructors

public constructor(owner: Component, cfg: *) source

Override:

Light#constructor

Params:

NameTypeAttributeDescription
owner Component

Owner component. When destroyed, the owner will destroy this DirLight as well.

cfg *
  • optional

The DirLight configuration

cfg.id String
  • optional

Optional ID, unique among all components in the parent Scene, generated automatically when omitted.

cfg.dir Number[]
  • optional
  • default: [1.0, 1.0, 1.0]

A unit vector indicating the direction that the light is shining, given in either World or View space, depending on the value of the space parameter.

cfg.color Number[]
  • optional
  • default: [0.7, 0.7, 0.8 ]

The color of this DirLight.

cfg.intensity Number
  • optional
  • default: 1.0

The intensity of this DirLight, as a factor in range [0..1].

cfg.space String
  • optional
  • default: "view"

The coordinate system the DirLight is defined in - "view" or "space".

cfg.castsShadow Boolean
  • optional
  • default: false

Flag which indicates if this DirLight casts a castsShadow.

Public Members

public set castsShadow(castsShadow: Boolean) source

Sets if this DirLight casts a shadow.

Default value is false.

public get castsShadow: Boolean: * source

Gets if this DirLight casts a shadow.

Default value is false.

Return:

Boolean

true if this DirLight casts shadows.

public set color(color: Number[]) source

Sets the RGB color of this DirLight.

Default value is [0.7, 0.7, 0.8].

public get color: Number[]: * source

Gets the RGB color of this DirLight.

Default value is [0.7, 0.7, 0.8].

Return:

Number[]

The DirLight's RGB color.

public set dir(value: Number[]) source

Sets the direction in which the DirLight is shining.

Default value is [1.0, 1.0, 1.0].

public get dir: Number[]: * source

Gets the direction in which the DirLight is shining.

Default value is [1.0, 1.0, 1.0].

Return:

Number[]

The direction vector.

public set intensity(intensity: Number) source

Sets the intensity of this DirLight.

Default intensity is 1.0 for maximum intensity.

public get intensity: Number: * source

Gets the intensity of this DirLight.

Default value is 1.0 for maximum intensity.

Return:

Number

The DirLight's intensity.

Public Methods

public destroy() source

Destroys this DirLight.

Override:

Component#destroy