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

package/lib/engine-components/ui/RaycastUtils.js

@@ -1,68 +1,68 @@
-import { foreachComponent } from "../../engine/engine_gameobject.js";
-import { $shadowDomOwner } from "./BaseUIComponent.js";
-export class UIRaycastUtils {
-    /** returns the real object when dealing with shadow UI */
-    static getObject(obj) {
-        const shadowOwner = obj[$shadowDomOwner];
-        if (shadowOwner) {
-            if (shadowOwner.isComponent === true)
-                obj = shadowOwner.gameObject;
-            else
-                obj = shadowOwner;
-        }
-        return obj;
-    }
-    ;
-    static isInteractable(obj, out) {
-        // reset state
-        if (out) {
-            out.canvasGroup = undefined;
-            out.graphic = undefined;
-        }
-        if (obj === null || obj === undefined || !obj.visible)
-            return false;
-        obj = this.getObject(obj);
-        if (!obj.visible)
-            return false;
-        const canvasGroup = this.tryFindCanvasGroup(obj);
-        if (canvasGroup?.isCanvasGroup === true) {
-            if (out)
-                out.canvasGroup = canvasGroup;
-            if (canvasGroup.blocksRaycasts === false)
-                return false;
-            if (canvasGroup.interactable === false)
-                return false;
-        }
-        // handle Graphic Raycast target
-        const graphic = foreachComponent(obj, c => {
-            if (c.isGraphic === true)
-                return c;
-            return undefined;
-        }, false);
-        // console.log(obj, graphic?.raycastTarget);
-        if (out) {
-            if (graphic?.isGraphic === true)
-                out.graphic = graphic;
-        }
-        if (graphic?.raycastTarget === false)
-            return false;
-        if (graphic?.layer === 2)
-            return false;
-        return true;
-    }
-    static tryFindCanvasGroup(obj) {
-        if (!obj)
-            return null;
-        // test for canvas groups
-        const res = foreachComponent(obj, c => {
-            const gr = c;
-            if (gr.blocksRaycasts !== undefined && gr.interactable !== undefined)
-                return gr;
-            return undefined;
-        }, false);
-        if (res !== undefined)
-            return res;
-        return this.tryFindCanvasGroup(obj.parent);
-    }
-}
+import { foreachComponent } from "../../engine/engine_gameobject.js";
+import { $shadowDomOwner } from "./BaseUIComponent.js";
+export class UIRaycastUtils {
+    /** returns the real object when dealing with shadow UI */
+    static getObject(obj) {
+        const shadowOwner = obj[$shadowDomOwner];
+        if (shadowOwner) {
+            if (shadowOwner.isComponent === true)
+                obj = shadowOwner.gameObject;
+            else
+                obj = shadowOwner;
+        }
+        return obj;
+    }
+    ;
+    static isInteractable(obj, out) {
+        // reset state
+        if (out) {
+            out.canvasGroup = undefined;
+            out.graphic = undefined;
+        }
+        if (obj === null || obj === undefined || !obj.visible)
+            return false;
+        obj = this.getObject(obj);
+        if (!obj.visible)
+            return false;
+        const canvasGroup = this.tryFindCanvasGroup(obj);
+        if (canvasGroup?.isCanvasGroup === true) {
+            if (out)
+                out.canvasGroup = canvasGroup;
+            if (canvasGroup.blocksRaycasts === false)
+                return false;
+            if (canvasGroup.interactable === false)
+                return false;
+        }
+        // handle Graphic Raycast target
+        const graphic = foreachComponent(obj, c => {
+            if (c.isGraphic === true)
+                return c;
+            return undefined;
+        }, false);
+        // console.log(obj, graphic?.raycastTarget);
+        if (out) {
+            if (graphic?.isGraphic === true)
+                out.graphic = graphic;
+        }
+        if (graphic?.raycastTarget === false)
+            return false;
+        if (graphic?.layer === 2)
+            return false;
+        return true;
+    }
+    static tryFindCanvasGroup(obj) {
+        if (!obj)
+            return null;
+        // test for canvas groups
+        const res = foreachComponent(obj, c => {
+            const gr = c;
+            if (gr.blocksRaycasts !== undefined && gr.interactable !== undefined)
+                return gr;
+            return undefined;
+        }, false);
+        if (res !== undefined)
+            return res;
+        return this.tryFindCanvasGroup(obj.parent);
+    }
+}
 //# sourceMappingURL=RaycastUtils.js.map

package/lib/engine-components/ui/Raycaster.d.ts

@@ -1,30 +1,30 @@
-import { Intersection } from "three";
-import { type IRaycastOptions, RaycastOptions } from "../../engine/engine_physics.js";
-import { Behaviour } from "../Component.js";
-/** Derive from this class to create your own custom Raycaster
- * If you override awake, onEnable or onDisable, be sure to call the base class methods
- * Implement `performRaycast` to perform your custom raycasting logic
- */
-export declare abstract class Raycaster extends Behaviour {
-    awake(): void;
-    onEnable(): void;
-    onDisable(): void;
-    abstract performRaycast(_opts?: IRaycastOptions | RaycastOptions | null): Intersection[] | null;
-}
-export declare class ObjectRaycaster extends Raycaster {
-    private targets;
-    private raycastHits;
-    ignoreSkinnedMeshes: boolean;
-    start(): void;
-    performRaycast(opts?: IRaycastOptions | RaycastOptions | null): Intersection[] | null;
-}
-export declare class GraphicRaycaster extends ObjectRaycaster {
-    constructor();
-}
-export declare class SpatialGrabRaycaster extends Raycaster {
-    /**
-     * Use to disable SpatialGrabRaycaster globally
-     */
-    static allow: boolean;
-    performRaycast(_opts?: IRaycastOptions | RaycastOptions | null): Intersection[] | null;
-}
+import { Intersection } from "three";
+import { type IRaycastOptions, RaycastOptions } from "../../engine/engine_physics.js";
+import { Behaviour } from "../Component.js";
+/** Derive from this class to create your own custom Raycaster
+ * If you override awake, onEnable or onDisable, be sure to call the base class methods
+ * Implement `performRaycast` to perform your custom raycasting logic
+ */
+export declare abstract class Raycaster extends Behaviour {
+    awake(): void;
+    onEnable(): void;
+    onDisable(): void;
+    abstract performRaycast(_opts?: IRaycastOptions | RaycastOptions | null): Intersection[] | null;
+}
+export declare class ObjectRaycaster extends Raycaster {
+    private targets;
+    private raycastHits;
+    ignoreSkinnedMeshes: boolean;
+    start(): void;
+    performRaycast(opts?: IRaycastOptions | RaycastOptions | null): Intersection[] | null;
+}
+export declare class GraphicRaycaster extends ObjectRaycaster {
+    constructor();
+}
+export declare class SpatialGrabRaycaster extends Raycaster {
+    /**
+     * Use to disable SpatialGrabRaycaster globally
+     */
+    static allow: boolean;
+    performRaycast(_opts?: IRaycastOptions | RaycastOptions | null): Intersection[] | null;
+}

package/lib/engine-components/ui/Raycaster.js

@@ -1,96 +1,96 @@
-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 { SkinnedMesh } from "three";
-import { RaycastOptions } from "../../engine/engine_physics.js";
-import { serializable } from "../../engine/engine_serialization.js";
-import { NeedleXRSession } from "../../engine/engine_xr.js";
-import { Behaviour } from "../Component.js";
-import { EventSystem } from "./EventSystem.js";
-/** Derive from this class to create your own custom Raycaster
- * If you override awake, onEnable or onDisable, be sure to call the base class methods
- * Implement `performRaycast` to perform your custom raycasting logic
- */
-export class Raycaster extends Behaviour {
-    awake() {
-        EventSystem.createIfNoneExists(this.context);
-    }
-    onEnable() {
-        EventSystem.get(this.context)?.register(this);
-    }
-    onDisable() {
-        EventSystem.get(this.context)?.unregister(this);
-    }
-}
-export class ObjectRaycaster extends Raycaster {
-    targets = null;
-    raycastHits = [];
-    ignoreSkinnedMeshes = false;
-    start() {
-        this.targets = [this.gameObject];
-    }
-    performRaycast(opts = null) {
-        if (!this.targets)
-            return null;
-        opts ??= new RaycastOptions();
-        opts.targets = this.targets;
-        opts.results = this.raycastHits;
-        opts.useAcceleratedRaycast = true;
-        const orig = opts.testObject;
-        if (this.ignoreSkinnedMeshes) {
-            opts.testObject = obj => {
-                // if we are set to ignore skinned meshes, we return false for them
-                if (obj instanceof SkinnedMesh) {
-                    return "continue in children";
-                }
-                // call the original testObject function
-                if (orig)
-                    return orig(obj);
-                // otherwise allow raycasting
-                return true;
-            };
-        }
-        const hits = this.context.physics.raycast(opts);
-        opts.testObject = orig;
-        return hits;
-    }
-}
-__decorate([
-    serializable()
-], ObjectRaycaster.prototype, "ignoreSkinnedMeshes", void 0);
-export class GraphicRaycaster extends ObjectRaycaster {
-    // eventCamera: Camera | null = null;
-    // ignoreReversedGraphics: boolean = false;
-    // rootRaycaster: GraphicRaycaster | null = null;
-    constructor() {
-        super();
-        this.ignoreSkinnedMeshes = true;
-    }
-}
-export class SpatialGrabRaycaster extends Raycaster {
-    /**
-     * Use to disable SpatialGrabRaycaster globally
-     */
-    static allow = true;
-    performRaycast(_opts) {
-        // ensure we're in XR, otherwise return
-        if (!NeedleXRSession.active)
-            return null;
-        if (!SpatialGrabRaycaster.allow)
-            return null;
-        if (!_opts?.ray)
-            return null;
-        // TODO this raycast should actually start from gripWorldPosition, not the ray origin, for
-        // cases like transient-pointer on VisionOS where the ray starts at the head and not the hand
-        const rayOrigin = _opts.ray.origin;
-        const radius = 0.015;
-        // TODO if needed, check if the input source is a XR controller or hand
-        // draw gizmo around ray origin
-        // Gizmos.DrawSphere(rayOrigin, radius, 0x00ff0022);
-        return this.context.physics.sphereOverlap(rayOrigin, radius, false, true);
-    }
-}
+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 { SkinnedMesh } from "three";
+import { RaycastOptions } from "../../engine/engine_physics.js";
+import { serializable } from "../../engine/engine_serialization.js";
+import { NeedleXRSession } from "../../engine/engine_xr.js";
+import { Behaviour } from "../Component.js";
+import { EventSystem } from "./EventSystem.js";
+/** Derive from this class to create your own custom Raycaster
+ * If you override awake, onEnable or onDisable, be sure to call the base class methods
+ * Implement `performRaycast` to perform your custom raycasting logic
+ */
+export class Raycaster extends Behaviour {
+    awake() {
+        EventSystem.createIfNoneExists(this.context);
+    }
+    onEnable() {
+        EventSystem.get(this.context)?.register(this);
+    }
+    onDisable() {
+        EventSystem.get(this.context)?.unregister(this);
+    }
+}
+export class ObjectRaycaster extends Raycaster {
+    targets = null;
+    raycastHits = [];
+    ignoreSkinnedMeshes = false;
+    start() {
+        this.targets = [this.gameObject];
+    }
+    performRaycast(opts = null) {
+        if (!this.targets)
+            return null;
+        opts ??= new RaycastOptions();
+        opts.targets = this.targets;
+        opts.results = this.raycastHits;
+        opts.useAcceleratedRaycast = true;
+        const orig = opts.testObject;
+        if (this.ignoreSkinnedMeshes) {
+            opts.testObject = obj => {
+                // if we are set to ignore skinned meshes, we return false for them
+                if (obj instanceof SkinnedMesh) {
+                    return "continue in children";
+                }
+                // call the original testObject function
+                if (orig)
+                    return orig(obj);
+                // otherwise allow raycasting
+                return true;
+            };
+        }
+        const hits = this.context.physics.raycast(opts);
+        opts.testObject = orig;
+        return hits;
+    }
+}
+__decorate([
+    serializable()
+], ObjectRaycaster.prototype, "ignoreSkinnedMeshes", void 0);
+export class GraphicRaycaster extends ObjectRaycaster {
+    // eventCamera: Camera | null = null;
+    // ignoreReversedGraphics: boolean = false;
+    // rootRaycaster: GraphicRaycaster | null = null;
+    constructor() {
+        super();
+        this.ignoreSkinnedMeshes = true;
+    }
+}
+export class SpatialGrabRaycaster extends Raycaster {
+    /**
+     * Use to disable SpatialGrabRaycaster globally
+     */
+    static allow = true;
+    performRaycast(_opts) {
+        // ensure we're in XR, otherwise return
+        if (!NeedleXRSession.active)
+            return null;
+        if (!SpatialGrabRaycaster.allow)
+            return null;
+        if (!_opts?.ray)
+            return null;
+        // TODO this raycast should actually start from gripWorldPosition, not the ray origin, for
+        // cases like transient-pointer on VisionOS where the ray starts at the head and not the hand
+        const rayOrigin = _opts.ray.origin;
+        const radius = 0.015;
+        // TODO if needed, check if the input source is a XR controller or hand
+        // draw gizmo around ray origin
+        // Gizmos.DrawSphere(rayOrigin, radius, 0x00ff0022);
+        return this.context.physics.sphereOverlap(rayOrigin, radius, false, true);
+    }
+}
 //# sourceMappingURL=Raycaster.js.map

package/lib/engine-components/ui/RectTransform.d.ts

@@ -1,61 +1,61 @@
-import { Quaternion, Vector2, Vector3 } from "three";
-import * as ThreeMeshUI from 'three-mesh-ui';
-import { type DocumentedOptions as ThreeMeshUIEveryOptions } from "three-mesh-ui/build/types/core/elements/MeshUIBaseElement.js";
-import { BaseUIComponent } from "./BaseUIComponent.js";
-import { type IRectTransform, type IRectTransformChangedReceiver } from "./Interfaces.js";
-export declare class Size {
-    width: number;
-    height: number;
-}
-export declare class Rect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-export declare class RectTransform extends BaseUIComponent implements IRectTransform, IRectTransformChangedReceiver {
-    get parent(): RectTransform | undefined;
-    get translation(): Vector3;
-    get rotation(): Quaternion;
-    get scale(): Vector3;
-    private _anchoredPosition;
-    get anchoredPosition(): Vector2;
-    private set anchoredPosition(value);
-    sizeDelta: Vector2;
-    pivot: Vector2;
-    anchorMin: Vector2;
-    anchorMax: Vector2;
-    /** Optional min width in pixel, set to undefined to disable it */
-    minWidth?: number;
-    /** Optional min height in pixel, set to undefined to disable it */
-    minHeight?: number;
-    get width(): number;
-    get height(): number;
-    private lastMatrix;
-    private rectBlock;
-    private _transformNeedsUpdate;
-    private _initialPosition;
-    awake(): void;
-    onEnable(): void;
-    onDisable(): void;
-    onParentRectTransformChanged(comp: IRectTransform): void;
-    get isDirty(): boolean;
-    markDirty(): void;
-    /** Will update the transforms if it changed or is dirty */
-    updateTransform(): void;
-    private _parentRectTransform?;
-    private _lastUpdateFrame;
-    private canUpdate;
-    private onApplyTransform;
-    private _lastAnchoring;
-    /** applies the position offset to the passed in vector */
-    private applyAnchoring;
-    /** applies the pivot offset to the passed in vector */
-    private applyPivot;
-    getBasicOptions(): ThreeMeshUIEveryOptions;
-    private ensureValidSize;
-    private _createdBlocks;
-    private _createdTextBlocks;
-    createNewBlock(opts?: ThreeMeshUIEveryOptions | object): ThreeMeshUI.Block;
-    createNewText(opts?: ThreeMeshUIEveryOptions | object): ThreeMeshUI.Block;
-}
+import { Quaternion, Vector2, Vector3 } from "three";
+import * as ThreeMeshUI from 'three-mesh-ui';
+import { type DocumentedOptions as ThreeMeshUIEveryOptions } from "three-mesh-ui/build/types/core/elements/MeshUIBaseElement.js";
+import { BaseUIComponent } from "./BaseUIComponent.js";
+import { type IRectTransform, type IRectTransformChangedReceiver } from "./Interfaces.js";
+export declare class Size {
+    width: number;
+    height: number;
+}
+export declare class Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export declare class RectTransform extends BaseUIComponent implements IRectTransform, IRectTransformChangedReceiver {
+    get parent(): RectTransform | undefined;
+    get translation(): Vector3;
+    get rotation(): Quaternion;
+    get scale(): Vector3;
+    private _anchoredPosition;
+    get anchoredPosition(): Vector2;
+    private set anchoredPosition(value);
+    sizeDelta: Vector2;
+    pivot: Vector2;
+    anchorMin: Vector2;
+    anchorMax: Vector2;
+    /** Optional min width in pixel, set to undefined to disable it */
+    minWidth?: number;
+    /** Optional min height in pixel, set to undefined to disable it */
+    minHeight?: number;
+    get width(): number;
+    get height(): number;
+    private lastMatrix;
+    private rectBlock;
+    private _transformNeedsUpdate;
+    private _initialPosition;
+    awake(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onParentRectTransformChanged(comp: IRectTransform): void;
+    get isDirty(): boolean;
+    markDirty(): void;
+    /** Will update the transforms if it changed or is dirty */
+    updateTransform(): void;
+    private _parentRectTransform?;
+    private _lastUpdateFrame;
+    private canUpdate;
+    private onApplyTransform;
+    private _lastAnchoring;
+    /** applies the position offset to the passed in vector */
+    private applyAnchoring;
+    /** applies the pivot offset to the passed in vector */
+    private applyPivot;
+    getBasicOptions(): ThreeMeshUIEveryOptions;
+    private ensureValidSize;
+    private _createdBlocks;
+    private _createdTextBlocks;
+    createNewBlock(opts?: ThreeMeshUIEveryOptions | object): ThreeMeshUI.Block;
+    createNewText(opts?: ThreeMeshUIEveryOptions | object): ThreeMeshUI.Block;
+}