Documentation

API Reference / Modules / common-core/src/lightsetting/dynamic-light-setting-loader / DynamicLight

# Interface: DynamicLight

common-core/src/lightsetting/dynamic-light-setting-loader.DynamicLight

Description of fields:

  • type: 'ambient'/'rectarea'/'spot'/'directional'
  • name: set a name for this light to identify it more easily
  • intensity: light intensity/brightness
  • color: light color as hex ('#ffffff')
  • position: position of the light, for example {"x": 0,"y": 0, "z": 0}, coords are right hand y up
  • target: position to which the light should shine, defaults to center
  • castShadow: defines if this light casts shadows
  • angle: used for spotlights, defines the light cone of the spotlight
  • penumbra: used for spotlights, defines how hard the edges of the light are
  • width: used for rect area light, width of the area
  • height: used for rect area light, height of the area
  • movesWithCamera: if true the light will always have the same position and angle as the camera

# Table of contents

# Properties

# Properties

# angle

• Optional angle: number

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:60 (opens new window)

# castShadow

• Optional castShadow: boolean

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:59 (opens new window)

# color

• Optional color: string

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:56 (opens new window)

# height

• Optional height: number

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:63 (opens new window)

# intensity

• Optional intensity: number

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:55 (opens new window)

# movesWithCamera

• Optional movesWithCamera: boolean

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:64 (opens new window)

# name

• Optional name: string

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:54 (opens new window)

# penumbra

• Optional penumbra: number

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:61 (opens new window)

# position

• Optional position: Vector3

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:57 (opens new window)

# target

• Optional target: Vector3

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:58 (opens new window)

# type

• type: string

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:53 (opens new window)

# width

• Optional width: number

# Defined in

packages/common-core/src/lightsetting/dynamic-light-setting-loader.ts:62 (opens new window)