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

    Class CameraComponentElement

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

    Engine component: CameraComponent (camera).

    Hierarchy (View Summary)

    Index
    clearColor clearColorBuffer clearDepthBuffer clearStencilBuffer closestApp closestEntity component cullFaces enabled farClip flipFaces fov frustumCulling gamma horizontalFov nearClip orthoHeight priority projection rect scissorRect tonemap
    _onReady _resetReady endXr getInitialComponentData initComponent ready startXr
    • 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 enabled(): boolean

      Gets the enabled state of the component.

      Returns boolean

      The enabled state of the component.

    • set enabled(value: boolean): void

      Sets the enabled state of the component.

      Parameters

      • value: boolean

        The enabled state of the component.

      Returns void

    • get horizontalFov(): boolean

      Gets whether the camera's field of view (fov) is horizontal or vertical.

      Returns boolean

      Whether the camera's field of view is horizontal.

    • set horizontalFov(value: boolean): void

      Sets whether the camera's field of view (fov) is horizontal or vertical. Defaults to false (meaning it is vertical be default).

      Parameters

      • value: boolean

        Whether the camera's field of view is horizontal.

      Returns void

    • get projection(): "perspective" | "orthographic"

      Gets the projection of the camera.

      Returns "perspective" | "orthographic"

      The projection.

    • set projection(value: "perspective" | "orthographic"): void

      Sets the projection of the camera. Use orthoHeight to size an orthographic projection.

      Parameters

      • value: "perspective" | "orthographic"

        The projection ('perspective' or 'orthographic').

      Returns void

    • get tonemap(): | "linear"
      | "none"
      | "filmic"
      | "hejl"
      | "aces"
      | "aces2"
      | "neutral"

      Gets the tone mapping of the camera.

      Returns "linear" | "none" | "filmic" | "hejl" | "aces" | "aces2" | "neutral"

      The tone mapping.

    • set tonemap(
          value:
              | "linear"
              | "none"
              | "filmic"
              | "hejl"
              | "aces"
              | "aces2"
              | "neutral",
      ): void

      Sets the tone mapping of the camera.

      Parameters

      • value: "linear" | "none" | "filmic" | "hejl" | "aces" | "aces2" | "neutral"

        The tone mapping.

      Returns void

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

      Returns void

    Protected_resetReady

    • _resetReady(): 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 the data the component is created with. Overridden by subclasses to supply the initial values of their cached properties.

      Returns {
          clearColor: Color;
          clearColorBuffer: boolean;
          clearDepthBuffer: boolean;
          clearStencilBuffer: boolean;
          cullFaces: boolean;
          farClip: number;
          flipFaces: boolean;
          fov: number;
          frustumCulling: boolean;
          gammaCorrection: 0 | 1;
          horizontalFov: boolean;
          nearClip: number;
          orthoHeight: number;
          priority: number;
          projection: number;
          rect: Vec4;
          scissorRect: Vec4;
          toneMapping: number;
      }

      The initial component data.

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

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

    • Starts the camera in XR mode.

      Parameters

      • type: "immersive-vr" | "immersive-ar"

        The type of XR mode to start.

      • space: "bounded-floor" | "local" | "local-floor" | "unbounded" | "viewer"

        The space to start the camera in.

      Returns void

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods