babylonjs-loaders 7.20.0 → 7.21.0

package/babylonjs.loaders.module.d.ts

@@ -169,8 +169,12 @@ type DefaultExtensionOptions<BaseExtensionOptions> = {
      */
     enabled?: boolean;
 } & BaseExtensionOptions;
-class GLTFLoaderOptions {
-    constructor(options?: Partial<Readonly<GLTFLoaderOptions>>);
+abstract class GLTFLoaderOptions {
+    protected copyFrom(options?: Partial<Readonly<GLTFLoaderOptions>>): void;
+    /**
+     * Raised when the asset has been parsed
+     */
+    abstract onParsed: (loaderData: IGLTFLoaderData) => void;
     /**
      * The coordinate system mode. Defaults to AUTO.
      */
@@ -260,6 +264,28 @@ class GLTFLoaderOptions {
      * You can also pass null if you don't want a root node to be created.
      */
     customRootNode?: Nullable<TransformNode>;
+    /**
+     * Callback raised when the loader creates a mesh after parsing the glTF properties of the mesh.
+     * Note that the callback is called as soon as the mesh object is created, meaning some data may not have been setup yet for this mesh (vertex data, morph targets, material, ...)
+     */
+    abstract onMeshLoaded: (mesh: AbstractMesh) => void;
+    /**
+     * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
+     */
+    abstract onSkinLoaded: (node: TransformNode, skinnedNode: TransformNode) => void;
+    /**
+     * Callback raised when the loader creates a texture after parsing the glTF properties of the texture.
+     */
+    abstract onTextureLoaded: (texture: BaseTexture) => void;
+    /**
+     * Callback raised when the loader creates a material after parsing the glTF properties of the material.
+     */
+    abstract onMaterialLoaded: (material: Material) => void;
+    /**
+     * Callback raised when the loader creates a camera after parsing the glTF properties of the camera.
+     */
+    abstract onCameraLoaded: (camera: Camera) => void;
     /**
      * Defines options for glTF extensions.
      */
@@ -277,6 +303,11 @@ export class GLTFFileLoader extends GLTFLoaderOptions implements IDisposable, IS
     static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
     /** @internal */
     static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
+    /**
+     * Creates a new glTF file loader.
+     * @param options The options for the loader
+     */
+    constructor(options?: Partial<Readonly<GLTFLoaderOptions>>);
     /**
      * Raised when the asset has been parsed
      */
@@ -311,7 +342,7 @@ export class GLTFFileLoader extends GLTFLoaderOptions implements IDisposable, IS
      */
     set onMeshLoaded(callback: (mesh: AbstractMesh) => void);
     /**
-     * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+     * Observable raised when the loader creates a skin after parsing the glTF properties of the skin node.
      * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
      * @param node - the transform node that corresponds to the original glTF skin node used for animations
      * @param skinnedNode - the transform node that is the skinned mesh itself or the parent of the skinned meshes
@@ -320,6 +351,12 @@ export class GLTFFileLoader extends GLTFLoaderOptions implements IDisposable, IS
         node: TransformNode;
         skinnedNode: TransformNode;
     }>;
+    private _onSkinLoadedObserver;
+    /**
+     * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
+     */
+    set onSkinLoaded(callback: (node: TransformNode, skinnedNode: TransformNode) => void);
     /**
      * Observable raised when the loader creates a texture after parsing the glTF properties of the texture.
      */
@@ -1578,13 +1615,12 @@ import { INode, IMaterial, IBuffer, IScene } from "babylonjs-loaders/glTF/2.0/gl
 import { IGLTFLoaderExtension } from "babylonjs-loaders/glTF/2.0/glTFLoaderExtension";
 import { GLTFLoader } from "babylonjs-loaders/glTF/2.0/glTFLoader";
 import { IProperty } from "babylonjs-gltf2interface";
-const NAME = "MSFT_lod";
 module "babylonjs-loaders/glTF/glTFFileLoader" {
     interface GLTFLoaderExtensionOptions {
         /**
          * Defines options for the MSFT_lod extension.
          */
-        [NAME]?: Partial<{
+        ["MSFT_lod"]?: Partial<{
             /**
              * Maximum number of LODs to load, starting from the lowest LOD.
              */
@@ -1674,7 +1710,6 @@ export class MSFT_lod implements IGLTFLoaderExtension {
     private _disposeTransformNode;
     private _disposeMaterials;
 }
-export {};
 
 }
 declare module "babylonjs-loaders/glTF/2.0/Extensions/MSFT_audio_emitter" {
@@ -4071,6 +4106,9 @@ export class SolidParser {
     private _setDataForCurrentFaceWithPattern5;
     private _addPreviousObjMesh;
     private _optimizeNormals;
+    private static _IsLineElement;
+    private static _IsObjectElement;
+    private static _IsGroupElement;
     /**
      * Function used to parse an OBJ string
      * @param meshesNames defines the list of meshes to load (all if not defined)
@@ -4520,8 +4558,12 @@ declare module BABYLON {
          */
         enabled?: boolean;
     } & BaseExtensionOptions;
-    class GLTFLoaderOptions {
-        constructor(options?: Partial<Readonly<GLTFLoaderOptions>>);
+    abstract class GLTFLoaderOptions {
+        protected copyFrom(options?: Partial<Readonly<GLTFLoaderOptions>>): void;
+        /**
+         * Raised when the asset has been parsed
+         */
+        abstract onParsed: (loaderData: IGLTFLoaderData) => void;
         /**
          * The coordinate system mode. Defaults to AUTO.
          */
@@ -4611,6 +4653,28 @@ declare module BABYLON {
          * You can also pass null if you don't want a root node to be created.
          */
         customRootNode?: Nullable<TransformNode>;
+        /**
+         * Callback raised when the loader creates a mesh after parsing the glTF properties of the mesh.
+         * Note that the callback is called as soon as the mesh object is created, meaning some data may not have been setup yet for this mesh (vertex data, morph targets, material, ...)
+         */
+        abstract onMeshLoaded: (mesh: AbstractMesh) => void;
+        /**
+         * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
+         */
+        abstract onSkinLoaded: (node: TransformNode, skinnedNode: TransformNode) => void;
+        /**
+         * Callback raised when the loader creates a texture after parsing the glTF properties of the texture.
+         */
+        abstract onTextureLoaded: (texture: BaseTexture) => void;
+        /**
+         * Callback raised when the loader creates a material after parsing the glTF properties of the material.
+         */
+        abstract onMaterialLoaded: (material: Material) => void;
+        /**
+         * Callback raised when the loader creates a camera after parsing the glTF properties of the camera.
+         */
+        abstract onCameraLoaded: (camera: Camera) => void;
         /**
          * Defines options for glTF extensions.
          */
@@ -4628,6 +4692,11 @@ declare module BABYLON {
         static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
         /** @internal */
         static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
+        /**
+         * Creates a new glTF file loader.
+         * @param options The options for the loader
+         */
+        constructor(options?: Partial<Readonly<GLTFLoaderOptions>>);
         /**
          * Raised when the asset has been parsed
          */
@@ -4662,7 +4731,7 @@ declare module BABYLON {
          */
         set onMeshLoaded(callback: (mesh: AbstractMesh) => void);
         /**
-         * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+         * Observable raised when the loader creates a skin after parsing the glTF properties of the skin node.
          * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
          * @param node - the transform node that corresponds to the original glTF skin node used for animations
          * @param skinnedNode - the transform node that is the skinned mesh itself or the parent of the skinned meshes
@@ -4671,6 +4740,12 @@ declare module BABYLON {
             node: TransformNode;
             skinnedNode: TransformNode;
         }>;
+        private _onSkinLoadedObserver;
+        /**
+         * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
+         */
+        set onSkinLoaded(callback: (node: TransformNode, skinnedNode: TransformNode) => void);
         /**
          * Observable raised when the loader creates a texture after parsing the glTF properties of the texture.
          */
@@ -4882,6 +4957,7 @@ declare module BABYLON.GLTF2 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader {
         /**
@@ -5131,6 +5207,7 @@ declare module BABYLON.GLTF2.Loader {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2 {
         /**
@@ -5289,6 +5366,7 @@ declare module BABYLON.GLTF2 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2 {
         /** @internal */
@@ -5333,6 +5411,7 @@ declare module BABYLON.GLTF2 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2 {
         interface IWithMetadata {
@@ -5740,6 +5819,7 @@ declare module BABYLON.GLTF2 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         export var gltfToFlowGraphTypeMap: {
@@ -5752,6 +5832,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -5766,6 +5847,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -5781,6 +5863,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
     
@@ -5789,6 +5872,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -5829,6 +5913,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /** @internal */
@@ -5851,6 +5936,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /** @internal */
@@ -5873,21 +5959,10 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
-        const NAME = "MSFT_lod";
-        interface GLTFLoaderExtensionOptions {
-            /**
-             * Defines options for the MSFT_lod extension.
-             */
-            [NAME]?: Partial<{
-                /**
-                 * Maximum number of LODs to load, starting from the lowest LOD.
-                 */
-                maxLODsToLoad: number;
-            }>;
-        }
-    /**
+        /**
      * [Specification](https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Vendor/MSFT_lod/README.md)
      */
     export class MSFT_lod implements BABYLON.GLTF2.IGLTFLoaderExtension {
@@ -5974,6 +6049,17 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 
 }
 declare module BABYLON {
+    interface GLTFLoaderExtensionOptions {
+        /**
+         * Defines options for the MSFT_lod extension.
+         */
+        ["MSFT_lod"]?: Partial<{
+            /**
+             * Maximum number of LODs to load, starting from the lowest LOD.
+             */
+            maxLODsToLoad: number;
+        }>;
+    }
 
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
@@ -6024,6 +6110,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6061,6 +6148,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6093,6 +6181,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6121,6 +6210,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6148,6 +6238,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6186,6 +6277,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6268,6 +6360,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6305,6 +6398,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6342,6 +6436,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6379,6 +6474,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6417,6 +6513,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6454,6 +6551,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6491,6 +6589,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6532,6 +6631,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6569,6 +6669,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6607,6 +6708,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6645,6 +6747,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6683,6 +6786,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6720,6 +6824,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6756,6 +6861,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6786,6 +6892,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -6826,6 +6933,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         class CameraAnimationPropertyInfo extends BABYLON.GLTF2.AnimationPropertyInfo {
@@ -7120,6 +7228,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -7160,6 +7269,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -7201,6 +7311,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -7229,6 +7340,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -7258,6 +7370,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -7293,6 +7406,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
         /**
@@ -7326,6 +7440,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
             /** @internal */
@@ -7367,6 +7482,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF1 {
     
@@ -7375,6 +7491,7 @@ declare module BABYLON.GLTF1 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF1 {
         /**
@@ -7393,6 +7510,7 @@ declare module BABYLON.GLTF1 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF1 {
         /**
@@ -7466,6 +7584,7 @@ declare module BABYLON.GLTF1 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF1 {
         /**
@@ -7879,6 +7998,7 @@ declare module BABYLON.GLTF1 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF1 {
         /**
@@ -8023,6 +8143,7 @@ declare module BABYLON.GLTF1 {
 }
 declare module BABYLON {
 
+
 }
 declare module BABYLON.GLTF1 {
         /**
@@ -8042,6 +8163,7 @@ declare module BABYLON.GLTF1 {
 
 }
 declare module BABYLON {
+
     const PLUGIN_STL = "stl";
         interface SceneLoaderPluginOptions {
             /**
@@ -8339,6 +8461,9 @@ declare module BABYLON {
         private _setDataForCurrentFaceWithPattern5;
         private _addPreviousObjMesh;
         private _optimizeNormals;
+        private static _IsLineElement;
+        private static _IsObjectElement;
+        private static _IsGroupElement;
         /**
          * Function used to parse an OBJ string
          * @param meshesNames defines the list of meshes to load (all if not defined)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-loaders",
-    "version": "7.20.0",
+    "version": "7.21.0",
     "main": "babylonjs.loaders.js",
     "types": "babylonjs.loaders.module.d.ts",
     "files": [
@@ -15,8 +15,8 @@
         "test:escheck": "es-check es6 ./babylonjs.loaders.js"
     },
     "dependencies": {
-        "babylonjs": "^7.20.0",
-        "babylonjs-gltf2interface": "^7.20.0"
+        "babylonjs": "^7.21.0",
+        "babylonjs-gltf2interface": "^7.21.0"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",