Class PointLight

constructor

• new PointLight(view: View, cfg?: PointLightParams): PointLight

  Parameters

  • view: View

    View that owns this PointLight. When destroyed, the View will destroy this PointLight as well.
  • cfg: PointLightParams = {}

    The PointLight configuration

  Returns PointLight

id

Readonlyview

color

• get color(): Vec3

  Gets the RGB color of this PointLight.

  Default value is [0.7, 0.7, 0.8].

  Returns Vec3

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

  Sets the RGB color of this PointLight.

  Default value is [0.7, 0.7, 0.8].

  Parameters

  • color: Vec3

    The PointLight's RGB color.

  Returns void

constantAttenuation

• get constantAttenuation(): number

  Gets the constant attenuation factor for this PointLight.

  Default value is 0.

  Returns number

  The constant attenuation factor.
• set constantAttenuation(value: number): void

  Sets the constant attenuation factor for this PointLight.

  Default value is 0.

  Parameters

  • value: number

    The constant attenuation factor.

  Returns void

intensity

• get intensity(): number

  Gets the intensity of this PointLight.

  Default value is 1.0 for maximum intensity.

  Returns number

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

  Sets the intensity of this PointLight.

  Default intensity is 1.0 for maximum intensity.

  Parameters

  • intensity: number

    The PointLight's intensity

  Returns void

linearAttenuation

• get linearAttenuation(): number

  Gets the linear attenuation factor for this PointLight.

  Default value is 0.

  Returns number

  The linear attenuation factor.
• set linearAttenuation(value: number): void

  Sets the linear attenuation factor for this PointLight.

  Default value is 0.

  Parameters

  • value: number

    The linear attenuation factor.

  Returns void

pos

• get pos(): Vec3

  Gets the position of this PointLight.

  This will be either World- or View-space, depending on the value of PointLight.space.

  Default value is [1.0, 1.0, 1.0].

  Returns Vec3

  The position.
• set pos(pos: Vec3): void

  Sets the position of this PointLight.

  This will be either World- or View-space, depending on the value of PointLight.space.

  Default value is [1.0, 1.0, 1.0].

  Parameters

  • pos: Vec3

    The position.

  Returns void

quadraticAttenuation

• get quadraticAttenuation(): number

  Gets the quadratic attenuation factor for this PointLight.

  Default value is 0.

  Returns number

  The quadratic attenuation factor.
• set quadraticAttenuation(value: number): void

  Sets the quadratic attenuation factor for this PointLight.

  Default value is 0.

  Parameters

  • value: number

    The quadratic attenuation factor.

  Returns void

space

• get space(): string

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

  Returns string

destroy

• destroy(): void

  Destroys this PointLight.

  Returns void

fromParams

• fromParams(pointLightParams: PointLightParams): void

  Configures this PointLight.

  Ignores PointLightParams.space, because PointLight.space is not dynamically updatable.

  Parameters

  • pointLightParams: PointLightParams

  Returns void

toParams

• toParams(): PointLightParams

  Gets the current configuration of this PointLight.

  Returns PointLightParams