babylonjs-addons 8.8.4 → 8.9.0

package/babylonjs.addons.d.ts

@@ -6,7 +6,7 @@ declare module ADDONS {
      * Abstract Node class from Babylon.js
      */
     export interface INodeLike {
-        getWorldMatrix(): BABYLON.ThinMatrix;
+        getWorldMatrix(): BABYLON.IMatrixLike;
     }
     /**
      * Class used to render text using MSDF (Multi-channel Signed Distance Field) technique
@@ -16,6 +16,7 @@ declare module ADDONS {
      * With metrics: #6RLCWP#35
      * Thickness: #IABMEZ#3
      * Solar system: #9YCDYC#9
+     * Stroke: #6RLCWP#37
      */
     export class TextRenderer implements BABYLON.IDisposable {
         private readonly _useVAO;
@@ -42,11 +43,22 @@ declare module ADDONS {
         private _finalMatrix;
         private _lineMatrix;
         private _parentWorldMatrix;
-        private _storedTranslation;
         /**
          * Gets or sets the color of the text
          */
         color: BABYLON.IColor4Like;
+        /**
+         * Gets or sets the color of the stroke around the text
+         */
+        strokeColor: BABYLON.IColor4Like;
+        /**
+         * Gets or sets the width of the stroke around the text (inset)
+         */
+        strokeInsetWidth: number;
+        /**
+         * Gets or sets the width of the stroke around the text (outset)
+         */
+        strokeOutsetWidth: number;
         /**
          * Gets or sets the thickness of the text (0 means as defined in the font)
          * Value must be between -0.5 and 0.5
@@ -58,14 +70,32 @@ declare module ADDONS {
          */
         get parent(): BABYLON.Nullable<INodeLike>;
         set parent(value: BABYLON.Nullable<INodeLike>);
+        private _transformMatrix;
+        /**
+         * Gets or sets the transform matrix of the text renderer
+         * It will be applied in that order:
+         * parent x transform x paragraph world
+         */
+        get transformMatrix(): BABYLON.IMatrixLike;
+        set transformMatrix(value: BABYLON.IMatrixLike);
         /**
          * Gets or sets if the text is billboarded
          */
         isBillboard: boolean;
+        /**
+         * Gets or sets if the text is screen projected
+         * This will work only if the text is billboarded
+         */
+        isBillboardScreenProjected: boolean;
         /**
          * Gets the number of characters in the text renderer
          */
         get characterCount(): number;
+        /**
+         * Gets or sets if the text renderer should ignore the depth buffer
+         * Default is false
+         */
+        ignoreDepthBuffer: boolean;
         private constructor();
         private _resizeBuffers;
         private _setShaders;
@@ -104,7 +134,7 @@ declare module ADDONS {
         tabSize: number;
         whiteSpace: "pre-line";
         textAlign: "left" | "right" | "center";
-        translate: BABYLON.Vector2 | undefined;
+        translate: BABYLON.IVector2Like | undefined;
     };
     /** @internal */
     export var DefaultParagraphOptions: ParagraphOptions;
@@ -115,7 +145,7 @@ declare module ADDONS {
     /**
      * Class representing a font asset for SDF (Signed Distance Field) rendering.
      */
-    export class FontAsset {
+    export class FontAsset implements BABYLON.IDisposable {
         private readonly _chars;
         private readonly _charsRegex;
         private readonly _kernings;
@@ -133,8 +163,10 @@ declare module ADDONS {
          * Creates a new FontAsset instance.
          * @param definitionData defines the font data in JSON format.
          * @param textureUrl defines the url of the texture to use for the font.
+         * @param scene defines the hosting scene.
          */
-        constructor(definitionData: string, textureUrl: string);
+        constructor(definitionData: string, textureUrl: string, scene?: BABYLON.Scene);
+        dispose(): void;
         private _updateFallbacks;
         /** @internal */
         _getChar(charCode: number): BMFontChar;
@@ -146,14 +178,16 @@ declare module ADDONS {
 
 
     /** @internal */
-    export var msdfVertexShader: {
+    export var msdfVertexShaderWGSL: {
         name: string;
         shader: string;
     };
 
 
+
+
     /** @internal */
-    export var msdfFragmentShader: {
+    export var msdfFragmentShaderWGSL: {
         name: string;
         shader: string;
     };
@@ -166,6 +200,8 @@ declare module ADDONS {
     };
 
 
+
+
     /** @internal */
     export var msdfFragmentShader: {
         name: string;
@@ -202,6 +238,8 @@ declare module ADDONS {
     };
 
 
+
+
     /** @internal */
     export type SdfGlyph = {
         char: BMFontChar;