Class SkyElement

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

Hierarchy (View Summary)

AsyncElement
- SkyElement

Index

Accessors

asset center intensity level lighting rotation scale type

Methods

Accessors

asset

get asset(): string
Gets the id of the pc-asset to use for the skybox.

Returns string
The asset ID.
- Defined in submodules/web-components/src/sky.ts:118
set asset(value: string): void
Sets the id of the pc-asset to use for the skybox.
Parameters
- value: string
  The asset ID.
Returns void
- Defined in submodules/web-components/src/sky.ts:107

center

get center(): Vec3
Gets the center of the skybox.

Returns Vec3
The center.
- Defined in submodules/web-components/src/sky.ts:137
set center(value: Vec3): void
Sets the center of the skybox.
Parameters
- value: Vec3
  The center.
Returns void
- Defined in submodules/web-components/src/sky.ts:126

intensity

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

Returns number
The intensity.
- Defined in submodules/web-components/src/sky.ts:156
set intensity(value: number): void
Sets the intensity of the skybox.
Parameters
- value: number
  The intensity.
Returns void
- Defined in submodules/web-components/src/sky.ts:145

level

get level(): number
Gets the mip level of the skybox.

Returns number
The mip level.
- Defined in submodules/web-components/src/sky.ts:175
set level(value: number): void
Sets the mip level of the skybox.
Parameters
- value: number
  The mip level.
Returns void
- Defined in submodules/web-components/src/sky.ts:164

lighting

get lighting(): boolean
Gets whether the skybox is used as a light source.

Returns boolean
Whether to use lighting.
- Defined in submodules/web-components/src/sky.ts:191
set lighting(value: boolean): void
Sets whether the skybox is used as a light source.
Parameters
- value: boolean
  Whether to use lighting.
Returns void
- Defined in submodules/web-components/src/sky.ts:183

rotation

get rotation(): Vec3
Gets the Euler rotation of the skybox.

Returns Vec3
The rotation.
- Defined in submodules/web-components/src/sky.ts:210
set rotation(value: Vec3): void
Sets the Euler rotation of the skybox.
Parameters
- value: Vec3
  The rotation.
Returns void
- Defined in submodules/web-components/src/sky.ts:199

scale

get scale(): Vec3
Gets the scale of the skybox.

Returns Vec3
The scale.
- Defined in submodules/web-components/src/sky.ts:229
set scale(value: Vec3): void
Sets the scale of the skybox.
Parameters
- value: Vec3
  The scale.
Returns void
- Defined in submodules/web-components/src/sky.ts:218

type

get type(): "none" | "infinite" | "box" | "dome"
Gets the type of the skybox.

Returns "none" | "infinite" | "box" | "dome"
The type.
- Defined in submodules/web-components/src/sky.ts:252
set type(value: "none" | "infinite" | "box" | "dome"): void
Sets the type of the skybox.
Parameters
- value: "none" | "infinite" | "box" | "dome"
  The type.
Returns void
- Defined in submodules/web-components/src/sky.ts:237

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 AsyncElement._onReady
- Defined in submodules/web-components/src/async-element.ts:32

ready

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

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