Class LightDirectional

constructor

• new LightDirectional(): LightDirectional

• Create a default directional light, pointing downward

  Returns LightDirectional

ambient

colour

enabled

direction

• get direction(): XYZ

• Get the direction of the light

  Returns XYZ
• set direction(direction: XYZ): void

• Set the direction of the light ensuring it is normalized

  Parameters

  • direction: XYZ

    Direction vector

  Returns void

shadowMapFrameBufffer

• get shadowMapFrameBufffer(): undefined | FramebufferInfo

• Get the shadow map framebuffer, will be undefined if shadows are not enabled

  Returns undefined | FramebufferInfo

shadowMapOptions

• get shadowMapOptions(): undefined | ShadowOptions

• Get the shadow map options, will be undefined if shadows are not enabled

  Returns undefined | ShadowOptions

shadowMapProgram

• get shadowMapProgram(): undefined | ProgramInfo

• Get the shadow map program, will be undefined if shadows are not enabled

  Returns undefined | ProgramInfo

shadowMapTexture

• get shadowMapTexture(): undefined | WebGLTexture

• Get the shadow map texture, will be undefined if shadows are not enabled

  Returns undefined | WebGLTexture

shadowsEnabled

• get shadowsEnabled(): boolean

• Are shadows enabled for this light?

  Returns boolean

uniforms

• get uniforms(): UniformSet

• Return the base set of uniforms for this light

  Returns UniformSet

enableShadows

• enableShadows(options?: ShadowOptions): void

• Enable shadows for this light, this will create a shadow map texture and framebuffer There is no way to disabled shadows once enabled

  Parameters

  • Optionaloptions: ShadowOptions

    A set of ShadowOptions to configure how shadows are calculated

  Returns void

getShadowCamera

• getShadowCamera(viewCam: Camera): undefined | Camera

• Get a virtual camera that can be used to render a shadow map for this light

  Parameters

  • viewCam: Camera

    The main camera used to view the scene, needed to get a good shadow view

  Returns undefined | Camera

getShadowMatrix

• getShadowMatrix(viewCam: Camera): undefined | mat4

• Get the forward view matrix for the virtual camera used to render the shadow map. Returns undefined if shadows are not enabled

  Parameters

  • viewCam: Camera

    The main camera used to view the scene, needed to get a good shadow view

  Returns undefined | mat4

setAsPosition

• setAsPosition(x: number, y: number, z: number): void

• Convenience method allows setting the direction as a point relative to the world origin Values are always converted to a normalized unit direction vector

  Parameters

  • x: number

    X position
  • y: number

    Y position
  • z: number

    Z position

  Returns void