@needle-tools/engine 4.4.0-alpha.5 → 4.4.0-beta.1

package/lib/engine/engine_utils_screenshot.xr.d.ts

@@ -1,5 +1,5 @@
-import { Texture, WebGLRenderer } from "three";
-/**
- * Assigns the camera feed to a texture - this must be called during the render loop
- */
-export declare function updateTextureFromXRFrame(renderer: WebGLRenderer, target: Texture): boolean;
+import { Texture, WebGLRenderer } from "three";
+/**
+ * Assigns the camera feed to a texture - this must be called during the render loop
+ */
+export declare function updateTextureFromXRFrame(renderer: WebGLRenderer, target: Texture): boolean;

package/lib/engine/engine_utils_screenshot.xr.js

@@ -1,91 +1,91 @@
-import { Mesh, MeshBasicMaterial, PerspectiveCamera, PlaneGeometry, Scene } from "three";
-import { isDevEnvironment, showBalloonError } from "./debug/index.js";
-// Adapted from WebARCameraBackground
-/**
- * Assigns the camera feed to a texture - this must be called during the render loop
- */
-export function updateTextureFromXRFrame(renderer, target) {
-    const xrframe = renderer.xr.getFrame();
-    if (!xrframe) {
-        console.warn("No XRFrame available");
-        return false;
-    }
-    // If camera feed is not present, then abort and hiden background
-    const enabledFeatures = xrframe.session.enabledFeatures;
-    if (enabledFeatures && !enabledFeatures.some(x => x === 'camera-access')) {
-        console.error(`No camera feed available - please request the 'camera-access' feature before starting WebXR or add the ARCameraBackground component to your scene.
-
-Example to request camera-access in global scope:
-NeedleXRSession.onSessionRequestStart(evt => {
-    evt.init.optionalFeatures = evt.init.optionalFeatures || [];
-    evt.init.optionalFeatures.push('camera-access');
-});
-`);
-        if (isDevEnvironment()) {
-            showBalloonError("No camera feed available - please request the 'camera-access' feature before starting WebXR or add the ARCameraBackground component to your scene");
-        }
-        return false;
-    }
-    // https://chromium.googlesource.com/chromium/src/+/7c5ac3c0f95b97cf12be95a5c1c0a8ff163246d8/third_party/webxr_test_pages/webxr-samples/proposals/camera-access-barebones.html
-    const pose = xrframe.getViewerPose(renderer.xr.getReferenceSpace());
-    if (pose) {
-        for (const view of pose.views) {
-            // @ts-ignore
-            if ('camera' in view && view.camera) {
-                let binding = renderer.xr.getBinding();
-                // not sure how / why this can be null, but we can recreate it here
-                if (!binding)
-                    binding = new XRWebGLBinding(xrframe.session, renderer.getContext());
-                if (binding) {
-                    let glImage = null;
-                    if ('getCameraImage' in binding) {
-                        ensureTextureIsInitialized(renderer, target);
-                        // discussion on exactly this:
-                        // https://discourse.threejs.org/t/using-a-webgltexture-as-texture-for-three-js/46245/8
-                        // HACK from https://stackoverflow.com/a/55084367 to inject a custom texture into three.js
-                        const texProps = renderer.properties.get(target);
-                        if (texProps) {
-                            // @ts-ignore
-                            glImage = binding.getCameraImage(view.camera);
-                            texProps.__webglTexture = glImage;
-                            return true;
-                        }
-                        else {
-                            console.warn("No texture properties found for target texture");
-                        }
-                    }
-                }
-                else {
-                    console.error(view.camera, renderer.xr);
-                }
-            }
-            else {
-                console.error("NO CAMERA IN VIEW");
-            }
-        }
-    }
-    else {
-        console.error(renderer.xr.getReferenceSpace(), xrframe);
-    }
-    return false;
-}
-const initcache = new WeakMap();
-function ensureTextureIsInitialized(renderer, texture) {
-    // ensure the texture is initialized
-    const inits = initcache.get(texture) || new WeakSet();
-    if (inits.has(renderer)) {
-        return;
-    }
-    inits.add(renderer);
-    initcache.set(texture, inits);
-    console.debug("Initialize texture for camera feed");
-    const material = new MeshBasicMaterial();
-    const geometry = new PlaneGeometry();
-    const scene = new Scene();
-    scene.add(new Mesh(geometry, material));
-    const camera = new PerspectiveCamera();
-    material.map = texture;
-    renderer.render(scene, camera);
-}
-;
+import { Mesh, MeshBasicMaterial, PerspectiveCamera, PlaneGeometry, Scene } from "three";
+import { isDevEnvironment, showBalloonError } from "./debug/index.js";
+// Adapted from WebARCameraBackground
+/**
+ * Assigns the camera feed to a texture - this must be called during the render loop
+ */
+export function updateTextureFromXRFrame(renderer, target) {
+    const xrframe = renderer.xr.getFrame();
+    if (!xrframe) {
+        console.warn("No XRFrame available");
+        return false;
+    }
+    // If camera feed is not present, then abort and hiden background
+    const enabledFeatures = xrframe.session.enabledFeatures;
+    if (enabledFeatures && !enabledFeatures.some(x => x === 'camera-access')) {
+        console.error(`No camera feed available - please request the 'camera-access' feature before starting WebXR or add the ARCameraBackground component to your scene.
+
+Example to request camera-access in global scope:
+NeedleXRSession.onSessionRequestStart(evt => {
+    evt.init.optionalFeatures = evt.init.optionalFeatures || [];
+    evt.init.optionalFeatures.push('camera-access');
+});
+`);
+        if (isDevEnvironment()) {
+            showBalloonError("No camera feed available - please request the 'camera-access' feature before starting WebXR or add the ARCameraBackground component to your scene");
+        }
+        return false;
+    }
+    // https://chromium.googlesource.com/chromium/src/+/7c5ac3c0f95b97cf12be95a5c1c0a8ff163246d8/third_party/webxr_test_pages/webxr-samples/proposals/camera-access-barebones.html
+    const pose = xrframe.getViewerPose(renderer.xr.getReferenceSpace());
+    if (pose) {
+        for (const view of pose.views) {
+            // @ts-ignore
+            if ('camera' in view && view.camera) {
+                let binding = renderer.xr.getBinding();
+                // not sure how / why this can be null, but we can recreate it here
+                if (!binding)
+                    binding = new XRWebGLBinding(xrframe.session, renderer.getContext());
+                if (binding) {
+                    let glImage = null;
+                    if ('getCameraImage' in binding) {
+                        ensureTextureIsInitialized(renderer, target);
+                        // discussion on exactly this:
+                        // https://discourse.threejs.org/t/using-a-webgltexture-as-texture-for-three-js/46245/8
+                        // HACK from https://stackoverflow.com/a/55084367 to inject a custom texture into three.js
+                        const texProps = renderer.properties.get(target);
+                        if (texProps) {
+                            // @ts-ignore
+                            glImage = binding.getCameraImage(view.camera);
+                            texProps.__webglTexture = glImage;
+                            return true;
+                        }
+                        else {
+                            console.warn("No texture properties found for target texture");
+                        }
+                    }
+                }
+                else {
+                    console.error(view.camera, renderer.xr);
+                }
+            }
+            else {
+                console.error("NO CAMERA IN VIEW");
+            }
+        }
+    }
+    else {
+        console.error(renderer.xr.getReferenceSpace(), xrframe);
+    }
+    return false;
+}
+const initcache = new WeakMap();
+function ensureTextureIsInitialized(renderer, texture) {
+    // ensure the texture is initialized
+    const inits = initcache.get(texture) || new WeakSet();
+    if (inits.has(renderer)) {
+        return;
+    }
+    inits.add(renderer);
+    initcache.set(texture, inits);
+    console.debug("Initialize texture for camera feed");
+    const material = new MeshBasicMaterial();
+    const geometry = new PlaneGeometry();
+    const scene = new Scene();
+    scene.add(new Mesh(geometry, material));
+    const camera = new PerspectiveCamera();
+    material.map = texture;
+    renderer.render(scene, camera);
+}
+;
 //# sourceMappingURL=engine_utils_screenshot.xr.js.map

package/lib/engine/engine_xr.d.ts

@@ -1 +1 @@
-export * from "./xr/api.js";
+export * from "./xr/api.js";

package/lib/engine/engine_xr.js

@@ -1,2 +1,2 @@
-export * from "./xr/api.js";
+export * from "./xr/api.js";
 //# sourceMappingURL=engine_xr.js.map

package/lib/engine/export/gltf/Writers.d.ts

@@ -1,19 +1,19 @@
-import { Object3D, Texture } from 'three';
-import { GLTFExporterPlugin, GLTFWriter } from 'three/examples/jsm/exporters/GLTFExporter.js';
-declare type BeforeWriteArgs = {
-    keep: boolean;
-};
-export declare abstract class BaseWriter implements GLTFExporterPlugin {
-    private readonly writer;
-    constructor(writer: GLTFWriter);
-    writeNode(_node: Object3D): void;
-}
-export declare class GizmoWriter extends BaseWriter {
-    beforeWriteNode(node: Object3D, args: BeforeWriteArgs): void;
-}
-export declare class RenderTextureWriter extends BaseWriter {
-    beforeWriteTexture(texture: Texture, args: BeforeWriteArgs & {
-        newTexture?: Texture;
-    }): void;
-}
-export {};
+import { Object3D, Texture } from 'three';
+import { GLTFExporterPlugin, GLTFWriter } from 'three/examples/jsm/exporters/GLTFExporter.js';
+declare type BeforeWriteArgs = {
+    keep: boolean;
+};
+export declare abstract class BaseWriter implements GLTFExporterPlugin {
+    private readonly writer;
+    constructor(writer: GLTFWriter);
+    writeNode(_node: Object3D): void;
+}
+export declare class GizmoWriter extends BaseWriter {
+    beforeWriteNode(node: Object3D, args: BeforeWriteArgs): void;
+}
+export declare class RenderTextureWriter extends BaseWriter {
+    beforeWriteTexture(texture: Texture, args: BeforeWriteArgs & {
+        newTexture?: Texture;
+    }): void;
+}
+export {};

package/lib/engine/export/gltf/Writers.js

@@ -1,25 +1,25 @@
-import { Gizmos } from '../../engine_gizmos.js';
-import { createFlatTexture } from '../../engine_shaders.js';
-import { RGBAColor } from '../../js-extensions/index.js';
-export class BaseWriter {
-    writer;
-    constructor(writer) {
-        this.writer = writer;
-    }
-    writeNode(_node) { }
-}
-export class GizmoWriter extends BaseWriter {
-    beforeWriteNode(node, args) {
-        if (Gizmos.isGizmo(node)) {
-            args.keep = false;
-        }
-    }
-}
-export class RenderTextureWriter extends BaseWriter {
-    beforeWriteTexture(texture, args) {
-        if (texture.isRenderTargetTexture) {
-            args.newTexture = createFlatTexture(new RGBAColor(1, 1, 1, 0));
-        }
-    }
-}
+import { Gizmos } from '../../engine_gizmos.js';
+import { createFlatTexture } from '../../engine_shaders.js';
+import { RGBAColor } from '../../js-extensions/index.js';
+export class BaseWriter {
+    writer;
+    constructor(writer) {
+        this.writer = writer;
+    }
+    writeNode(_node) { }
+}
+export class GizmoWriter extends BaseWriter {
+    beforeWriteNode(node, args) {
+        if (Gizmos.isGizmo(node)) {
+            args.keep = false;
+        }
+    }
+}
+export class RenderTextureWriter extends BaseWriter {
+    beforeWriteTexture(texture, args) {
+        if (texture.isRenderTargetTexture) {
+            args.newTexture = createFlatTexture(new RGBAColor(1, 1, 1, 0));
+        }
+    }
+}
 //# sourceMappingURL=Writers.js.map

package/lib/engine/export/gltf/index.d.ts

@@ -1,11 +1,11 @@
-import { Object3D } from "three";
-import type { Context } from "../../engine_setup.js";
-declare type ExportOptions = {
-    context: Context;
-    scene?: Object3D | Array<Object3D>;
-    binary?: boolean;
-    animations?: boolean;
-    downloadAs?: string;
-};
-export declare function exportAsGLTF(_opts: ExportOptions): Promise<ArrayBuffer | Record<string, any>>;
-export {};
+import { Object3D } from "three";
+import type { Context } from "../../engine_setup.js";
+declare type ExportOptions = {
+    context: Context;
+    scene?: Object3D | Array<Object3D>;
+    binary?: boolean;
+    animations?: boolean;
+    downloadAs?: string;
+};
+export declare function exportAsGLTF(_opts: ExportOptions): Promise<ArrayBuffer | Record<string, any>>;
+export {};

package/lib/engine/export/gltf/index.js

@@ -1,124 +1,124 @@
-import { GLTFExporter } from "three/examples/jsm/exporters/GLTFExporter.js";
-import GLTFMeshGPUInstancingExtension from "../../../include/three/EXT_mesh_gpu_instancing_exporter.js";
-import { AnimationUtils } from "../../engine_animation.js";
-import { registerExportExtensions } from "../../extensions/index.js";
-import { __isExporting } from "../state.js";
-import { shouldExport_HideFlags } from "../utils.js";
-import { GizmoWriter as GLTFGizmoWriter, RenderTextureWriter as GLTFRenderTextureWriter } from "./Writers.js";
-const DEFAULT_OPTIONS = {
-    binary: true,
-    animations: true,
-};
-export async function exportAsGLTF(_opts) {
-    if (!_opts.context) {
-        throw new Error("No context provided to exportAsGLTF");
-    }
-    if (!_opts.scene) {
-        _opts.scene = _opts.context.scene;
-    }
-    const opts = {
-        ...DEFAULT_OPTIONS,
-        ..._opts
-    };
-    const { context } = opts;
-    const exporter = new GLTFExporter();
-    exporter.register(writer => new GLTFMeshGPUInstancingExtension(writer));
-    exporter.register(writer => new GLTFGizmoWriter(writer));
-    exporter.register(writer => new GLTFRenderTextureWriter(writer));
-    registerExportExtensions(exporter, opts.context);
-    const exporterOptions = {
-        binary: opts.binary,
-        animations: collectAnimations(context, opts.scene, []),
-    };
-    const state = new ExporterState();
-    console.debug("Exporting GLTF", exporterOptions);
-    state.onBeforeExport(opts);
-    __isExporting(true);
-    const res = await exporter.parseAsync(opts.scene, exporterOptions).catch((e) => {
-        console.error(e);
-        return null;
-    });
-    __isExporting(false);
-    state.onAfterExport(opts);
-    if (!res) {
-        throw new Error("Failed to export GLTF");
-    }
-    if (opts.downloadAs != undefined) {
-        let blob = null;
-        if (res instanceof ArrayBuffer) {
-            blob = new Blob([res], { type: "application/octet-stream" });
-        }
-        else {
-            console.error("Can not download GLTF as a blob", res);
-        }
-        if (blob) {
-            const url = URL.createObjectURL(blob);
-            const a = document.createElement("a");
-            a.href = url;
-            let name = opts.downloadAs;
-            if (!name.endsWith(".glb") && !name.endsWith(".gltf")) {
-                name += opts.binary ? ".glb" : ".gltf";
-            }
-            a.download = name;
-            a.click();
-        }
-    }
-    return res;
-}
-const ACTIONS_WEIGHT_KEY = Symbol("needle:weight");
-class ExporterState {
-    _undo = [];
-    onBeforeExport(opts) {
-        opts.context.animations.mixers.forEach(mixer => {
-            const actions = AnimationUtils.tryGetActionsFromMixer(mixer);
-            if (actions) {
-                for (let i = 0; i < actions.length; i++) {
-                    const action = actions[i];
-                    action[ACTIONS_WEIGHT_KEY] = action.weight;
-                    action.weight = 0;
-                    this._undo.push(() => { action.weight = action[ACTIONS_WEIGHT_KEY]; });
-                }
-            }
-            mixer.update(0);
-        });
-        opts.context.scene.traverse(obj => {
-            if (!shouldExport_HideFlags(obj)) {
-                const parent = obj.parent;
-                if (parent) {
-                    obj.removeFromParent();
-                    this._undo.push(() => parent.add(obj));
-                }
-            }
-        });
-    }
-    onAfterExport(_opts) {
-        this._undo.forEach(fn => fn());
-        this._undo.length = 0;
-    }
-}
-function collectAnimations(context, scene, clips) {
-    // Get all animations that are used by any mixer in the scene
-    // technically we might also collect animations here that aren't used by any object in the scene because they're part of another scene
-    // But that's a problem for later...
-    context.animations.mixers.forEach(mixer => {
-        const actions = AnimationUtils.tryGetActionsFromMixer(mixer);
-        if (actions) {
-            for (let i = 0; i < actions.length; i++) {
-                const action = actions[i];
-                const clip = action.getClip();
-                // TODO: might need to check if the clip is part of the scene that we want to export
-                clips.push(clip);
-            }
-        }
-    });
-    // Get all animations that are directly assigned to objects in the scene
-    if (!Array.isArray(scene))
-        scene = [scene];
-    for (const obj of scene) {
-        AnimationUtils.tryGetAnimationClipsFromObjectHierarchy(obj, clips);
-    }
-    // ensure we only have unique clips
-    const uniqueClips = new Set(clips);
-    return Array.from(uniqueClips);
-}
+import { GLTFExporter } from "three/examples/jsm/exporters/GLTFExporter.js";
+import GLTFMeshGPUInstancingExtension from "../../../include/three/EXT_mesh_gpu_instancing_exporter.js";
+import { AnimationUtils } from "../../engine_animation.js";
+import { registerExportExtensions } from "../../extensions/index.js";
+import { __isExporting } from "../state.js";
+import { shouldExport_HideFlags } from "../utils.js";
+import { GizmoWriter as GLTFGizmoWriter, RenderTextureWriter as GLTFRenderTextureWriter } from "./Writers.js";
+const DEFAULT_OPTIONS = {
+    binary: true,
+    animations: true,
+};
+export async function exportAsGLTF(_opts) {
+    if (!_opts.context) {
+        throw new Error("No context provided to exportAsGLTF");
+    }
+    if (!_opts.scene) {
+        _opts.scene = _opts.context.scene;
+    }
+    const opts = {
+        ...DEFAULT_OPTIONS,
+        ..._opts
+    };
+    const { context } = opts;
+    const exporter = new GLTFExporter();
+    exporter.register(writer => new GLTFMeshGPUInstancingExtension(writer));
+    exporter.register(writer => new GLTFGizmoWriter(writer));
+    exporter.register(writer => new GLTFRenderTextureWriter(writer));
+    registerExportExtensions(exporter, opts.context);
+    const exporterOptions = {
+        binary: opts.binary,
+        animations: collectAnimations(context, opts.scene, []),
+    };
+    const state = new ExporterState();
+    console.debug("Exporting GLTF", exporterOptions);
+    state.onBeforeExport(opts);
+    __isExporting(true);
+    const res = await exporter.parseAsync(opts.scene, exporterOptions).catch((e) => {
+        console.error(e);
+        return null;
+    });
+    __isExporting(false);
+    state.onAfterExport(opts);
+    if (!res) {
+        throw new Error("Failed to export GLTF");
+    }
+    if (opts.downloadAs != undefined) {
+        let blob = null;
+        if (res instanceof ArrayBuffer) {
+            blob = new Blob([res], { type: "application/octet-stream" });
+        }
+        else {
+            console.error("Can not download GLTF as a blob", res);
+        }
+        if (blob) {
+            const url = URL.createObjectURL(blob);
+            const a = document.createElement("a");
+            a.href = url;
+            let name = opts.downloadAs;
+            if (!name.endsWith(".glb") && !name.endsWith(".gltf")) {
+                name += opts.binary ? ".glb" : ".gltf";
+            }
+            a.download = name;
+            a.click();
+        }
+    }
+    return res;
+}
+const ACTIONS_WEIGHT_KEY = Symbol("needle:weight");
+class ExporterState {
+    _undo = [];
+    onBeforeExport(opts) {
+        opts.context.animations.mixers.forEach(mixer => {
+            const actions = AnimationUtils.tryGetActionsFromMixer(mixer);
+            if (actions) {
+                for (let i = 0; i < actions.length; i++) {
+                    const action = actions[i];
+                    action[ACTIONS_WEIGHT_KEY] = action.weight;
+                    action.weight = 0;
+                    this._undo.push(() => { action.weight = action[ACTIONS_WEIGHT_KEY]; });
+                }
+            }
+            mixer.update(0);
+        });
+        opts.context.scene.traverse(obj => {
+            if (!shouldExport_HideFlags(obj)) {
+                const parent = obj.parent;
+                if (parent) {
+                    obj.removeFromParent();
+                    this._undo.push(() => parent.add(obj));
+                }
+            }
+        });
+    }
+    onAfterExport(_opts) {
+        this._undo.forEach(fn => fn());
+        this._undo.length = 0;
+    }
+}
+function collectAnimations(context, scene, clips) {
+    // Get all animations that are used by any mixer in the scene
+    // technically we might also collect animations here that aren't used by any object in the scene because they're part of another scene
+    // But that's a problem for later...
+    context.animations.mixers.forEach(mixer => {
+        const actions = AnimationUtils.tryGetActionsFromMixer(mixer);
+        if (actions) {
+            for (let i = 0; i < actions.length; i++) {
+                const action = actions[i];
+                const clip = action.getClip();
+                // TODO: might need to check if the clip is part of the scene that we want to export
+                clips.push(clip);
+            }
+        }
+    });
+    // Get all animations that are directly assigned to objects in the scene
+    if (!Array.isArray(scene))
+        scene = [scene];
+    for (const obj of scene) {
+        AnimationUtils.tryGetAnimationClipsFromObjectHierarchy(obj, clips);
+    }
+    // ensure we only have unique clips
+    const uniqueClips = new Set(clips);
+    return Array.from(uniqueClips);
+}
 //# sourceMappingURL=index.js.map

package/lib/engine/export/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./gltf/index.js";
-export { isExporting } from "./state.js";
+export * from "./gltf/index.js";
+export { isExporting } from "./state.js";

package/lib/engine/export/index.js

@@ -1,3 +1,3 @@
-export * from "./gltf/index.js";
-export { isExporting } from "./state.js";
+export * from "./gltf/index.js";
+export { isExporting } from "./state.js";
 //# sourceMappingURL=index.js.map

package/lib/engine/export/state.d.ts

@@ -1,7 +1,7 @@
-/** @internal */
-export declare function __isExporting(state: boolean): void;
-/**
- * Returns whether an export process is currently running.
- * @returns True if an export process is currently running, false otherwise.
- */
-export declare function isExporting(): boolean;
+/** @internal */
+export declare function __isExporting(state: boolean): void;
+/**
+ * Returns whether an export process is currently running.
+ * @returns True if an export process is currently running, false otherwise.
+ */
+export declare function isExporting(): boolean;

package/lib/engine/export/state.js

@@ -1,18 +1,18 @@
-let exportingStack = 0;
-/** @internal */
-export function __isExporting(state) {
-    if (state) {
-        exportingStack++;
-    }
-    else {
-        exportingStack--;
-    }
-}
-/**
- * Returns whether an export process is currently running.
- * @returns True if an export process is currently running, false otherwise.
- */
-export function isExporting() {
-    return exportingStack > 0;
-}
+let exportingStack = 0;
+/** @internal */
+export function __isExporting(state) {
+    if (state) {
+        exportingStack++;
+    }
+    else {
+        exportingStack--;
+    }
+}
+/**
+ * Returns whether an export process is currently running.
+ * @returns True if an export process is currently running, false otherwise.
+ */
+export function isExporting() {
+    return exportingStack > 0;
+}
 //# sourceMappingURL=state.js.map

package/lib/engine/export/utils.d.ts

@@ -1,2 +1,2 @@
-import { Object3D } from "three";
-export declare function shouldExport_HideFlags(obj: Object3D): boolean;
+import { Object3D } from "three";
+export declare function shouldExport_HideFlags(obj: Object3D): boolean;

package/lib/engine/export/utils.js

@@ -1,8 +1,8 @@
-import { HideFlags } from "../engine_types.js";
-export function shouldExport_HideFlags(obj) {
-    const dontExport = HideFlags.DontExport;
-    if (obj.hideFlags & dontExport)
-        return false;
-    return true;
-}
+import { HideFlags } from "../engine_types.js";
+export function shouldExport_HideFlags(obj) {
+    const dontExport = HideFlags.DontExport;
+    if (obj.hideFlags & dontExport)
+        return false;
+    return true;
+}
 //# sourceMappingURL=utils.js.map