Class DirLight

constructor

• new DirLight(view: View, options?: DirLightParams): DirLight

  Parameters

  • view: View

    View that owns this DirLight. When destroyed, the View will destroy this DirLight as well.
  • options: DirLightParams = {}

    The DirLight configuration

    Parameters for a DirLight.

    • Returned by DirLight.toParams
    • Passed to DirLight.fromParams
    • Located at ViewParams.lights

    • Optionalcolor?: Vec3

      RGB color of the DirLight.

      Range is [0..1, 0..1, 0..1].

      Default value is [1.0, 1.0, 1.0].

    • Optionaldir?: Vec3

      3D direction of the DirLight.

      Range is [-1..1, -1..1, -1..1].

      Default value is [1.0, 1.0, 1.0].

    • Optionalid?: string

      Optional ID, generated automatically when omitted.

    • Optionalintensity?: number

      Intensity of the DirLight.

      Value is in range [0..1].

      Default value is 1.0.

    • Optionalspace?: string

      3D coordinate space in which the DirLight is oriented.

      Accepted value is "world" or "view".

      Default is "world".

  Returns DirLight

id

Readonlyview

color

• get color(): Vec3

  Gets the RGB color of this DirLight.

  Default value is [0.7, 0.7, 0.8].

  Returns Vec3

  The DirLight's RGB color.
• set color(color: Vec3): void

  Sets the RGB color of this DirLight.

  Default value is [0.7, 0.7, 0.8].

  Parameters

  • color: Vec3

    The DirLight's RGB color.

  Returns void

dir

• get dir(): Vec3

  Gets the direction in which the DirLight is shining.

  Default value is [1.0, 1.0, 1.0].

  Returns Vec3

  The direction vector.
• set dir(value: Vec3): void

  Sets the direction in which the DirLight is shining.

  Default value is [1.0, 1.0, 1.0].

  Parameters

  • value: Vec3

    The direction vector.

  Returns void

intensity

• get intensity(): number

  Gets the intensity of this DirLight.

  Default value is 1.0 for maximum intensity.

  Returns number

  The DirLight's intensity.
• set intensity(intensity: number): void

  Sets the intensity of this DirLight.

  Default intensity is 1.0 for maximum intensity.

  Parameters

  • intensity: number

    The DirLight's intensity

  Returns void

space

• get space(): string

  The coordinate system the DirLight is defined in - "view" or "space".

  Returns string

destroy

• destroy(): void

  Destroys this DirLight.

  Returns void

fromParams

• fromParams(dirLightParams: DirLightParams): SDKResult<any>

  Configures this DirLight.

  Ignores DirLightParams.space, because DirLight.space is not dynamically updatable.

  Parameters

  • dirLightParams: DirLightParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<DirLightParams>

  Gets this DirLight's current configuration.

  Returns SDKResult<DirLightParams>