@playcanvas/web-components 0.1.11 → 0.1.12

package/dist/pwc.cjs

@@ -40,8 +40,9 @@ class AsyncElement extends HTMLElement {
 
 /**
  * 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 */
@@ -79,7 +80,10 @@ class ModuleElement extends HTMLElement {
 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 {
     /**
@@ -238,13 +242,14 @@ class AppElement extends AsyncElement {
         // 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
@@ -275,14 +280,14 @@ class AppElement extends AsyncElement {
         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;
             }
         }
     }
@@ -651,8 +656,9 @@ const parseVec4 = (value) => {
 
 /**
  * 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() {
@@ -990,8 +996,9 @@ const extToType = new Map([
 ]);
 /**
  * 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() {
@@ -1140,8 +1147,9 @@ class ComponentElement extends AsyncElement {
 
 /**
  * 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
  */
@@ -1151,7 +1159,7 @@ class ListenerComponentElement extends ComponentElement {
         super('audiolistener');
     }
     /**
-     * Gets the audio listener component.
+     * Gets the underlying PlayCanvas audio listener component.
      * @returns The audio listener component.
      */
     get component() {
@@ -1171,8 +1179,9 @@ const tonemaps = new Map([
 ]);
 /**
  * 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
  */
@@ -1242,7 +1251,7 @@ class CameraComponentElement extends ComponentElement {
         }
     }
     /**
-     * Gets the camera component.
+     * Gets the underlying PlayCanvas camera component.
      * @returns The camera component.
      */
     get component() {
@@ -1643,8 +1652,9 @@ customElements.define('pc-camera', CameraComponentElement);
 
 /**
  * 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
  */
@@ -1674,7 +1684,7 @@ class CollisionComponentElement extends ComponentElement {
         };
     }
     /**
-     * Gets the collision component.
+     * Gets the underlying PlayCanvas collision component.
      * @returns The collision component.
      */
     get component() {
@@ -1789,8 +1799,9 @@ customElements.define('pc-collision', CollisionComponentElement);
 
 /**
  * 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
  */
@@ -1829,21 +1840,33 @@ class ElementComponentElement extends ComponentElement {
         };
     }
     /**
-     * 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);
@@ -1851,60 +1874,112 @@ class ElementComponentElement extends ComponentElement {
             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;
     }
@@ -1925,21 +2000,37 @@ class ElementComponentElement extends ComponentElement {
     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;
     }
@@ -2001,13 +2092,14 @@ class ElementComponentElement extends ComponentElement {
 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');
@@ -2019,12 +2111,16 @@ class GSplatComponentElement extends ComponentElement {
         };
     }
     /**
-     * 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);
@@ -2032,6 +2128,10 @@ class GSplatComponentElement extends ComponentElement {
             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;
     }
@@ -2047,7 +2147,7 @@ class GSplatComponentElement extends ComponentElement {
         }
     }
 }
-customElements.define('pc-splat', GSplatComponentElement);
+customElements.define('pc-splat', SplatComponentElement);
 
 const shadowTypes = new Map([
     ['pcf1-16f', playcanvas.SHADOW_PCF1_16F],
@@ -2062,8 +2162,9 @@ const shadowTypes = new Map([
 ]);
 /**
  * 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
  */
@@ -2105,7 +2206,7 @@ class LightComponentElement extends ComponentElement {
         };
     }
     /**
-     * Gets the light component.
+     * Gets the underlying PlayCanvas light component.
      * @returns The light component.
      */
     get component() {
@@ -2435,8 +2536,9 @@ customElements.define('pc-light', LightComponentElement);
 
 /**
  * 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() {
@@ -2551,8 +2653,9 @@ customElements.define('pc-material', MaterialElement);
 
 /**
  * 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
  */
@@ -2574,7 +2677,7 @@ class RenderComponentElement extends ComponentElement {
         };
     }
     /**
-     * Gets the render component.
+     * Gets the underlying PlayCanvas render component.
      * @returns The render component.
      */
     get component() {
@@ -2673,8 +2776,9 @@ customElements.define('pc-render', RenderComponentElement);
 
 /**
  * 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
  */
@@ -2733,8 +2837,8 @@ class RigidBodyComponentElement extends ComponentElement {
         };
     }
     /**
-     * Gets the collision component.
-     * @returns The collision component.
+     * Gets the underlying PlayCanvas rigidbody component.
+     * @returns The rigidbody component.
      */
     get component() {
         return super.component;
@@ -2860,8 +2964,9 @@ customElements.define('pc-rigidbody', RigidBodyComponentElement);
 
 /**
  * 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
  */
@@ -2887,7 +2992,7 @@ class ScreenComponentElement extends ComponentElement {
         };
     }
     /**
-     * Gets the screen component.
+     * Gets the underlying PlayCanvas screen component.
      * @returns The screen component.
      */
     get component() {
@@ -2986,8 +3091,9 @@ customElements.define('pc-screen', ScreenComponentElement);
 
 /**
  * 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
  */
@@ -3137,7 +3243,7 @@ class ScriptComponentElement extends ComponentElement {
         (_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() {
@@ -3229,8 +3335,9 @@ customElements.define('pc-script', ScriptElement);
 
 /**
  * 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
  */
@@ -3258,7 +3365,7 @@ class SoundComponentElement extends ComponentElement {
         };
     }
     /**
-     * Gets the sound component.
+     * Gets the underlying PlayCanvas sound component.
      * @returns The sound component.
      */
     get component() {
@@ -3477,7 +3584,7 @@ class SoundSlotElement extends AsyncElement {
         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) {
@@ -3491,7 +3598,7 @@ class SoundSlotElement extends AsyncElement {
         }
     }
     /**
-     * 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() {
@@ -3669,8 +3776,9 @@ customElements.define('pc-sound', SoundSlotElement);
 
 /**
  * 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() {
@@ -3733,7 +3841,7 @@ class ModelElement extends AsyncElement {
         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) {
@@ -3743,8 +3851,8 @@ class ModelElement extends AsyncElement {
         }
     }
     /**
-     * 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;
@@ -3764,8 +3872,9 @@ customElements.define('pc-model', ModelElement);
 
 /**
  * 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() {
@@ -4003,66 +4112,126 @@ class SkyElement extends AsyncElement {
         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) {
@@ -4073,6 +4242,10 @@ class SkyElement extends AsyncElement {
             }
         }
     }
+    /**
+     * Gets the type of the skybox.
+     * @returns The type.
+     */
     get type() {
         return this._type;
     }
@@ -4118,7 +4291,6 @@ exports.CollisionComponentElement = CollisionComponentElement;
 exports.ComponentElement = ComponentElement;
 exports.ElementComponentElement = ElementComponentElement;
 exports.EntityElement = EntityElement;
-exports.GSplatComponentElement = GSplatComponentElement;
 exports.LightComponentElement = LightComponentElement;
 exports.ListenerComponentElement = ListenerComponentElement;
 exports.MaterialElement = MaterialElement;
@@ -4133,4 +4305,5 @@ exports.ScriptElement = ScriptElement;
 exports.SkyElement = SkyElement;
 exports.SoundComponentElement = SoundComponentElement;
 exports.SoundSlotElement = SoundSlotElement;
+exports.SplatComponentElement = SplatComponentElement;
 //# sourceMappingURL=pwc.cjs.map