@needle-tools/engine 4.4.0-beta.3 → 4.4.0-beta.5

package/lib/engine-components/webxr/WebXRRig.d.ts

@@ -1,32 +1,32 @@
-/// <reference types="webxr" />
-import type { IXRRig } from "../../engine/engine_xr.js";
-import { type NeedleXREventArgs } from "../../engine/engine_xr.js";
-import { Behaviour } from "../Component.js";
-/**
- * A user in XR (VR or AR) is parented to an XR rig during the session.
- * When moving through the scene the rig is moved instead of the user.
- * @category XR
- * @group Components
- */
-export declare class XRRig extends Behaviour implements IXRRig {
-    priority: number;
-    get isActive(): boolean;
-    /**
-     * 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(): void;
-    /**
-     * Sets the priority of the rig.
-     */
-    setPriority(value: number): void;
-    /** @internal */
-    awake(): void;
-    isXRRig(): boolean;
-    supportsXR(_mode: XRSessionMode): boolean;
-    private _startScale?;
-    /** @internal */
-    onEnterXR(args: NeedleXREventArgs): void;
-    /** @internal */
-    onLeaveXR(args: NeedleXREventArgs): void;
-}
+/// <reference types="webxr" />
+import type { IXRRig } from "../../engine/engine_xr.js";
+import { type NeedleXREventArgs } from "../../engine/engine_xr.js";
+import { Behaviour } from "../Component.js";
+/**
+ * A user in XR (VR or AR) is parented to an XR rig during the session.
+ * When moving through the scene the rig is moved instead of the user.
+ * @category XR
+ * @group Components
+ */
+export declare class XRRig extends Behaviour implements IXRRig {
+    priority: number;
+    get isActive(): boolean;
+    /**
+     * 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(): void;
+    /**
+     * Sets the priority of the rig.
+     */
+    setPriority(value: number): void;
+    /** @internal */
+    awake(): void;
+    isXRRig(): boolean;
+    supportsXR(_mode: XRSessionMode): boolean;
+    private _startScale?;
+    /** @internal */
+    onEnterXR(args: NeedleXREventArgs): void;
+    /** @internal */
+    onLeaveXR(args: NeedleXREventArgs): void;
+}

package/lib/engine-components/webxr/WebXRRig.js

@@ -1,73 +1,73 @@
-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 { AxesHelper, Object3D } from "three";
-import { serializable } from "../../engine/engine_serialization_decorator.js";
-import { getParam } from "../../engine/engine_utils.js";
-import { NeedleXRSession } from "../../engine/engine_xr.js";
-import { Behaviour } from "../Component.js";
-import { BoxGizmo } from "../Gizmos.js";
-const debug = getParam("debugwebxr");
-/**
- * A user in XR (VR or AR) is parented to an XR rig during the session.
- * When moving through the scene the rig is moved instead of the user.
- * @category XR
- * @group Components
- */
-export class XRRig extends Behaviour {
-    priority = 0;
-    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)
-     * 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) {
-        this.priority = value;
-    }
-    /** @internal */
-    awake() {
-        if (debug) {
-            const gizmoObj = new Object3D();
-            gizmoObj.position.y += .5;
-            this.gameObject.add(gizmoObj);
-            const box = gizmoObj.addNewComponent(BoxGizmo);
-            if (box)
-                box.isGizmo = false;
-            const axes = new AxesHelper(.5);
-            this.gameObject.add(axes);
-        }
-    }
-    isXRRig() {
-        return true;
-    }
-    supportsXR(_mode) {
-        return true;
-    }
-    _startScale;
-    /** @internal */
-    onEnterXR(args) {
-        this._startScale = this.gameObject.scale.clone();
-        args.xr.addRig(this);
-        if (debug)
-            console.log("WebXR: add Rig", this.name, this.priority);
-    }
-    /** @internal */
-    onLeaveXR(args) {
-        args.xr.removeRig(this);
-        if (this._startScale && this.gameObject)
-            this.gameObject.scale.copy(this._startScale);
-    }
-}
-__decorate([
-    serializable()
-], XRRig.prototype, "priority", 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 { AxesHelper, Object3D } from "three";
+import { serializable } from "../../engine/engine_serialization_decorator.js";
+import { getParam } from "../../engine/engine_utils.js";
+import { NeedleXRSession } from "../../engine/engine_xr.js";
+import { Behaviour } from "../Component.js";
+import { BoxGizmo } from "../Gizmos.js";
+const debug = getParam("debugwebxr");
+/**
+ * A user in XR (VR or AR) is parented to an XR rig during the session.
+ * When moving through the scene the rig is moved instead of the user.
+ * @category XR
+ * @group Components
+ */
+export class XRRig extends Behaviour {
+    priority = 0;
+    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)
+     * 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) {
+        this.priority = value;
+    }
+    /** @internal */
+    awake() {
+        if (debug) {
+            const gizmoObj = new Object3D();
+            gizmoObj.position.y += .5;
+            this.gameObject.add(gizmoObj);
+            const box = gizmoObj.addNewComponent(BoxGizmo);
+            if (box)
+                box.isGizmo = false;
+            const axes = new AxesHelper(.5);
+            this.gameObject.add(axes);
+        }
+    }
+    isXRRig() {
+        return true;
+    }
+    supportsXR(_mode) {
+        return true;
+    }
+    _startScale;
+    /** @internal */
+    onEnterXR(args) {
+        this._startScale = this.gameObject.scale.clone();
+        args.xr.addRig(this);
+        if (debug)
+            console.log("WebXR: add Rig", this.name, this.priority);
+    }
+    /** @internal */
+    onLeaveXR(args) {
+        args.xr.removeRig(this);
+        if (this._startScale && this.gameObject)
+            this.gameObject.scale.copy(this._startScale);
+    }
+}
+__decorate([
+    serializable()
+], XRRig.prototype, "priority", void 0);
 //# sourceMappingURL=WebXRRig.js.map

package/lib/engine-components/webxr/XRFlag.d.ts

@@ -1,38 +1,38 @@
-import { Behaviour } from "../Component.js";
-export declare enum XRStateFlag {
-    Never = 0,
-    Browser = 1,
-    AR = 2,
-    VR = 4,
-    FirstPerson = 8,
-    ThirdPerson = 16,
-    All = 4294967295
-}
-export declare class XRState {
-    static Global: XRState;
-    Mask: XRStateFlag;
-    Has(state: XRStateFlag): boolean;
-    Set(state: number): void;
-    Enable(state: number): void;
-    Disable(state: number): void;
-    Toggle(state: number): void;
-    EnableAll(): void;
-    DisableAll(): void;
-}
-/**
- * @category XR
- * @category Utilities
- * @group Components
- */
-export declare class XRFlag extends Behaviour {
-    private static registry;
-    static Apply(): void;
-    private static firstApply;
-    private static buffer;
-    visibleIn: number;
-    awake(): void;
-    onEnable(): void;
-    onDestroy(): void;
-    get isOn(): boolean;
-    UpdateVisible(state?: XRState | XRStateFlag | null): void;
-}
+import { Behaviour } from "../Component.js";
+export declare enum XRStateFlag {
+    Never = 0,
+    Browser = 1,
+    AR = 2,
+    VR = 4,
+    FirstPerson = 8,
+    ThirdPerson = 16,
+    All = 4294967295
+}
+export declare class XRState {
+    static Global: XRState;
+    Mask: XRStateFlag;
+    Has(state: XRStateFlag): boolean;
+    Set(state: number): void;
+    Enable(state: number): void;
+    Disable(state: number): void;
+    Toggle(state: number): void;
+    EnableAll(): void;
+    DisableAll(): void;
+}
+/**
+ * @category XR
+ * @category Utilities
+ * @group Components
+ */
+export declare class XRFlag extends Behaviour {
+    private static registry;
+    static Apply(): void;
+    private static firstApply;
+    private static buffer;
+    visibleIn: number;
+    awake(): void;
+    onEnable(): void;
+    onDestroy(): void;
+    get isOn(): boolean;
+    UpdateVisible(state?: XRState | XRStateFlag | null): void;
+}

package/lib/engine-components/webxr/XRFlag.js

@@ -1,140 +1,140 @@
-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_decorator.js";
-import { getParam } from "../../engine/engine_utils.js";
-import { Behaviour, GameObject } from "../Component.js";
-const debug = getParam("debugxrflags");
-const disable = getParam("disablexrflags");
-if (disable) {
-    console.warn("XRFlags are disabled");
-}
-export var XRStateFlag;
-(function (XRStateFlag) {
-    XRStateFlag[XRStateFlag["Never"] = 0] = "Never";
-    XRStateFlag[XRStateFlag["Browser"] = 1] = "Browser";
-    XRStateFlag[XRStateFlag["AR"] = 2] = "AR";
-    XRStateFlag[XRStateFlag["VR"] = 4] = "VR";
-    XRStateFlag[XRStateFlag["FirstPerson"] = 8] = "FirstPerson";
-    XRStateFlag[XRStateFlag["ThirdPerson"] = 16] = "ThirdPerson";
-    XRStateFlag[XRStateFlag["All"] = 4294967295] = "All";
-})(XRStateFlag || (XRStateFlag = {}));
-export class XRState {
-    static Global = new XRState();
-    Mask = XRStateFlag.Browser | XRStateFlag.ThirdPerson;
-    Has(state) {
-        const res = (this.Mask & state);
-        return res !== 0;
-    }
-    Set(state) {
-        if (debug)
-            console.warn("Set XR flag state to", state);
-        this.Mask = state;
-        XRFlag.Apply();
-    }
-    Enable(state) {
-        this.Mask |= state;
-        XRFlag.Apply();
-    }
-    Disable(state) {
-        this.Mask &= ~state;
-        XRFlag.Apply();
-    }
-    Toggle(state) {
-        this.Mask ^= state;
-        XRFlag.Apply();
-    }
-    EnableAll() {
-        this.Mask = 0xffffffff | 0;
-        XRFlag.Apply();
-    }
-    DisableAll() {
-        this.Mask = 0;
-        XRFlag.Apply();
-    }
-}
-/**
- * @category XR
- * @category Utilities
- * @group Components
- */
-export class XRFlag extends Behaviour {
-    static registry = [];
-    static Apply() {
-        for (const r of this.registry)
-            r.UpdateVisible(XRState.Global);
-    }
-    static firstApply;
-    static buffer = new XRState();
-    visibleIn;
-    awake() {
-        XRFlag.registry.push(this);
-    }
-    onEnable() {
-        if (!XRFlag.firstApply) {
-            XRFlag.firstApply = true;
-            XRFlag.Apply();
-        }
-        else {
-            this.UpdateVisible(XRState.Global);
-        }
-    }
-    onDestroy() {
-        const i = XRFlag.registry.indexOf(this);
-        if (i >= 0)
-            XRFlag.registry.splice(i, 1);
-    }
-    get isOn() { return this.gameObject.visible; }
-    UpdateVisible(state = null) {
-        if (disable) {
-            return;
-        }
-        // XR flags set visibility of whole hierarchy which is like setting the whole object inactive
-        // so we need to ignore the enabled state of the XRFlag component
-        // if(!this.enabled) return;
-        let res = undefined;
-        const flag = state;
-        if (flag && typeof flag === "number") {
-            console.assert(typeof flag === "number", "XRFlag.UpdateVisible: state must be a number", flag);
-            if (debug)
-                console.log(flag);
-            XRFlag.buffer.Mask = flag;
-            state = XRFlag.buffer;
-        }
-        if (state instanceof XRState) {
-            if (debug)
-                console.warn(this.name, "use passed in mask", state.Mask, this.visibleIn);
-            res = state.Has(this.visibleIn);
-        }
-        else {
-            if (debug)
-                console.log(this.name, "use global mask");
-            XRState.Global.Has(this.visibleIn);
-        }
-        if (res === undefined)
-            return;
-        if (res) {
-            if (debug)
-                console.log(this.name, "is visible", this.gameObject.uuid);
-            // this.gameObject.visible = true;
-            GameObject.setActive(this.gameObject, true);
-        }
-        else {
-            if (debug)
-                console.log(this.name, "is not visible", this.gameObject.uuid);
-            const isVisible = this.gameObject.visible;
-            if (!isVisible)
-                return;
-            this.gameObject.visible = false;
-            // console.trace("DISABLE", this.name);
-            // GameObject.setActive(this.gameObject, false);
-        }
-    }
-}
-__decorate([
-    serializable()
-], XRFlag.prototype, "visibleIn", 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_decorator.js";
+import { getParam } from "../../engine/engine_utils.js";
+import { Behaviour, GameObject } from "../Component.js";
+const debug = getParam("debugxrflags");
+const disable = getParam("disablexrflags");
+if (disable) {
+    console.warn("XRFlags are disabled");
+}
+export var XRStateFlag;
+(function (XRStateFlag) {
+    XRStateFlag[XRStateFlag["Never"] = 0] = "Never";
+    XRStateFlag[XRStateFlag["Browser"] = 1] = "Browser";
+    XRStateFlag[XRStateFlag["AR"] = 2] = "AR";
+    XRStateFlag[XRStateFlag["VR"] = 4] = "VR";
+    XRStateFlag[XRStateFlag["FirstPerson"] = 8] = "FirstPerson";
+    XRStateFlag[XRStateFlag["ThirdPerson"] = 16] = "ThirdPerson";
+    XRStateFlag[XRStateFlag["All"] = 4294967295] = "All";
+})(XRStateFlag || (XRStateFlag = {}));
+export class XRState {
+    static Global = new XRState();
+    Mask = XRStateFlag.Browser | XRStateFlag.ThirdPerson;
+    Has(state) {
+        const res = (this.Mask & state);
+        return res !== 0;
+    }
+    Set(state) {
+        if (debug)
+            console.warn("Set XR flag state to", state);
+        this.Mask = state;
+        XRFlag.Apply();
+    }
+    Enable(state) {
+        this.Mask |= state;
+        XRFlag.Apply();
+    }
+    Disable(state) {
+        this.Mask &= ~state;
+        XRFlag.Apply();
+    }
+    Toggle(state) {
+        this.Mask ^= state;
+        XRFlag.Apply();
+    }
+    EnableAll() {
+        this.Mask = 0xffffffff | 0;
+        XRFlag.Apply();
+    }
+    DisableAll() {
+        this.Mask = 0;
+        XRFlag.Apply();
+    }
+}
+/**
+ * @category XR
+ * @category Utilities
+ * @group Components
+ */
+export class XRFlag extends Behaviour {
+    static registry = [];
+    static Apply() {
+        for (const r of this.registry)
+            r.UpdateVisible(XRState.Global);
+    }
+    static firstApply;
+    static buffer = new XRState();
+    visibleIn;
+    awake() {
+        XRFlag.registry.push(this);
+    }
+    onEnable() {
+        if (!XRFlag.firstApply) {
+            XRFlag.firstApply = true;
+            XRFlag.Apply();
+        }
+        else {
+            this.UpdateVisible(XRState.Global);
+        }
+    }
+    onDestroy() {
+        const i = XRFlag.registry.indexOf(this);
+        if (i >= 0)
+            XRFlag.registry.splice(i, 1);
+    }
+    get isOn() { return this.gameObject.visible; }
+    UpdateVisible(state = null) {
+        if (disable) {
+            return;
+        }
+        // XR flags set visibility of whole hierarchy which is like setting the whole object inactive
+        // so we need to ignore the enabled state of the XRFlag component
+        // if(!this.enabled) return;
+        let res = undefined;
+        const flag = state;
+        if (flag && typeof flag === "number") {
+            console.assert(typeof flag === "number", "XRFlag.UpdateVisible: state must be a number", flag);
+            if (debug)
+                console.log(flag);
+            XRFlag.buffer.Mask = flag;
+            state = XRFlag.buffer;
+        }
+        if (state instanceof XRState) {
+            if (debug)
+                console.warn(this.name, "use passed in mask", state.Mask, this.visibleIn);
+            res = state.Has(this.visibleIn);
+        }
+        else {
+            if (debug)
+                console.log(this.name, "use global mask");
+            XRState.Global.Has(this.visibleIn);
+        }
+        if (res === undefined)
+            return;
+        if (res) {
+            if (debug)
+                console.log(this.name, "is visible", this.gameObject.uuid);
+            // this.gameObject.visible = true;
+            GameObject.setActive(this.gameObject, true);
+        }
+        else {
+            if (debug)
+                console.log(this.name, "is not visible", this.gameObject.uuid);
+            const isVisible = this.gameObject.visible;
+            if (!isVisible)
+                return;
+            this.gameObject.visible = false;
+            // console.trace("DISABLE", this.name);
+            // GameObject.setActive(this.gameObject, false);
+        }
+    }
+}
+__decorate([
+    serializable()
+], XRFlag.prototype, "visibleIn", void 0);
 //# sourceMappingURL=XRFlag.js.map

package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts

@@ -1,47 +1,47 @@
-/// <reference types="webxr" />
-import type { NeedleXREventArgs } from "../../../engine/engine_xr.js";
-import { Behaviour } from "../../Component.js";
-/**
- * Add this script to an object and set `side` to make the object follow a specific controller.
- * @category XR
- * @group Components
- * */
-export declare class XRControllerFollow extends Behaviour {
-    get activeAndEnabled(): boolean;
-    /** Should this object follow a right hand/controller or left hand/controller.
-     * When a number is provided, the controller with that index is followed.
-     * @default "none"
-     **/
-    side: XRHandedness | number;
-    /** should it follow controllers (the physics controller)
-     * @default true
-    */
-    controller: boolean;
-    /** should it follow hands (when using hand tracking in WebXR)
-     * @default false
-    */
-    hands: boolean;
-    /** Disable if you don't want this script to modify the object's visibility
-     * If enabled the object will be hidden when the configured controller or hand is not available
-     * If disabled this script will not modify the object's visibility
-     * @default true
-     */
-    controlVisibility: boolean;
-    /** when true it will use the grip space, otherwise the ray space
-     * @default false
-    */
-    useGripSpace: boolean;
-    /** when enabled the position, rotation and scale of this object will be set to the position it was at when it entered the XR session
-     * @default true
-    */
-    resetTransformAfterXRSession: boolean;
-    private readonly _startPosition;
-    private readonly _startRotation;
-    private readonly _startScale;
-    /** @internal */
-    onEnterXR(_args: NeedleXREventArgs): void;
-    /** @internal */
-    onUpdateXR(args: NeedleXREventArgs): void;
-    /** @internal */
-    onLeaveXR(_args: NeedleXREventArgs): void;
-}
+/// <reference types="webxr" />
+import type { NeedleXREventArgs } from "../../../engine/engine_xr.js";
+import { Behaviour } from "../../Component.js";
+/**
+ * Add this script to an object and set `side` to make the object follow a specific controller.
+ * @category XR
+ * @group Components
+ * */
+export declare class XRControllerFollow extends Behaviour {
+    get activeAndEnabled(): boolean;
+    /** Should this object follow a right hand/controller or left hand/controller.
+     * When a number is provided, the controller with that index is followed.
+     * @default "none"
+     **/
+    side: XRHandedness | number;
+    /** should it follow controllers (the physics controller)
+     * @default true
+    */
+    controller: boolean;
+    /** should it follow hands (when using hand tracking in WebXR)
+     * @default false
+    */
+    hands: boolean;
+    /** Disable if you don't want this script to modify the object's visibility
+     * If enabled the object will be hidden when the configured controller or hand is not available
+     * If disabled this script will not modify the object's visibility
+     * @default true
+     */
+    controlVisibility: boolean;
+    /** when true it will use the grip space, otherwise the ray space
+     * @default false
+    */
+    useGripSpace: boolean;
+    /** when enabled the position, rotation and scale of this object will be set to the position it was at when it entered the XR session
+     * @default true
+    */
+    resetTransformAfterXRSession: boolean;
+    private readonly _startPosition;
+    private readonly _startRotation;
+    private readonly _startScale;
+    /** @internal */
+    onEnterXR(_args: NeedleXREventArgs): void;
+    /** @internal */
+    onUpdateXR(args: NeedleXREventArgs): void;
+    /** @internal */
+    onLeaveXR(_args: NeedleXREventArgs): void;
+}