Common interface for async node initialization

playcanvas · Nov 11, 2024 · 51763b9 · 51763b9
1 parent ae0aa9d
commit 51763b9
Show file tree

Hide file tree

Showing 17 changed files with 177 additions and 139 deletions.
diff --git a/examples/animation.html b/examples/animation.html
@@ -42,5 +42,27 @@
                 </pc-entity>
             </pc-scene>
         </pc-app>
+        <button id="xr-button" style="position: absolute; bottom: 20px; left: 50%; transform: translateX(-50%); display: none;">
+            Enter VR
+        </button>
+        <script>
+            document.addEventListener('DOMContentLoaded', async () => {
+                const camera = document.querySelector('pc-camera');
+                await camera.ready();
+                if (camera.xrAvailable) {
+                    const button = document.getElementById('xr-button');
+                    button.style.display = 'block';
+                    button.addEventListener('click', () => {
+                        if (button.textContent === 'Enter VR') {
+                            camera.startXr();
+                            button.textContent = 'Exit VR';
+                        } else {
+                            camera.endXr();
+                            button.textContent = 'Enter VR';
+                        }
+                    });
+                }
+            });
+        </script>
     </body>
 </html>
diff --git a/examples/spinning-cube-api.html b/examples/spinning-cube-api.html
@@ -21,7 +21,8 @@
             // Use the DOM API to programmatically create the scene
             const app = document.createElement('pc-app');
             document.body.appendChild(app);
-            await app.getApplication();
+
+            await app.ready();
 
             class Rotate extends Script { 
                 update(dt) {

diff --git a/examples/splat.html b/examples/splat.html
@@ -18,7 +18,6 @@
         <pc-app>
             <!-- Assets -->
             <pc-asset id="orbit-camera" src="scripts/orbit-camera.mjs" preload></pc-asset>
-            <pc-asset id="helipad" src="assets/helipad-env-atlas.png" preload></pc-asset>
             <pc-asset id="angel" src="assets/angel.compressed.ply" preload></pc-asset>
             <!-- Scene -->
             <pc-scene>

diff --git a/src/app.ts b/src/app.ts
@@ -1,22 +1,19 @@
 import { Application, FILLMODE_FILL_WINDOW, Keyboard, Mouse, RESOLUTION_AUTO } from 'playcanvas';
 
 import { AssetElement } from './asset';
+import { AsyncElement } from './async-element';
 import { MaterialElement } from './material';
 import { ModuleElement } from './module';
 
 /**
  * The main application element.
  */
-class AppElement extends HTMLElement {
+class AppElement extends AsyncElement {
     /**
      * The canvas element.
      */
     private _canvas: HTMLCanvasElement | null = null;
 
-    private appReadyPromise: Promise<Application>;
-
-    private appReadyResolve!: (app: Application) => void;
-
     private _highResolution = false;
 
     /**
@@ -32,10 +29,6 @@ class AppElement extends HTMLElement {
 
         // Bind methods to maintain 'this' context
         this._onWindowResize = this._onWindowResize.bind(this);
-
-        this.appReadyPromise = new Promise<Application>((resolve) => {
-            this.appReadyResolve = resolve;
-        });
     }
 
     async connectedCallback() {
@@ -84,7 +77,7 @@ class AppElement extends HTMLElement {
             // Handle window resize to keep the canvas responsive
             window.addEventListener('resize', this._onWindowResize);
 
-            this.appReadyResolve(this.app!);
+            this._onReady();
         });
     }
 
@@ -105,24 +98,28 @@ class AppElement extends HTMLElement {
         }
     }
 
-    async getApplication(): Promise<Application> {
-        await this.appReadyPromise;
-        return this.app!;
-    }
-
     _onWindowResize() {
         if (this.app) {
             this.app.resizeCanvas();
         }
     }
 
+    /**
+     * Sets the high resolution flag. When true, the application will render at the device's
+     * physical resolution. When false, the application will render at CSS resolution.
+     * @param value - The high resolution flag.
+     */
     set highResolution(value: boolean) {
         this._highResolution = value;
         if (this.app) {
             this.app.graphicsDevice.maxPixelRatio = value ? window.devicePixelRatio : 1;
         }
     }
 
+    /**
+     * Gets the high resolution flag.
+     * @returns The high resolution flag.
+     */
     get highResolution() {
         return this._highResolution;
     }

diff --git a/src/asset.ts b/src/asset.ts
@@ -31,9 +31,6 @@ class AssetElement extends HTMLElement {
      */
     asset: Asset | null = null;
 
-    async connectedCallback() {
-    }
-
     disconnectedCallback() {
         this.destroyAsset();
     }

diff --git a/src/async-element.ts b/src/async-element.ts
@@ -0,0 +1,45 @@
+import { AppElement } from './app';
+import { EntityElement } from './entity';
+
+/**
+ * Base class for all PlayCanvas web components.
+ */
+class AsyncElement extends HTMLElement {
+    private _readyPromise: Promise<void>;
+
+    private _readyResolve!: () => void;
+
+    constructor() {
+        super();
+        this._readyPromise = new Promise<void>((resolve) => {
+            this._readyResolve = resolve;
+        });
+    }
+
+    get closestApp(): AppElement | undefined {
+        return this.parentElement?.closest('pc-app') as AppElement;
+    }
+
+    get closestEntity(): EntityElement | undefined {
+        return this.parentElement?.closest('pc-entity') as EntityElement;
+    }
+
+    /**
+     * Called when the element is fully initialized and ready.
+     * Subclasses should call this when they're ready.
+     */
+    protected _onReady() {
+        this._readyResolve();
+        this.dispatchEvent(new CustomEvent('ready'));
+    }
+
+    /**
+     * Returns a promise that resolves when the element is ready.
+     * @returns A promise that resolves when the element is ready.
+     */
+    ready(): Promise<void> {
+        return this._readyPromise;
+    }
+}
+
+export { AsyncElement };
diff --git a/src/components/camera-component.ts b/src/components/camera-component.ts
@@ -1,4 +1,4 @@
-import { PROJECTION_ORTHOGRAPHIC, PROJECTION_PERSPECTIVE, CameraComponent, Color, Vec4 } from 'playcanvas';
+import { PROJECTION_ORTHOGRAPHIC, PROJECTION_PERSPECTIVE, CameraComponent, Color, Vec4, XRSPACE_LOCAL, XRTYPE_VR } from 'playcanvas';
 
 import { ComponentElement } from './component';
 import { parseColor, parseVec4 } from '../utils';
@@ -66,6 +66,26 @@ class CameraComponentElement extends ComponentElement {
         };
     }
 
+    get xrAvailable() {
+        return this.component?.system.app.xr!.isAvailable(XRTYPE_VR);
+    }
+
+    startXr() {
+        if (this.component && this.xrAvailable) {
+            this.component.startXr(XRTYPE_VR, XRSPACE_LOCAL, {
+                callback: (err: any) => {
+                    if (err) console.error(`WebXR Immersive VR failed to start: ${err.message}`);
+                }
+            });
+        }
+    }
+
+    endXr() {
+        if (this.component) {
+            this.component.endXr();
+        }
+    }
+
     /**
      * Gets the camera component.
      * @returns The camera component.

diff --git a/src/components/component.ts b/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() {

diff --git a/src/components/element-component.ts b/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;
     }
 

diff --git a/src/components/render-component.ts b/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
         };
     }

diff --git a/src/components/script-component.ts b/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');

diff --git a/src/components/sound-slot.ts b/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() {