@needle-tools/engine 4.1.0-beta → 4.1.0-beta.2

package/src/engine-components/postprocessing/Effects/Sharpening.ts

@@ -24,30 +24,39 @@ export class SharpeningEffect extends PostProcessingEffect {
     private _effect?: any;
 
     onCreateEffect() {
+        this._effect ??= new (createSharpeningEffectType())();
         return this.effect;
     }
 
     private get effect() {
-        this._effect ??= new (createSharpeningEffectType())();
-        // return null;
         return this._effect;
     }
 
     @serializable()
     set amount(value: number) {
-        this.effect.uniforms.get("amount")!.value = value;
+        this._amount = value;
+        if (this._effect)
+            this._effect.uniforms.get("amount")!.value = value;
     }
     get amount() {
-        return this.effect.uniforms.get("amount")!.value;
+        if (this._effect)
+            return this._effect.uniforms.get("amount")!.value;
+        return this._amount;
     }
+    private _amount = 1;
 
     @serializable()
     set radius(value: number) {
-        this.effect.uniforms.get("radius")!.value = value;
+        this._radius = value;
+        if (this._effect)
+            this._effect.uniforms.get("radius")!.value = value;
     }
     get radius() {
-        return this.effect.uniforms.get("radius")!.value;
+        if (this._effect)
+            return this._effect.uniforms.get("radius")!.value;
+        return this._radius;
     }
+    private _radius = 1;
 
     // @serializable()
     // set threshold(value: number) {
@@ -110,7 +119,7 @@ function createSharpeningEffectType() {
     }
     
     `
-    
+
     class _SharpeningEffect extends MODULES.POSTPROCESSING.MODULE!.Effect {
         constructor() {
             super("Sharpening", frag, {

package/src/engine-components/webxr/WebXRImageTracking.ts

@@ -4,7 +4,7 @@ import { Object3DEventMap } from "three";
 import { isDevEnvironment, showBalloonWarning } from "../../engine/debug/index.js";
 import { AssetReference } from "../../engine/engine_addressables.js";
 import { serializable } from "../../engine/engine_serialization.js";
-import { CircularBuffer, getParam } from "../../engine/engine_utils.js";
+import { CircularBuffer, DeviceUtilities, getParam } from "../../engine/engine_utils.js";
 import { type NeedleXREventArgs, NeedleXRSession } from "../../engine/xr/api.js";
 import { IUSDExporterExtension } from "../../engine-components/export/usdz/Extension.js";
 import { imageToCanvas, USDObject, USDWriter, USDZExporterContext } from "../../engine-components/export/usdz/ThreeUSDZExporter.js";
@@ -236,11 +236,17 @@ export class WebXRImageTracking extends Behaviour {
     trackedImages?: WebXRImageTrackingModel[];
 
     /** Applies smoothing based on detected jitter to the tracked image. */
+    @serializable()
     smooth: boolean = true;
 
     private readonly trackedImageIndexMap: Map<number, WebXRImageTrackingModel> = new Map();
     private static _imageElements: Map<string, ImageBitmap | null> = new Map();
 
+    /** @returns true if image tracking is supported on this device. This may return false at runtime if the user's browser did not enable webxr incubations */
+    get supported() { return this._supported; }
+
+    private _supported: boolean = true;
+
     awake(): void {
         if (debug) console.log(this)
         if (!this.trackedImages) return;
@@ -324,6 +330,11 @@ export class WebXRImageTracking extends Behaviour {
     };
 
     onLeaveXR(_args: NeedleXREventArgs): void {
+
+        if(!this.supported && DeviceUtilities.isAndroidDevice()) {
+            showBalloonWarning(this.webXRIncubationsWarning);
+        }
+
         if (this.trackedImages) {
             for (const trackedImage of this.trackedImages) {
                 if (trackedImage.object?.asset) {
@@ -347,6 +358,9 @@ export class WebXRImageTracking extends Behaviour {
     private readonly imageToObjectMap = new Map<WebXRImageTrackingModel, { object: GameObject | null, frames: number, lastTrackingTime: number }>();
     private readonly currentImages: WebXRTrackedImage[] = [];
 
+    
+    private readonly webXRIncubationsWarning = "Image tracking is currently not supported on this device. On Chrome for Android, you can enable the <a target=\"_blank\" href=\"#\" onclick=\"() => console.log('I')\">chrome://flags/#webxr-incubations</a> flag.";
+
     onUpdateXR(args: NeedleXREventArgs): void {
         this.currentImages.length = 0;
 
@@ -354,12 +368,12 @@ export class WebXRImageTracking extends Behaviour {
         if (!frame) return;
 
         if (!("getImageTrackingResults" in frame)) {
-            const warning = "Image tracking is currently not supported on this device. On Chrome for Android, you can enable the <a target=\"_blank\" href=\"#\" onclick=\"() => console.log('I')\">chrome://flags/#webxr-incubations</a> flag.";
             if (!this["didPrintWarning"]) {
                 this["didPrintWarning"] = true;
-                console.log(warning);
+                console.log(this.webXRIncubationsWarning);
             }
-            showBalloonWarning(warning);
+            this._supported = false;
+            showBalloonWarning(this.webXRIncubationsWarning);
             return;
         }
         // Check if enabled features (if available) contains image tracking - if it's not available this statement should not catch

package/src/engine-components/webxr/WebXRRig.ts

@@ -23,11 +23,21 @@ export class XRRig extends Behaviour implements IXRRig {
 
     get isActive() { return this.activeAndEnabled && this.gameObject.visible; }
 
-    /** Sets this rig to be the active XR rig (needs to be called during an active XR session) */
+    /** 
+     * Sets this rig to be the active XR rig (needs to be called during an active XR session) 
+     * Note that this might modify the priority of this rig to be the highest.
+    */
     setAsActiveXRRig() {
         NeedleXRSession.active?.setRigActive(this);
     }
+    /** 
+     * Sets the priority of the rig.
+     */
+    setPriority(value: number) {
+        this.priority = value;
+    }
 
+    /** @internal */
     awake(): void {
         if (debug) {
             const gizmoObj = new Object3D() as IGameObject;
@@ -51,15 +61,18 @@ export class XRRig extends Behaviour implements IXRRig {
 
     private _startScale?: Vector3;
 
+    /** @internal */
     onEnterXR(args: NeedleXREventArgs): void {
         this._startScale = this.gameObject.scale.clone();
         args.xr.addRig(this);
-        if(debug) console.log("WebXR: add Rig", this.name, this.priority);
+        if (debug) console.log("WebXR: add Rig", this.name, this.priority);
     }
+    /** @internal */
     onLeaveXR(args: NeedleXREventArgs): void {
         args.xr.removeRig(this);
         if (this._startScale && this.gameObject)
             this.gameObject.scale.copy(this._startScale);
     }
 
+
 }

package/src/needle-engine.ts

@@ -29,11 +29,11 @@ function registerGlobal(obj: object) {
         Needle[key] = obj[key];
     }
 }
-// import * as Component from "./engine-components/Component.js";
-// registerGlobal(Component);
+import * as Component from "./engine-components/Component.js";
+registerGlobal(Component);
 
-// import * as Components from "./engine-components/codegen/components.js";
-// registerGlobal(Components);
+import * as Components from "./engine-components/codegen/components.js";
+registerGlobal(Components);
 
 import { GameObject } from "./engine-components/Component.js";
 for (const method of Object.getOwnPropertyNames(GameObject)) {
@@ -64,5 +64,5 @@ import * as THREE from "three";
 if (!globalThis["THREE"]) {
     globalThis["THREE"] = THREE;
 }
-else console.warn("Threejs is already imported");
+else console.warn("Three.js is already imported");