@playcanvas/web-components 0.1.3 → 0.1.5

package/src/components/collision-component.ts

@@ -1,7 +1,7 @@
-import { CollisionComponent, Vec3 } from 'playcanvas';
+import { CollisionComponent, Quat, Vec3 } from 'playcanvas';
 
 import { ComponentElement } from './component';
-import { parseVec3 } from '../utils';
+import { parseQuat, parseVec3 } from '../utils';
 
 /**
  * Represents a collision component in the PlayCanvas engine.
@@ -9,6 +9,8 @@ import { parseVec3 } from '../utils';
  * @category Components
  */
 class CollisionComponentElement extends ComponentElement {
+    private _angularOffset: Quat = new Quat();
+
     private _axis: number = 1;
 
     private _convexHull: boolean = false;
@@ -17,6 +19,8 @@ class CollisionComponentElement extends ComponentElement {
 
     private _height: number = 2;
 
+    private _linearOffset: Vec3 = new Vec3();
+
     private _radius: number = 0.5;
 
     private _type: string = 'box';
@@ -31,9 +35,11 @@ class CollisionComponentElement extends ComponentElement {
     getInitialComponentData() {
         return {
             axis: this._axis,
+            angularOffset: this._angularOffset,
             convexHull: this._convexHull,
             halfExtents: this._halfExtents,
             height: this._height,
+            linearOffset: this._linearOffset,
             radius: this._radius,
             type: this._type
         };
@@ -47,6 +53,17 @@ class CollisionComponentElement extends ComponentElement {
         return super.component as CollisionComponent | null;
     }
 
+    set angularOffset(value: Quat) {
+        this._angularOffset = value;
+        if (this.component) {
+            this.component.angularOffset = value;
+        }
+    }
+
+    get angularOffset() {
+        return this._angularOffset;
+    }
+
     set axis(value: number) {
         this._axis = value;
         if (this.component) {
@@ -91,6 +108,17 @@ class CollisionComponentElement extends ComponentElement {
         return this._height;
     }
 
+    set linearOffset(value: Vec3) {
+        this._linearOffset = value;
+        if (this.component) {
+            this.component.linearOffset = value;
+        }
+    }
+
+    get linearOffset() {
+        return this._linearOffset;
+    }
+
     set radius(value: number) {
         this._radius = value;
         if (this.component) {
@@ -114,13 +142,16 @@ class CollisionComponentElement extends ComponentElement {
     }
 
     static get observedAttributes() {
-        return [...super.observedAttributes, 'axis', 'convex-hull', 'half-extents', 'height', 'radius', 'type'];
+        return [...super.observedAttributes, 'angular-offset', 'axis', 'convex-hull', 'half-extents', 'height', 'linear-offset', 'radius', 'type'];
     }
 
     attributeChangedCallback(name: string, _oldValue: string, newValue: string) {
         super.attributeChangedCallback(name, _oldValue, newValue);
 
         switch (name) {
+            case 'angular-offset':
+                this.angularOffset = parseQuat(newValue);
+                break;
             case 'axis':
                 this.axis = parseInt(newValue, 10);
                 break;
@@ -133,6 +164,9 @@ class CollisionComponentElement extends ComponentElement {
             case 'height':
                 this.height = parseFloat(newValue);
                 break;
+            case 'linear-offset':
+                this.linearOffset = parseVec3(newValue);
+                break;
             case 'radius':
                 this.radius = parseFloat(newValue);
                 break;

package/src/components/component.ts

@@ -1,14 +1,13 @@
 import { Component } from 'playcanvas';
 
-import { AppElement } from '../app';
-import { EntityElement } from '../entity';
+import { AsyncElement } from '../async-element';
 
 /**
  * Represents a component in the PlayCanvas engine.
  *
  * @category Components
  */
-class ComponentElement extends HTMLElement {
+class ComponentElement extends AsyncElement {
     private _componentName: string;
 
     private _enabled = true;
@@ -30,33 +29,23 @@ class ComponentElement extends HTMLElement {
         return {};
     }
 
-    async connectedCallback() {
-        const appElement = this.closest('pc-app') as AppElement | null;
-        if (!appElement) {
-            console.error(`${this.tagName.toLowerCase()} should be a descendant of pc-app`);
-            return;
+    async addComponent() {
+        const entityElement = this.closestEntity;
+        if (entityElement) {
+            await entityElement.ready();
+            // Add the component to the entity
+            const data = this.getInitialComponentData();
+            this._component = entityElement.entity!.addComponent(this._componentName, data);
         }
-
-        await appElement.getApplication();
-
-        this.addComponent();
     }
 
-    addComponent() {
-        // Access the parent pc-entity's 'entity' property
-        const entityElement = this.closest('pc-entity') as EntityElement | null;
-        if (!entityElement) {
-            console.error(`${this.tagName.toLowerCase()} should be a child of pc-entity`);
-            return;
-        }
+    initComponent() {}
 
-        if (entityElement && entityElement.entity) {
-            // Add the component to the entity
-            this._component = entityElement.entity.addComponent(
-                this._componentName,
-                this.getInitialComponentData()
-            );
-        }
+    async connectedCallback() {
+        await this.closestApp?.ready();
+        await this.addComponent();
+        this.initComponent();
+        this._onReady();
     }
 
     disconnectedCallback() {

package/src/components/element-component.ts

@@ -37,9 +37,7 @@ class ElementComponentElement extends ComponentElement {
         super('element');
     }
 
-    async connectedCallback() {
-        await super.connectedCallback();
-
+    initComponent() {
         this.component!._text._material.useFog = true;
     }
 
@@ -198,7 +196,20 @@ class ElementComponentElement extends ComponentElement {
     }
 
     static get observedAttributes() {
-        return [...super.observedAttributes, 'anchor', 'asset', 'auto-width', 'color', 'font-size', 'line-height', 'pivot', 'text', 'type', 'width', 'wrap-lines'];
+        return [
+            ...super.observedAttributes,
+            'anchor',
+            'asset',
+            'auto-width',
+            'color',
+            'font-size',
+            'line-height',
+            'pivot',
+            'text',
+            'type',
+            'width',
+            'wrap-lines'
+        ];
     }
 
     attributeChangedCallback(name: string, _oldValue: string, newValue: string) {

package/src/components/render-component.ts

@@ -21,16 +21,11 @@ class RenderComponentElement extends ComponentElement {
         super('render');
     }
 
-    async connectedCallback() {
-        await super.connectedCallback();
-
-        this.material = this._material;
-    }
-
     getInitialComponentData() {
         return {
             type: this._type,
             castShadows: this._castShadows,
+            material: MaterialElement.get(this._material),
             receiveShadows: this._receiveShadows
         };
     }

package/src/components/screen-component.ts

@@ -127,7 +127,7 @@ class ScreenComponentElement extends ComponentElement {
 
         switch (name) {
             case 'priority':
-                this.priority = parseInt(newValue);
+                this.priority = parseInt(newValue, 10);
                 break;
             case 'reference-resolution':
                 this.referenceResolution = parseVec2(newValue);

package/src/components/script-component.ts

@@ -42,9 +42,7 @@ class ScriptComponentElement extends ComponentElement {
         this.addEventListener('scriptenablechange', this.handleScriptEnableChange.bind(this));
     }
 
-    async connectedCallback() {
-        await super.connectedCallback();
-
+    initComponent() {
         // Handle initial script elements
         this.querySelectorAll<ScriptElement>(':scope > pc-script').forEach((scriptElement) => {
             const scriptName = scriptElement.getAttribute('name');

package/src/components/sound-slot.ts

@@ -1,13 +1,13 @@
 import { SoundSlot } from 'playcanvas';
 
-import { AppElement } from '../app';
-import { SoundComponentElement } from './sound-component';
 import { AssetElement } from '../asset';
+import { AsyncElement } from '../async-element';
+import { SoundComponentElement } from './sound-component';
 
 /**
  * Represents a sound slot in the PlayCanvas engine.
  */
-class SoundSlotElement extends HTMLElement {
+class SoundSlotElement extends AsyncElement {
     private _asset: string = '';
 
     private _autoPlay: boolean = false;
@@ -32,13 +32,7 @@ class SoundSlotElement extends HTMLElement {
     soundSlot: SoundSlot | null = null;
 
     async connectedCallback() {
-        const appElement = this.closest('pc-app') as AppElement | null;
-        if (!appElement) {
-            console.error(`${this.tagName.toLowerCase()} should be a descendant of pc-app`);
-            return;
-        }
-
-        await appElement.getApplication();
+        await this.soundElement?.ready();
 
         const options = {
             autoPlay: this._autoPlay,
@@ -51,9 +45,12 @@ class SoundSlotElement extends HTMLElement {
         if (this._duration) {
             options.duration = this._duration;
         }
+
         this.soundSlot = this.soundElement!.component!.addSlot(this._name, options);
         this.asset = this._asset;
         this.soundSlot!.play();
+
+        this._onReady();
     }
 
     disconnectedCallback() {

package/src/entity.ts

@@ -1,12 +1,12 @@
 import { Entity, Vec3 } from 'playcanvas';
 
-import { AppElement } from './app';
+import { AsyncElement } from './async-element';
 import { parseVec3 } from './utils';
 
 /**
  * Represents an entity in the PlayCanvas engine.
  */
-class EntityElement extends HTMLElement {
+class EntityElement extends AsyncElement {
     /**
      * Whether the entity is enabled.
      */
@@ -43,24 +43,17 @@ class EntityElement extends HTMLElement {
     entity: Entity | null = null;
 
     async connectedCallback() {
-        // Get the application
-        const appElement = this.closest('pc-app') as AppElement;
-        if (!appElement) {
-            console.warn(`${this.tagName} must be a child of pc-app`);
-            return;
-        }
+        const closestApp = this.closestApp;
+        if (!closestApp) return;
+
+        // Wait for the app to complete initialization
+        await closestApp.ready();
 
-        const app = await appElement.getApplication();
+        const app = closestApp.app!;
 
         // Create a new entity
         this.entity = new Entity(this._name, app);
 
-        if (this.parentElement && this.parentElement.tagName.toLowerCase() === 'pc-entity' && (this.parentElement as EntityElement).entity) {
-            (this.parentElement as EntityElement).entity!.addChild(this.entity);
-        } else {
-            app.root.addChild(this.entity);
-        }
-
         // Initialize from attributes
         const nameAttr = this.getAttribute('name');
         const positionAttr = this.getAttribute('position');
@@ -73,10 +66,27 @@ class EntityElement extends HTMLElement {
         if (rotationAttr) this.rotation = parseVec3(rotationAttr);
         if (scaleAttr) this.scale = parseVec3(scaleAttr);
         if (tagsAttr) this.tags = tagsAttr.split(',').map(tag => tag.trim());
+
+        const closestEntity = this.closestEntity;
+        if (closestEntity) {
+            closestEntity.ready().then(() => {
+                closestEntity.entity!.addChild(this.entity!);
+                this._onReady();
+            });
+        } else {
+            app.root.addChild(this.entity);
+            this._onReady();
+        }
     }
 
     disconnectedCallback() {
         if (this.entity) {
+            // Notify all children that their entities are about to become invalid
+            const children = this.querySelectorAll('pc-entity');
+            children.forEach((child) => {
+                (child as EntityElement).entity = null;
+            });
+
             this.entity.destroy();
             this.entity = null;
         }

package/src/index.ts

@@ -1,6 +1,16 @@
+/**
+ * The Engine Web Components module provides a set of Web Components for the PlayCanvas Engine.
+ * While these components are normally instantiated in a declarative fashion using HTML, this
+ * reference covers the TypeScript/JavaScript API that allows these components to be created
+ * programmatically.
+ *
+ * @module EngineWebComponents
+ */
+
 /* eslint-disable import/order */
 
 // Note that order matters here (e.g. pc-entity must be defined before components)
+import { AsyncElement } from './async-element';
 import { ModuleElement } from './module';
 import { AppElement } from './app';
 import { EntityElement } from './entity';
@@ -25,6 +35,7 @@ import { SceneElement } from './scene';
 import { SkyElement } from './sky';
 
 export {
+    AsyncElement,
     ModuleElement,
     AppElement,
     EntityElement,

package/src/model.ts

@@ -1,27 +1,21 @@
-import { AppElement } from './app';
 import { AssetElement } from './asset';
-import { EntityElement } from './entity';
+import { AsyncElement } from './async-element';
 
 /**
  * Represents a model in the PlayCanvas engine.
  */
-class ModelElement extends HTMLElement {
+class ModelElement extends AsyncElement {
     private _asset: string = '';
 
     async connectedCallback() {
-        // Get the application
-        const appElement = this.closest('pc-app') as AppElement;
-        if (!appElement) {
-            console.warn(`${this.tagName} must be a child of pc-app`);
-            return;
-        }
-
-        await appElement.getApplication();
+        await this.closestApp?.ready();
 
         const asset = this.getAttribute('asset');
         if (asset) {
             this.asset = asset;
         }
+
+        this._onReady();
     }
 
     _loadModel() {
@@ -31,12 +25,23 @@ class ModelElement extends HTMLElement {
         }
         const entity = asset.resource.instantiateRenderEntity();
 
-        const parentEntityElement = this.closest('pc-entity') as EntityElement | null;
+        if (asset.resource.animations.length > 0) {
+            entity.addComponent('anim');
+            entity.anim.assignAnimation('animation', asset.resource.animations[0].resource);
+        }
+
+        const parentEntityElement = this.closestEntity;
         if (parentEntityElement) {
-            parentEntityElement.entity!.addChild(entity);
+            parentEntityElement.ready().then(() => {
+                parentEntityElement.entity!.addChild(entity);
+            });
         } else {
-            const appElement = this.closest('pc-app') as AppElement;
-            appElement.app!.root.addChild(entity);
+            const appElement = this.closestApp;
+            if (appElement) {
+                appElement.ready().then(() => {
+                    appElement.app!.root.addChild(entity);
+                });
+            }
         }
     }
 

package/src/scene.ts

@@ -1,12 +1,12 @@
 import { Color, Scene } from 'playcanvas';
 
-import { AppElement } from './app';
+import { AsyncElement } from './async-element';
 import { parseColor } from './utils';
 
 /**
  * Represents a scene in the PlayCanvas engine.
  */
-class SceneElement extends HTMLElement {
+class SceneElement extends AsyncElement {
     /**
      * The fog type of the scene.
      */
@@ -38,17 +38,12 @@ class SceneElement extends HTMLElement {
     scene: Scene | null = null;
 
     async connectedCallback() {
-        // Get the application
-        const appElement = this.closest('pc-app') as AppElement;
-        if (!appElement) {
-            console.warn(`${this.tagName} must be a child of pc-app`);
-            return;
-        }
-
-        const app = await appElement.getApplication();
+        await this.closestApp?.ready();
 
-        this.scene = app.scene;
+        this.scene = this.closestApp!.app!.scene;
         this.updateSceneSettings();
+
+        this._onReady();
     }
 
     updateSceneSettings() {