HomeWeb Components API Reference - v0.8.1
    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.

    Hierarchy (View Summary)

    Index

    Accessors

    • 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 base distance for the first LOD transition.

      Returns number

      The LOD base distance.

    • set lodBaseDistance(value: number): void

      Sets the base distance for the first LOD transition (LOD 0 to LOD 1). Splats closer than this distance use the highest quality LOD. Each subsequent LOD level transitions at a progressively larger distance, controlled by lodMultiplier. 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 distance thresholds.

      Returns number

      The LOD multiplier.

    • set lodMultiplier(value: number): void

      Sets the multiplier between successive LOD distance thresholds. Each LOD level transitions at this factor times the previous level's distance, creating a geometric progression. Lower values keep higher quality at distance; higher values switch to coarser LODs 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

    Methods