@playcanvas/web-components 0.11.1 → 0.13.0

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

@@ -1,6 +1,6 @@
 import type { LayoutGroupComponent } from 'playcanvas';
 import { Vec2, Vec4 } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The LayoutGroupComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-layoutgroup/ | `<pc-layoutgroup>`} elements.

package/dist/components/light-component.d.cts

@@ -0,0 +1,264 @@
+import type { LightComponent } from 'playcanvas';
+import { Color } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The LightComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-light/ | `<pc-light>`} elements.
+ * The LightComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class LightComponentElement extends ComponentElement {
+    private _castShadows;
+    private _color;
+    private _innerConeAngle;
+    private _intensity;
+    private _normalOffsetBias;
+    private _outerConeAngle;
+    private _range;
+    private _shadowBias;
+    private _shadowDistance;
+    private _shadowIntensity;
+    private _shadowResolution;
+    private _shadowType;
+    private _type;
+    private _vsmBias;
+    private _vsmBlurSize;
+    private _penumbraSize;
+    private _penumbraFalloff;
+    private _shadowSamples;
+    private _shadowBlockerSamples;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): {
+        castShadows: boolean;
+        color: Color;
+        innerConeAngle: number;
+        intensity: number;
+        normalOffsetBias: number;
+        outerConeAngle: number;
+        penumbraFalloff: number;
+        penumbraSize: number;
+        range: number;
+        shadowBias: number;
+        shadowBlockerSamples: number;
+        shadowDistance: number;
+        shadowIntensity: number;
+        shadowResolution: number;
+        shadowSamples: number;
+        shadowType: number | undefined;
+        type: "directional" | "omni" | "spot";
+        vsmBias: number;
+        vsmBlurSize: number;
+    };
+    /**
+     * Gets the underlying PlayCanvas light component.
+     * @returns The light component.
+     */
+    get component(): LightComponent;
+    /**
+     * Sets the cast shadows flag of the light.
+     * @param value - The cast shadows flag.
+     */
+    set castShadows(value: boolean);
+    /**
+     * Gets the cast shadows flag of the light.
+     * @returns The cast shadows flag.
+     */
+    get castShadows(): boolean;
+    /**
+     * Sets the color of the light.
+     * @param value - The color.
+     */
+    set color(value: Color);
+    /**
+     * Gets the color of the light.
+     * @returns The color.
+     */
+    get color(): Color;
+    /**
+     * Sets the inner cone angle of the light.
+     * @param value - The inner cone angle.
+     */
+    set innerConeAngle(value: number);
+    /**
+     * Gets the inner cone angle of the light.
+     * @returns The inner cone angle.
+     */
+    get innerConeAngle(): number;
+    /**
+     * Sets the intensity of the light.
+     * @param value - The intensity.
+     */
+    set intensity(value: number);
+    /**
+     * Gets the intensity of the light.
+     * @returns The intensity.
+     */
+    get intensity(): number;
+    /**
+     * Sets the normal offset bias of the light.
+     * @param value - The normal offset bias.
+     */
+    set normalOffsetBias(value: number);
+    /**
+     * Gets the normal offset bias of the light.
+     * @returns The normal offset bias.
+     */
+    get normalOffsetBias(): number;
+    /**
+     * Sets the outer cone angle of the light.
+     * @param value - The outer cone angle.
+     */
+    set outerConeAngle(value: number);
+    /**
+     * Gets the outer cone angle of the light.
+     * @returns The outer cone angle.
+     */
+    get outerConeAngle(): number;
+    /**
+     * Sets the range of the light.
+     * @param value - The range.
+     */
+    set range(value: number);
+    /**
+     * Gets the range of the light.
+     * @returns The range.
+     */
+    get range(): number;
+    /**
+     * Sets the shadow bias of the light.
+     * @param value - The shadow bias.
+     */
+    set shadowBias(value: number);
+    /**
+     * Gets the shadow bias of the light.
+     * @returns The shadow bias.
+     */
+    get shadowBias(): number;
+    /**
+     * Sets the shadow distance of the light.
+     * @param value - The shadow distance.
+     */
+    set shadowDistance(value: number);
+    /**
+     * Gets the shadow distance of the light.
+     * @returns The shadow distance.
+     */
+    get shadowDistance(): number;
+    /**
+     * Sets the shadow intensity of the light.
+     * @param value - The shadow intensity.
+     */
+    set shadowIntensity(value: number);
+    /**
+     * Gets the shadow intensity of the light.
+     * @returns The shadow intensity.
+     */
+    get shadowIntensity(): number;
+    /**
+     * Sets the shadow resolution of the light.
+     * @param value - The shadow resolution.
+     */
+    set shadowResolution(value: number);
+    /**
+     * Gets the shadow resolution of the light.
+     * @returns The shadow resolution.
+     */
+    get shadowResolution(): number;
+    /**
+     * Sets the shadow type of the light.
+     * @param value - The shadow type. Can be:
+     *
+     * - `pcf1-16f` - 1-tap percentage-closer filtered shadow map with 16-bit depth.
+     * - `pcf1-32f` - 1-tap percentage-closer filtered shadow map with 32-bit depth.
+     * - `pcf3-16f` - 3-tap percentage-closer filtered shadow map with 16-bit depth.
+     * - `pcf3-32f` - 3-tap percentage-closer filtered shadow map with 32-bit depth.
+     * - `pcf5-16f` - 5-tap percentage-closer filtered shadow map with 16-bit depth.
+     * - `pcf5-32f` - 5-tap percentage-closer filtered shadow map with 32-bit depth.
+     * - `vsm-16f` - Variance shadow map with 16-bit depth.
+     * - `vsm-32f` - Variance shadow map with 32-bit depth.
+     * - `pcss-32f` - Percentage-closer soft shadow with 32-bit depth.
+     */
+    set shadowType(value: 'pcf1-16f' | 'pcf1-32f' | 'pcf3-16f' | 'pcf3-32f' | 'pcf5-16f' | 'pcf5-32f' | 'vsm-16f' | 'vsm-32f' | 'pcss-32f');
+    /**
+     * Gets the shadow type of the light.
+     * @returns The shadow type.
+     */
+    get shadowType(): "pcf1-16f" | "pcf1-32f" | "pcf3-16f" | "pcf3-32f" | "pcf5-16f" | "pcf5-32f" | "vsm-16f" | "vsm-32f" | "pcss-32f";
+    /**
+     * Sets the type of the light. Can be `directional`, `omni` or `spot`. Defaults to
+     * `directional`.
+     * @param value - The type.
+     */
+    set type(value: 'directional' | 'omni' | 'spot');
+    /**
+     * Gets the type of the light.
+     * @returns The type.
+     */
+    get type(): "directional" | "omni" | "spot";
+    /**
+     * Sets the VSM bias of the light.
+     * @param value - The VSM bias.
+     */
+    set vsmBias(value: number);
+    /**
+     * Gets the VSM bias of the light.
+     * @returns The VSM bias.
+     */
+    get vsmBias(): number;
+    /**
+     * Sets the VSM blur size of the light. Minimum is 1, maximum is 25. Default is 11.
+     * @param value - The VSM blur size.
+     */
+    set vsmBlurSize(value: number);
+    /**
+     * Gets the VSM blur size of the light.
+     * @returns The VSM blur size.
+     */
+    get vsmBlurSize(): number;
+    /**
+     * Sets the penumbra size of the light. Used for PCSS shadows.
+     * @param value - The penumbra size.
+     */
+    set penumbraSize(value: number);
+    /**
+     * Gets the penumbra size of the light.
+     * @returns The penumbra size.
+     */
+    get penumbraSize(): number;
+    /**
+     * Sets the penumbra falloff of the light. Used for PCSS shadows.
+     * @param value - The penumbra falloff.
+     */
+    set penumbraFalloff(value: number);
+    /**
+     * Gets the penumbra falloff of the light.
+     * @returns The penumbra falloff.
+     */
+    get penumbraFalloff(): number;
+    /**
+     * Sets the number of shadow samples. Used for PCSS shadows.
+     * @param value - The number of shadow samples.
+     */
+    set shadowSamples(value: number);
+    /**
+     * Gets the number of shadow samples.
+     * @returns The number of shadow samples.
+     */
+    get shadowSamples(): number;
+    /**
+     * Sets the number of shadow blocker samples. Used for PCSS shadows.
+     * @param value - The number of shadow blocker samples.
+     */
+    set shadowBlockerSamples(value: number);
+    /**
+     * Gets the number of shadow blocker samples.
+     * @returns The number of shadow blocker samples.
+     */
+    get shadowBlockerSamples(): number;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { LightComponentElement };

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

@@ -1,6 +1,6 @@
 import type { LightComponent } from 'playcanvas';
 import { Color } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The LightComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-light/ | `<pc-light>`} elements.

package/dist/components/listener-component.d.cts

@@ -0,0 +1,20 @@
+import type { AudioListenerComponent } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The ListenerComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-listener/ | `<pc-listener>`} elements.
+ * The ListenerComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ListenerComponentElement extends ComponentElement {
+    /** @ignore */
+    constructor();
+    /**
+     * Gets the underlying PlayCanvas audio listener component.
+     * @returns The audio listener component.
+     */
+    get component(): AudioListenerComponent;
+}
+export { ListenerComponentElement };

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

@@ -1,5 +1,5 @@
 import type { AudioListenerComponent } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The ListenerComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-listener/ | `<pc-listener>`} elements.

package/dist/components/particlesystem-component.d.cts

@@ -0,0 +1,52 @@
+import type { ParticleSystemComponent } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The ParticleSystemComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-particles/ | `<pc-particles>`} elements.
+ * The ParticleSystemComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ParticleSystemComponentElement extends ComponentElement {
+    private _asset;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): object;
+    /**
+     * Gets the underlying PlayCanvas particle system component.
+     * @returns The particle system component.
+     */
+    get component(): ParticleSystemComponent;
+    private applyConfig;
+    private _loadAsset;
+    /**
+     * Sets the id of the `pc-asset` to use for the model.
+     * @param value - The asset ID.
+     */
+    set asset(value: string);
+    /**
+     * Gets the id of the `pc-asset` to use for the model.
+     * @returns The asset ID.
+     */
+    get asset(): string;
+    /**
+     * Starts playing the particle system
+     */
+    play(): void;
+    /**
+     * Pauses the particle system
+     */
+    pause(): void;
+    /**
+     * Resets the particle system
+     */
+    reset(): void;
+    /**
+     * Stops the particle system
+     */
+    stop(): void;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { ParticleSystemComponentElement };

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

@@ -1,5 +1,5 @@
 import type { ParticleSystemComponent } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The ParticleSystemComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-particles/ | `<pc-particles>`} elements.

package/dist/components/render-component.d.cts

@@ -0,0 +1,76 @@
+import type { RenderComponent, StandardMaterial } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The RenderComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-render/ | `<pc-render>`} elements.
+ * The RenderComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * This element renders one of the engine's built-in primitives, selected with `type` (defaulting
+ * to `box`). It does not cover the engine's `asset` render type, since there is no way to supply
+ * a render asset here — use `pc-model` for glTF content instead.
+ *
+ * @category Components
+ */
+declare class RenderComponentElement extends ComponentElement {
+    private _castShadows;
+    private _material;
+    private _receiveShadows;
+    private _type;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): {
+        type: "box" | "capsule" | "cone" | "cylinder" | "sphere" | "plane";
+        castShadows: boolean;
+        material: StandardMaterial | null | undefined;
+        receiveShadows: boolean;
+    };
+    /**
+     * Gets the underlying PlayCanvas render component.
+     * @returns The render component.
+     */
+    get component(): RenderComponent;
+    /**
+     * Sets the type of the render component.
+     * @param value - The type.
+     */
+    set type(value: 'box' | 'capsule' | 'cone' | 'cylinder' | 'plane' | 'sphere');
+    /**
+     * Gets the type of the render component.
+     * @returns The type.
+     */
+    get type(): 'box' | 'capsule' | 'cone' | 'cylinder' | 'plane' | 'sphere';
+    /**
+     * Sets the cast shadows flag of the render component.
+     * @param value - The cast shadows flag.
+     */
+    set castShadows(value: boolean);
+    /**
+     * Gets the cast shadows flag of the render component.
+     * @returns The cast shadows flag.
+     */
+    get castShadows(): boolean;
+    /**
+     * Sets the material of the render component.
+     * @param value - The id of the material asset to use.
+     */
+    set material(value: string);
+    /**
+     * Gets the id of the material asset used by the render component.
+     * @returns The id of the material asset.
+     */
+    get material(): string;
+    /**
+     * Sets the receive shadows flag of the render component.
+     * @param value - The receive shadows flag.
+     */
+    set receiveShadows(value: boolean);
+    /**
+     * Gets the receive shadows flag of the render component.
+     * @returns The receive shadows flag.
+     */
+    get receiveShadows(): boolean;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { RenderComponentElement };

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

@@ -1,5 +1,5 @@
 import type { RenderComponent, StandardMaterial } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The RenderComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-render/ | `<pc-render>`} elements.

package/dist/components/rigidbody-component.d.cts

@@ -0,0 +1,88 @@
+import type { RigidBodyComponent } from 'playcanvas';
+import { Vec3 } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The RigidBodyComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-rigidbody/ | `<pc-rigidbody>`} elements.
+ * The RigidBodyComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class RigidBodyComponentElement extends ComponentElement {
+    /**
+     * The angular damping of the rigidbody.
+     */
+    private _angularDamping;
+    /**
+     * The angular factor of the rigidbody.
+     */
+    private _angularFactor;
+    /**
+     * The friction of the rigidbody.
+     */
+    private _friction;
+    /**
+     * The linear damping of the rigidbody.
+     */
+    private _linearDamping;
+    /**
+     * The linear factor of the rigidbody.
+     */
+    private _linearFactor;
+    /**
+     * The mass of the rigidbody.
+     */
+    private _mass;
+    /**
+     * The restitution of the rigidbody.
+     */
+    private _restitution;
+    /**
+     * The rolling friction of the rigidbody.
+     */
+    private _rollingFriction;
+    /**
+     * The type of the rigidbody.
+     */
+    private _type;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): {
+        angularDamping: number;
+        angularFactor: Vec3;
+        friction: number;
+        linearDamping: number;
+        linearFactor: Vec3;
+        mass: number;
+        restitution: number;
+        rollingFriction: number;
+        type: "static" | "dynamic" | "kinematic";
+    };
+    /**
+     * Gets the underlying PlayCanvas rigidbody component.
+     * @returns The rigidbody component.
+     */
+    get component(): RigidBodyComponent;
+    set angularDamping(value: number);
+    get angularDamping(): number;
+    set angularFactor(value: Vec3);
+    get angularFactor(): Vec3;
+    set friction(value: number);
+    get friction(): number;
+    set linearDamping(value: number);
+    get linearDamping(): number;
+    set linearFactor(value: Vec3);
+    get linearFactor(): Vec3;
+    set mass(value: number);
+    get mass(): number;
+    set restitution(value: number);
+    get restitution(): number;
+    set rollingFriction(value: number);
+    get rollingFriction(): number;
+    set type(value: 'static' | 'dynamic' | 'kinematic');
+    get type(): "static" | "dynamic" | "kinematic";
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { RigidBodyComponentElement };

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

@@ -1,6 +1,6 @@
 import type { RigidBodyComponent } from 'playcanvas';
 import { Vec3 } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The RigidBodyComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-rigidbody/ | `<pc-rigidbody>`} elements.

package/dist/components/screen-component.d.cts

@@ -0,0 +1,70 @@
+import type { ScreenComponent } from 'playcanvas';
+import { Vec2 } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The ScreenComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-screen/ | `<pc-screen>`} elements.
+ * The ScreenComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ScreenComponentElement extends ComponentElement {
+    private _screenSpace;
+    private _resolution;
+    private _referenceResolution;
+    private _priority;
+    private _scaleMode;
+    private _scaleBlend;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): {
+        priority: number;
+        referenceResolution: Vec2;
+        resolution: Vec2;
+        scaleBlend: number;
+        scaleMode: string;
+        screenSpace: boolean;
+    };
+    /**
+     * Gets the underlying PlayCanvas screen component.
+     * @returns The screen component.
+     */
+    get component(): ScreenComponent;
+    set priority(value: number);
+    get priority(): number;
+    set referenceResolution(value: Vec2);
+    get referenceResolution(): Vec2;
+    set resolution(value: Vec2);
+    get resolution(): Vec2;
+    /**
+     * Sets how the screen's `resolution` and `referenceResolution` are weighted against each other
+     * when `scaleMode` is `blend`, from 0 (follow the resolution) to 1 (follow the reference
+     * resolution). Ignored while `scaleMode` is `none`.
+     * @param value - The scale blend factor.
+     */
+    set scaleBlend(value: number);
+    /**
+     * Gets how the screen's resolutions are weighted against each other.
+     * @returns The scale blend factor.
+     */
+    get scaleBlend(): number;
+    /**
+     * Sets how the screen scales its contents. `none` renders at `resolution` and ignores
+     * `referenceResolution`; `blend` scales between the two, weighted by `scaleBlend`, which is what
+     * keeps a UI laid out at one resolution usable at another. Requires `screenSpace` - the engine
+     * forces `none` on a world-space screen, which does not support scaling.
+     * @param value - The scale mode ('none' or 'blend').
+     */
+    set scaleMode(value: 'none' | 'blend');
+    /**
+     * Gets how the screen scales its contents.
+     * @returns The scale mode.
+     */
+    get scaleMode(): "none" | "blend";
+    set screenSpace(value: boolean);
+    get screenSpace(): boolean;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { ScreenComponentElement };

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

@@ -1,6 +1,6 @@
 import type { ScreenComponent } from 'playcanvas';
 import { Vec2 } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The ScreenComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-screen/ | `<pc-screen>`} elements.