Class SceneElement

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

Hierarchy (View Summary)

AsyncElement
- SceneElement

Index

Accessors

closestApp closestEntity fog fogColor fogDensity fogEnd fogStart gravity scene

Methods

Accessors

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

fog

get fog(): "linear" | "none" | "exp" | "exp2"
Gets the fog type of the scene.

Returns "linear" | "none" | "exp" | "exp2"
The fog type.
- Defined in src/scene.ts:124
set fog(value: "linear" | "none" | "exp" | "exp2"): void
Sets the fog type of the scene. Can be none, linear, exp or exp2. Defaults to none.
Parameters
- value: "linear" | "none" | "exp" | "exp2"
  The fog type.
Returns void
- Defined in src/scene.ts:113

fogColor

get fogColor(): Color
Gets the fog color of the scene.

Returns Color
The fog color.
- Defined in src/scene.ts:143
set fogColor(value: Color): void
Sets the fog color of the scene.
Parameters
- value: Color
  The fog color.
Returns void
- Defined in src/scene.ts:132

fogDensity

get fogDensity(): number
Gets the fog density of the scene.

Returns number
The fog density.
- Defined in src/scene.ts:162
set fogDensity(value: number): void
Sets the fog density of the scene.
Parameters
- value: number
  The fog density.
Returns void
- Defined in src/scene.ts:151

fogEnd

get fogEnd(): number
Gets the fog end distance of the scene.

Returns number
The fog end distance.
- Defined in src/scene.ts:200
set fogEnd(value: number): void
Sets the fog end distance of the scene.
Parameters
- value: number
  The fog end distance.
Returns void
- Defined in src/scene.ts:189

fogStart

get fogStart(): number
Gets the fog start distance of the scene.

Returns number
The fog start distance.
- Defined in src/scene.ts:181
set fogStart(value: number): void
Sets the fog start distance of the scene.
Parameters
- value: number
  The fog start distance.
Returns void
- Defined in src/scene.ts:170

gravity

get gravity(): Vec3
Gets the gravity of the scene.

Returns Vec3
The gravity.
- Defined in src/scene.ts:219
set gravity(value: Vec3): void
Sets the gravity of the scene.
Parameters
- value: Vec3
  The gravity.
Returns void
- Defined in src/scene.ts:208

scene

get scene(): Scene | null
The PlayCanvas scene instance. null until the element is ready — await whenReady or the element's ready() promise before accessing it.

Returns Scene | null
The scene instance, or null.
- Defined in src/scene.ts:50

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<SceneElement>
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<SceneElement>
A promise that resolves with this element when it's ready.
Inherited from AsyncElement.ready
- Defined in src/async-element.ts:56