@needle-tools/engine 4.6.3 → 4.6.4

package/lib/engine-components/LookAtConstraint.d.ts

@@ -1,19 +1,19 @@
-import { Object3D } from "three";
-import { Behaviour } from "./Component.js";
-/**
- * A LookAtConstraint is used by OrbitControls to make the camera look at a target.
- */
-export declare class LookAtConstraint extends Behaviour {
-    /**
-     * When true the constraint is active.
-     */
-    constraintActive: boolean;
-    /**
-     * When true the look at is locked to the position of the assigned sources.
-     */
-    locked: boolean;
-    /**
-     * The sources to look at.
-     */
-    sources: Object3D[];
-}
+import { Object3D } from "three";
+import { Behaviour } from "./Component.js";
+/**
+ * A LookAtConstraint is used by OrbitControls to make the camera look at a target.
+ */
+export declare class LookAtConstraint extends Behaviour {
+    /**
+     * When true the constraint is active.
+     */
+    constraintActive: boolean;
+    /**
+     * When true the look at is locked to the position of the assigned sources.
+     */
+    locked: boolean;
+    /**
+     * The sources to look at.
+     */
+    sources: Object3D[];
+}

package/lib/engine-components/LookAtConstraint.js

@@ -1,36 +1,36 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { Object3D } from "three";
-import { serializable } from "../engine/engine_serialization_decorator.js";
-import { Behaviour } from "./Component.js";
-/**
- * A LookAtConstraint is used by OrbitControls to make the camera look at a target.
- */
-export class LookAtConstraint extends Behaviour {
-    /**
-     * When true the constraint is active.
-     */
-    constraintActive = true;
-    /**
-     * When true the look at is locked to the position of the assigned sources.
-     */
-    locked = false;
-    /**
-     * The sources to look at.
-     */
-    sources = [];
-}
-__decorate([
-    serializable()
-], LookAtConstraint.prototype, "constraintActive", void 0);
-__decorate([
-    serializable()
-], LookAtConstraint.prototype, "locked", void 0);
-__decorate([
-    serializable(Object3D)
-], LookAtConstraint.prototype, "sources", void 0);
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Object3D } from "three";
+import { serializable } from "../engine/engine_serialization_decorator.js";
+import { Behaviour } from "./Component.js";
+/**
+ * A LookAtConstraint is used by OrbitControls to make the camera look at a target.
+ */
+export class LookAtConstraint extends Behaviour {
+    /**
+     * When true the constraint is active.
+     */
+    constraintActive = true;
+    /**
+     * When true the look at is locked to the position of the assigned sources.
+     */
+    locked = false;
+    /**
+     * The sources to look at.
+     */
+    sources = [];
+}
+__decorate([
+    serializable()
+], LookAtConstraint.prototype, "constraintActive", void 0);
+__decorate([
+    serializable()
+], LookAtConstraint.prototype, "locked", void 0);
+__decorate([
+    serializable(Object3D)
+], LookAtConstraint.prototype, "sources", void 0);
 //# sourceMappingURL=LookAtConstraint.js.map

package/lib/engine-components/NeedleMenu.d.ts

@@ -1,50 +1,50 @@
-import { Behaviour } from './Component.js';
-/**
- * Provides configuration options for the built-in Needle Menu.
- * Needle Menu uses HTML in 2D mode, and automatically switches to a 3D menu in VR/AR mode.
- *
- * Controls display options, button visibility, and menu positioning.
- * From code, you can access the menu via {@link Context.menu}.
- * @category User Interface
- * @group Components
- **/
-export declare class NeedleMenu extends Behaviour {
-    /**
-     * Determines the vertical positioning of the menu on the screen
-     */
-    position: "top" | "bottom";
-    /**
-     * Controls the visibility of the Needle logo in the menu (requires PRO license)
-     */
-    showNeedleLogo: boolean;
-    /**
-     * When enabled, displays the menu in VR/AR mode when the user looks up
-     * @default undefined
-     */
-    showSpatialMenu?: boolean;
-    /**
-     * When enabled, adds a fullscreen toggle button to the menu
-     * @default undefined
-     */
-    createFullscreenButton?: boolean;
-    /**
-     * When enabled, adds an audio mute/unmute button to the menu
-     * @default undefined
-     */
-    createMuteButton?: boolean;
-    /**
-     * When enabled, adds a button to display a QR code for sharing the application.
-     * The QR code is only displayed on desktop devices.
-     * @default undefined
-     */
-    createQRCodeButton?: boolean;
-    /**
-     * Applies the configured menu options when the component is enabled
-     * @hidden
-     */
-    onEnable(): void;
-    /**
-     * Applies all configured options to the active {@link Context.menu}.
-     */
-    applyOptions(): void;
-}
+import { Behaviour } from './Component.js';
+/**
+ * Provides configuration options for the built-in Needle Menu.
+ * Needle Menu uses HTML in 2D mode, and automatically switches to a 3D menu in VR/AR mode.
+ *
+ * Controls display options, button visibility, and menu positioning.
+ * From code, you can access the menu via {@link Context.menu}.
+ * @category User Interface
+ * @group Components
+ **/
+export declare class NeedleMenu extends Behaviour {
+    /**
+     * Determines the vertical positioning of the menu on the screen
+     */
+    position: "top" | "bottom";
+    /**
+     * Controls the visibility of the Needle logo in the menu (requires PRO license)
+     */
+    showNeedleLogo: boolean;
+    /**
+     * When enabled, displays the menu in VR/AR mode when the user looks up
+     * @default undefined
+     */
+    showSpatialMenu?: boolean;
+    /**
+     * When enabled, adds a fullscreen toggle button to the menu
+     * @default undefined
+     */
+    createFullscreenButton?: boolean;
+    /**
+     * When enabled, adds an audio mute/unmute button to the menu
+     * @default undefined
+     */
+    createMuteButton?: boolean;
+    /**
+     * When enabled, adds a button to display a QR code for sharing the application.
+     * The QR code is only displayed on desktop devices.
+     * @default undefined
+     */
+    createQRCodeButton?: boolean;
+    /**
+     * Applies the configured menu options when the component is enabled
+     * @hidden
+     */
+    onEnable(): void;
+    /**
+     * Applies all configured options to the active {@link Context.menu}.
+     */
+    applyOptions(): void;
+}

package/lib/engine-components/NeedleMenu.js

@@ -1,93 +1,93 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { serializable } from '../engine/engine_serialization.js';
-import { DeviceUtilities } from '../engine/engine_utils.js';
-import { Behaviour } from './Component.js';
-/**
- * Provides configuration options for the built-in Needle Menu.
- * Needle Menu uses HTML in 2D mode, and automatically switches to a 3D menu in VR/AR mode.
- *
- * Controls display options, button visibility, and menu positioning.
- * From code, you can access the menu via {@link Context.menu}.
- * @category User Interface
- * @group Components
- **/
-export class NeedleMenu extends Behaviour {
-    /**
-     * Determines the vertical positioning of the menu on the screen
-     */
-    position = "bottom";
-    /**
-     * Controls the visibility of the Needle logo in the menu (requires PRO license)
-     */
-    showNeedleLogo = false;
-    /**
-     * When enabled, displays the menu in VR/AR mode when the user looks up
-     * @default undefined
-     */
-    showSpatialMenu;
-    /**
-     * When enabled, adds a fullscreen toggle button to the menu
-     * @default undefined
-     */
-    createFullscreenButton;
-    /**
-     * When enabled, adds an audio mute/unmute button to the menu
-     * @default undefined
-     */
-    createMuteButton;
-    /**
-     * When enabled, adds a button to display a QR code for sharing the application.
-     * The QR code is only displayed on desktop devices.
-     * @default undefined
-     */
-    createQRCodeButton;
-    /**
-     * Applies the configured menu options when the component is enabled
-     * @hidden
-     */
-    onEnable() {
-        this.applyOptions();
-    }
-    /**
-     * Applies all configured options to the active {@link Context.menu}.
-     */
-    applyOptions() {
-        this.context.menu.setPosition(this.position);
-        this.context.menu.showNeedleLogo(this.showNeedleLogo);
-        if (this.createFullscreenButton === true)
-            this.context.menu.showFullscreenOption(true);
-        if (this.createMuteButton === true)
-            this.context.menu.showAudioPlaybackOption(true);
-        if (this.showSpatialMenu === true)
-            this.context.menu.showSpatialMenu(this.showSpatialMenu);
-        if (this.createQRCodeButton === true) {
-            if (!DeviceUtilities.isMobileDevice()) {
-                this.context.menu.showQRCodeButton(true);
-            }
-        }
-    }
-}
-__decorate([
-    serializable()
-], NeedleMenu.prototype, "position", void 0);
-__decorate([
-    serializable()
-], NeedleMenu.prototype, "showNeedleLogo", void 0);
-__decorate([
-    serializable()
-], NeedleMenu.prototype, "showSpatialMenu", void 0);
-__decorate([
-    serializable()
-], NeedleMenu.prototype, "createFullscreenButton", void 0);
-__decorate([
-    serializable()
-], NeedleMenu.prototype, "createMuteButton", void 0);
-__decorate([
-    serializable()
-], NeedleMenu.prototype, "createQRCodeButton", void 0);
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { serializable } from '../engine/engine_serialization.js';
+import { DeviceUtilities } from '../engine/engine_utils.js';
+import { Behaviour } from './Component.js';
+/**
+ * Provides configuration options for the built-in Needle Menu.
+ * Needle Menu uses HTML in 2D mode, and automatically switches to a 3D menu in VR/AR mode.
+ *
+ * Controls display options, button visibility, and menu positioning.
+ * From code, you can access the menu via {@link Context.menu}.
+ * @category User Interface
+ * @group Components
+ **/
+export class NeedleMenu extends Behaviour {
+    /**
+     * Determines the vertical positioning of the menu on the screen
+     */
+    position = "bottom";
+    /**
+     * Controls the visibility of the Needle logo in the menu (requires PRO license)
+     */
+    showNeedleLogo = false;
+    /**
+     * When enabled, displays the menu in VR/AR mode when the user looks up
+     * @default undefined
+     */
+    showSpatialMenu;
+    /**
+     * When enabled, adds a fullscreen toggle button to the menu
+     * @default undefined
+     */
+    createFullscreenButton;
+    /**
+     * When enabled, adds an audio mute/unmute button to the menu
+     * @default undefined
+     */
+    createMuteButton;
+    /**
+     * When enabled, adds a button to display a QR code for sharing the application.
+     * The QR code is only displayed on desktop devices.
+     * @default undefined
+     */
+    createQRCodeButton;
+    /**
+     * Applies the configured menu options when the component is enabled
+     * @hidden
+     */
+    onEnable() {
+        this.applyOptions();
+    }
+    /**
+     * Applies all configured options to the active {@link Context.menu}.
+     */
+    applyOptions() {
+        this.context.menu.setPosition(this.position);
+        this.context.menu.showNeedleLogo(this.showNeedleLogo);
+        if (this.createFullscreenButton === true)
+            this.context.menu.showFullscreenOption(true);
+        if (this.createMuteButton === true)
+            this.context.menu.showAudioPlaybackOption(true);
+        if (this.showSpatialMenu === true)
+            this.context.menu.showSpatialMenu(this.showSpatialMenu);
+        if (this.createQRCodeButton === true) {
+            if (!DeviceUtilities.isMobileDevice()) {
+                this.context.menu.showQRCodeButton(true);
+            }
+        }
+    }
+}
+__decorate([
+    serializable()
+], NeedleMenu.prototype, "position", void 0);
+__decorate([
+    serializable()
+], NeedleMenu.prototype, "showNeedleLogo", void 0);
+__decorate([
+    serializable()
+], NeedleMenu.prototype, "showSpatialMenu", void 0);
+__decorate([
+    serializable()
+], NeedleMenu.prototype, "createFullscreenButton", void 0);
+__decorate([
+    serializable()
+], NeedleMenu.prototype, "createMuteButton", void 0);
+__decorate([
+    serializable()
+], NeedleMenu.prototype, "createQRCodeButton", void 0);
 //# sourceMappingURL=NeedleMenu.js.map

package/lib/engine-components/NestedGltf.d.ts

@@ -1,25 +1,25 @@
-import { AssetReference, type ProgressCallback } from "../engine/engine_addressables.js";
-import { Behaviour } from "../engine-components/Component.js";
-/** The nested gltf is a component that is used to load a gltf file when the component becomes active (start)
- * It will load the gltf file and instantiate it as a child of the parent of the GameObject that has this component
- */
-export declare class NestedGltf extends Behaviour {
-    /**
-     * A reference to the gltf file that should be loaded
-     */
-    filePath?: AssetReference;
-    /**
-     * EXPERIMENTAL for cloud asset loading
-     */
-    loadAssetInParent: boolean;
-    private _isLoadingOrDoneLoading;
-    /** Register a callback that will be called when the progress of the loading changes */
-    listenToProgress(evt: ProgressCallback): void;
-    /** Begin loading the referenced gltf file in filePath */
-    preload(): void;
-    /** @internal */
-    start(): Promise<void>;
-    /** @internal */
-    onDestroy(): void;
-    private hash;
-}
+import { AssetReference, type ProgressCallback } from "../engine/engine_addressables.js";
+import { Behaviour } from "../engine-components/Component.js";
+/** The nested gltf is a component that is used to load a gltf file when the component becomes active (start)
+ * It will load the gltf file and instantiate it as a child of the parent of the GameObject that has this component
+ */
+export declare class NestedGltf extends Behaviour {
+    /**
+     * A reference to the gltf file that should be loaded
+     */
+    filePath?: AssetReference;
+    /**
+     * EXPERIMENTAL for cloud asset loading
+     */
+    loadAssetInParent: boolean;
+    private _isLoadingOrDoneLoading;
+    /** Register a callback that will be called when the progress of the loading changes */
+    listenToProgress(evt: ProgressCallback): void;
+    /** Begin loading the referenced gltf file in filePath */
+    preload(): void;
+    /** @internal */
+    start(): Promise<void>;
+    /** @internal */
+    onDestroy(): void;
+    private hash;
+}

package/lib/engine-components/NestedGltf.js

@@ -1,89 +1,89 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { AssetReference } from "../engine/engine_addressables.js";
-import { InstantiateOptions } from "../engine/engine_gameobject.js";
-import { InstantiateIdProvider } from "../engine/engine_networking_instantiate.js";
-import { serializable } from "../engine/engine_serialization_decorator.js";
-import { getParam } from "../engine/engine_utils.js";
-import { Behaviour } from "../engine-components/Component.js";
-const debug = getParam("debugnestedgltf");
-/** The nested gltf is a component that is used to load a gltf file when the component becomes active (start)
- * It will load the gltf file and instantiate it as a child of the parent of the GameObject that has this component
- */
-export class NestedGltf extends Behaviour {
-    /**
-     * A reference to the gltf file that should be loaded
-     */
-    filePath;
-    /**
-     * EXPERIMENTAL for cloud asset loading
-     */
-    loadAssetInParent = true;
-    _isLoadingOrDoneLoading = false;
-    /** Register a callback that will be called when the progress of the loading changes */
-    listenToProgress(evt) {
-        this.filePath?.beginListenDownload(evt);
-    }
-    /** Begin loading the referenced gltf file in filePath */
-    preload() {
-        this.filePath?.preload();
-    }
-    /** @internal */
-    async start() {
-        if (this._isLoadingOrDoneLoading)
-            return;
-        if (debug)
-            console.log(this, this.guid);
-        const parent = this.gameObject.parent;
-        if (parent) {
-            this._isLoadingOrDoneLoading = true;
-            const opts = new InstantiateOptions();
-            // we need to provide stable guids for creating nested gltfs
-            opts.idProvider = new InstantiateIdProvider(this.hash(this.guid));
-            opts.parent = this.loadAssetInParent !== false ? parent : this.gameObject;
-            this.gameObject.updateMatrix();
-            const matrix = this.gameObject.matrix;
-            if (debug)
-                console.log("Load nested:", this.filePath?.url ?? this.filePath, this.gameObject.position);
-            const res = await this.filePath?.instantiate?.call(this.filePath, opts);
-            if (debug)
-                console.log("Nested loaded:", this.filePath?.url ?? this.filePath, res);
-            if (res && this.loadAssetInParent !== false) {
-                res.matrixAutoUpdate = false;
-                res.matrix.identity();
-                res.applyMatrix4(matrix);
-                res.matrixAutoUpdate = true;
-                res.layers.disableAll();
-                res.layers.set(this.layer);
-                this.dispatchEvent(new CustomEvent("loaded", { detail: { instance: res, assetReference: this.filePath } }));
-            }
-            if (debug)
-                console.log("Nested loading done:", this.filePath?.url ?? this.filePath, res);
-        }
-    }
-    /** @internal */
-    onDestroy() {
-        // When the NestedGLTF gets destroyed we assume the loaded glTF is also destroyed
-        // meaning the resources, textures etc are disposed
-        // When this NestedGLTF would now be loaded again the AssetReference would still be in the loaded state
-        // so it would instantiate without textures etc...
-        // Perhaps we want to add a dispose callback or event method too?
-        // Somehow we have to clean the AssetReference state
-        this.filePath?.unload();
-    }
-    hash(str) {
-        let hash = 0;
-        for (let i = 0; i < str.length; i++) {
-            hash = str.charCodeAt(i) + ((hash << 5) - hash);
-        }
-        return hash;
-    }
-}
-__decorate([
-    serializable(AssetReference)
-], NestedGltf.prototype, "filePath", void 0);
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { AssetReference } from "../engine/engine_addressables.js";
+import { InstantiateOptions } from "../engine/engine_gameobject.js";
+import { InstantiateIdProvider } from "../engine/engine_networking_instantiate.js";
+import { serializable } from "../engine/engine_serialization_decorator.js";
+import { getParam } from "../engine/engine_utils.js";
+import { Behaviour } from "../engine-components/Component.js";
+const debug = getParam("debugnestedgltf");
+/** The nested gltf is a component that is used to load a gltf file when the component becomes active (start)
+ * It will load the gltf file and instantiate it as a child of the parent of the GameObject that has this component
+ */
+export class NestedGltf extends Behaviour {
+    /**
+     * A reference to the gltf file that should be loaded
+     */
+    filePath;
+    /**
+     * EXPERIMENTAL for cloud asset loading
+     */
+    loadAssetInParent = true;
+    _isLoadingOrDoneLoading = false;
+    /** Register a callback that will be called when the progress of the loading changes */
+    listenToProgress(evt) {
+        this.filePath?.beginListenDownload(evt);
+    }
+    /** Begin loading the referenced gltf file in filePath */
+    preload() {
+        this.filePath?.preload();
+    }
+    /** @internal */
+    async start() {
+        if (this._isLoadingOrDoneLoading)
+            return;
+        if (debug)
+            console.log(this, this.guid);
+        const parent = this.gameObject.parent;
+        if (parent) {
+            this._isLoadingOrDoneLoading = true;
+            const opts = new InstantiateOptions();
+            // we need to provide stable guids for creating nested gltfs
+            opts.idProvider = new InstantiateIdProvider(this.hash(this.guid));
+            opts.parent = this.loadAssetInParent !== false ? parent : this.gameObject;
+            this.gameObject.updateMatrix();
+            const matrix = this.gameObject.matrix;
+            if (debug)
+                console.log("Load nested:", this.filePath?.url ?? this.filePath, this.gameObject.position);
+            const res = await this.filePath?.instantiate?.call(this.filePath, opts);
+            if (debug)
+                console.log("Nested loaded:", this.filePath?.url ?? this.filePath, res);
+            if (res && this.loadAssetInParent !== false) {
+                res.matrixAutoUpdate = false;
+                res.matrix.identity();
+                res.applyMatrix4(matrix);
+                res.matrixAutoUpdate = true;
+                res.layers.disableAll();
+                res.layers.set(this.layer);
+                this.dispatchEvent(new CustomEvent("loaded", { detail: { instance: res, assetReference: this.filePath } }));
+            }
+            if (debug)
+                console.log("Nested loading done:", this.filePath?.url ?? this.filePath, res);
+        }
+    }
+    /** @internal */
+    onDestroy() {
+        // When the NestedGLTF gets destroyed we assume the loaded glTF is also destroyed
+        // meaning the resources, textures etc are disposed
+        // When this NestedGLTF would now be loaded again the AssetReference would still be in the loaded state
+        // so it would instantiate without textures etc...
+        // Perhaps we want to add a dispose callback or event method too?
+        // Somehow we have to clean the AssetReference state
+        this.filePath?.unload();
+    }
+    hash(str) {
+        let hash = 0;
+        for (let i = 0; i < str.length; i++) {
+            hash = str.charCodeAt(i) + ((hash << 5) - hash);
+        }
+        return hash;
+    }
+}
+__decorate([
+    serializable(AssetReference)
+], NestedGltf.prototype, "filePath", void 0);
 //# sourceMappingURL=NestedGltf.js.map