Interface ILightSceneApi

The api for a light scene. A light scene is a collection of lights. Therefore multiple light scene can be used to switch between different lighting environments. It can be created by calling the createLightScene method.

interface ILightSceneApi {
    id: string;
    lights: { [key: string]: ILightApi };
    node: ITreeNode;
    addAmbientLight(
        properties: {
            color?: Color;
            id?: string;
            intensity?: number;
            name?: string;
        },
    ): ILightApi;
    addDirectionalLight(
        properties: {
            castShadow?: boolean;
            color?: Color;
            direction?: vec3;
            id?: string;
            intensity?: number;
            name?: string;
            shadowMapBias?: number;
            shadowMapResolution?: number;
        },
    ): IDirectionalLightApi;
    addHemisphereLight(
        properties: {
            color?: Color;
            groundColor?: Color;
            id?: string;
            intensity?: number;
            name?: string;
        },
    ): IHemisphereLightApi;
    addPointLight(
        properties: {
            color?: Color;
            decay?: number;
            distance?: number;
            id?: string;
            intensity?: number;
            name?: string;
            position?: vec3;
        },
    ): IPointLightApi;
    addSpotLight(
        properties: {
            angle?: number;
            color?: Color;
            decay?: number;
            distance?: number;
            id?: string;
            intensity?: number;
            name?: string;
            penumbra?: number;
            position?: vec3;
            target?: vec3;
        },
    ): ISpotLightApi;
    removeLight(id: string): boolean;
    name?: string;
}

Index

Properties

id lights node name?

Methods

addAmbientLight addDirectionalLight addHemisphereLight addPointLight addSpotLight removeLight

Properties

`Readonly`id

id: string

The id of the light scene.

lights

lights: { [key: string]: ILightApi }

The collection of lights in the light scene.

`Readonly`node

node: ITreeNode

The node in which the lights are stored in the scene tree.

`Optional`name

name?: string

The name of the light scene.

Methods

addAmbientLight

addAmbientLight(
    properties: {
        color?: Color;
        id?: string;
        intensity?: number;
        name?: string;
    },
): ILightApi
Create an ambient light and add it to the light scene.
Parameters
- properties: { color?: Color; id?: string; intensity?: number; name?: string }
  - Optionalcolor?: Color
    The color of the light.
  - Optionalid?: string
    The id of the light.
  - Optionalintensity?: number
    The intensity of the light. (0-Infinity, default: 0.5)
  - Optionalname?: string
    The name of the light.
Returns ILightApi

addDirectionalLight

addDirectionalLight(
    properties: {
        castShadow?: boolean;
        color?: Color;
        direction?: vec3;
        id?: string;
        intensity?: number;
        name?: string;
        shadowMapBias?: number;
        shadowMapResolution?: number;
    },
): IDirectionalLightApi
Create a directional light and add it to the light scene.
Parameters
- properties: {
      castShadow?: boolean;
      color?: Color;
      direction?: vec3;
      id?: string;
      intensity?: number;
      name?: string;
      shadowMapBias?: number;
      shadowMapResolution?: number;
  }
  - OptionalcastShadow?: boolean
    Option for the light to cast shadows.
  - Optionalcolor?: Color
    The color of the light.
  - Optionaldirection?: vec3
    The direction of the light.
  - Optionalid?: string
    The id of the light.
  - Optionalintensity?: number
    The intensity of the light. (0-Infinity, default: 0.5)
  - Optionalname?: string
    The name of the light.
  - OptionalshadowMapBias?: number
    The bias of the shadow map. For more info on the shadow bias, see here.
  - OptionalshadowMapResolution?: number
    The resolution of the shadow map. (default: 1024, has to be power of two)
Returns IDirectionalLightApi

addHemisphereLight

addHemisphereLight(
    properties: {
        color?: Color;
        groundColor?: Color;
        id?: string;
        intensity?: number;
        name?: string;
    },
): IHemisphereLightApi
Create an hemisphere light and add it to the light scene.
Parameters
- properties: {
      color?: Color;
      groundColor?: Color;
      id?: string;
      intensity?: number;
      name?: string;
  }
  - Optionalcolor?: Color
    The color of the light.
  - OptionalgroundColor?: Color
    The ground color of the light.
  - Optionalid?: string
    The id of the light.
  - Optionalintensity?: number
    The intensity of the light. (0-Infinity, default: 0.5)
  - Optionalname?: string
    The name of the light.
Returns IHemisphereLightApi

addPointLight

addPointLight(
    properties: {
        color?: Color;
        decay?: number;
        distance?: number;
        id?: string;
        intensity?: number;
        name?: string;
        position?: vec3;
    },
): IPointLightApi
Create a point light and add it to the light scene.
Parameters
- properties: {
      color?: Color;
      decay?: number;
      distance?: number;
      id?: string;
      intensity?: number;
      name?: string;
      position?: vec3;
  }
  - Optionalcolor?: Color
    The color of the light.
  - Optionaldecay?: number
    The decay of the light.
  - Optionaldistance?: number
    The distance of the light.
  - Optionalid?: string
    The id of the light.
  - Optionalintensity?: number
    The intensity of the light. (0-Infinity, default: 0.5)
  - Optionalname?: string
    The name of the light.
  - Optionalposition?: vec3
    The position of the light.
Returns IPointLightApi

addSpotLight

addSpotLight(
    properties: {
        angle?: number;
        color?: Color;
        decay?: number;
        distance?: number;
        id?: string;
        intensity?: number;
        name?: string;
        penumbra?: number;
        position?: vec3;
        target?: vec3;
    },
): ISpotLightApi
Create a point light and add it to the light scene.
Parameters
- properties: {
      angle?: number;
      color?: Color;
      decay?: number;
      distance?: number;
      id?: string;
      intensity?: number;
      name?: string;
      penumbra?: number;
      position?: vec3;
      target?: vec3;
  }
  - Optionalangle?: number
    The angle of the light.
  - Optionalcolor?: Color
    The color of the light.
  - Optionaldecay?: number
    The decay of the light.
  - Optionaldistance?: number
    The distance of the light.
  - Optionalid?: string
    The id of the light.
  - Optionalintensity?: number
    The intensity of the light. (0-Infinity, default: 0.5)
  - Optionalname?: string
    The name of the light.
  - Optionalpenumbra?: number
    The penumbra of the light.
  - Optionalposition?: vec3
    The position of the light.
  - Optionaltarget?: vec3
    The target of the light.
Returns ISpotLightApi

removeLight

removeLight(id: string): boolean
Remove a light from the light scene with the specified id.
Parameters
- id: string
  The id of the light to remove.
Returns boolean

Interface ILightSceneApi

Index

Properties

Methods

Properties

Readonlyid

lights

Readonlynode

Optionalname

Methods

addAmbientLight

Parameters

Optionalcolor?: Color

Optionalid?: string

Optionalintensity?: number

Optionalname?: string

Returns ILightApi

addDirectionalLight

Parameters

OptionalcastShadow?: boolean

Optionalcolor?: Color

Optionaldirection?: vec3

Optionalid?: string

Optionalintensity?: number

Optionalname?: string

OptionalshadowMapBias?: number

OptionalshadowMapResolution?: number

Returns IDirectionalLightApi

addHemisphereLight

Parameters

Optionalcolor?: Color

OptionalgroundColor?: Color

Optionalid?: string

Optionalintensity?: number

Optionalname?: string

Returns IHemisphereLightApi

addPointLight

Parameters

Optionalcolor?: Color

Optionaldecay?: number

Optionaldistance?: number

Optionalid?: string

Optionalintensity?: number

Optionalname?: string

Optionalposition?: vec3

Returns IPointLightApi

addSpotLight

Parameters

Optionalangle?: number

Optionalcolor?: Color

Optionaldecay?: number

Optionaldistance?: number

Optionalid?: string

Optionalintensity?: number

Optionalname?: string

Optionalpenumbra?: number

Optionalposition?: vec3

Optionaltarget?: vec3

Returns ISpotLightApi

removeLight

Parameters

Returns boolean

Settings

On This Page

`Readonly`id

`Readonly`node

`Optional`name

`Optional`color?: Color

`Optional`id?: string

`Optional`intensity?: number

`Optional`name?: string

`Optional`castShadow?: boolean

`Optional`color?: Color

`Optional`direction?: vec3

`Optional`id?: string

`Optional`intensity?: number

`Optional`name?: string

`Optional`shadowMapBias?: number

`Optional`shadowMapResolution?: number

`Optional`color?: Color

`Optional`groundColor?: Color

`Optional`id?: string

`Optional`intensity?: number

`Optional`name?: string

`Optional`color?: Color

`Optional`decay?: number

`Optional`distance?: number

`Optional`id?: string

`Optional`intensity?: number

`Optional`name?: string

`Optional`position?: vec3

`Optional`angle?: number

`Optional`color?: Color

`Optional`decay?: number

`Optional`distance?: number

`Optional`id?: string

`Optional`intensity?: number

`Optional`name?: string

`Optional`penumbra?: number

`Optional`position?: vec3

`Optional`target?: vec3