@needle-tools/engine 5.0.0 → 5.1.0-experimental.0

package/lib/engine-components/ui/Canvas.legacy.js

@@ -0,0 +1,409 @@
+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 { Matrix4 } from "three";
+import * as ThreeMeshUI from 'three-mesh-ui';
+import { Mathf } from "../../engine/engine_math.js";
+import { serializable } from "../../engine/engine_serialization_decorator.js";
+import { FrameEvent } from "../../engine/engine_setup.js";
+import { delayForFrames, getParam } from "../../engine/engine_utils.js";
+import { Camera } from "../Camera.js";
+import { GameObject } from "../Component.js";
+import { BaseUIComponent, UIRootComponent } from "./BaseUIComponent.js";
+import { EventSystem } from "./EventSystem.js";
+import { LayoutGroup } from "./Layout.js";
+import { RectTransform } from "./RectTransform.js";
+import { updateRenderSettings as updateRenderSettingsRecursive } from "./Utils.js";
+import { RenderMode } from "./RenderMode.js";
+const debugLayout = getParam("debuguilayout");
+/**
+ * @deprecated Use CanvasUikit instead. This Canvas implementation uses three-mesh-ui which is being replaced by pmndrs/uikit.
+ *
+ * Canvas is the root component for all UI elements in a scene.
+ * It defines the area where UI elements are rendered and manages their layout and rendering settings.
+ * Canvases can be set to render in world space or screen space (overlay or camera).
+ * Multiple canvases can exist in a scene, each with its own settings and hierarchy of UI elements.
+ * @summary Root component for UI elements, managing layout and rendering settings (DEPRECATED - use CanvasUikit)
+ * @category User Interface
+ * @group Components
+ */
+export class Canvas extends UIRootComponent {
+    get isCanvas() {
+        return true;
+    }
+    get screenspace() {
+        return this.renderMode !== RenderMode.WorldSpace;
+    }
+    set renderOnTop(val) {
+        if (val === this._renderOnTop) {
+            return;
+        }
+        this._renderOnTop = val;
+        this.onRenderSettingsChanged();
+    }
+    get renderOnTop() {
+        if (this._renderOnTop !== undefined)
+            return this._renderOnTop;
+        if (this.screenspace) {
+            // Render ScreenSpaceOverlay always on top
+            if (this._renderMode === RenderMode.ScreenSpaceOverlay)
+                return true;
+        }
+        return false;
+    }
+    _renderOnTop;
+    set depthWrite(val) {
+        if (this._depthWrite === val)
+            return;
+        this._depthWrite = val;
+        this.onRenderSettingsChanged();
+    }
+    get depthWrite() { return this._depthWrite; }
+    _depthWrite = false;
+    set doubleSided(val) {
+        if (this._doubleSided === val)
+            return;
+        this._doubleSided = val;
+        this.onRenderSettingsChanged();
+    }
+    get doubleSided() { return this._doubleSided; }
+    _doubleSided = true;
+    set castShadows(val) {
+        if (this._castShadows === val)
+            return;
+        this._castShadows = val;
+        this.onRenderSettingsChanged();
+    }
+    get castShadows() { return this._castShadows; }
+    _castShadows = false;
+    set receiveShadows(val) {
+        if (this._receiveShadows === val)
+            return;
+        this._receiveShadows = val;
+        this.onRenderSettingsChanged();
+    }
+    get receiveShadows() { return this._receiveShadows; }
+    _receiveShadows = false;
+    get renderMode() {
+        return this._renderMode;
+    }
+    set renderMode(val) {
+        if (this._renderMode === val)
+            return;
+        this._renderMode = val;
+        this.onRenderSettingsChanged();
+    }
+    _renderMode = RenderMode.Undefined;
+    _rootCanvas;
+    set rootCanvas(val) {
+        if (this._rootCanvas instanceof Canvas)
+            return;
+        this._rootCanvas = val;
+    }
+    get rootCanvas() {
+        return this._rootCanvas;
+    }
+    _scaleFactor = 1;
+    get scaleFactor() {
+        return this._scaleFactor;
+    }
+    set scaleFactor(val) {
+        this._scaleFactor = val;
+    }
+    worldCamera;
+    planeDistance = -1;
+    awake() {
+        //@ts-ignore
+        this.shadowComponent = this.gameObject;
+        this.previousParent = this.gameObject.parent;
+        if (debugLayout)
+            console.log("Canvas.Awake()", this.previousParent?.name + "/" + this.gameObject.name);
+        super.awake();
+    }
+    start() {
+        this.applyRenderSettings();
+    }
+    onEnable() {
+        super.onEnable();
+        this._updateRenderSettingsRoutine = undefined;
+        this._lastMatrixWorld = new Matrix4();
+        this.applyRenderSettings();
+        document.addEventListener("resize", this._boundRenderSettingsChanged);
+        // We want to run AFTER all regular onBeforeRender callbacks
+        this.context.pre_render_callbacks.push(this.onBeforeRenderRoutine);
+        this.context.post_render_callbacks.push(this.onAfterRenderRoutine);
+    }
+    onDisable() {
+        super.onDisable();
+        document.removeEventListener("resize", this._boundRenderSettingsChanged);
+        // Remove callbacks
+        const preRenderIndex = this.context.pre_render_callbacks.indexOf(this.onBeforeRenderRoutine);
+        if (preRenderIndex !== -1) {
+            this.context.pre_render_callbacks.splice(preRenderIndex, 1);
+        }
+        const postRenderIndex = this.context.post_render_callbacks.indexOf(this.onAfterRenderRoutine);
+        if (postRenderIndex !== -1) {
+            this.context.post_render_callbacks.splice(postRenderIndex, 1);
+        }
+    }
+    _boundRenderSettingsChanged = this.onRenderSettingsChanged.bind(this);
+    previousParent = null;
+    _lastMatrixWorld = null;
+    _rectTransforms = [];
+    registerTransform(rt) {
+        this._rectTransforms.push(rt);
+    }
+    unregisterTransform(rt) {
+        const index = this._rectTransforms.indexOf(rt);
+        if (index !== -1) {
+            this._rectTransforms.splice(index, 1);
+        }
+    }
+    _layoutGroups = new Map();
+    registerLayoutGroup(group) {
+        const obj = group.gameObject;
+        this._layoutGroups.set(obj, group);
+    }
+    unregisterLayoutGroup(group) {
+        const obj = group.gameObject;
+        this._layoutGroups.delete(obj);
+    }
+    _receivers = [];
+    registerEventReceiver(receiver) {
+        this._receivers.push(receiver);
+    }
+    unregisterEventReceiver(receiver) {
+        const index = this._receivers.indexOf(receiver);
+        if (index !== -1) {
+            this._receivers.splice(index, 1);
+        }
+    }
+    async onEnterXR(args) {
+        // workaround for https://linear.app/needle/issue/NE-4114
+        if (this.screenspace) {
+            if (args.xr.isVR || args.xr.isPassThrough) {
+                this.gameObject.visible = false;
+            }
+        }
+        else {
+            this.gameObject.visible = false;
+            await delayForFrames(1).then(() => {
+                this.gameObject.visible = true;
+            });
+        }
+    }
+    onLeaveXR(args) {
+        if (this.screenspace) {
+            if (args.xr.isVR || args.xr.isPassThrough) {
+                this.gameObject.visible = true;
+            }
+        }
+    }
+    onBeforeRenderRoutine = () => {
+        this.previousParent = this.gameObject.parent;
+        if ((this.context.xr?.isVR || this.context.xr?.isPassThrough) && this.screenspace) {
+            // see https://linear.app/needle/issue/NE-4114
+            this.gameObject.visible = false;
+            this.gameObject.removeFromParent();
+            return;
+        }
+        // console.log(this.previousParent?.name + "/" + this.gameObject.name);
+        if (this.renderOnTop || this.screenspace) {
+            // TODO: Ideally all screenspace canvases should be combined in one render pass
+            this.gameObject.removeFromParent();
+        }
+        else {
+            this.onUpdateRenderMode();
+            this.handleLayoutUpdates();
+            // TODO: we might need to optimize this. This is here to make sure the TMUI text clipping matrices are correct. Ideally the text does use onBeforeRender and apply the clipping matrix there so we dont have to force update all the matrices here
+            this.shadowComponent?.updateMatrixWorld(true);
+            this.shadowComponent?.updateWorldMatrix(true, true);
+            this.invokeBeforeRenderEvents();
+            EventSystem.ensureUpdateMeshUI(ThreeMeshUI, this.context);
+        }
+    };
+    onAfterRenderRoutine = () => {
+        if ((this.context.xr?.isVR || this.context.xr?.isPassThrough) && this.screenspace) {
+            this.previousParent?.add(this.gameObject);
+            // this is currently causing an error during XR (https://linear.app/needle/issue/NE-4114)
+            // this.gameObject.visible = true;
+            return;
+        }
+        if ((this.screenspace || this.renderOnTop) && this.previousParent && this.context.mainCamera) {
+            if (this.screenspace) {
+                const camObj = this.context.mainCamera;
+                camObj?.add(this.gameObject);
+            }
+            else {
+                this.previousParent.add(this.gameObject);
+            }
+            const prevAutoClearDepth = this.context.renderer.autoClear;
+            const prevAutoClearColor = this.context.renderer.autoClearColor;
+            this.context.renderer.autoClear = false;
+            this.context.renderer.autoClearColor = false;
+            this.context.renderer.clearDepth();
+            this.onUpdateRenderMode(true);
+            this.handleLayoutUpdates();
+            this.shadowComponent?.updateMatrixWorld(true);
+            // this.handleLayoutUpdates();
+            this.invokeBeforeRenderEvents();
+            EventSystem.ensureUpdateMeshUI(ThreeMeshUI, this.context, true);
+            this.context.renderer.render(this.gameObject, this.context.mainCamera);
+            this.context.renderer.autoClear = prevAutoClearDepth;
+            this.context.renderer.autoClearColor = prevAutoClearColor;
+            this.previousParent.add(this.gameObject);
+        }
+        this._lastMatrixWorld?.copy(this.gameObject.matrixWorld);
+    };
+    invokeBeforeRenderEvents() {
+        for (const receiver of this._receivers) {
+            receiver.onBeforeCanvasRender?.(this);
+        }
+    }
+    handleLayoutUpdates() {
+        if (this._lastMatrixWorld === null) {
+            this._lastMatrixWorld = new Matrix4();
+        }
+        const matrixWorldChanged = !this._lastMatrixWorld.equals(this.gameObject.matrixWorld);
+        if (debugLayout && matrixWorldChanged)
+            console.log("Canvas Layout changed", this.context.time.frameCount, this.name);
+        // TODO: optimize this, we should only need to update a subhierarchy of the parts where layout has changed
+        const didLog = false;
+        for (const ch of this._rectTransforms) {
+            if (matrixWorldChanged)
+                ch.markDirty();
+            let layout = this._layoutGroups.get(ch.gameObject);
+            if (ch.isDirty && !layout) {
+                layout = ch.gameObject.getComponentInParent(LayoutGroup);
+            }
+            if (ch.isDirty || layout?.isDirty) {
+                if (debugLayout && !didLog) {
+                    console.log("CANVAS UPDATE ### " + ch.name + " ##################################### " + this.context.time.frame);
+                    // didLog = true;
+                }
+                layout?.updateLayout();
+                ch.updateTransform();
+            }
+        }
+    }
+    applyRenderSettings() {
+        this.onRenderSettingsChanged();
+    }
+    _updateRenderSettingsRoutine;
+    onRenderSettingsChanged() {
+        if (this._updateRenderSettingsRoutine)
+            return;
+        this._updateRenderSettingsRoutine = this.startCoroutine(this._updateRenderSettingsDelayed(), FrameEvent.OnBeforeRender);
+    }
+    *_updateRenderSettingsDelayed() {
+        yield;
+        this._updateRenderSettingsRoutine = undefined;
+        if (this.shadowComponent) {
+            this.onUpdateRenderMode();
+            // this.onWillUpdateRenderSettings();
+            updateRenderSettingsRecursive(this.shadowComponent, this);
+            for (const ch of GameObject.getComponentsInChildren(this.gameObject, BaseUIComponent)) {
+                updateRenderSettingsRecursive(ch.shadowComponent, this);
+            }
+        }
+    }
+    _activeRenderMode = -1;
+    _lastWidth = -1;
+    _lastHeight = -1;
+    onUpdateRenderMode(force = false) {
+        if (!force) {
+            if (this._renderMode === this._activeRenderMode && this._lastWidth === this.context.domWidth && this._lastHeight === this.context.domHeight) {
+                return;
+            }
+        }
+        this._activeRenderMode = this._renderMode;
+        let camera = this.context.mainCameraComponent;
+        let planeDistance = 10;
+        if (camera && camera.nearClipPlane > 0 && camera.farClipPlane > 0) {
+            // TODO: this is a hack/workaround for event system currently only passing events to the nearest object so we move the canvas close to the nearplane
+            planeDistance = Mathf.lerp(camera.nearClipPlane, camera.farClipPlane, .01);
+        }
+        if (this._renderMode === RenderMode.ScreenSpaceCamera) {
+            if (this.worldCamera)
+                camera = this.worldCamera;
+            if (this.planeDistance > 0)
+                planeDistance = this.planeDistance;
+        }
+        switch (this._renderMode) {
+            case RenderMode.ScreenSpaceOverlay:
+            case RenderMode.ScreenSpaceCamera:
+                this._lastWidth = this.context.domWidth;
+                this._lastHeight = this.context.domHeight;
+                // showBalloonWarning("Screenspace Canvas is not supported yet. Please use worldspace");
+                if (!camera)
+                    return;
+                // we move the plane SLIGHTLY closer to be sure not to cull the canvas
+                const plane = planeDistance + .01;
+                this.gameObject.position.x = 0;
+                this.gameObject.position.y = 0;
+                this.gameObject.position.z = -plane;
+                this.gameObject.quaternion.identity();
+                const rect = this.gameObject.getComponent(RectTransform);
+                let hasChanged = false;
+                if (rect.sizeDelta.x !== this.context.domWidth) {
+                    hasChanged = true;
+                }
+                if (rect.sizeDelta.y !== this.context.domHeight) {
+                    hasChanged = true;
+                }
+                const vFOV = camera.fieldOfView * Math.PI / 180;
+                const h = 2 * Math.tan(vFOV / 2) * Math.abs(plane);
+                this.gameObject.scale.x = h / this.context.domHeight;
+                this.gameObject.scale.y = h / this.context.domHeight;
+                // Set scale.z, otherwise small offsets in screenspace mode have different visual results based on export scale and other settings
+                this.gameObject.scale.z = .01;
+                if (hasChanged) {
+                    rect.sizeDelta.x = this.context.domWidth;
+                    rect.sizeDelta.y = this.context.domHeight;
+                    rect?.markDirty();
+                }
+                // this.context.scene.add(this.gameObject)
+                // this.gameObject.scale.multiplyScalar(.01);
+                // this.gameObject.position.set(0,0,0);
+                break;
+            case RenderMode.WorldSpace:
+                this._lastWidth = -1;
+                this._lastHeight = -1;
+                break;
+        }
+    }
+}
+__decorate([
+    serializable()
+], Canvas.prototype, "renderOnTop", null);
+__decorate([
+    serializable()
+], Canvas.prototype, "depthWrite", null);
+__decorate([
+    serializable()
+], Canvas.prototype, "doubleSided", null);
+__decorate([
+    serializable()
+], Canvas.prototype, "castShadows", null);
+__decorate([
+    serializable()
+], Canvas.prototype, "receiveShadows", null);
+__decorate([
+    serializable()
+], Canvas.prototype, "renderMode", null);
+__decorate([
+    serializable(Canvas)
+], Canvas.prototype, "rootCanvas", null);
+__decorate([
+    serializable()
+], Canvas.prototype, "scaleFactor", null);
+__decorate([
+    serializable(Camera)
+], Canvas.prototype, "worldCamera", void 0);
+__decorate([
+    serializable()
+], Canvas.prototype, "planeDistance", void 0);
+//# sourceMappingURL=Canvas.legacy.js.map

package/lib/engine-components/ui/Canvas.legacy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Canvas.legacy.js","sourceRoot":"","sources":["../../../src/engine-components/ui/Canvas.legacy.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,OAAO,EAAY,MAAM,OAAO,CAAC;AAC1C,OAAO,KAAK,WAAW,MAAM,eAAe,CAAA;AAE5C,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,gDAAgD,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,IAAI,6BAA6B,EAAE,MAAM,YAAY,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,WAAW,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,MAAM,OAAO,MAAO,SAAQ,eAAe;IAEvC,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,UAAU,KAAK,UAAU,CAAC,UAAU,CAAC;IACrD,CAAC;IAGD,IAAI,WAAW,CAAC,GAAY;QACxB,IAAI,GAAG,KAAK,IAAI,CAAC,YAAY,EAAE;YAC3B,OAAO;SACV;QACD,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QACxB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IACD,IAAI,WAAW;QACX,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC9D,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,0CAA0C;YAC1C,IAAI,IAAI,CAAC,WAAW,KAAK,UAAU,CAAC,kBAAkB;gBAAE,OAAO,IAAI,CAAC;SACvE;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IACO,YAAY,CAAsB;IAG1C,IAAI,UAAU,CAAC,GAAY;QACvB,IAAI,IAAI,CAAC,WAAW,KAAK,GAAG;YAAE,OAAO;QACrC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IACD,IAAI,UAAU,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACrC,WAAW,GAAY,KAAK,CAAC;IAGrC,IAAI,WAAW,CAAC,GAAY;QACxB,IAAI,IAAI,CAAC,YAAY,KAAK,GAAG;YAAE,OAAO;QACtC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QACxB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IACD,IAAI,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACvC,YAAY,GAAY,IAAI,CAAC;IAGrC,IAAI,WAAW,CAAC,GAAY;QACxB,IAAI,IAAI,CAAC,YAAY,KAAK,GAAG;YAAE,OAAO;QACtC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QACxB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IACD,IAAI,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACvC,YAAY,GAAY,KAAK,CAAC;IAGtC,IAAI,cAAc,CAAC,GAAY;QAC3B,IAAI,IAAI,CAAC,eAAe,KAAK,GAAG;YAAE,OAAO;QACzC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;QAC3B,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IACD,IAAI,cAAc,KAAK,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC7C,eAAe,GAAY,KAAK,CAAC;IAIzC,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IACD,IAAI,UAAU,CAAC,GAAe;QAC1B,IAAI,IAAI,CAAC,WAAW,KAAK,GAAG;YAAE,OAAO;QACrC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IACO,WAAW,GAAe,UAAU,CAAC,SAAS,CAAC;IAE/C,WAAW,CAAU;IAG7B,IAAI,UAAU,CAAC,GAAW;QACtB,IAAI,IAAI,CAAC,WAAW,YAAY,MAAM;YAAE,OAAO;QAC/C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEO,YAAY,GAAW,CAAC,CAAC;IAEjC,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IACD,IAAY,WAAW,CAAC,GAAW;QAC/B,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;IAC5B,CAAC;IAGD,WAAW,CAAU;IAGrB,aAAa,GAAW,CAAC,CAAC,CAAC;IAE3B,KAAK;QACD,YAAY;QACZ,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC7C,IAAI,WAAW;YACX,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACzF,KAAK,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC;IAED,KAAK;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/B,CAAC;IAED,QAAQ;QACJ,KAAK,CAAC,QAAQ,EAAE,CAAC;QACjB,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;QAC9C,IAAI,CAAC,gBAAgB,GAAG,IAAI,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,2BAA2B,CAAC,CAAC;QACtE,4DAA4D;QAC5D,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACvE,CAAC;IAED,SAAS;QACL,KAAK,CAAC,SAAS,EAAE,CAAC;QAClB,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,2BAA2B,CAAC,CAAC;QACzE,mBAAmB;QACnB,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC7F,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE;YACvB,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;SAC/D;QACD,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC9F,IAAI,eAAe,KAAK,CAAC,CAAC,EAAE;YACxB,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;SACjE;IACL,CAAC;IAEO,2BAA2B,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEtE,cAAc,GAAoB,IAAI,CAAC;IACvC,gBAAgB,GAAmB,IAAI,CAAC;IACxC,eAAe,GAAqB,EAAE,CAAC;IAE/C,iBAAiB,CAAC,EAAkB;QAChC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC;IACD,mBAAmB,CAAC,EAAkB;QAClC,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YACd,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACzC;IACL,CAAC;IAEO,aAAa,GAAgC,IAAI,GAAG,EAAE,CAAC;IAC/D,mBAAmB,CAAC,KAAmB;QACnC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IACtC,CAAC;IACD,qBAAqB,CAAC,KAAmB;QACrC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAEO,UAAU,GAA2B,EAAE,CAAC;IAChD,qBAAqB,CAAC,QAA8B;QAChD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IACD,uBAAuB,CAAC,QAA8B;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACpC;IACL,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAuB;QACnC,yDAAyD;QACzD,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,IAAI,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC,aAAa,EAAE;gBACvC,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;aACnC;SACJ;aACI;YACD,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;YAChC,MAAM,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAE,EAAE;gBAC7B,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;YACnC,CAAC,CAAC,CAAC;SACN;IACL,CAAC;IACD,SAAS,CAAC,IAAuB;QAC7B,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,IAAI,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC,aAAa,EAAE;gBACvC,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;aAClC;SACJ;IACL,CAAC;IAED,qBAAqB,GAAG,GAAG,EAAE;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE;YAC/E,8CAA8C;YAC9C,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC;YACnC,OAAO;SACV;QAED,uEAAuE;QAEvE,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,EAAE;YACtC,+EAA+E;YAC/E,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC;SACtC;aACI;YACD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1B,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,kPAAkP;YAClP,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAChC,WAAW,CAAC,kBAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7D;IACL,CAAC,CAAA;IAED,oBAAoB,GAAG,GAAG,EAAE;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE;YAC/E,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1C,yFAAyF;YACzF,kCAAkC;YAClC,OAAO;SACV;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC1F,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;gBACvC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAChC;iBAAM;gBACH,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC5C;YACD,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC3D,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;YAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,KAAK,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,GAAG,KAAK,CAAC;YAC7C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YACnC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC9C,8BAA8B;YAC9B,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAChC,WAAW,CAAC,kBAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACvE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,kBAAkB,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,GAAG,kBAAkB,CAAC;YAC1D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC5C;QACD,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC,CAAA;IAEO,wBAAwB;QAC5B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,CAAC;SACzC;IACL,CAAC;IAEO,mBAAmB;QACvB,IAAI,IAAI,CAAC,gBAAgB,KAAK,IAAI,EAAE;YAChC,IAAI,CAAC,gBAAgB,GAAG,IAAI,OAAO,EAAE,CAAC;SACzC;QACD,MAAM,kBAAkB,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtF,IAAI,WAAW,IAAI,kBAAkB;YAAE,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAErH,0GAA0G;QAC1G,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,eAAe,EAAE;YACnC,IAAI,kBAAkB;gBAAE,EAAE,CAAC,SAAS,EAAE,CAAC;YACvC,IAAI,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;YACnD,IAAI,EAAE,CAAC,OAAO,IAAI,CAAC,MAAM,EAAE;gBACvB,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC,WAAW,CAAgB,CAAC;aAC3E;YACD,IAAI,EAAE,CAAC,OAAO,IAAI,MAAM,EAAE,OAAO,EAAE;gBAC/B,IAAI,WAAW,IAAI,CAAC,MAAM,EAAE;oBACxB,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,EAAE,CAAC,IAAI,GAAG,yCAAyC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAClH,iBAAiB;iBACpB;gBACD,MAAM,EAAE,YAAY,EAAE,CAAC;gBACvB,EAAE,CAAC,eAAe,EAAE,CAAC;aACxB;SACJ;IACL,CAAC;IAED,mBAAmB;QACf,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IAEO,4BAA4B,CAAa;IACzC,uBAAuB;QAC3B,IAAI,IAAI,CAAC,4BAA4B;YAAE,OAAO;QAC9C,IAAI,CAAC,4BAA4B,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAC5H,CAAC;IAEO,CAAC,4BAA4B;QACjC,KAAK,CAAC;QACN,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;QAC9C,IAAI,IAAI,CAAC,eAAe,EAAE;YACtB,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1B,qCAAqC;YACrC,6BAA6B,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAC1D,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,EAAE;gBACnF,6BAA6B,CAAC,EAAE,CAAC,eAAgB,EAAE,IAAI,CAAC,CAAC;aAC5D;SACJ;IACL,CAAC;IAEO,iBAAiB,GAAe,CAAC,CAAC,CAAC;IACnC,UAAU,GAAW,CAAC,CAAC,CAAC;IACxB,WAAW,GAAW,CAAC,CAAC,CAAC;IAGzB,kBAAkB,CAAC,QAAiB,KAAK;QAC7C,IAAI,CAAC,KAAK,EAAE;YACR,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;gBACzI,OAAO;aACV;SACJ;QACD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC;QAC1C,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;QAC9C,IAAI,aAAa,GAAW,EAAE,CAAC;QAC/B,IAAI,MAAM,IAAI,MAAM,CAAC,aAAa,GAAG,CAAC,IAAI,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE;YAC/D,oJAAoJ;YACpJ,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;SAC9E;QACD,IAAI,IAAI,CAAC,WAAW,KAAK,UAAU,CAAC,iBAAiB,EAAE;YACnD,IAAI,IAAI,CAAC,WAAW;gBAChB,MAAM,GAAG,IAAI,CAAC,WAAqB,CAAC;YACxC,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC;gBACtB,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;SAC1C;QAED,QAAQ,IAAI,CAAC,WAAW,EAAE;YACtB,KAAK,UAAU,CAAC,kBAAkB,CAAC;YACnC,KAAK,UAAU,CAAC,iBAAiB;gBAC7B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;gBACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;gBAE1C,wFAAwF;gBACxF,IAAI,CAAC,MAAM;oBAAE,OAAO;gBAEpB,sEAAsE;gBACtE,MAAM,KAAK,GAAG,aAAa,GAAG,GAAG,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC/B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC/B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;gBACpC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;gBAEtC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,aAAa,CAAE,CAAC;gBAC1D,IAAI,UAAU,GAAG,KAAK,CAAC;gBACvB,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBAC5C,UAAU,GAAG,IAAI,CAAC;iBACrB;gBACD,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;oBAC7C,UAAU,GAAG,IAAI,CAAC;iBACrB;gBAED,MAAM,IAAI,GAAG,MAAM,CAAC,WAAY,GAAG,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC;gBACjD,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;gBACrD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;gBACrD,kIAAkI;gBAClI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC;gBAE9B,IAAI,UAAU,EAAE;oBACZ,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACzC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;oBAC1C,IAAI,EAAE,SAAS,EAAE,CAAC;iBACrB;gBAGD,0CAA0C;gBAC1C,6CAA6C;gBAC7C,uCAAuC;gBAEvC,MAAM;YACV,KAAK,UAAU,CAAC,UAAU;gBACtB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;gBACrB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;gBACtB,MAAM;SACb;IACL,CAAC;CACJ;AA1XG;IADC,YAAY,EAAE;yCAOd;AAYD;IADC,YAAY,EAAE;wCAKd;AAKD;IADC,YAAY,EAAE;yCAKd;AAKD;IADC,YAAY,EAAE;yCAKd;AAKD;IADC,YAAY,EAAE;4CAKd;AAMD;IADC,YAAY,EAAE;wCAGd;AAWD;IADC,YAAY,CAAC,MAAM,CAAC;wCAIpB;AAQD;IADC,YAAY,EAAE;yCAGd;AAMD;IADC,YAAY,CAAC,MAAM,CAAC;2CACA;AAGrB;IADC,YAAY,EAAE;6CACY"}

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

@@ -0,0 +1,68 @@
+import { Container, Fullscreen } from "@pmndrs/uikit";
+import { type NeedleXREventArgs } from "../../engine/xr/api.js";
+import { Camera } from "../Camera.js";
+import { Behaviour } from "../Component.js";
+import type { ICanvas, ICanvasEventReceiver } from "./Interfaces.js";
+import { RenderMode } from "./Canvas.js";
+/**
+ * Modern Canvas implementation using pmndrs/uikit.
+ * This is the new default Canvas component that replaces the three-mesh-ui based implementation.
+ *
+ * @summary Root component for UI elements using pmndrs/uikit
+ * @category User Interface
+ * @group Components
+ */
+export declare class CanvasUikit extends Behaviour implements ICanvas {
+    private _uikitRoot;
+    private _previousParent;
+    private _lastMatrixWorld;
+    get isCanvas(): boolean;
+    get screenspace(): boolean;
+    set renderOnTop(val: boolean);
+    get renderOnTop(): boolean;
+    private _renderOnTop;
+    set depthWrite(val: boolean);
+    get depthWrite(): boolean;
+    private _depthWrite;
+    set doubleSided(val: boolean);
+    get doubleSided(): boolean;
+    private _doubleSided;
+    set castShadows(val: boolean);
+    get castShadows(): boolean;
+    private _castShadows;
+    set receiveShadows(val: boolean);
+    get receiveShadows(): boolean;
+    private _receiveShadows;
+    get renderMode(): RenderMode;
+    set renderMode(val: RenderMode);
+    private _renderMode;
+    get scaleFactor(): number;
+    set scaleFactor(val: number);
+    private _scaleFactor;
+    worldCamera?: Camera;
+    planeDistance: number;
+    pixelSize: number;
+    private _receivers;
+    private _updateUnsubscribe?;
+    registerEventReceiver(receiver: ICanvasEventReceiver): void;
+    unregisterEventReceiver(receiver: ICanvasEventReceiver): void;
+    awake(): void;
+    start(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onEnterXR(args: NeedleXREventArgs): Promise<void>;
+    onLeaveXR(args: NeedleXREventArgs): void;
+    private _boundOnRenderSettingsChanged;
+    private createUikitRoot;
+    private updateUikit;
+    private onRenderSettingsChanged;
+    /**
+     * Get the uikit root container.
+     * Use this to add uikit UI elements to the canvas.
+     */
+    get uikitRoot(): Container | Fullscreen | null;
+    registerTransform(_rt: any): void;
+    unregisterTransform(_rt: any): void;
+    registerLayoutGroup(_group: any): void;
+    unregisterLayoutGroup(_group: any): void;
+}