babylonjs-addons 9.0.0 → 9.2.1

package/babylonjs.addons.module.d.ts

@@ -882,7 +882,7 @@ import { Mesh } from "babylonjs/Meshes/mesh";
 import { INavMeshParametersV2 } from "babylonjs-addons/navigation/types";
 /**
  * Builds a any and any from meshes using provided parameters.
- * @param meshes The array of meshes used to create the any
+ * @param meshes The array of meshes used to create the any.
  * @param parameters The parameters used to configure the any generation.
  * @param workerOptions Options for the worker, including a completion callback and the worker instance.
  * @throws Error if the any data is invalid or cannot be deserialized.
@@ -890,8 +890,8 @@ import { INavMeshParametersV2 } from "babylonjs-addons/navigation/types";
 export function GenerateNavMeshWithWorker(meshes: Array<Mesh>, parameters: INavMeshParametersV2, workerOptions: {
     /**
      * Completion callback that is called when the any generation is complete.
-     * @param navMesh The generated any
-     * @param navMeshQuery The any associated with the generated any
+     * @param navMesh The generated any.
+     * @param navMeshQuery The any associated with the generated any.
      * @param tileCache Optional any if tile cache generation was used.
      */
     completion: (navMesh: any, navMeshQuery: any, tileCache?: any) => void;
@@ -1103,8 +1103,8 @@ export class NavigationDebugger {
      * * You can modify this property to include or exclude specific primitive types based on your debugging needs.
      * @returns An array of primitive types that the debug drawer will render.
      */
-    get primitiveTypes(): any;
-    set primitiveTypes(value: any);
+    get primitiveTypes(): any[];
+    set primitiveTypes(value: any[]);
     private _lineMaterialOptions;
     private _pointMesh;
     private _debugDrawerUtils;
@@ -1113,7 +1113,7 @@ export class NavigationDebugger {
         parent?: {
             node?: TransformNode | string;
         };
-        primitiveTypes?: any;
+        primitiveTypes?: any[];
         materials?: {
             triMaterial?: StandardMaterial;
             pointMaterial?: StandardMaterial;
@@ -1139,7 +1139,7 @@ export class NavigationDebugger {
      * @param primitives An array of debug drawer primitives to be drawn.
      * @param options Optional parameters to control the drawing behavior, such as whether to join meshes.
      */
-    drawPrimitives(primitives: any, options?: {
+    drawPrimitives(primitives: any[], options?: {
         joinMeshes?: boolean;
     }): void;
     /**
@@ -1254,11 +1254,11 @@ export class NavigationDebugger {
      *  @returns An object containing lists of heightfields, compact heightfields, contour sets
      */
     getIntermediates: (intermediates: GeneratorIntermediates) => {
-        heightfieldList: any;
-        compactHeightfieldList: any;
-        contourSetList: any;
-        polyMeshList: any;
-        polyMeshDetailList: any;
+        heightfieldList: any[];
+        compactHeightfieldList: any[];
+        contourSetList: any[];
+        polyMeshList: any[];
+        polyMeshDetailList: any[];
     };
     /**
      *  Draw debug information based on the selected option
@@ -1310,7 +1310,7 @@ declare module "babylonjs-addons/navigation/common/tile-cache" {
  * @param flags the flags to be set for each poly
  * @returns the tile cache mesh process function
  */
-export function CreateDefaultTileCacheMeshProcess(offMeshConnections?: any, area?: number, flags?: number): any;
+export function CreateDefaultTileCacheMeshProcess(offMeshConnections?: any[], area?: number, flags?: number): any;
 /**
  * Waits until the tile cache is fully updated
  * @param navMesh The any
@@ -1543,6 +1543,10 @@ export class TextRenderer implements IDisposable {
      * @param worldMatrix define the world matrix to use for the paragraph (optional)
      */
     addParagraph(text: string, options?: Partial<ParagraphOptions>, worldMatrix?: IMatrixLike): void;
+    /**
+     * Clear all paragraphs from the renderer to allow adding new ones from scratch
+     */
+    clearParagraphs(): void;
     /**
      * Render the text using the provided view and projection matrices
      * @param viewMatrix define the view matrix to use
@@ -1679,7 +1683,7 @@ export const msdfPixelShader: {
 }
 declare module "babylonjs-addons/msdfText/sdf/paragraph" {
 import { FontAsset } from "babylonjs-addons/msdfText/fontAsset";
-import { type ParagraphOptions } from "babylonjs-addons/msdfText/paragraphOptions";
+import { ParagraphOptions } from "babylonjs-addons/msdfText/paragraphOptions";
 import { SdfGlyph } from "babylonjs-addons/msdfText/sdf/glyph";
 import { SdfTextLine } from "babylonjs-addons/msdfText/sdf/line";
 /** @internal */
@@ -3596,7 +3600,7 @@ declare module "babylonjs-addons" {
 }
 
 
-declare module ADDONS {
+declare namespace ADDONS {
 
 
     /**
@@ -4430,7 +4434,7 @@ declare module ADDONS {
      */
     /**
      * Builds a any and any from meshes using provided parameters.
-     * @param meshes The array of meshes used to create the any
+     * @param meshes The array of meshes used to create the any.
      * @param parameters The parameters used to configure the any generation.
      * @param workerOptions Options for the worker, including a completion callback and the worker instance.
      * @throws Error if the any data is invalid or cannot be deserialized.
@@ -4438,8 +4442,8 @@ declare module ADDONS {
     export function GenerateNavMeshWithWorker(meshes: Array<BABYLON.Mesh>, parameters: INavMeshParametersV2, workerOptions: {
         /**
          * Completion callback that is called when the any generation is complete.
-         * @param navMesh The generated any
-         * @param navMeshQuery The any associated with the generated any
+         * @param navMesh The generated any.
+         * @param navMeshQuery The any associated with the generated any.
          * @param tileCache Optional any if tile cache generation was used.
          */
         completion: (navMesh: any, navMeshQuery: any, tileCache?: any) => void;
@@ -4621,8 +4625,8 @@ declare module ADDONS {
          * * You can modify this property to include or exclude specific primitive types based on your debugging needs.
          * @returns An array of primitive types that the debug drawer will render.
          */
-        get primitiveTypes(): any;
-        set primitiveTypes(value: any);
+        get primitiveTypes(): any[];
+        set primitiveTypes(value: any[]);
         private _lineMaterialOptions;
         private _pointMesh;
         private _debugDrawerUtils;
@@ -4631,7 +4635,7 @@ declare module ADDONS {
             parent?: {
                 node?: BABYLON.TransformNode | string;
             };
-            primitiveTypes?: any;
+            primitiveTypes?: any[];
             materials?: {
                 triMaterial?: BABYLON.StandardMaterial;
                 pointMaterial?: BABYLON.StandardMaterial;
@@ -4657,7 +4661,7 @@ declare module ADDONS {
          * @param primitives An array of debug drawer primitives to be drawn.
          * @param options Optional parameters to control the drawing behavior, such as whether to join meshes.
          */
-        drawPrimitives(primitives: any, options?: {
+        drawPrimitives(primitives: any[], options?: {
             joinMeshes?: boolean;
         }): void;
         /**
@@ -4772,11 +4776,11 @@ declare module ADDONS {
          *  @returns An object containing lists of heightfields, compact heightfields, contour sets
          */
         getIntermediates: (intermediates: GeneratorIntermediates) => {
-            heightfieldList: any;
-            compactHeightfieldList: any;
-            contourSetList: any;
-            polyMeshList: any;
-            polyMeshDetailList: any;
+            heightfieldList: any[];
+            compactHeightfieldList: any[];
+            contourSetList: any[];
+            polyMeshList: any[];
+            polyMeshDetailList: any[];
         };
         /**
          *  Draw debug information based on the selected option
@@ -4823,7 +4827,7 @@ declare module ADDONS {
      * @param flags the flags to be set for each poly
      * @returns the tile cache mesh process function
      */
-    export function CreateDefaultTileCacheMeshProcess(offMeshConnections?: any, area?: number, flags?: number): any;
+    export function CreateDefaultTileCacheMeshProcess(offMeshConnections?: any[], area?: number, flags?: number): any;
     /**
      * Waits until the tile cache is fully updated
      * @param navMesh The any
@@ -5029,6 +5033,10 @@ declare module ADDONS {
          * @param worldMatrix define the world matrix to use for the paragraph (optional)
          */
         addParagraph(text: string, options?: Partial<ParagraphOptions>, worldMatrix?: BABYLON.IMatrixLike): void;
+        /**
+         * Clear all paragraphs from the renderer to allow adding new ones from scratch
+         */
+        clearParagraphs(): void;
         /**
          * Render the text using the provided view and projection matrices
          * @param viewMatrix define the view matrix to use
@@ -5411,7 +5419,7 @@ declare module ADDONS {
         interface Window {
             "pointer-events-capture-debug": boolean | null;
         }
-    declare module ADDONS {
+    declare namespace ADDONS {
     
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-addons",
-    "version": "9.0.0",
+    "version": "9.2.1",
     "main": "babylonjs.addons.min.js",
     "types": "babylonjs.addons.module.d.ts",
     "files": [
@@ -15,7 +15,7 @@
         "test:escheck": "es-check es6 ./babylonjs.addons.js"
     },
     "dependencies": {
-        "babylonjs": "9.0.0"
+        "babylonjs": "9.2.1"
     },
     "devDependencies": {
         "@dev/addons": "1.0.0",

package/readme.md

@@ -1 +1,13 @@
 # Babylon.js Addons Library
+
+> We recommend using the [ES6 package `@babylonjs/addons`](https://www.npmjs.com/package/@babylonjs/addons) for new projects.
+
+A collection of addons and extensions for Babylon.js.
+
+## Installation
+
+To install using npm:
+
+```bash
+npm install babylonjs babylonjs-addons
+```

package/tsconfig.build.json

@@ -4,12 +4,13 @@
     "compilerOptions": {
         "outDir": "./dist",
         "target": "ES5",
+        "ignoreDeprecations": "6.0",
         "rootDir": "../../../",
         "declaration": false,
         "importHelpers": true,
         "paths": {
-            "core/*": ["dev/core/dist/*"],
-            "addons/*": ["dev/addons/src/*"]
+            "core/*": ["../../../dev/core/dist/*"],
+            "addons/*": ["../../../dev/addons/src/*"]
         }
     },
     "include": ["./src/**/*", "../../../dev/addons/src/**/*"]

package/tsconfig.json

@@ -3,7 +3,7 @@
 
     "compilerOptions": {
         "paths": {
-            "addons/*": ["dev/addons/src/*"]
+            "addons/*": ["../../../dev/addons/src/*"]
         }
     }
 }

package/webpack.config.js

@@ -1,20 +1,20 @@
-const commonConfigGenerator = require("@dev/build-tools").webpackTools.commonUMDWebpackConfiguration;
-const path = require("path");
-module.exports = (env) => {
-    const commonConfig = commonConfigGenerator({
-        mode: env.production ? "production" : "development",
-        devPackageName: "addons",
-        outputPath: path.resolve(__dirname),
-        entryPoints: {
-            addons: "./src/index.ts",
-        },
-        alias: {
-            addons: path.resolve(__dirname, "../../../dev/addons/src"),
-        },
-        overrideFilename: () => {
-            return `babylonjs.[name]${env.production ? ".min" : ""}.js`;
-        },
-        minToMax: true,
-    });
-    return commonConfig;
-};
+const commonConfigGenerator = require("@dev/build-tools").webpackTools.commonUMDWebpackConfiguration;
+const path = require("path");
+module.exports = (env) => {
+    const commonConfig = commonConfigGenerator({
+        mode: env.production ? "production" : "development",
+        devPackageName: "addons",
+        outputPath: path.resolve(__dirname),
+        entryPoints: {
+            addons: "./src/index.ts",
+        },
+        alias: {
+            addons: path.resolve(__dirname, "../../../dev/addons/src"),
+        },
+        overrideFilename: () => {
+            return `babylonjs.[name]${env.production ? ".min" : ""}.js`;
+        },
+        minToMax: true,
+    });
+    return commonConfig;
+};