DirLight

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

• Has an emission direction vector in DirLight#dir, but no position.
• Defined in either World or View coordinate space. When in World-space, DirLight#dir is relative to the World coordinate system, and will appear to move as the Camera moves. When in View-space, DirLight#dir is relative to the View coordinate system, and will behave as if fixed to the viewer's head.
• AmbientLights, DirLights and PointLights are registered by their Component#id on Scene#lights.

Usage

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

[Run this example]

import {Viewer, Mesh, buildSphereGeometry,
     buildPlaneGeometry, ReadableGeometry,
     PhongMaterial, Texture, DirLight} from "xeokit-sdk.es.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]
});