@needle-tools/engine 3.28.6-beta → 3.28.7-beta.1

package/src/engine-components/export/usdz/extensions/USDZUI.ts

@@ -1,120 +1,120 @@
-import type { IUSDExporterExtension } from "../Extension.js";
-import { USDObject, USDZExporterContext } from "../ThreeUSDZExporter.js";
-import { GameObject } from "../../../Component.js";
-import { Canvas } from "../../../ui/Canvas.js";
-import { CanvasGroup } from "../../../ui/CanvasGroup.js";
-import { $shadowDomOwner } from "../../../ui/BaseUIComponent.js";
-import { RectTransform } from "../../../ui/RectTransform.js";
-import { Color, Mesh, MeshBasicMaterial, Object3D } from "three";
-import { TextExtension } from "./USDZText.js";
-import { RenderMode } from "../../../ui/Canvas.js";
-
-export class USDZUIExtension implements IUSDExporterExtension {
-    get extensionName(): string {
-        return "tmui";
-    }
-
-    // TODO would probably be better to export each object instead of the entire Canvas
-    // so that we don't export them twice (once as regular hierarchy, once as part of Canvas export)
-    onExportObject(object: Object3D, model: USDObject, _context: USDZExporterContext) {
-        const canvas = GameObject.getComponent(object, Canvas);
-
-        if (canvas && canvas.activeAndEnabled && canvas.renderMode === RenderMode.WorldSpace) {
-            const textExt = new TextExtension();
-            const rt = GameObject.getComponent(object, RectTransform);
-            const canvasGroup = GameObject.getComponent(object, CanvasGroup);
-
-            let width = 100;
-            let height = 100;
-            if (rt) {
-                width = rt.width;
-                height = rt.height;
-
-                const shadowRootModel = USDObject.createEmpty();
-                const shadowComponent = rt.shadowComponent;
-                model.add(shadowRootModel);
-
-                if (shadowComponent) {
-                    const mat = shadowComponent.matrix;
-                    shadowRootModel.matrix.copy(mat);
-                    // shadowRootModel.matrix.premultiply(invertX);
-
-                    // TODO build map of parent GOs to USDObjects so we can reparent while traversing
-                    const usdObjectMap = new Map<Object3D, USDObject>();
-                    const opacityMap = new Map<Object3D, number>();
-                    usdObjectMap.set(shadowComponent, shadowRootModel);
-                    opacityMap.set(shadowComponent, canvasGroup ? canvasGroup.alpha : 1);
-
-                    shadowComponent.traverse((child) => {
-                        if (child === shadowComponent) return;
-
-                        const childModel = USDObject.createEmpty();
-                        childModel.matrix.copy(child.matrix);
-
-                        const childParent = child.parent;
-                        const isText = childParent && typeof childParent["textContent"] === "string" && childParent["textContent"].length;
-                        let hierarchyOpacity = opacityMap.get(childParent!) || 1;
-                        
-                        // TODO CanvasGroup doesn't render something but modifies opacity
-                        // get CanvasGroup and modify alpha here
-
-                        const canvasGroup = GameObject.getComponent(child, CanvasGroup);
-                        if (canvasGroup)
-                            hierarchyOpacity *= canvasGroup.alpha;
-
-                        if (child instanceof Mesh && isText) {
-                            // get shadoDomOwner so we can export Text from the text extension directly
-                            const shadowDomOwner = child[$shadowDomOwner].gameObject;
-                            textExt.exportText(shadowDomOwner, childModel, _context);
-                        }
-
-                        if (child instanceof Mesh && !isText)
-                        {
-                            // UI behaves weird: it seems it's always flipped right now,
-                            // and three magically fixes it when rendering
-                            // see https://github.com/mrdoob/three.js/pull/12720#issue-275923930
-                            // https://github.com/mrdoob/three.js/issues/17361
-                            // So we need to fix the winding order after applying the negative scale.
-                            const clonedGeo = child.geometry.clone();
-                            clonedGeo.scale(1, 1, -1);
-                            this.flipWindingOrder(clonedGeo);
-                            childModel.geometry = clonedGeo;
-
-                            const color = new Color();
-                            const ownOpacity = child.material.opacity;
-                            color.copy(child.material.color);
-
-                            // Calculate opacity from parent chain and own alpha
-                            childModel.material = new MeshBasicMaterial({
-                                color: color,
-                                opacity: ownOpacity * hierarchyOpacity,
-                                map: child.material.map,
-                                transparent: true,
-                            });
-                        }
-
-                        usdObjectMap.set(child, childModel);
-                        opacityMap.set(child, hierarchyOpacity);
-
-                        const parentUsdzObject = usdObjectMap.get(childParent!);
-                        if (!parentUsdzObject) {
-                            console.error("Error when exporting UI: shadow component parent not found!", child, child.parent);
-                            return;
-                        }
-                        parentUsdzObject.add(childModel);
-                    });
-                }
-            }
-        }
-    }
-    
-    private flipWindingOrder(geometry) {
-        const index = geometry.index.array
-        for (let i = 0, il = index.length / 3; i < il; i++) {
-          const x = index[i * 3]
-          index[i * 3] = index[i * 3 + 2]
-          index[i * 3 + 2] = x
-        }
-        geometry.index.needsUpdate = true
-    }
+import type { IUSDExporterExtension } from "../Extension.js";
+import { USDObject, USDZExporterContext } from "../ThreeUSDZExporter.js";
+import { GameObject } from "../../../Component.js";
+import { Canvas } from "../../../ui/Canvas.js";
+import { CanvasGroup } from "../../../ui/CanvasGroup.js";
+import { $shadowDomOwner } from "../../../ui/BaseUIComponent.js";
+import { RectTransform } from "../../../ui/RectTransform.js";
+import { Color, Mesh, MeshBasicMaterial, Object3D } from "three";
+import { TextExtension } from "./USDZText.js";
+import { RenderMode } from "../../../ui/Canvas.js";
+
+export class USDZUIExtension implements IUSDExporterExtension {
+    get extensionName(): string {
+        return "tmui";
+    }
+
+    // TODO would probably be better to export each object instead of the entire Canvas
+    // so that we don't export them twice (once as regular hierarchy, once as part of Canvas export)
+    onExportObject(object: Object3D, model: USDObject, _context: USDZExporterContext) {
+        const canvas = GameObject.getComponent(object, Canvas);
+
+        if (canvas && canvas.activeAndEnabled && canvas.renderMode === RenderMode.WorldSpace) {
+            const textExt = new TextExtension();
+            const rt = GameObject.getComponent(object, RectTransform);
+            const canvasGroup = GameObject.getComponent(object, CanvasGroup);
+
+            let width = 100;
+            let height = 100;
+            if (rt) {
+                width = rt.width;
+                height = rt.height;
+
+                const shadowRootModel = USDObject.createEmpty();
+                const shadowComponent = rt.shadowComponent;
+                model.add(shadowRootModel);
+
+                if (shadowComponent) {
+                    const mat = shadowComponent.matrix;
+                    shadowRootModel.matrix.copy(mat);
+                    // shadowRootModel.matrix.premultiply(invertX);
+
+                    // TODO build map of parent GOs to USDObjects so we can reparent while traversing
+                    const usdObjectMap = new Map<Object3D, USDObject>();
+                    const opacityMap = new Map<Object3D, number>();
+                    usdObjectMap.set(shadowComponent, shadowRootModel);
+                    opacityMap.set(shadowComponent, canvasGroup ? canvasGroup.alpha : 1);
+
+                    shadowComponent.traverse((child) => {
+                        if (child === shadowComponent) return;
+
+                        const childModel = USDObject.createEmpty();
+                        childModel.matrix.copy(child.matrix);
+
+                        const childParent = child.parent;
+                        const isText = childParent && typeof childParent["textContent"] === "string" && childParent["textContent"].length;
+                        let hierarchyOpacity = opacityMap.get(childParent!) || 1;
+                        
+                        // TODO CanvasGroup doesn't render something but modifies opacity
+                        // get CanvasGroup and modify alpha here
+
+                        const canvasGroup = GameObject.getComponent(child, CanvasGroup);
+                        if (canvasGroup)
+                            hierarchyOpacity *= canvasGroup.alpha;
+
+                        if (child instanceof Mesh && isText) {
+                            // get shadoDomOwner so we can export Text from the text extension directly
+                            const shadowDomOwner = child[$shadowDomOwner].gameObject;
+                            textExt.exportText(shadowDomOwner, childModel, _context);
+                        }
+
+                        if (child instanceof Mesh && !isText)
+                        {
+                            // UI behaves weird: it seems it's always flipped right now,
+                            // and three magically fixes it when rendering
+                            // see https://github.com/mrdoob/three.js/pull/12720#issue-275923930
+                            // https://github.com/mrdoob/three.js/issues/17361
+                            // So we need to fix the winding order after applying the negative scale.
+                            const clonedGeo = child.geometry.clone();
+                            clonedGeo.scale(1, 1, -1);
+                            this.flipWindingOrder(clonedGeo);
+                            childModel.geometry = clonedGeo;
+
+                            const color = new Color();
+                            const ownOpacity = child.material.opacity;
+                            color.copy(child.material.color);
+
+                            // Calculate opacity from parent chain and own alpha
+                            childModel.material = new MeshBasicMaterial({
+                                color: color,
+                                opacity: ownOpacity * hierarchyOpacity,
+                                map: child.material.map,
+                                transparent: true,
+                            });
+                        }
+
+                        usdObjectMap.set(child, childModel);
+                        opacityMap.set(child, hierarchyOpacity);
+
+                        const parentUsdzObject = usdObjectMap.get(childParent!);
+                        if (!parentUsdzObject) {
+                            console.error("Error when exporting UI: shadow component parent not found!", child, child.parent);
+                            return;
+                        }
+                        parentUsdzObject.add(childModel);
+                    });
+                }
+            }
+        }
+    }
+    
+    private flipWindingOrder(geometry) {
+        const index = geometry.index.array
+        for (let i = 0, il = index.length / 3; i < il; i++) {
+          const x = index[i * 3]
+          index[i * 3] = index[i * 3 + 2]
+          index[i * 3 + 2] = x
+        }
+        geometry.index.needsUpdate = true
+    }
 }

package/src/engine-components/export/usdz/extensions/behavior/Actions.ts

@@ -1,99 +1,99 @@
-import { Object3D, Matrix4, Material, BufferGeometry } from "three";
-import { ActionBuilder, ActionModel } from "./BehavioursBuilder.js";
-import { USDObject, USDDocument } from "../../ThreeUSDZExporter.js";
-
-export abstract class DocumentAction {
-
-    get id(): string { return this.object.uuid; }
-
-    protected object: Object3D;
-    protected model?: USDObject;
-
-    constructor(obj: Object3D) {
-        this.object = obj;
-    }
-
-    apply(document: USDDocument) {
-        if (!this.model) {
-            this.model = document.findById(this.object.uuid);
-            if (!this.model) {
-                console.error("could not find model with id " + this.object.uuid);
-                return;
-            }
-        }
-        this.onApply(document);
-    }
-
-    protected abstract onApply(document: USDDocument);
-}
-
-export class VariantAction extends DocumentAction {
-    constructor(obj: Object3D, matrix?: Matrix4, material?: Material, geometry?: BufferGeometry) {
-        super(obj);
-        this.matrix = matrix;
-        this.material = material;
-        this.geometry = geometry;
-    }
-
-    private matrix: Matrix4 | undefined;
-    private material: Material | undefined;
-    private geometry: BufferGeometry | undefined;
-
-    protected onApply(_: USDDocument) {
-        const model = this.model;
-        if (!model) return;
-        if (!model.parent?.isDynamic) {
-            USDObject.createEmptyParent(model);
-        }
-        const clone = model.clone();
-        if (this.matrix) clone.matrix = this.matrix;
-        if (this.material) clone.material = this.material;
-        if (this.geometry) clone.geometry = this.geometry;
-        model.parent?.add(clone);
-    }
-
-    private _enableAction?: ActionModel;
-    private _disableAction?: ActionModel;
-
-    enable(): ActionModel {
-        if (this._enableAction) return this._enableAction;
-        this._enableAction = ActionBuilder.fadeAction(this.object, 0, true);;
-        return this._enableAction;
-    }
-
-    disable(): ActionModel {
-        if (this._disableAction) return this._disableAction;
-        this._disableAction = ActionBuilder.fadeAction(this.object, 0, false);;
-        return this._disableAction;
-    }
-}
-
-export class ActionCollection {
-
-    private actions: DocumentAction[];
-    private sortedActions?: { [key: string]: DocumentAction[] };
-
-    constructor(actions: DocumentAction[]) {
-        this.actions = [...actions]
-    }
-
-    // organize is called once when getting an action for the first time
-    // the sorted actions are baked then and adding new actions will not be added anymore
-    private organize() {
-        this.sortedActions = {};
-        for (const action of this.actions) {
-            const id = action.id;
-            if (!this.sortedActions[id]) {
-                this.sortedActions[id] = [];
-            }
-            this.sortedActions[id].push(action);
-        }
-    }
-
-    /** returns all document actions affecting the object passed in */
-    getActions(obj: Object3D): DocumentAction[] | null {
-        if (!this.sortedActions) this.organize();
-        return this.sortedActions![obj.uuid];
-    }
-
+import { Object3D, Matrix4, Material, BufferGeometry } from "three";
+import { ActionBuilder, ActionModel } from "./BehavioursBuilder.js";
+import { USDObject, USDDocument } from "../../ThreeUSDZExporter.js";
+
+export abstract class DocumentAction {
+
+    get id(): string { return this.object.uuid; }
+
+    protected object: Object3D;
+    protected model?: USDObject;
+
+    constructor(obj: Object3D) {
+        this.object = obj;
+    }
+
+    apply(document: USDDocument) {
+        if (!this.model) {
+            this.model = document.findById(this.object.uuid);
+            if (!this.model) {
+                console.error("could not find model with id " + this.object.uuid);
+                return;
+            }
+        }
+        this.onApply(document);
+    }
+
+    protected abstract onApply(document: USDDocument);
+}
+
+export class VariantAction extends DocumentAction {
+    constructor(obj: Object3D, matrix?: Matrix4, material?: Material, geometry?: BufferGeometry) {
+        super(obj);
+        this.matrix = matrix;
+        this.material = material;
+        this.geometry = geometry;
+    }
+
+    private matrix: Matrix4 | undefined;
+    private material: Material | undefined;
+    private geometry: BufferGeometry | undefined;
+
+    protected onApply(_: USDDocument) {
+        const model = this.model;
+        if (!model) return;
+        if (!model.parent?.isDynamic) {
+            USDObject.createEmptyParent(model);
+        }
+        const clone = model.clone();
+        if (this.matrix) clone.matrix = this.matrix;
+        if (this.material) clone.material = this.material;
+        if (this.geometry) clone.geometry = this.geometry;
+        model.parent?.add(clone);
+    }
+
+    private _enableAction?: ActionModel;
+    private _disableAction?: ActionModel;
+
+    enable(): ActionModel {
+        if (this._enableAction) return this._enableAction;
+        this._enableAction = ActionBuilder.fadeAction(this.object, 0, true);;
+        return this._enableAction;
+    }
+
+    disable(): ActionModel {
+        if (this._disableAction) return this._disableAction;
+        this._disableAction = ActionBuilder.fadeAction(this.object, 0, false);;
+        return this._disableAction;
+    }
+}
+
+export class ActionCollection {
+
+    private actions: DocumentAction[];
+    private sortedActions?: { [key: string]: DocumentAction[] };
+
+    constructor(actions: DocumentAction[]) {
+        this.actions = [...actions]
+    }
+
+    // organize is called once when getting an action for the first time
+    // the sorted actions are baked then and adding new actions will not be added anymore
+    private organize() {
+        this.sortedActions = {};
+        for (const action of this.actions) {
+            const id = action.id;
+            if (!this.sortedActions[id]) {
+                this.sortedActions[id] = [];
+            }
+            this.sortedActions[id].push(action);
+        }
+    }
+
+    /** returns all document actions affecting the object passed in */
+    getActions(obj: Object3D): DocumentAction[] | null {
+        if (!this.sortedActions) this.organize();
+        return this.sortedActions![obj.uuid];
+    }
+
 }

package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts

@@ -1,68 +1,68 @@
-import { GameObject } from "../../../../Component.js";
-import type { IUSDExporterExtension } from "../../Extension.js";
-import { USDObject, USDWriter, USDZExporterContext } from "../../ThreeUSDZExporter.js";
-import { Object3D } from "three";
-import { AudioSource } from "../../../../AudioSource.js";
-
-export class AudioExtension implements IUSDExporterExtension {
-
-    get extensionName(): string {
-        return "Audio";
-    }
-
-    private files: string[] = [];
-
-    onExportObject?(object: Object3D, model : USDObject, _context: USDZExporterContext) {
-        // check if this object has an audio source, add the relevant schema in that case.
-        const audioSources = GameObject.getComponents(object, AudioSource);
-        if (audioSources.length) {
-            for (const audioSource of audioSources) {
-                
-                if (!audioSource.clip) continue;
-                if(typeof audioSource.clip !== "string") continue;
-
-                // do nothing if this audio source is not set to play on awake - 
-                // should be controlled via PlayAudioOnClick instead then.
-                if (!audioSource.playOnAwake)
-                    continue;
-
-                const clipName = audioSource.clip.split("/").pop();
-                // TODO: ensure audio clip doesnt start with number
-                
-
-                // TODO: store clipname in file and use in onAfterSerialize instead of creating it again!
-                if (!this.files.includes(audioSource.clip)) {
-                    this.files.push(audioSource.clip);
-                }
-                
-                model.addEventListener('serialize', (writer: USDWriter, _context: USDZExporterContext) => {
-                    writer.appendLine();
-                    writer.beginBlock(`def SpatialAudio "${model.name}"`);
-                    writer.appendLine(`uniform asset filePath = @audio/${clipName}@`);
-                    writer.appendLine(`uniform token auralMode = "${ audioSource.spatialBlend > 0 ? "spatial" : "nonSpatial" }"`);
-                    // theoretically we could do timeline-like audio sequencing with this.
-                    writer.appendLine(`uniform token playbackMode = "${audioSource.loop ?  "loopFromStage" : "onceFromStart" }"`);
-                    writer.appendLine(`uniform float gain = ${audioSource.volume}`);
-                    writer.closeBlock();
-                });
-            }
-        }
-    }
-
-    async onAfterSerialize(context: USDZExporterContext) {
-        // write the files to the context.
-        for (const file of this.files) {
-
-            const clipName = file.split("/").pop();
-
-            // convert file (which is a path) to a blob.
-            const audio = await fetch(file);
-            const audioBlob = await audio.blob();
-            const arrayBuffer = await audioBlob.arrayBuffer();
-
-            const audioData: Uint8Array = new Uint8Array(arrayBuffer)
-
-            context.files["audio/" + clipName] = audioData;
-        }
-    }
+import { GameObject } from "../../../../Component.js";
+import type { IUSDExporterExtension } from "../../Extension.js";
+import { USDObject, USDWriter, USDZExporterContext } from "../../ThreeUSDZExporter.js";
+import { Object3D } from "three";
+import { AudioSource } from "../../../../AudioSource.js";
+
+export class AudioExtension implements IUSDExporterExtension {
+
+    get extensionName(): string {
+        return "Audio";
+    }
+
+    private files: string[] = [];
+
+    onExportObject?(object: Object3D, model : USDObject, _context: USDZExporterContext) {
+        // check if this object has an audio source, add the relevant schema in that case.
+        const audioSources = GameObject.getComponents(object, AudioSource);
+        if (audioSources.length) {
+            for (const audioSource of audioSources) {
+                
+                if (!audioSource.clip) continue;
+                if(typeof audioSource.clip !== "string") continue;
+
+                // do nothing if this audio source is not set to play on awake - 
+                // should be controlled via PlayAudioOnClick instead then.
+                if (!audioSource.playOnAwake)
+                    continue;
+
+                const clipName = audioSource.clip.split("/").pop();
+                // TODO: ensure audio clip doesnt start with number
+                
+
+                // TODO: store clipname in file and use in onAfterSerialize instead of creating it again!
+                if (!this.files.includes(audioSource.clip)) {
+                    this.files.push(audioSource.clip);
+                }
+                
+                model.addEventListener('serialize', (writer: USDWriter, _context: USDZExporterContext) => {
+                    writer.appendLine();
+                    writer.beginBlock(`def SpatialAudio "${model.name}"`);
+                    writer.appendLine(`uniform asset filePath = @audio/${clipName}@`);
+                    writer.appendLine(`uniform token auralMode = "${ audioSource.spatialBlend > 0 ? "spatial" : "nonSpatial" }"`);
+                    // theoretically we could do timeline-like audio sequencing with this.
+                    writer.appendLine(`uniform token playbackMode = "${audioSource.loop ?  "loopFromStage" : "onceFromStart" }"`);
+                    writer.appendLine(`uniform float gain = ${audioSource.volume}`);
+                    writer.closeBlock();
+                });
+            }
+        }
+    }
+
+    async onAfterSerialize(context: USDZExporterContext) {
+        // write the files to the context.
+        for (const file of this.files) {
+
+            const clipName = file.split("/").pop();
+
+            // convert file (which is a path) to a blob.
+            const audio = await fetch(file);
+            const audioBlob = await audio.blob();
+            const arrayBuffer = await audioBlob.arrayBuffer();
+
+            const audioData: Uint8Array = new Uint8Array(arrayBuffer)
+
+            context.files["audio/" + clipName] = audioData;
+        }
+    }
 }