Class LightComponentElement

The LightComponentElement interface provides properties and methods for manipulating <pc-light> elements. The LightComponentElement interface also inherits the properties and methods of the HTMLElement interface.

Hierarchy (View Summary)

ComponentElement
- LightComponentElement

Index

Accessors

castShadows color component enabled innerConeAngle intensity normalOffsetBias outerConeAngle range shadowBias shadowDistance shadowIntensity shadowResolution shadowType type vsmBias vsmBlurSize

Methods

_onReady ready

Accessors

castShadows

get castShadows(): boolean
Gets the cast shadows flag of the light.

Returns boolean
The cast shadows flag.
- Defined in src/components/light-component.ts:105
set castShadows(value: boolean): void
Sets the cast shadows flag of the light.
Parameters
- value: boolean
  The cast shadows flag.
Returns void
- Defined in src/components/light-component.ts:94

color

get color(): Color
Gets the color of the light.

Returns Color
The color.
- Defined in src/components/light-component.ts:124
set color(value: Color): void
Sets the color of the light.
Parameters
- value: Color
  The color.
Returns void
- Defined in src/components/light-component.ts:113

component

get component(): null | LightComponent
Gets the underlying PlayCanvas light component.

Returns null | LightComponent
The light component.
Overrides ComponentElement.component
- Defined in src/components/light-component.ts:86

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:80
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:69

innerConeAngle

get innerConeAngle(): number
Gets the inner cone angle of the light.

Returns number
The inner cone angle.
- Defined in src/components/light-component.ts:143
set innerConeAngle(value: number): void
Sets the inner cone angle of the light.
Parameters
- value: number
  The inner cone angle.
Returns void
- Defined in src/components/light-component.ts:132

intensity

get intensity(): number
Gets the intensity of the light.

Returns number
The intensity.
- Defined in src/components/light-component.ts:162
set intensity(value: number): void
Sets the intensity of the light.
Parameters
- value: number
  The intensity.
Returns void
- Defined in src/components/light-component.ts:151

normalOffsetBias

get normalOffsetBias(): number
Gets the normal offset bias of the light.

Returns number
The normal offset bias.
- Defined in src/components/light-component.ts:181
set normalOffsetBias(value: number): void
Sets the normal offset bias of the light.
Parameters
- value: number
  The normal offset bias.
Returns void
- Defined in src/components/light-component.ts:170

outerConeAngle

get outerConeAngle(): number
Gets the outer cone angle of the light.

Returns number
The outer cone angle.
- Defined in src/components/light-component.ts:200
set outerConeAngle(value: number): void
Sets the outer cone angle of the light.
Parameters
- value: number
  The outer cone angle.
Returns void
- Defined in src/components/light-component.ts:189

range

get range(): number
Gets the range of the light.

Returns number
The range.
- Defined in src/components/light-component.ts:219
set range(value: number): void
Sets the range of the light.
Parameters
- value: number
  The range.
Returns void
- Defined in src/components/light-component.ts:208

shadowBias

get shadowBias(): number
Gets the shadow bias of the light.

Returns number
The shadow bias.
- Defined in src/components/light-component.ts:238
set shadowBias(value: number): void
Sets the shadow bias of the light.
Parameters
- value: number
  The shadow bias.
Returns void
- Defined in src/components/light-component.ts:227

shadowDistance

get shadowDistance(): number
Gets the shadow distance of the light.

Returns number
The shadow distance.
- Defined in src/components/light-component.ts:257
set shadowDistance(value: number): void
Sets the shadow distance of the light.
Parameters
- value: number
  The shadow distance.
Returns void
- Defined in src/components/light-component.ts:246

shadowIntensity

get shadowIntensity(): number
Gets the shadow intensity of the light.

Returns number
The shadow intensity.
- Defined in src/components/light-component.ts:276
set shadowIntensity(value: number): void
Sets the shadow intensity of the light.
Parameters
- value: number
  The shadow intensity.
Returns void
- Defined in src/components/light-component.ts:265

shadowResolution

get shadowResolution(): number
Gets the shadow resolution of the light.

Returns number
The shadow resolution.
- Defined in src/components/light-component.ts:295
set shadowResolution(value: number): void
Sets the shadow resolution of the light.
Parameters
- value: number
  The shadow resolution.
Returns void
- Defined in src/components/light-component.ts:284

shadowType

get shadowType(): | "pcf1-16f"
| "pcf1-32f"
| "pcf3-16f"
| "pcf3-32f"
| "pcf5-16f"
| "pcf5-32f"
| "vsm-16f"
| "vsm-32f"
| "pcss-32f"
Gets the shadow type of the light.

Returns
    | "pcf1-16f"
    | "pcf1-32f"
    | "pcf3-16f"
    | "pcf3-32f"
    | "pcf5-16f"
    | "pcf5-32f"
    | "vsm-16f"
    | "vsm-32f"
    | "pcss-32f"
The shadow type.
- Defined in src/components/light-component.ts:324
set shadowType(
    value:
        | "pcf1-16f"
        | "pcf1-32f"
        | "pcf3-16f"
        | "pcf3-32f"
        | "pcf5-16f"
        | "pcf5-32f"
        | "vsm-16f"
        | "vsm-32f"
        | "pcss-32f",
): void
Sets the shadow type of the light.
Parameters
- value:
      | "pcf1-16f"
      | "pcf1-32f"
      | "pcf3-16f"
      | "pcf3-32f"
      | "pcf5-16f"
      | "pcf5-32f"
      | "vsm-16f"
      | "vsm-32f"
      | "pcss-32f"
  The shadow type. Can be:
  
  pcf1-16f - 1-tap percentage-closer filtered shadow map with 16-bit depth.
  
  pcf1-32f - 1-tap percentage-closer filtered shadow map with 32-bit depth.
  
  pcf3-16f - 3-tap percentage-closer filtered shadow map with 16-bit depth.
  
  pcf3-32f - 3-tap percentage-closer filtered shadow map with 32-bit depth.
  
  pcf5-16f - 5-tap percentage-closer filtered shadow map with 16-bit depth.
  
  pcf5-32f - 5-tap percentage-closer filtered shadow map with 32-bit depth.
  
  vsm-16f - Variance shadow map with 16-bit depth.
  
  vsm-32f - Variance shadow map with 32-bit depth.
  
  pcss-32f - Percentage-closer soft shadow with 32-bit depth.
Returns void
- Defined in src/components/light-component.ts:313

type

get type(): string
Gets the type of the light.

Returns string
The type.
- Defined in src/components/light-component.ts:348
set type(value: string): void
Sets the type of the light.
Parameters
- value: string
  The type.
Returns void
- Defined in src/components/light-component.ts:332

vsmBias

get vsmBias(): number
Gets the VSM bias of the light.

Returns number
The VSM bias.
- Defined in src/components/light-component.ts:367
set vsmBias(value: number): void
Sets the VSM bias of the light.
Parameters
- value: number
  The VSM bias.
Returns void
- Defined in src/components/light-component.ts:356

vsmBlurSize

get vsmBlurSize(): number
Gets the VSM blur size of the light.

Returns number
The VSM blur size.
- Defined in src/components/light-component.ts:386
set vsmBlurSize(value: number): void
Sets the VSM blur size of the light. Minimum is 1, maximum is 25. Default is 11.
Parameters
- value: number
  The VSM blur size.
Returns void
- Defined in src/components/light-component.ts:375

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready.

Returns void
Inherited from ComponentElement._onReady
- Defined in src/async-element.ts:32

ready

ready(): Promise<LightComponentElement>
Returns a promise that resolves with this element when it's ready.

Returns Promise<LightComponentElement>
A promise that resolves with this element when it's ready.
Inherited from ComponentElement.ready
- Defined in src/async-element.ts:41

Class LightComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

castShadows

Returns boolean

Parameters

Returns void

color

Returns Color

Parameters

Returns void

component

Returns null | LightComponent

enabled

Returns boolean

Parameters

Returns void

innerConeAngle

Returns number

Parameters

Returns void

intensity

Returns number

Parameters

Returns void

normalOffsetBias

Returns number

Parameters

Returns void

outerConeAngle

Returns number

Parameters

Returns void

range

Returns number

Parameters

Returns void

shadowBias

Returns number

Parameters

Returns void

shadowDistance

Returns number

Parameters

Returns void

shadowIntensity

Returns number

Parameters

Returns void

shadowResolution

Returns number

Parameters

Returns void

shadowType

Returns | "pcf1-16f" | "pcf1-32f" | "pcf3-16f" | "pcf3-32f" | "pcf5-16f" | "pcf5-32f" | "vsm-16f" | "vsm-32f" | "pcss-32f"

Parameters

Returns void

type

Returns string

Parameters

Returns void

vsmBias

Returns number

Parameters

Returns void

vsmBlurSize

Returns number

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<LightComponentElement>

Settings

On This Page

Returns
| "pcf1-16f"
| "pcf1-32f"
| "pcf3-16f"
| "pcf3-32f"
| "pcf5-16f"
| "pcf5-32f"
| "vsm-16f"
| "vsm-32f"
| "pcss-32f"

`Protected`_onReady