HomeWeb Components API Reference - v0.17.0
    Preparing search index...

    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)

    Index
    • 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.

    • get closestEntity(): EntityBaseElement | null

      The nearest ancestor element that fronts an entity — <pc-entity>, <pc-model> or <pc-node> — or null if this element has no such ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns EntityBaseElement | null

      The closest entity-fronting element, or null.

    • get fog(): "linear" | "none" | "exp" | "exp2"

      Gets the fog type of the scene.

      Returns "linear" | "none" | "exp" | "exp2"

      The fog type.

    • 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

    • get fogDensity(): number

      Gets the fog density of the scene.

      Returns number

      The fog density.

    • set fogDensity(value: number): void

      Sets the fog density of the scene.

      Parameters

      • value: number

        The fog density.

      Returns void

    • get fogEnd(): number

      Gets the fog end distance of the scene.

      Returns number

      The fog end distance.

    • set fogEnd(value: number): void

      Sets the fog end distance of the scene.

      Parameters

      • value: number

        The fog end distance.

      Returns void

    • get fogStart(): number

      Gets the fog start distance of the scene.

      Returns number

      The fog start distance.

    • set fogStart(value: number): void

      Sets the fog start distance of the scene.

      Parameters

      • value: number

        The fog start distance.

      Returns void

    • get gravity(): Vec3

      Gets the gravity of the scene.

      Returns Vec3

      The gravity.

    • set gravity(value: Vec3): void

      Sets the gravity of the scene.

      Parameters

      • value: Vec3

        The gravity.

      Returns void

    • 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.

    • 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. Signals at most once per readiness cycle: a repeat call before _resetReady has re-armed the promise does nothing.

      Returns void

    • Returns the ready promise to its pending state. Subclasses should call this when the resource their readiness announced is torn down (typically from disconnectedCallback), so that a later re-initialization can signal readiness again. Does nothing while the promise is still pending — an in-flight waiter carries over to the next readiness cycle rather than being stranded on a promise nothing will ever resolve.

      Returns void

    • 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.

      Readiness tracks the element's current lifecycle: once a ready element is torn down (for example by removing it from the document), this returns a fresh promise that resolves when the element is next ready. A promise obtained earlier stays resolved — call this again after re-inserting an element rather than reusing a promise from before its removal.

      Returns Promise<SceneElement>

      A promise that resolves with this element when it's ready.