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

    Class GSplatComponentElement

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

    Engine component: GSplatComponent (gsplat).

    Hierarchy (View Summary)

    Index
    asset castShadows closestApp closestEntity component enabled lodBaseDistance lodMultiplier lodRangeMax lodRangeMin
    _onReady _resetReady getInitialComponentData initComponent ready
    • 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 lodBaseDistance(): number

      Gets the camera distance of the first LOD transition.

      Returns number

      The LOD base distance.

    • set lodBaseDistance(value: number): void

      Sets the camera distance of the first LOD transition, from LOD 0 to LOD 1. Parts of the splat closer than this use the finest LOD, and each further level starts at lodMultiplier times the previous distance. In world units, compensated for the camera's field of view. How these distances combine with the scene-wide splat budget is set by the gsplat-splat-budget-mode attribute of <pc-scene>. Clamped to a minimum of 0.1. Defaults to 5. Only affects assets that contain LOD levels (e.g. .lod-meta.json).

      Parameters

      • value: number

        The LOD base distance.

      Returns void

    • get lodMultiplier(): number

      Gets the multiplier between successive LOD transition distances.

      Returns number

      The LOD multiplier.

    • set lodMultiplier(value: number): void

      Sets the multiplier between successive LOD transition distances. Higher values keep finer detail further from the camera, at a higher memory cost; lower values switch to coarser levels sooner. Clamped to a minimum of 1.2. Defaults to 3. Only affects assets that contain LOD levels (e.g. .lod-meta.json).

      Parameters

      • value: number

        The LOD multiplier.

      Returns void

    • get lodRangeMax(): number

      Gets the maximum allowed LOD index.

      Returns number

      The maximum LOD index.

    • set lodRangeMax(value: number): void

      Sets the maximum allowed LOD index (inclusive). The LOD selected by distance is clamped so it never goes coarser (higher index) than this value. The default of 99 effectively means "no cap". Defaults to 99. Only affects assets that contain LOD levels (e.g. .lod-meta.json).

      Parameters

      • value: number

        The maximum LOD index.

      Returns void

    • get lodRangeMin(): number

      Gets the minimum allowed LOD index.

      Returns number

      The minimum LOD index.

    • set lodRangeMin(value: number): void

      Sets the minimum allowed LOD index (inclusive). The LOD selected by distance is clamped so it never goes finer (lower index) than this value. Raising it avoids downloading the highest quality (largest) LOD files. Defaults to 0. Only affects assets that contain LOD levels (e.g. .lod-meta.json).

      Parameters

      • value: number

        The minimum LOD index.

      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. The element's enabled state is not among them: the base class adds it when it creates the component.

      Returns {
          asset: Asset<string> | null | undefined;
          castShadows: boolean;
          lodBaseDistance: number;
          lodMultiplier: number;
          lodRangeMax: number;
          lodRangeMin: 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<GSplatComponentElement>

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

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods