@babylonjs/gui 5.24.0 → 5.26.0

package/2D/advancedDynamicTexture.d.ts

@@ -2,6 +2,7 @@ import type { Nullable } from "@babylonjs/core/types.js";
 import { Observable } from "@babylonjs/core/Misc/observable.js";
 import type { Matrix } from "@babylonjs/core/Maths/math.vector.js";
 import { Vector2, Vector3 } from "@babylonjs/core/Maths/math.vector.js";
+import type { PointerInfoPre } from "@babylonjs/core/Events/pointerEvents.js";
 import { ClipboardInfo } from "@babylonjs/core/Events/clipboardEvents.js";
 import { DynamicTexture } from "@babylonjs/core/Materials/Textures/dynamicTexture.js";
 import type { AbstractMesh } from "@babylonjs/core/Meshes/abstractMesh.js";
@@ -33,27 +34,27 @@ export declare class AdvancedDynamicTexture extends DynamicTexture {
     private _canvasPointerOutObserver;
     private _canvasBlurObserver;
     private _background;
-    /** @hidden */
+    /** @internal */
     _rootContainer: Container;
-    /** @hidden */
+    /** @internal */
     _lastPickedControl: Control;
-    /** @hidden */
+    /** @internal */
     _lastControlOver: {
         [pointerId: number]: Control;
     };
-    /** @hidden */
+    /** @internal */
     _lastControlDown: {
         [pointerId: number]: Control;
     };
-    /** @hidden */
+    /** @internal */
     _capturingControl: {
         [pointerId: number]: Control;
     };
-    /** @hidden */
+    /** @internal */
     _shouldBlockPointer: boolean;
-    /** @hidden */
+    /** @internal */
     _layerToDispose: Nullable<Layer>;
-    /** @hidden */
+    /** @internal */
     _linkedControls: Control[];
     private _isFullscreen;
     private _fullscreenViewport;
@@ -67,13 +68,13 @@ export declare class AdvancedDynamicTexture extends DynamicTexture {
     private _rootElement;
     private _cursorChanged;
     private _defaultMousePointerId;
-    /** @hidden */
+    /** @internal */
     _capturedPointerIds: Set<number>;
-    /** @hidden */
+    /** @internal */
     _numLayoutCalls: number;
     /** Gets the number of layout calls made the last time the ADT has been rendered */
     get numLayoutCalls(): number;
-    /** @hidden */
+    /** @internal */
     _numRenderCalls: number;
     /** Gets the number of render calls made the last time the ADT has been rendered */
     get numRenderCalls(): number;
@@ -282,7 +283,7 @@ export declare class AdvancedDynamicTexture extends DynamicTexture {
      */
     dispose(): void;
     private _onResize;
-    /** @hidden */
+    /** @internal */
     _getGlobalViewport(): Viewport;
     /**
      * Get screen coordinates for a vector3
@@ -302,46 +303,45 @@ export declare class AdvancedDynamicTexture extends DynamicTexture {
     private _clearMeasure;
     private _render;
     /**
-     * @param cursor
-     * @hidden
+     * @internal
      */
     _changeCursor(cursor: string): void;
     /**
-     * @param control
-     * @param pointerId
-     * @hidden
+     * @internal
      */
     _registerLastControlDown(control: Control, pointerId: number): void;
     private _doPicking;
     /**
-     * @param list
-     * @param control
-     * @hidden
+     * @internal
      */
     _cleanControlAfterRemovalFromList(list: {
         [pointerId: number]: Control;
     }, control: Control): void;
     /**
-     * @param control
-     * @hidden
+     * @internal
      */
     _cleanControlAfterRemoval(control: Control): void;
+    /**
+     * This function will run a pointer event on this ADT and will trigger any pointer events on any controls
+     * This will work on a fullscreen ADT only. For mesh based ADT, simulate pointer events using the scene directly.
+     * @param x pointer X on the canvas for the picking
+     * @param y pointer Y on the canvas for the picking
+     * @param pi optional pointer information
+     */
+    pick(x: number, y: number, pi?: Nullable<PointerInfoPre>): void;
     private _translateToPicking;
     /** Attach to all scene events required to support pointer events */
     attach(): void;
     /**
-     * @param rawEvt
-     * @hidden
+     * @internal
      */
     private _onClipboardCopy;
     /**
-     * @param rawEvt
-     * @hidden
+     * @internal
      */
     private _onClipboardCut;
     /**
-     * @param rawEvt
-     * @hidden
+     * @internal
      */
     private _onClipboardPaste;
     /**

package/2D/advancedDynamicTexture.js

@@ -35,15 +35,15 @@ export class AdvancedDynamicTexture extends DynamicTexture {
     constructor(name, width = 0, height = 0, scene, generateMipMaps = false, samplingMode = Texture.NEAREST_SAMPLINGMODE, invertY = true) {
         super(name, { width: width, height: height }, scene, generateMipMaps, samplingMode, Constants.TEXTUREFORMAT_RGBA, invertY);
         this._isDirty = false;
-        /** @hidden */
+        /** @internal */
         this._rootContainer = new Container("root");
-        /** @hidden */
+        /** @internal */
         this._lastControlOver = {};
-        /** @hidden */
+        /** @internal */
         this._lastControlDown = {};
-        /** @hidden */
+        /** @internal */
         this._capturingControl = {};
-        /** @hidden */
+        /** @internal */
         this._linkedControls = new Array();
         this._isFullscreen = false;
         this._fullscreenViewport = new Viewport(0, 0, 1, 1);
@@ -55,11 +55,11 @@ export class AdvancedDynamicTexture extends DynamicTexture {
         this._renderScale = 1;
         this._cursorChanged = false;
         this._defaultMousePointerId = 0;
-        /** @hidden */
+        /** @internal */
         this._capturedPointerIds = new Set();
-        /** @hidden */
+        /** @internal */
         this._numLayoutCalls = 0;
-        /** @hidden */
+        /** @internal */
         this._numRenderCalls = 0;
         /**
          * Define type to string to ensure compatibility across browsers
@@ -110,8 +110,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
         this._invalidatedRectangle = null;
         this._clearMeasure = new Measure(0, 0, 0, 0);
         /**
-         * @param rawEvt
-         * @hidden
+         * @internal
          */
         this._onClipboardCopy = (rawEvt) => {
             const evt = rawEvt;
@@ -120,8 +119,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
             evt.preventDefault();
         };
         /**
-         * @param rawEvt
-         * @hidden
+         * @internal
          */
         this._onClipboardCut = (rawEvt) => {
             const evt = rawEvt;
@@ -130,8 +128,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
             evt.preventDefault();
         };
         /**
-         * @param rawEvt
-         * @hidden
+         * @internal
          */
         this._onClipboardPaste = (rawEvt) => {
             const evt = rawEvt;
@@ -587,7 +584,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
         }
         this.invalidateRect(0, 0, textureSize.width - 1, textureSize.height - 1);
     }
-    /** @hidden */
+    /** @internal */
     _getGlobalViewport() {
         const size = this.getSize();
         const globalViewPort = this._fullscreenViewport.toGlobal(size.width, size.height);
@@ -700,8 +697,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
         this._invalidatedRectangle = null;
     }
     /**
-     * @param cursor
-     * @hidden
+     * @internal
      */
     _changeCursor(cursor) {
         if (this._rootElement) {
@@ -710,9 +706,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
         }
     }
     /**
-     * @param control
-     * @param pointerId
-     * @hidden
+     * @internal
      */
     _registerLastControlDown(control, pointerId) {
         this._lastControlDown[pointerId] = control;
@@ -759,9 +753,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
         this._manageFocus();
     }
     /**
-     * @param list
-     * @param control
-     * @hidden
+     * @internal
      */
     _cleanControlAfterRemovalFromList(list, control) {
         for (const pointerId in list) {
@@ -775,14 +767,25 @@ export class AdvancedDynamicTexture extends DynamicTexture {
         }
     }
     /**
-     * @param control
-     * @hidden
+     * @internal
      */
     _cleanControlAfterRemoval(control) {
         this._cleanControlAfterRemovalFromList(this._lastControlDown, control);
         this._cleanControlAfterRemovalFromList(this._lastControlOver, control);
     }
-    _translateToPicking(scene, tempViewport, pi) {
+    /**
+     * This function will run a pointer event on this ADT and will trigger any pointer events on any controls
+     * This will work on a fullscreen ADT only. For mesh based ADT, simulate pointer events using the scene directly.
+     * @param x pointer X on the canvas for the picking
+     * @param y pointer Y on the canvas for the picking
+     * @param pi optional pointer information
+     */
+    pick(x, y, pi = null) {
+        if (this._isFullscreen && this._scene) {
+            this._translateToPicking(this._scene, new Viewport(0, 0, 0, 0), pi, x, y);
+        }
+    }
+    _translateToPicking(scene, tempViewport, pi, x = scene.pointerX, y = scene.pointerY) {
         const camera = scene.cameraToUseForPointers || scene.activeCamera;
         const engine = scene.getEngine();
         const originalCameraToUseForPointers = scene.cameraToUseForPointers;
@@ -799,10 +802,10 @@ export class AdvancedDynamicTexture extends DynamicTexture {
                 camera.rigCameras.forEach((rigCamera) => {
                     // generate the viewport of this camera
                     rigCamera.viewport.toGlobalToRef(engine.getRenderWidth(), engine.getRenderHeight(), rigViewport);
-                    const x = scene.pointerX / engine.getHardwareScalingLevel() - rigViewport.x;
-                    const y = scene.pointerY / engine.getHardwareScalingLevel() - (engine.getRenderHeight() - rigViewport.y - rigViewport.height);
+                    const transformedX = x / engine.getHardwareScalingLevel() - rigViewport.x;
+                    const transformedY = y / engine.getHardwareScalingLevel() - (engine.getRenderHeight() - rigViewport.y - rigViewport.height);
                     // check if the pointer is in the camera's viewport
-                    if (x < 0 || y < 0 || x > rigViewport.width || y > rigViewport.height) {
+                    if (transformedX < 0 || transformedY < 0 || x > rigViewport.width || y > rigViewport.height) {
                         // out of viewport - don't use this camera
                         return;
                     }
@@ -819,20 +822,20 @@ export class AdvancedDynamicTexture extends DynamicTexture {
                 camera.viewport.toGlobalToRef(engine.getRenderWidth(), engine.getRenderHeight(), tempViewport);
             }
         }
-        const x = scene.pointerX / engine.getHardwareScalingLevel() - tempViewport.x;
-        const y = scene.pointerY / engine.getHardwareScalingLevel() - (engine.getRenderHeight() - tempViewport.y - tempViewport.height);
+        const transformedX = x / engine.getHardwareScalingLevel() - tempViewport.x;
+        const transformedY = y / engine.getHardwareScalingLevel() - (engine.getRenderHeight() - tempViewport.y - tempViewport.height);
         this._shouldBlockPointer = false;
         // Do picking modifies _shouldBlockPointer
         if (pi) {
             const pointerId = pi.event.pointerId || this._defaultMousePointerId;
-            this._doPicking(x, y, pi, pi.type, pointerId, pi.event.button, pi.event.deltaX, pi.event.deltaY);
+            this._doPicking(transformedX, transformedY, pi, pi.type, pointerId, pi.event.button, pi.event.deltaX, pi.event.deltaY);
             // Avoid overwriting a true skipOnPointerObservable to false
             if (this._shouldBlockPointer || this._capturingControl[pointerId]) {
                 pi.skipOnPointerObservable = true;
             }
         }
         else {
-            this._doPicking(x, y, null, PointerEventTypes.POINTERMOVE, this._defaultMousePointerId, 0);
+            this._doPicking(transformedX, transformedY, null, PointerEventTypes.POINTERMOVE, this._defaultMousePointerId, 0);
         }
         // if overridden by a rig camera - reset back to the original value
         scene.cameraToUseForPointers = originalCameraToUseForPointers;