@needle-tools/engine 3.2.12-alpha → 3.2.14-alpha

package/src/engine-components/ui/EventSystem.ts

@@ -6,14 +6,14 @@ import * as ThreeMeshUI from 'three-mesh-ui'
 import { Context } from "../../engine/engine_setup";
 import { OrbitControls } from "../OrbitControls";
 import { IPointerEventHandler, PointerEventData } from "./PointerEvents";
-import { Raycaster } from "./Raycaster";
+import { ObjectRaycaster, Raycaster } from "./Raycaster";
 import { InputEvents } from "../../engine/engine_input";
 import { Object3D } from "three";
 import { ICanvasGroup, IGraphic } from "./Interfaces";
 import { getParam } from "../../engine/engine_utils";
 import { UIRaycastUtils } from "./RaycastUtils";
 import { $shadowDomOwner } from "./BaseUIComponent";
-import { showBalloonMessage, showBalloonWarning } from "../../engine/debug";
+import { isDevEnvironment, showBalloonMessage, showBalloonWarning } from "../../engine/debug";
 
 const debug = getParam("debugeventsystem");
 
@@ -86,9 +86,15 @@ export class EventSystem extends Behaviour {
     }
 
     start() {
-        // const res = GameObject.findObjectsOfType(Raycaster, this.context);
-        // if (res)
-        //     this.raycaster = [...res];
+        if (this.raycaster.length <= 0) {
+            const res = GameObject.findObjectOfType(Raycaster, this.context);
+            if (!res) {
+                const rc = GameObject.addNewComponent(this.context.scene, ObjectRaycaster);
+                this.raycaster.push(rc);
+                if (isDevEnvironment())
+                    console.warn("Added an ObjectRaycaster to the scene because no raycaster was found", this);
+            }
+        }
     }
 
     register(rc: Raycaster) {

package/src/engine-components/utils/OpenURL.ts

@@ -0,0 +1,119 @@
+
+import { IPointerClickHandler, PointerEventData } from "../ui";
+import { Behaviour } from "../Component";
+import { serializable } from "../../engine/engine_serialization";
+import { isDevEnvironment, showBalloonMessage } from "../../engine/debug";
+import { isSafari } from "../../engine/engine_utils";
+import { ObjectRaycaster, Raycaster } from "../ui/Raycaster";
+import { tryGetUIComponent } from "../ui/Utils";
+
+export enum OpenURLMode {
+    NewTab = 0,
+    SameTab = 1,
+    NewWindow = 2
+}
+
+export class OpenURL extends Behaviour implements IPointerClickHandler {
+
+    @serializable()
+    clickable: boolean = true;
+
+    @serializable()
+    url?: string;
+
+    @serializable()
+    mode: OpenURLMode = OpenURLMode.NewTab;
+
+    async open() {
+        if (!this.url) {
+            console.error("URL is not set", this);
+            return;
+        }
+
+        this._validateUrl();
+
+        if (isDevEnvironment()) showBalloonMessage("Open URL: " + this.url)
+
+
+        switch (this.mode) {
+            case OpenURLMode.NewTab:
+                if (isSafari()) {
+                    globalThis.open(this.url, "_blank");
+                }
+                else
+                    globalThis.open(this.url, "_blank");
+                break;
+            case OpenURLMode.SameTab:
+                if (isSafari()) {
+                    globalThis.open(this.url, "_top");
+                }
+                else globalThis.open(this.url, "_self");
+                break;
+            case OpenURLMode.NewWindow:
+                if (isSafari()) {
+                    globalThis.open(this.url, "_top");
+                }
+                else globalThis.open(this.url, "_new");
+                break;
+
+        }
+    }
+
+    start(): void {
+        const raycaster = this.gameObject.getComponentInParent(ObjectRaycaster);
+        if (!raycaster) this.gameObject.addNewComponent(ObjectRaycaster);
+    }
+
+    onEnable(): void {
+        if (isSafari()) window.addEventListener("touchend", this._safariNewTabWorkaround);
+    }
+    onDisable(): void {
+        if (isSafari()) window.removeEventListener("touchend", this._safariNewTabWorkaround);
+    }
+
+    onPointerEnter(args) {
+        if (!args.used && this.clickable)
+            this.context.input.setCursorPointer();
+    }
+    onPointerExit() {
+        if (this.clickable)
+            this.context.input.setCursorNormal();
+    }
+    onPointerClick(args: PointerEventData) {
+        if (this.clickable && !args.used && this.url?.length)
+            this.open();
+    }
+
+    private _safariNewTabWorkaround = () => {
+        if (!this.clickable || !this.url?.length) return;
+        // we only need this workaround for opening a new tab
+        if (this.mode === OpenURLMode.SameTab) return;
+        // When we process the click directly in the browser event we can open a new tab
+        // by emitting a link attribute and calling onClick
+        const raycaster = this.gameObject.getComponentInParent(Raycaster);
+        if (raycaster) {
+            const hits = raycaster.performRaycast();
+            if (!hits) return;
+            for (const hit of hits) {
+                if (hit.object === this.gameObject || tryGetUIComponent(hit.object)?.gameObject === this.gameObject) {
+                    this._validateUrl();
+                    var a = document.createElement('a') as HTMLAnchorElement;
+                    a.setAttribute("target", "_blank");
+                    a.setAttribute("href", this.url);
+                    a.click();
+                    break;
+                }
+            }
+        }
+    }
+
+    private _validateUrl() {
+        if (!this.url) return;
+        if (this.url.startsWith("www.")) {
+            if (isDevEnvironment()) {
+                console.warn("URL is not valid, adding https:// to the start of the URL", this.url);
+            }
+            this.url = "https://" + this.url;
+        }
+    }
+}