@playcanvas/web-components 0.5.0 → 0.6.0

package/dist/components/gsplat-component.d.ts

@@ -0,0 +1,79 @@
+import { GSplatComponent } from 'playcanvas';
+import { ComponentElement } from './component';
+/**
+ * The GSplatComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-gsplat/ | `<pc-gsplat>`} elements.
+ * The GSplatComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class GSplatComponentElement extends ComponentElement {
+    private _asset;
+    private _castShadows;
+    private _lodBaseDistance;
+    private _lodMultiplier;
+    /** @ignore */
+    constructor();
+    getInitialComponentData(): {
+        asset: import("playcanvas").Asset | null | undefined;
+        castShadows: boolean;
+        lodBaseDistance: number;
+        lodMultiplier: number;
+    };
+    /**
+     * Gets the underlying PlayCanvas gsplat component.
+     * @returns The gsplat component.
+     */
+    get component(): GSplatComponent | null;
+    /**
+     * Sets id of the `pc-asset` to use for the splat.
+     * @param value - The asset ID.
+     */
+    set asset(value: string);
+    /**
+     * Gets the id of the `pc-asset` to use for the splat.
+     * @returns The asset ID.
+     */
+    get asset(): string;
+    /**
+     * Sets whether the splat casts shadows.
+     * @param value - Whether the splat casts shadows.
+     */
+    set castShadows(value: boolean);
+    /**
+     * Gets whether the splat casts shadows.
+     * @returns Whether the splat casts shadows.
+     */
+    get castShadows(): boolean;
+    /**
+     * 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 {@link lodMultiplier}. Clamped to a minimum of
+     * 0.1. Defaults to 5. Only affects assets that contain LOD levels (e.g. `.lod-meta.json`).
+     * @param value - The LOD base distance.
+     */
+    set lodBaseDistance(value: number);
+    /**
+     * Gets the base distance for the first LOD transition.
+     * @returns The LOD base distance.
+     */
+    get lodBaseDistance(): number;
+    /**
+     * 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`).
+     * @param value - The LOD multiplier.
+     */
+    set lodMultiplier(value: number);
+    /**
+     * Gets the multiplier between successive LOD distance thresholds.
+     * @returns The LOD multiplier.
+     */
+    get lodMultiplier(): number;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
+}
+export { GSplatComponentElement };

package/dist/index.d.ts

@@ -25,9 +25,9 @@ import { ScriptComponentElement } from './components/script-component';
 import { ScriptElement } from './components/script';
 import { SoundComponentElement } from './components/sound-component';
 import { SoundSlotElement } from './components/sound-slot';
-import { SplatComponentElement } from './components/splat-component';
+import { GSplatComponentElement } from './components/gsplat-component';
 import { MaterialElement } from './material';
 import { ModelElement } from './model';
 import { SceneElement } from './scene';
 import { SkyElement } from './sky';
-export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, SplatComponentElement, MaterialElement, ModelElement, SceneElement, SkyElement };
+export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, GSplatComponentElement, MaterialElement, ModelElement, SceneElement, SkyElement };

package/dist/pwc.cjs

@@ -4365,29 +4365,33 @@ class SoundSlotElement extends AsyncElement {
 customElements.define('pc-sound', SoundSlotElement);
 
 /**
- * The SplatComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-splat/ | `<pc-splat>`} elements.
- * The SplatComponentElement interface also inherits the properties and methods of the
+ * The GSplatComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-gsplat/ | `<pc-gsplat>`} elements.
+ * The GSplatComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *
  * @category Components
  */
-class SplatComponentElement extends ComponentElement {
+class GSplatComponentElement extends ComponentElement {
     /** @ignore */
     constructor() {
         super('gsplat');
         this._asset = '';
         this._castShadows = false;
+        this._lodBaseDistance = 5;
+        this._lodMultiplier = 3;
     }
     getInitialComponentData() {
         return {
             asset: AssetElement.get(this._asset),
-            castShadows: this._castShadows
+            castShadows: this._castShadows,
+            lodBaseDistance: this._lodBaseDistance,
+            lodMultiplier: this._lodMultiplier
         };
     }
     /**
-     * Gets the underlying PlayCanvas splat component.
-     * @returns The splat component.
+     * Gets the underlying PlayCanvas gsplat component.
+     * @returns The gsplat component.
      */
     get component() {
         return super.component;
@@ -4427,11 +4431,54 @@ class SplatComponentElement extends ComponentElement {
     get castShadows() {
         return this._castShadows;
     }
+    /**
+     * 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 {@link lodMultiplier}. Clamped to a minimum of
+     * 0.1. Defaults to 5. Only affects assets that contain LOD levels (e.g. `.lod-meta.json`).
+     * @param value - The LOD base distance.
+     */
+    set lodBaseDistance(value) {
+        this._lodBaseDistance = value;
+        if (this.component) {
+            this.component.lodBaseDistance = value;
+        }
+    }
+    /**
+     * Gets the base distance for the first LOD transition.
+     * @returns The LOD base distance.
+     */
+    get lodBaseDistance() {
+        return this._lodBaseDistance;
+    }
+    /**
+     * 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`).
+     * @param value - The LOD multiplier.
+     */
+    set lodMultiplier(value) {
+        this._lodMultiplier = value;
+        if (this.component) {
+            this.component.lodMultiplier = value;
+        }
+    }
+    /**
+     * Gets the multiplier between successive LOD distance thresholds.
+     * @returns The LOD multiplier.
+     */
+    get lodMultiplier() {
+        return this._lodMultiplier;
+    }
     static get observedAttributes() {
         return [
             ...super.observedAttributes,
             'asset',
-            'cast-shadows'
+            'cast-shadows',
+            'lod-base-distance',
+            'lod-multiplier'
         ];
     }
     attributeChangedCallback(name, _oldValue, newValue) {
@@ -4443,10 +4490,16 @@ class SplatComponentElement extends ComponentElement {
             case 'cast-shadows':
                 this.castShadows = this.hasAttribute('cast-shadows');
                 break;
+            case 'lod-base-distance':
+                this.lodBaseDistance = Number(newValue);
+                break;
+            case 'lod-multiplier':
+                this.lodMultiplier = Number(newValue);
+                break;
         }
     }
 }
-customElements.define('pc-splat', SplatComponentElement);
+customElements.define('pc-gsplat', GSplatComponentElement);
 
 /**
  * The ModelElement interface provides properties and methods for manipulating
@@ -4992,6 +5045,7 @@ exports.CollisionComponentElement = CollisionComponentElement;
 exports.ComponentElement = ComponentElement;
 exports.ElementComponentElement = ElementComponentElement;
 exports.EntityElement = EntityElement;
+exports.GSplatComponentElement = GSplatComponentElement;
 exports.LightComponentElement = LightComponentElement;
 exports.ListenerComponentElement = ListenerComponentElement;
 exports.MaterialElement = MaterialElement;
@@ -5007,5 +5061,4 @@ exports.ScriptElement = ScriptElement;
 exports.SkyElement = SkyElement;
 exports.SoundComponentElement = SoundComponentElement;
 exports.SoundSlotElement = SoundSlotElement;
-exports.SplatComponentElement = SplatComponentElement;
 //# sourceMappingURL=pwc.cjs.map