import {LightMap} from '@xeokit/xeokit-sdk/src/viewer/scene/lights/LightMap.js'
LightMap
Extends:
A LightMap specifies a cube texture light map.
Usage
import {Viewer, Mesh, buildSphereGeometry,
ReadableGeometry, MetallicMaterial, LightMap} 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];
new LightMap(viewer.scene, {
src: [
"textures/light/Uffizi_Gallery/Uffizi_Gallery_Irradiance_PX.png",
"textures/light/Uffizi_Gallery/Uffizi_Gallery_Irradiance_NX.png",
"textures/light/Uffizi_Gallery/Uffizi_Gallery_Irradiance_PY.png",
"textures/light/Uffizi_Gallery/Uffizi_Gallery_Irradiance_NY.png",
"textures/light/Uffizi_Gallery/Uffizi_Gallery_Irradiance_PZ.png",
"textures/light/Uffizi_Gallery/Uffizi_Gallery_Irradiance_NZ.png"
]
});
// Create a sphere and ground plane
new Mesh(viewer.scene, {
geometry: new ReadableGeometry(viewer.scene, buildSphereGeometry({
radius: 2.0
}),
new MetallicMaterial(viewer.scene, {
baseColor: [1, 1, 1],
metallic: 1.0,
roughness: 1.0
})
});
Constructor Summary
Public Constructor | ||
public |
constructor(owner: Component, cfg: *) |
Method Summary
Public Methods | ||
public |
destroy() |
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 |
The viewer that contains this Scene. |
|
public |
clear() Destroys all Components that are owned by this. |
|
public |
destroy() Destroys this component. |
|
public |
Logs an error for this component to the JavaScript console. |
|
public |
Fires an event on this component. |
|
public |
Returns true if there are any subscribers to the given event on this component. |
|
public |
Tests if this component is of the given type, or is a subclass of the given type. |
|
public |
Logs a console debugging message for this component. |
|
public |
Cancels an event subscription that was previously made with Component#on or Component#once. |
|
public |
Subscribes to an event on this component. |
|
public |
Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd. |
|
public |
scheduleTask(task: *) Schedule a task to perform on the next browser interval |
|
public |
Logs a warning for this component to the JavaScript console. |
From class CubeTexture | ||
public |
destroy() Destroys this CubeTexture |
Public Constructors
public constructor(owner: Component, cfg: *) source
Override:
CubeTexture#constructorParams:
Name | Type | Attribute | Description |
owner | Component | Owner component. When destroyed, the owner will destroy this component as well. |
|
cfg | * |
|
Configs |
cfg.id | String |
|
Optional ID for this LightMap, unique among all components in the parent scene, generated automatically when omitted. |
cfg.meta | String:Object |
|
Optional map of user-defined metadata to attach to this LightMap. |
cfg.src | String[] |
|
Paths to six image files to load into this LightMap. |
cfg.flipY | Boolean |
|
Flips this LightMap's source data along its vertical axis when true. |
cfg.encoding | Number |
|
Encoding format. Supported values are LinearEncoding and sRGBEncoding. |