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 closestApp closestEntity 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 src/sky.ts:131
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 src/sky.ts:120

center

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

Returns Vec3
The center.
- Defined in src/sky.ts:150
set center(value: Vec3): void
Sets the center of the skybox.
Parameters
- value: Vec3
  The center.
Returns void
- Defined in src/sky.ts:139

closestApp

get closestApp(): AppElement | null
The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns AppElement | null
The closest app element, or null.
Inherited from AsyncElement.closestApp
- Defined in src/async-element.ts:28

closestEntity

get closestEntity(): EntityElement | null
The nearest ancestor <pc-entity> element, or null if this element has no <pc-entity> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns EntityElement | null
The closest entity element, or null.
Inherited from AsyncElement.closestEntity
- Defined in src/async-element.ts:37

intensity

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

Returns number
The intensity.
- Defined in src/sky.ts:169
set intensity(value: number): void
Sets the intensity of the skybox.
Parameters
- value: number
  The intensity.
Returns void
- Defined in src/sky.ts:158

level

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

Returns number
The mip level.
- Defined in src/sky.ts:188
set level(value: number): void
Sets the mip level of the skybox.
Parameters
- value: number
  The mip level.
Returns void
- Defined in src/sky.ts:177

lighting

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

Returns boolean
Whether to use lighting.
- Defined in src/sky.ts:204
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 src/sky.ts:196

rotation

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

Returns Vec3
The rotation.
- Defined in src/sky.ts:223
set rotation(value: Vec3): void
Sets the Euler rotation of the skybox.
Parameters
- value: Vec3
  The rotation.
Returns void
- Defined in src/sky.ts:212

scale

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

Returns Vec3
The scale.
- Defined in src/sky.ts:242
set scale(value: Vec3): void
Sets the scale of the skybox.
Parameters
- value: Vec3
  The scale.
Returns void
- Defined in src/sky.ts:231

type

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

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

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event.

Returns void
Inherited from AsyncElement._onReady
- Defined in src/async-element.ts:46

ready

ready(): Promise<SkyElement>
Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

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