babylonjs-gui 7.5.0 → 7.6.1

package/babylon.gui.module.d.ts

@@ -451,8 +451,9 @@ export class AdvancedDynamicTexture extends DynamicTexture {
      * Recreate the content of the ADT from a JSON object
      * @param serializedObject define the JSON serialized object to restore from
      * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      */
-    parseSerializedObject(serializedObject: any, scaleToSize?: boolean): void;
+    parseSerializedObject(serializedObject: any, scaleToSize?: boolean, urlRewriter?: (url: string) => string): void;
     /**
      * Clones the ADT. If no mesh is defined, the GUI will be considered as a fullscreen GUI
      * @param newName defines the name of the new ADT
@@ -464,39 +465,44 @@ export class AdvancedDynamicTexture extends DynamicTexture {
      * Recreate the content of the ADT from a JSON object
      * @param serializedObject define the JSON serialized object to restore from
      * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      * @deprecated Please use parseSerializedObject instead
      */
-    parseContent: (serializedObject: any, scaleToSize?: boolean) => void;
+    parseContent: (serializedObject: any, scaleToSize?: boolean, urlRewriter?: ((url: string) => string) | undefined) => void;
     /**
      * Recreate the content of the ADT from a snippet saved by the GUI editor
      * @param snippetId defines the snippet to load
      * @param scaleToSize defines whether to scale to texture to the saved size
      * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      * @returns a promise that will resolve on success
      */
-    static ParseFromSnippetAsync(snippetId: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture): Promise<AdvancedDynamicTexture>;
+    static ParseFromSnippetAsync(snippetId: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
     /**
      * Recreate the content of the ADT from a snippet saved by the GUI editor
      * @param snippetId defines the snippet to load
      * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      * @returns a promise that will resolve on success
      */
-    parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean): Promise<AdvancedDynamicTexture>;
+    parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
     /**
      * Recreate the content of the ADT from a url json
      * @param url defines the url to load
      * @param scaleToSize defines whether to scale to texture to the saved size
      * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      * @returns a promise that will resolve on success
      */
-    static ParseFromFileAsync(url: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture): Promise<AdvancedDynamicTexture>;
+    static ParseFromFileAsync(url: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
     /**
      * Recreate the content of the ADT from a url json
      * @param url defines the url to load
      * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      * @returns a promise that will resolve on success
      */
-    parseFromURLAsync(url: string, scaleToSize?: boolean): Promise<AdvancedDynamicTexture>;
+    parseFromURLAsync(url: string, scaleToSize?: boolean, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
     private static _LoadURLContentAsync;
     /**
      * Compares two rectangle based controls for pixel overlap
@@ -1009,7 +1015,7 @@ export class Container extends Control {
     /**
      * @internal
      */
-    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
+    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): void;
     isReady(): boolean;
 }
 
@@ -1032,6 +1038,7 @@ import { IAccessibilityTag } from "babylonjs/IAccessibilityTag";
 import { IAnimatable } from "babylonjs/Animations/animatable.interface";
 import { Animation } from "babylonjs/Animations/animation";
 import { BaseGradient } from "babylonjs-gui/2D/controls/gradient/BaseGradient";
+import { AbstractEngine } from "babylonjs/Engines/abstractEngine";
 /**
  * Root class used for all 2D controls
  * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#controls
@@ -1130,6 +1137,8 @@ export class Control implements IAnimatable {
     private _gradient;
     /** @internal */
     protected _rebuildLayout: boolean;
+    /** @internal */
+    protected _urlRewriter?: (url: string) => string;
     /**
      * Observable that fires when the control's enabled state changes
      */
@@ -1836,9 +1845,10 @@ export class Control implements IAnimatable {
      * Parses a serialized object into this control
      * @param serializedObject the object with the serialized properties
      * @param host the texture where the control will be instantiated. Can be empty, in which case the control will be created on the same texture
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      * @returns this control
      */
-    parse(serializedObject: any, host?: AdvancedDynamicTexture): Control;
+    parse(serializedObject: any, host?: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Control;
     /**
      * Serializes the current control
      * @param serializationObject defined the JSON serialized object
@@ -1849,7 +1859,7 @@ export class Control implements IAnimatable {
     /**
      * @internal
      */
-    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
+    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): void;
     /** Releases associated resources */
     dispose(): void;
     private static _HORIZONTAL_ALIGNMENT_LEFT;
@@ -1874,7 +1884,7 @@ export class Control implements IAnimatable {
     /**
      * @internal
      */
-    static _GetFontOffset(font: string): {
+    static _GetFontOffset(font: string, engineToUse?: AbstractEngine): {
         ascent: number;
         height: number;
         descent: number;
@@ -1883,9 +1893,10 @@ export class Control implements IAnimatable {
      * Creates a Control from parsed data
      * @param serializedObject defines parsed data
      * @param host defines the hosting AdvancedDynamicTexture
+     * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
      * @returns a new Control
      */
-    static Parse(serializedObject: any, host: AdvancedDynamicTexture): Control;
+    static Parse(serializedObject: any, host: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Control;
     static AddHeader: (control: Control, text: string, size: string | number, options: {
         isHorizontal: boolean;
         controlFirst: boolean;
@@ -9287,8 +9298,9 @@ declare module BABYLON.GUI {
          * Recreate the content of the ADT from a JSON object
          * @param serializedObject define the JSON serialized object to restore from
          * @param scaleToSize defines whether to scale to texture to the saved size
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          */
-        parseSerializedObject(serializedObject: any, scaleToSize?: boolean): void;
+        parseSerializedObject(serializedObject: any, scaleToSize?: boolean, urlRewriter?: (url: string) => string): void;
         /**
          * Clones the ADT. If no mesh is defined, the GUI will be considered as a fullscreen GUI
          * @param newName defines the name of the new ADT
@@ -9300,39 +9312,44 @@ declare module BABYLON.GUI {
          * Recreate the content of the ADT from a JSON object
          * @param serializedObject define the JSON serialized object to restore from
          * @param scaleToSize defines whether to scale to texture to the saved size
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          * @deprecated Please use parseSerializedObject instead
          */
-        parseContent: (serializedObject: any, scaleToSize?: boolean) => void;
+        parseContent: (serializedObject: any, scaleToSize?: boolean, urlRewriter?: ((url: string) => string) | undefined) => void;
         /**
          * Recreate the content of the ADT from a snippet saved by the GUI editor
          * @param snippetId defines the snippet to load
          * @param scaleToSize defines whether to scale to texture to the saved size
          * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          * @returns a promise that will resolve on success
          */
-        static ParseFromSnippetAsync(snippetId: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture): Promise<AdvancedDynamicTexture>;
+        static ParseFromSnippetAsync(snippetId: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
         /**
          * Recreate the content of the ADT from a snippet saved by the GUI editor
          * @param snippetId defines the snippet to load
          * @param scaleToSize defines whether to scale to texture to the saved size
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          * @returns a promise that will resolve on success
          */
-        parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean): Promise<AdvancedDynamicTexture>;
+        parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
         /**
          * Recreate the content of the ADT from a url json
          * @param url defines the url to load
          * @param scaleToSize defines whether to scale to texture to the saved size
          * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          * @returns a promise that will resolve on success
          */
-        static ParseFromFileAsync(url: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture): Promise<AdvancedDynamicTexture>;
+        static ParseFromFileAsync(url: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
         /**
          * Recreate the content of the ADT from a url json
          * @param url defines the url to load
          * @param scaleToSize defines whether to scale to texture to the saved size
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          * @returns a promise that will resolve on success
          */
-        parseFromURLAsync(url: string, scaleToSize?: boolean): Promise<AdvancedDynamicTexture>;
+        parseFromURLAsync(url: string, scaleToSize?: boolean, urlRewriter?: (url: string) => string): Promise<AdvancedDynamicTexture>;
         private static _LoadURLContentAsync;
         /**
          * Compares two rectangle based controls for pixel overlap
@@ -9809,7 +9826,7 @@ declare module BABYLON.GUI {
         /**
          * @internal
          */
-        _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
+        _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): void;
         isReady(): boolean;
     }
 
@@ -9912,6 +9929,8 @@ declare module BABYLON.GUI {
         private _gradient;
         /** @internal */
         protected _rebuildLayout: boolean;
+        /** @internal */
+        protected _urlRewriter?: (url: string) => string;
         /**
          * BABYLON.Observable that fires when the control's enabled state changes
          */
@@ -10618,9 +10637,10 @@ declare module BABYLON.GUI {
          * Parses a serialized object into this control
          * @param serializedObject the object with the serialized properties
          * @param host the texture where the control will be instantiated. Can be empty, in which case the control will be created on the same texture
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          * @returns this control
          */
-        parse(serializedObject: any, host?: AdvancedDynamicTexture): Control;
+        parse(serializedObject: any, host?: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Control;
         /**
          * Serializes the current control
          * @param serializationObject defined the JSON serialized object
@@ -10631,7 +10651,7 @@ declare module BABYLON.GUI {
         /**
          * @internal
          */
-        _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
+        _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): void;
         /** Releases associated resources */
         dispose(): void;
         private static _HORIZONTAL_ALIGNMENT_LEFT;
@@ -10656,7 +10676,7 @@ declare module BABYLON.GUI {
         /**
          * @internal
          */
-        static _GetFontOffset(font: string): {
+        static _GetFontOffset(font: string, engineToUse?: BABYLON.AbstractEngine): {
             ascent: number;
             height: number;
             descent: number;
@@ -10665,9 +10685,10 @@ declare module BABYLON.GUI {
          * Creates a Control from parsed data
          * @param serializedObject defines parsed data
          * @param host defines the hosting AdvancedDynamicTexture
+         * @param urlRewriter defines an url rewriter to update urls before sending them to the controls
          * @returns a new Control
          */
-        static Parse(serializedObject: any, host: AdvancedDynamicTexture): Control;
+        static Parse(serializedObject: any, host: AdvancedDynamicTexture, urlRewriter?: (url: string) => string): Control;
         static AddHeader: (control: Control, text: string, size: string | number, options: {
             isHorizontal: boolean;
             controlFirst: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-gui",
-    "version": "7.5.0",
+    "version": "7.6.1",
     "main": "babylon.gui.js",
     "types": "babylon.gui.module.d.ts",
     "files": [
@@ -15,7 +15,7 @@
         "test:escheck": "es-check es6 ./babylon.gui.js"
     },
     "dependencies": {
-        "babylonjs": "^7.5.0"
+        "babylonjs": "^7.6.1"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",