Needle Engine 3.48.3

Files changed (8) hide show

plugins/next/next.js +4 -1
src/engine/engine_networking_streams.ts +20 -3
src/engine/engine_types.ts +3 -0
src/engine/xr/NeedleXRSession.ts +44 -11
src/engine/codegen/register_types.ts +2 -2
src/engine-components/ScreenCapture.ts +1 -2
src/engine-components/Voip.ts +26 -8
plugins/next/alias.cjs +42 -0

plugins/next/next.js CHANGED Viewed

@@ -3,8 +3,9 @@
 import { tryGetNeedleEngineVersion } from '../common/version.js';
 import { tryGetGenerator } from '../common/generator.js';
 import { getMeta } from '../common/config.cjs';
-// import { ApplyLicensePlugin } from './license.js';
+import { alias } from './alias.cjs';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -72,6 +73,8 @@
             loader: resolve(__dirname, 'meshbvhworker.cjs')
         });
+        alias(config);
         return config;
     }

src/engine/engine_networking_streams.ts CHANGED Viewed

@@ -6,9 +6,9 @@
 import { getPeerjsInstance } from "../engine/engine_networking_peer.js";
 import { showBalloonMessage } from "./debug/index.js";
 import { Application } from "./engine_application.js";
-import { type Context } from "./engine_context.js";
+import { Context } from "./engine_context.js";
 import type { IModel } from "./engine_networking_types.js";
-import { type IComponent } from "./engine_types.js";
+import { type IComponent,isComponent } from "./engine_types.js";
 import { getParam } from "./engine_utils.js";
@@ -463,8 +463,25 @@
      */
     debug: boolean = false;
-    constructor(context: Context, peer: PeerHandle) {
+    constructor(context: IComponent);
+    constructor(context: Context, guid: string);
+    constructor(context: Context, peer: PeerHandle);
+    constructor(context: Context | IComponent, peer?: PeerHandle | string) {
         super();
+        if (isComponent(context)) {
+            const comp = context;
+            context = comp.context;
+            peer = PeerHandle.getOrCreate(comp.context, comp.guid);
+        }
+        else if (typeof peer === "string") {
+            peer = PeerHandle.getOrCreate(context, peer);
+        }
+        if (!context) throw new Error("Failed to create NetworkedStreams because context is undefined");
+        else if(!(context instanceof Context)) throw new Error("Failed to create NetworkedStreams because context is not an instance of Context");
+        if (!peer) throw new Error("Failed to create NetworkedStreams because peer is undefined");
         this.context = context;
         this.peer = peer;
         if (debug) this.debug = true;

src/engine/engine_types.ts CHANGED Viewed

@@ -210,6 +210,9 @@
     get worldQuaternion(): Quaternion;
 }
+export function isComponent(obj:any) : obj is IComponent {
+    return obj && obj.isComponent;
+}
 export type ICamera = CameraComponent;

src/engine/xr/NeedleXRSession.ts CHANGED Viewed

@@ -240,8 +240,13 @@
     static get currentSessionRequest(): XRSessionMode | null { return this._currentSessionRequestMode; }
     private static _currentSessionRequestMode: XRSessionMode | null = null;
+    /**
+     * @returns the active @type {NeedleXRSession} (if any active) or null
+     */
     static get active(): NeedleXRSession | null { return this._activeSession; }
-    /** The active xr session mode (if any xr session is active) */
+    /** The active xr session mode (if any xr session is active)
+     * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode
+    */
     static get activeMode() { return this._activeSession?.mode ?? null; }
     /** XRSystem via navigator.xr access
      * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem
@@ -249,17 +254,35 @@
     static get xrSystem(): XRSystem | undefined {
         return ('xr' in navigator) ? navigator.xr : undefined;
     }
+    /**
+     * @returns true if the browser supports WebXR (`immersive-vr` or `immersive-ar`)
+     * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
+     */
     static isXRSupported() { return Promise.all([this.isVRSupported(), this.isARSupported()]).then(res => res.some(e => e)).catch(() => false); }
+    /**
+     * @returns true if the browser supports immersive-vr (WebXR)
+     * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
+     */
     static isVRSupported() { return this.isSessionSupported("immersive-vr"); }
+    /**
+     * @returns true if the browser supports immersive-ar (WebXR)
+     * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
+    */
     static isARSupported() { return this.isSessionSupported("immersive-ar"); }
+    /**
+     * @param mode The XRSessionMode to check if it is supported
+     * @returns true if the browser supports the given XRSessionMode
+     */
     static isSessionSupported(mode: XRSessionMode) { return this.xrSystem?.isSessionSupported(mode).catch(err => { if (debug) console.error(err); return false }) ?? Promise.resolve(false); }
     private static _currentSessionRequest?: Promise<XRSession>;
     private static _activeSession: NeedleXRSession | null;
+    /** Register to listen to XRSession start events. Unsubscribe with `offXRSessionStart` */
     static onSessionRequestStart(evt: SessionRequestedEvent) {
         this._sessionRequestStartListeners.push(evt);
     }
+    /** Unsubscribe from request start evt. Register with `onSessionRequestStart` */
     static offSessionRequestStart(evt: SessionRequestedEvent) {
         const index = this._sessionRequestStartListeners.indexOf(evt);
         if (index >= 0) this._sessionRequestStartListeners.splice(index, 1);
@@ -364,22 +387,32 @@
     }
     /** start a new webXR session (make sure to stop already running sessions before calling this method)
-     * @param mode The XRSessionMode to start (e.g. `immersive-vr` or `immersive-ar`), docs: https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode
+     * @param mode The XRSessionMode to start (e.g. `immersive-vr` or `immersive-ar`) or `ar` to start `immersive-ar` on supported devices OR on iOS devices it will export an interactive USDZ and open in Quicklook.
+     * Get more information about WebXR modes: https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode
      * @param init The XRSessionInit to use (optional), docs: https://developer.mozilla.org/en-US/docs/Web/API/XRSessionInit
      * @param context The Needle Engine context to use
      */
-    static async start(mode: XRSessionMode, init?: XRSessionInit, context?: Context): Promise<NeedleXRSession | null> {
+    static async start(mode: XRSessionMode | "ar", init?: XRSessionInit, context?: Context): Promise<NeedleXRSession | null> {
         // handle iOS platform where "immersive-ar" is not supported
         // TODO: should we add a separate mode (e.g. "AR")? https://linear.app/needle/issue/NE-5303
-        if (mode === "immersive-ar" && isiOS()) {
-            const arSupported = await this.isARSupported();
-            if (!arSupported && InternalUSDZRegistry.exportAndOpen()) {
-                return null;
+        if (isiOS()) {
+            if (mode === "ar") {
+                const arSupported = await this.isARSupported();
+                if (!arSupported && InternalUSDZRegistry.exportAndOpen()) {
+                    return null;
+                }
+                else {
+                    mode = "immersive-ar";
+                }
             }
         }
+        else if (mode == "ar") {
+            mode = "immersive-ar";
+        }
         if (isDevEnvironment() && getParam("debugxrpreroom")) {
             console.warn("Debug: Starting temporary XR session");
             await TemporaryXRContext.start(mode, init || NeedleXRSession.getDefaultSessionInit(mode));
@@ -406,7 +439,7 @@
         // setup session init args, make sure we have default values
         if (!init) init = {};
         switch (mode) {
             // Setup VR initialization parameters
@@ -564,7 +597,7 @@
     /**
      * Check if the session has system keyboard support
      */
-    get isSystemKeyboardSupported(): boolean {  return this.session.isSystemKeyboardSupported; }
+    get isSystemKeyboardSupported(): boolean { return this.session.isSystemKeyboardSupported; }
     /**
      * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession/environmentBlendMode
@@ -586,7 +619,7 @@
     /** @returns the given controller if it is connected */
     getController(side: XRHandedness | number) {
         if (typeof side === "number") return this.controllers[side] || null;
-        return this.controllers.find(c => c.side === side) || null;
+        return this.controllers.find(c => c.side === side) || null;
     }
     /** Returns true if running in pass through mode in immersive AR (e.g. user is wearing a headset while in AR) */
@@ -1069,7 +1102,7 @@
         this._defaultRig.gameObject.removeFromParent();
         enableSpatialConsole(false);
         performance.mark(measure_SessionEndedMarker);
         performance.measure('NeedleXRSession', measure_SessionStartedMarker, measure_SessionEndedMarker);
     };

src/engine/codegen/register_types.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 /* eslint-disable */
 import { TypeStore } from "./../engine_typestore.js"
 // Import types
 import { __Ignore } from "../../engine-components/codegen/components.js";
 import { ActionBuilder } from "../../engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js";
@@ -220,7 +220,7 @@
 import { XRFlag } from "../../engine-components/webxr/XRFlag.js";
 import { XRRig } from "../../engine-components/webxr/WebXRRig.js";
 import { XRState } from "../../engine-components/webxr/XRFlag.js";
 // Register types
 TypeStore.add("__Ignore", __Ignore);
 TypeStore.add("ActionBuilder", ActionBuilder);

src/engine-components/ScreenCapture.ts CHANGED Viewed

@@ -217,8 +217,7 @@
                 this._videoPlayer.setVideo(this._currentStream);
             }
         });
-        const handle = PeerHandle.getOrCreate(this.context, this.guid);
-        this._net = new NetworkedStreams(this.context, handle);
+        this._net = new NetworkedStreams(this);
     }
     /** @internal */

src/engine-components/Voip.ts CHANGED Viewed

@@ -1,11 +1,9 @@
-import { AudioAnalyser } from "three";
 import { isDevEnvironment, showBalloonError, showBalloonWarning } from "../engine/debug/index.js";
 import { Application } from "../engine/engine_application.js";
 import { RoomEvents } from "../engine/engine_networking.js";
 import { disposeStream, NetworkedStreamEvents, NetworkedStreams, StreamEndedEvent, StreamReceivedEvent } from "../engine/engine_networking_streams.js"
 import { serializable } from "../engine/engine_serialization_decorator.js";
-import { getParam, microphonePermissionsGranted } from "../engine/engine_utils.js";
+import { getParam, isiOS, microphonePermissionsGranted } from "../engine/engine_utils.js";
 import { delay } from "../engine/engine_utils.js";
 import { getIconElement } from "../engine/webcomponents/icons.js";
 import { Behaviour } from "./Component.js";
@@ -271,11 +269,31 @@
             return null;
         }
-        const stream = await navigator.mediaDevices.getUserMedia({ audio: audio ?? true, video: false })
-            .catch((err) => {
-                console.warn("VOIP failed getting audio stream", err);
-                return null;
-            });
+        const getUserMedia = async (constraints?: MediaTrackConstraints): Promise<MediaStream | null> => {
+            return await navigator.mediaDevices.getUserMedia({ audio: constraints ?? true, video: false })
+                .catch((err) => {
+                    console.warn("VOIP failed getting audio stream", err);
+                    return null;
+                });;
+        }
+        const stream = await getUserMedia(audio);
+        if (!stream) return null;
+        // NE-5445, on iOS after calling `getUserMedia` it automatically switches the audio to the built-in microphone and speakers even if headphones are connected
+        // if there's no device selected explictly we will try to automatically select an external device
+        if (isiOS() && audio?.deviceId === undefined) {
+            const devices = await navigator.mediaDevices.enumerateDevices();
+            // select anything that doesn't have "iPhone" is likely "AirPods" or other bluetooth headphones
+            const nonBuiltInAudioSource = devices.find((device) => (device.kind === "audioinput" || device.kind === "audiooutput") && !device.label.includes("iPhone"));
+            if (nonBuiltInAudioSource) {
+                const constraints = Object.assign({}, audio);
+                constraints.deviceId = nonBuiltInAudioSource.deviceId;
+                return await getUserMedia(constraints);
+            }
+        }
         return stream;
     }

plugins/next/alias.cjs ADDED Viewed

@@ -0,0 +1,42 @@
+const { existsSync } = require("fs");
+const path = require("path");
+module.exports.alias = function (config) {
+    const workingDirectory = process.cwd();
+    config.resolve.alias['three'] = path.resolve(workingDirectory, 'node_modules/three');
+    config.resolve.alias['three/examples/jsm'] = path.resolve(workingDirectory, 'node_modules/three/examples/jsm');
+    config.resolve.alias['@needle-tools/engine'] = path.resolve(workingDirectory, 'node_modules/@needle-tools/engine');
+    // first check if gltf-progressive exists locally (due to local installation of engine)
+    const gltfProgressive_local = path.resolve(workingDirectory, 'node_modules/@needle-tools/engine/node_modules/@needle-tools/gltf-progressive');
+    if (existsSync(gltfProgressive_local)) {
+        config.resolve.alias['@needle-tools/gltf-progressive'] = gltfProgressive_local;
+    }
+    else {
+        config.resolve.alias['@needle-tools/gltf-progressive'] = path.resolve(workingDirectory, 'node_modules/@needle-tools/gltf-progressive');
+    }
+    const packageJsonPath = path.resolve(workingDirectory, 'package.json');
+    // now resolve all local package dependencies
+    if (existsSync(packageJsonPath)) {
+        /**
+         * @type {{ dependencies?: { [key: string]: string } }}
+         */
+        const packageJson = require(packageJsonPath);
+        if (packageJson?.dependencies) {
+            for (const key of Object.keys(packageJson.dependencies)) {
+                const value = packageJson.dependencies[key];
+                if (value.startsWith("file:")) {
+                    const pathValue = value.substring(5);
+                    config.resolve.alias[key] = path.resolve(workingDirectory, pathValue);
+                }
+            }
+        }
+    }
+    console.log(config.resolve.alias);
+}