@playcanvas/web-components 0.1.11 → 0.1.12

package/dist/pwc.js

@@ -42,8 +42,9 @@
 
     /**
      * The ModuleElement interface provides properties and methods for manipulating
-     * `<pc-module>` elements. The ModuleElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-module/ | `<pc-module>`} elements.
+     * The ModuleElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      */
     class ModuleElement extends HTMLElement {
         /** @ignore */
@@ -81,7 +82,10 @@
     customElements.define('pc-module', ModuleElement);
 
     /**
-     * The main application element.
+     * The AppElement interface provides properties and methods for manipulating
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-app/ | `<pc-app>`} elements.
+     * The AppElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      */
     class AppElement extends AsyncElement {
         /**
@@ -240,13 +244,14 @@
             // Get the currently hovered entity by walking up the hierarchy
             let newHoverEntity = null;
             if (selection.length > 0) {
-                let node = selection[0].node;
-                while (node && !newHoverEntity) {
-                    const entityElement = this.querySelector(`pc-entity[name="${node.name}"]`);
+                let currentNode = selection[0].node;
+                while (currentNode !== null) {
+                    const entityElement = this.querySelector(`pc-entity[name="${currentNode.name}"]`);
                     if (entityElement) {
                         newHoverEntity = entityElement;
+                        break;
                     }
-                    node = node.parent;
+                    currentNode = currentNode.parent;
                 }
             }
             // Handle enter/leave events
@@ -277,14 +282,14 @@
             this._picker.prepare(camera, this.app.scene);
             const selection = this._picker.getSelection(x, y);
             if (selection.length > 0) {
-                let node = selection[0].node;
-                while (node) {
-                    const entityElement = this.querySelector(`pc-entity[name="${node.name}"]`);
+                let currentNode = selection[0].node;
+                while (currentNode !== null) {
+                    const entityElement = this.querySelector(`pc-entity[name="${currentNode.name}"]`);
                     if (entityElement && entityElement.hasListeners('pointerdown')) {
                         entityElement.dispatchEvent(new PointerEvent('pointerdown', event));
                         break;
                     }
-                    node = node.parent;
+                    currentNode = currentNode.parent;
                 }
             }
         }
@@ -653,8 +658,9 @@
 
     /**
      * The EntityElement interface provides properties and methods for manipulating
-     * `<pc-entity>` elements. The EntityElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-entity/ | `<pc-entity>`} elements.
+     * The EntityElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      */
     class EntityElement extends AsyncElement {
         constructor() {
@@ -992,8 +998,9 @@
     ]);
     /**
      * The AssetElement interface provides properties and methods for manipulating
-     * `<pc-asset>` elements. The AssetElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-asset/ | `<pc-asset>`} elements.
+     * The AssetElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      */
     class AssetElement extends HTMLElement {
         constructor() {
@@ -1142,8 +1149,9 @@
 
     /**
      * The ListenerComponentElement interface provides properties and methods for manipulating
-     * `<pc-listener>` elements. The ListenerComponentElement interface also inherits the properties
-     * and methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-listener/ | `<pc-listener>`} elements.
+     * The ListenerComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -1153,7 +1161,7 @@
             super('audiolistener');
         }
         /**
-         * Gets the audio listener component.
+         * Gets the underlying PlayCanvas audio listener component.
          * @returns The audio listener component.
          */
         get component() {
@@ -1173,8 +1181,9 @@
     ]);
     /**
      * The CameraComponentElement interface provides properties and methods for manipulating
-     * `<pc-camera>` elements. The CameraComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-camera/ | `<pc-camera>`} elements.
+     * The CameraComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -1244,7 +1253,7 @@
             }
         }
         /**
-         * Gets the camera component.
+         * Gets the underlying PlayCanvas camera component.
          * @returns The camera component.
          */
         get component() {
@@ -1645,8 +1654,9 @@
 
     /**
      * The CollisionComponentElement interface provides properties and methods for manipulating
-     * `<pc-collision>` elements. The CollisionComponentElement interface also inherits the properties
-     * and methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-collision/ | `<pc-collision>`} elements.
+     * The CollisionComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -1676,7 +1686,7 @@
             };
         }
         /**
-         * Gets the collision component.
+         * Gets the underlying PlayCanvas collision component.
          * @returns The collision component.
          */
         get component() {
@@ -1791,8 +1801,9 @@
 
     /**
      * The ElementComponentElement interface provides properties and methods for manipulating
-     * `<pc-element>` elements. The ElementComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-element/ | `<pc-element>`} elements.
+     * The ElementComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -1831,21 +1842,33 @@
             };
         }
         /**
-         * Gets the element component.
+         * Gets the underlying PlayCanvas element component.
          * @returns The element component.
          */
         get component() {
             return super.component;
         }
+        /**
+         * Sets the anchor of the element component.
+         * @param value - The anchor.
+         */
         set anchor(value) {
             this._anchor = value;
             if (this.component) {
                 this.component.anchor = value;
             }
         }
+        /**
+         * Gets the anchor of the element component.
+         * @returns The anchor.
+         */
         get anchor() {
             return this._anchor;
         }
+        /**
+         * Sets the id of the `pc-asset` to use for the font.
+         * @param value - The asset ID.
+         */
         set asset(value) {
             this._asset = value;
             const asset = AssetElement.get(value);
@@ -1853,60 +1876,112 @@
                 this.component.fontAsset = asset.id;
             }
         }
+        /**
+         * Gets the id of the `pc-asset` to use for the font.
+         * @returns The asset ID.
+         */
         get asset() {
             return this._asset;
         }
+        /**
+         * Sets whether the element component should automatically adjust its width.
+         * @param value - Whether to automatically adjust the width.
+         */
         set autoWidth(value) {
             this._autoWidth = value;
             if (this.component) {
                 this.component.autoWidth = value;
             }
         }
+        /**
+         * Gets whether the element component should automatically adjust its width.
+         * @returns Whether to automatically adjust the width.
+         */
         get autoWidth() {
             return this._autoWidth;
         }
+        /**
+         * Sets the color of the element component.
+         * @param value - The color.
+         */
         set color(value) {
             this._color = value;
             if (this.component) {
                 this.component.color = value;
             }
         }
+        /**
+         * Gets the color of the element component.
+         * @returns The color.
+         */
         get color() {
             return this._color;
         }
+        /**
+         * Sets the font size of the element component.
+         * @param value - The font size.
+         */
         set fontSize(value) {
             this._fontSize = value;
             if (this.component) {
                 this.component.fontSize = value;
             }
         }
+        /**
+         * Gets the font size of the element component.
+         * @returns The font size.
+         */
         get fontSize() {
             return this._fontSize;
         }
+        /**
+         * Sets the line height of the element component.
+         * @param value - The line height.
+         */
         set lineHeight(value) {
             this._lineHeight = value;
             if (this.component) {
                 this.component.lineHeight = value;
             }
         }
+        /**
+         * Gets the line height of the element component.
+         * @returns The line height.
+         */
         get lineHeight() {
             return this._lineHeight;
         }
+        /**
+         * Sets the pivot of the element component.
+         * @param value - The pivot.
+         */
         set pivot(value) {
             this._pivot = value;
             if (this.component) {
                 this.component.pivot = value;
             }
         }
+        /**
+         * Gets the pivot of the element component.
+         * @returns The pivot.
+         */
         get pivot() {
             return this._pivot;
         }
+        /**
+         * Sets the text of the element component.
+         * @param value - The text.
+         */
         set text(value) {
             this._text = value;
             if (this.component) {
                 this.component.text = value;
             }
         }
+        /**
+         * Gets the text of the element component.
+         * @returns The text.
+         */
         get text() {
             return this._text;
         }
@@ -1927,21 +2002,37 @@
         get type() {
             return this._type;
         }
+        /**
+         * Sets the width of the element component.
+         * @param value - The width.
+         */
         set width(value) {
             this._width = value;
             if (this.component) {
                 this.component.width = value;
             }
         }
+        /**
+         * Gets the width of the element component.
+         * @returns The width.
+         */
         get width() {
             return this._width;
         }
+        /**
+         * Sets whether the element component should wrap lines.
+         * @param value - Whether to wrap lines.
+         */
         set wrapLines(value) {
             this._wrapLines = value;
             if (this.component) {
                 this.component.wrapLines = value;
             }
         }
+        /**
+         * Gets whether the element component should wrap lines.
+         * @returns Whether to wrap lines.
+         */
         get wrapLines() {
             return this._wrapLines;
         }
@@ -2003,13 +2094,14 @@
     customElements.define('pc-element', ElementComponentElement);
 
     /**
-     * The GSplatComponentElement interface provides properties and methods for manipulating
-     * `<pc-splat>` elements. The GSplatComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * The SplatComponentElement interface provides properties and methods for manipulating
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-splat/ | `<pc-splat>`} elements.
+     * The SplatComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
-    class GSplatComponentElement extends ComponentElement {
+    class SplatComponentElement extends ComponentElement {
         /** @ignore */
         constructor() {
             super('gsplat');
@@ -2021,12 +2113,16 @@
             };
         }
         /**
-         * Gets the gsplat component.
-         * @returns The gsplat component.
+         * Gets the underlying PlayCanvas splat component.
+         * @returns The splat component.
          */
         get component() {
             return super.component;
         }
+        /**
+         * Sets id of the `pc-asset` to use for the splat.
+         * @param value - The asset ID.
+         */
         set asset(value) {
             this._asset = value;
             const asset = AssetElement.get(value);
@@ -2034,6 +2130,10 @@
                 this.component.asset = asset;
             }
         }
+        /**
+         * Gets the id of the `pc-asset` to use for the splat.
+         * @returns The asset ID.
+         */
         get asset() {
             return this._asset;
         }
@@ -2049,7 +2149,7 @@
             }
         }
     }
-    customElements.define('pc-splat', GSplatComponentElement);
+    customElements.define('pc-splat', SplatComponentElement);
 
     const shadowTypes = new Map([
         ['pcf1-16f', playcanvas.SHADOW_PCF1_16F],
@@ -2064,8 +2164,9 @@
     ]);
     /**
      * The LightComponentElement interface provides properties and methods for manipulating
-     * `<pc-light>` elements. The LightComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-light/ | `<pc-light>`} elements.
+     * The LightComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -2107,7 +2208,7 @@
             };
         }
         /**
-         * Gets the light component.
+         * Gets the underlying PlayCanvas light component.
          * @returns The light component.
          */
         get component() {
@@ -2437,8 +2538,9 @@
 
     /**
      * The MaterialElement interface provides properties and methods for manipulating
-     * `<pc-material>` elements. The MaterialElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-material/ | `<pc-material>`} elements.
+     * The MaterialElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      */
     class MaterialElement extends HTMLElement {
         constructor() {
@@ -2553,8 +2655,9 @@
 
     /**
      * The RenderComponentElement interface provides properties and methods for manipulating
-     * `<pc-render>` elements. The RenderComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-render/ | `<pc-render>`} elements.
+     * The RenderComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -2576,7 +2679,7 @@
             };
         }
         /**
-         * Gets the render component.
+         * Gets the underlying PlayCanvas render component.
          * @returns The render component.
          */
         get component() {
@@ -2675,8 +2778,9 @@
 
     /**
      * The RigidBodyComponentElement interface provides properties and methods for manipulating
-     * `<pc-rigidbody>` elements. The RigidBodyComponentElement interface also inherits the properties
-     * and methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-rigidbody/ | `<pc-rigidbody>`} elements.
+     * The RigidBodyComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -2735,8 +2839,8 @@
             };
         }
         /**
-         * Gets the collision component.
-         * @returns The collision component.
+         * Gets the underlying PlayCanvas rigidbody component.
+         * @returns The rigidbody component.
          */
         get component() {
             return super.component;
@@ -2862,8 +2966,9 @@
 
     /**
      * The ScreenComponentElement interface provides properties and methods for manipulating
-     * `<pc-screen>` elements. The ScreenComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-screen/ | `<pc-screen>`} elements.
+     * The ScreenComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -2889,7 +2994,7 @@
             };
         }
         /**
-         * Gets the screen component.
+         * Gets the underlying PlayCanvas screen component.
          * @returns The screen component.
          */
         get component() {
@@ -2988,8 +3093,9 @@
 
     /**
      * The ScriptComponentElement interface provides properties and methods for manipulating
-     * `<pc-scripts>` elements. The ScriptComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-scripts/ | `<pc-scripts>`} elements.
+     * The ScriptComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -3139,7 +3245,7 @@
             (_a = super.disconnectedCallback) === null || _a === undefined ? undefined : _a.call(this);
         }
         /**
-         * Gets the script component.
+         * Gets the underlying PlayCanvas script component.
          * @returns The script component.
          */
         get component() {
@@ -3231,8 +3337,9 @@
 
     /**
      * The SoundComponentElement interface provides properties and methods for manipulating
-     * `<pc-sounds>` elements. The SoundComponentElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-sounds/ | `<pc-sounds>`} elements.
+     * The SoundComponentElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      *
      * @category Components
      */
@@ -3260,7 +3367,7 @@
             };
         }
         /**
-         * Gets the sound component.
+         * Gets the underlying PlayCanvas sound component.
          * @returns The sound component.
          */
         get component() {
@@ -3479,7 +3586,7 @@
             return soundElement;
         }
         /**
-         * Sets the asset of the sound slot.
+         * Sets the id of the `pc-asset` to use for the sound slot.
          * @param value - The asset.
          */
         set asset(value) {
@@ -3493,7 +3600,7 @@
             }
         }
         /**
-         * Gets the asset of the sound slot.
+         * Gets the id of the `pc-asset` to use for the sound slot.
          * @returns The asset.
          */
         get asset() {
@@ -3671,8 +3778,9 @@
 
     /**
      * The ModelElement interface provides properties and methods for manipulating
-     * `<pc-model>` elements. The ModelElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-model/ | `<pc-model>`} elements.
+     * The ModelElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      */
     class ModelElement extends AsyncElement {
         constructor() {
@@ -3735,7 +3843,7 @@
             this._entity = null;
         }
         /**
-         * Sets the asset ID of the model.
+         * Sets the id of the `pc-asset` to use for the model.
          * @param value - The asset ID.
          */
         set asset(value) {
@@ -3745,8 +3853,8 @@
             }
         }
         /**
-         * Gets the source URL of the model.
-         * @returns The source URL of the model.
+         * Gets the id of the `pc-asset` to use for the model.
+         * @returns The asset ID.
          */
         get asset() {
             return this._asset;
@@ -3766,8 +3874,9 @@
 
     /**
      * The SceneElement interface provides properties and methods for manipulating
-     * `<pc-scene>` elements. The SceneElement interface also inherits the properties and
-     * methods of the {@link HTMLElement} interface.
+     * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-scene/ | `<pc-scene>`} elements.
+     * The SceneElement interface also inherits the properties and methods of the
+     * {@link HTMLElement} interface.
      */
     class SceneElement extends AsyncElement {
         constructor() {
@@ -4005,66 +4114,126 @@
             this._scene.envAtlas = null;
             this._scene = null;
         }
+        /**
+         * Sets the id of the `pc-asset` to use for the skybox.
+         * @param value - The asset ID.
+         */
         set asset(value) {
             this._asset = value;
             if (this.isConnected) {
                 this._loadSkybox();
             }
         }
+        /**
+         * Gets the id of the `pc-asset` to use for the skybox.
+         * @returns The asset ID.
+         */
         get asset() {
             return this._asset;
         }
+        /**
+         * Sets the center of the skybox.
+         * @param value - The center.
+         */
         set center(value) {
             this._center = value;
             if (this._scene) {
                 this._scene.sky.center = this._center;
             }
         }
+        /**
+         * Gets the center of the skybox.
+         * @returns The center.
+         */
         get center() {
             return this._center;
         }
+        /**
+         * Sets the intensity of the skybox.
+         * @param value - The intensity.
+         */
         set intensity(value) {
             this._intensity = value;
             if (this._scene) {
                 this._scene.skyboxIntensity = this._intensity;
             }
         }
+        /**
+         * Gets the intensity of the skybox.
+         * @returns The intensity.
+         */
         get intensity() {
             return this._intensity;
         }
+        /**
+         * Sets the mip level of the skybox.
+         * @param value - The mip level.
+         */
         set level(value) {
             this._level = value;
             if (this._scene) {
                 this._scene.skyboxMip = this._level;
             }
         }
+        /**
+         * Gets the mip level of the skybox.
+         * @returns The mip level.
+         */
         get level() {
             return this._level;
         }
+        /**
+         * Sets whether the skybox is used as a light source.
+         * @param value - Whether to use lighting.
+         */
         set lighting(value) {
             this._lighting = value;
         }
+        /**
+         * Gets whether the skybox is used as a light source.
+         * @returns Whether to use lighting.
+         */
         get lighting() {
             return this._lighting;
         }
+        /**
+         * Sets the Euler rotation of the skybox.
+         * @param value - The rotation.
+         */
         set rotation(value) {
             this._rotation = value;
             if (this._scene) {
                 this._scene.skyboxRotation = new playcanvas.Quat().setFromEulerAngles(value);
             }
         }
+        /**
+         * Gets the Euler rotation of the skybox.
+         * @returns The rotation.
+         */
         get rotation() {
             return this._rotation;
         }
+        /**
+         * Sets the scale of the skybox.
+         * @param value - The scale.
+         */
         set scale(value) {
             this._scale = value;
             if (this._scene) {
                 this._scene.sky.node.setLocalScale(this._scale);
             }
         }
+        /**
+         * Gets the scale of the skybox.
+         * @returns The scale.
+         */
         get scale() {
             return this._scale;
         }
+        /**
+         * Sets the type of the skybox.
+         * @param value - The type.
+         */
         set type(value) {
             this._type = value;
             if (this._scene) {
@@ -4075,6 +4244,10 @@
                 }
             }
         }
+        /**
+         * Gets the type of the skybox.
+         * @returns The type.
+         */
         get type() {
             return this._type;
         }
@@ -4120,7 +4293,6 @@
     exports.ComponentElement = ComponentElement;
     exports.ElementComponentElement = ElementComponentElement;
     exports.EntityElement = EntityElement;
-    exports.GSplatComponentElement = GSplatComponentElement;
     exports.LightComponentElement = LightComponentElement;
     exports.ListenerComponentElement = ListenerComponentElement;
     exports.MaterialElement = MaterialElement;
@@ -4135,6 +4307,7 @@
     exports.SkyElement = SkyElement;
     exports.SoundComponentElement = SoundComponentElement;
     exports.SoundSlotElement = SoundSlotElement;
+    exports.SplatComponentElement = SplatComponentElement;
 
 }));
 //# sourceMappingURL=pwc.js.map