@babylonjs/serializers 7.37.1 → 7.37.2

package/glTF/2.0/glTFExporterExtension.d.ts

@@ -4,10 +4,10 @@ import type { Nullable } from "@babylonjs/core/types.js";
 import type { Texture } from "@babylonjs/core/Materials/Textures/texture.js";
 import type { SubMesh } from "@babylonjs/core/Meshes/subMesh.js";
 import type { IDisposable } from "@babylonjs/core/scene.js";
-import type { _BinaryWriter } from "./glTFExporter";
 import type { IGLTFExporterExtension } from "../glTFFileExporter";
 import type { Material } from "@babylonjs/core/Materials/material.js";
 import type { BaseTexture } from "@babylonjs/core/Materials/Textures/baseTexture.js";
+import type { DataWriter } from "./dataWriter";
 /** @internal */
 export declare var __IGLTFExporterExtensionV2: number;
 /**
@@ -22,7 +22,7 @@ export interface IGLTFExporterExtensionV2 extends IGLTFExporterExtension, IDispo
      * @param mimeType The mime-type of the generated image
      * @returns A promise that resolves with the exported texture
      */
-    preExportTextureAsync?(context: string, babylonTexture: Nullable<Texture>, mimeType: ImageMimeType): Promise<Nullable<Texture>>;
+    preExportTextureAsync?(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Nullable<Texture>>;
     /**
      * Define this method to get notified when a texture info is created
      * @param context The context when loading the asset
@@ -31,31 +31,30 @@ export interface IGLTFExporterExtensionV2 extends IGLTFExporterExtension, IDispo
      */
     postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;
     /**
-     * Define this method to modify the default behavior when exporting texture info
+     * Define this method to modify the default behavior when exporting a mesh primitive
      * @param context The context when loading the asset
      * @param meshPrimitive glTF mesh primitive
      * @param babylonSubMesh Babylon submesh
-     * @param binaryWriter glTF serializer binary writer instance
      * @returns nullable IMeshPrimitive promise
      */
-    postExportMeshPrimitiveAsync?(context: string, meshPrimitive: Nullable<IMeshPrimitive>, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<IMeshPrimitive>;
+    postExportMeshPrimitiveAsync?(context: string, meshPrimitive: IMeshPrimitive, babylonSubMesh: SubMesh): Promise<IMeshPrimitive>;
     /**
      * Define this method to modify the default behavior when exporting a node
      * @param context The context when exporting the node
      * @param node glTF node
      * @param babylonNode BabylonJS node
+     * @param nodeMap Current node mapping of babylon node to glTF node index. Useful for combining nodes together.
+     * @param convertToRightHanded Flag indicating whether to convert values to right-handed
      * @returns nullable INode promise
      */
-    postExportNodeAsync?(context: string, node: Nullable<INode>, babylonNode: Node, nodeMap: {
-        [key: number]: number;
-    }, binaryWriter: _BinaryWriter): Promise<Nullable<INode>>;
+    postExportNodeAsync?(context: string, node: INode, babylonNode: Node, nodeMap: Map<Node, number>, convertToRightHanded: boolean, dataWriter: DataWriter): Promise<Nullable<INode>>;
     /**
      * Define this method to modify the default behavior when exporting a material
      * @param material glTF material
      * @param babylonMaterial BabylonJS material
      * @returns nullable IMaterial promise
      */
-    postExportMaterialAsync?(context: string, node: Nullable<IMaterial>, babylonMaterial: Material): Promise<IMaterial>;
+    postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;
     /**
      * Define this method to return additional textures to export from a material
      * @param material glTF material

package/glTF/2.0/glTFExporterExtension.js.map

@@ -1 +1 @@
-{"version":3,"file":"glTFExporterExtension.js","sourceRoot":"","sources":["../../../../../dev/serializers/src/glTF/2.0/glTFExporterExtension.ts"],"names":[],"mappings":"AAaA,gBAAgB;AAChB,wEAAwE;AACxE,MAAM,CAAC,IAAI,0BAA0B,GAAG,CAAC,CAAC,CAAC,uCAAuC","sourcesContent":["import type { ImageMimeType, IMeshPrimitive, INode, IMaterial, ITextureInfo } from \"babylonjs-gltf2interface\";\r\nimport type { Node } from \"core/node\";\r\nimport type { Nullable } from \"core/types\";\r\n\r\nimport type { Texture } from \"core/Materials/Textures/texture\";\r\nimport type { SubMesh } from \"core/Meshes/subMesh\";\r\nimport type { IDisposable } from \"core/scene\";\r\n\r\nimport type { _BinaryWriter } from \"./glTFExporter\";\r\nimport type { IGLTFExporterExtension } from \"../glTFFileExporter\";\r\nimport type { Material } from \"core/Materials/material\";\r\nimport type { BaseTexture } from \"core/Materials/Textures/baseTexture\";\r\n\r\n/** @internal */\r\n// eslint-disable-next-line no-var, @typescript-eslint/naming-convention\r\nexport var __IGLTFExporterExtensionV2 = 0; // I am here to allow dts to be created\r\n\r\n/**\r\n * Interface for a glTF exporter extension\r\n * @internal\r\n */\r\nexport interface IGLTFExporterExtensionV2 extends IGLTFExporterExtension, IDisposable {\r\n    /**\r\n     * Define this method to modify the default behavior before exporting a texture\r\n     * @param context The context when loading the asset\r\n     * @param babylonTexture The Babylon.js texture\r\n     * @param mimeType The mime-type of the generated image\r\n     * @returns A promise that resolves with the exported texture\r\n     */\r\n    preExportTextureAsync?(context: string, babylonTexture: Nullable<Texture>, mimeType: ImageMimeType): Promise<Nullable<Texture>>;\r\n\r\n    /**\r\n     * Define this method to get notified when a texture info is created\r\n     * @param context The context when loading the asset\r\n     * @param textureInfo The glTF texture info\r\n     * @param babylonTexture The Babylon.js texture\r\n     */\r\n    postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;\r\n\r\n    /**\r\n     * Define this method to modify the default behavior when exporting texture info\r\n     * @param context The context when loading the asset\r\n     * @param meshPrimitive glTF mesh primitive\r\n     * @param babylonSubMesh Babylon submesh\r\n     * @param binaryWriter glTF serializer binary writer instance\r\n     * @returns nullable IMeshPrimitive promise\r\n     */\r\n    postExportMeshPrimitiveAsync?(context: string, meshPrimitive: Nullable<IMeshPrimitive>, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<IMeshPrimitive>;\r\n\r\n    /**\r\n     * Define this method to modify the default behavior when exporting a node\r\n     * @param context The context when exporting the node\r\n     * @param node glTF node\r\n     * @param babylonNode BabylonJS node\r\n     * @returns nullable INode promise\r\n     */\r\n    postExportNodeAsync?(context: string, node: Nullable<INode>, babylonNode: Node, nodeMap: { [key: number]: number }, binaryWriter: _BinaryWriter): Promise<Nullable<INode>>;\r\n\r\n    /**\r\n     * Define this method to modify the default behavior when exporting a material\r\n     * @param material glTF material\r\n     * @param babylonMaterial BabylonJS material\r\n     * @returns nullable IMaterial promise\r\n     */\r\n    postExportMaterialAsync?(context: string, node: Nullable<IMaterial>, babylonMaterial: Material): Promise<IMaterial>;\r\n\r\n    /**\r\n     * Define this method to return additional textures to export from a material\r\n     * @param material glTF material\r\n     * @param babylonMaterial BabylonJS material\r\n     * @returns List of textures\r\n     */\r\n    postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];\r\n\r\n    /** Gets a boolean indicating that this extension was used */\r\n    wasUsed: boolean;\r\n\r\n    /** Gets a boolean indicating that this extension is required for the file to work */\r\n    required: boolean;\r\n\r\n    /**\r\n     * Called after the exporter state changes to EXPORTING\r\n     */\r\n    onExporting?(): void;\r\n}\r\n"]}
+{"version":3,"file":"glTFExporterExtension.js","sourceRoot":"","sources":["../../../../../dev/serializers/src/glTF/2.0/glTFExporterExtension.ts"],"names":[],"mappings":"AAaA,gBAAgB;AAChB,wEAAwE;AACxE,MAAM,CAAC,IAAI,0BAA0B,GAAG,CAAC,CAAC,CAAC,uCAAuC","sourcesContent":["import type { ImageMimeType, IMeshPrimitive, INode, IMaterial, ITextureInfo } from \"babylonjs-gltf2interface\";\r\nimport type { Node } from \"core/node\";\r\nimport type { Nullable } from \"core/types\";\r\n\r\nimport type { Texture } from \"core/Materials/Textures/texture\";\r\nimport type { SubMesh } from \"core/Meshes/subMesh\";\r\nimport type { IDisposable } from \"core/scene\";\r\n\r\nimport type { IGLTFExporterExtension } from \"../glTFFileExporter\";\r\nimport type { Material } from \"core/Materials/material\";\r\nimport type { BaseTexture } from \"core/Materials/Textures/baseTexture\";\r\nimport type { DataWriter } from \"./dataWriter\";\r\n\r\n/** @internal */\r\n// eslint-disable-next-line no-var, @typescript-eslint/naming-convention\r\nexport var __IGLTFExporterExtensionV2 = 0; // I am here to allow dts to be created\r\n\r\n/**\r\n * Interface for a glTF exporter extension\r\n * @internal\r\n */\r\nexport interface IGLTFExporterExtensionV2 extends IGLTFExporterExtension, IDisposable {\r\n    /**\r\n     * Define this method to modify the default behavior before exporting a texture\r\n     * @param context The context when loading the asset\r\n     * @param babylonTexture The Babylon.js texture\r\n     * @param mimeType The mime-type of the generated image\r\n     * @returns A promise that resolves with the exported texture\r\n     */\r\n    preExportTextureAsync?(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Nullable<Texture>>;\r\n\r\n    /**\r\n     * Define this method to get notified when a texture info is created\r\n     * @param context The context when loading the asset\r\n     * @param textureInfo The glTF texture info\r\n     * @param babylonTexture The Babylon.js texture\r\n     */\r\n    postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;\r\n\r\n    /**\r\n     * Define this method to modify the default behavior when exporting a mesh primitive\r\n     * @param context The context when loading the asset\r\n     * @param meshPrimitive glTF mesh primitive\r\n     * @param babylonSubMesh Babylon submesh\r\n     * @returns nullable IMeshPrimitive promise\r\n     */\r\n    postExportMeshPrimitiveAsync?(context: string, meshPrimitive: IMeshPrimitive, babylonSubMesh: SubMesh): Promise<IMeshPrimitive>;\r\n\r\n    /**\r\n     * Define this method to modify the default behavior when exporting a node\r\n     * @param context The context when exporting the node\r\n     * @param node glTF node\r\n     * @param babylonNode BabylonJS node\r\n     * @param nodeMap Current node mapping of babylon node to glTF node index. Useful for combining nodes together.\r\n     * @param convertToRightHanded Flag indicating whether to convert values to right-handed\r\n     * @returns nullable INode promise\r\n     */\r\n    postExportNodeAsync?(\r\n        context: string,\r\n        node: INode,\r\n        babylonNode: Node,\r\n        nodeMap: Map<Node, number>,\r\n        convertToRightHanded: boolean,\r\n        dataWriter: DataWriter\r\n    ): Promise<Nullable<INode>>;\r\n\r\n    /**\r\n     * Define this method to modify the default behavior when exporting a material\r\n     * @param material glTF material\r\n     * @param babylonMaterial BabylonJS material\r\n     * @returns nullable IMaterial promise\r\n     */\r\n    postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;\r\n\r\n    /**\r\n     * Define this method to return additional textures to export from a material\r\n     * @param material glTF material\r\n     * @param babylonMaterial BabylonJS material\r\n     * @returns List of textures\r\n     */\r\n    postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];\r\n\r\n    /** Gets a boolean indicating that this extension was used */\r\n    wasUsed: boolean;\r\n\r\n    /** Gets a boolean indicating that this extension is required for the file to work */\r\n    required: boolean;\r\n\r\n    /**\r\n     * Called after the exporter state changes to EXPORTING\r\n     */\r\n    onExporting?(): void;\r\n}\r\n"]}

package/glTF/2.0/glTFMaterialExporter.d.ts

@@ -1,113 +1,33 @@
-import type { ITextureInfo, IMaterial, IMaterialPbrMetallicRoughness } from "babylonjs-gltf2interface";
+import type { ITextureInfo } from "babylonjs-gltf2interface";
 import { ImageMimeType } from "babylonjs-gltf2interface";
 import type { Nullable } from "@babylonjs/core/types.js";
 import type { BaseTexture } from "@babylonjs/core/Materials/Textures/baseTexture.js";
-import type { _Exporter } from "./glTFExporter";
-import type { Material } from "@babylonjs/core/Materials/material.js";
+import type { GLTFExporter } from "./glTFExporter";
 import type { StandardMaterial } from "@babylonjs/core/Materials/standardMaterial.js";
 import type { PBRBaseMaterial } from "@babylonjs/core/Materials/PBR/pbrBaseMaterial.js";
 /**
- * Utility methods for working with glTF material conversion properties.  This class should only be used internally
+ * Computes the metallic factor.
+ * @param diffuse diffused value
+ * @param specular specular value
+ * @param oneMinusSpecularStrength one minus the specular strength
+ * @returns metallic value
  * @internal
  */
-export declare class _GLTFMaterialExporter {
-    /**
-     * Represents the dielectric specular values for R, G and B
-     */
-    private static readonly _DielectricSpecular;
-    /**
-     * Allows the maximum specular power to be defined for material calculations
-     */
-    private static readonly _MaxSpecularPower;
-    /**
-     * Mapping to store textures
-     */
+export declare function _SolveMetallic(diffuse: number, specular: number, oneMinusSpecularStrength: number): number;
+/**
+ * Utility methods for working with glTF material conversion properties.
+ * @internal
+ */
+export declare class GLTFMaterialExporter {
+    private readonly _exporter;
     private _textureMap;
     private _internalTextureToImage;
-    /**
-     * Numeric tolerance value
-     */
-    private static readonly _Epsilon;
-    /**
-     * Reference to the glTF Exporter
-     */
-    private _exporter;
-    constructor(exporter: _Exporter);
-    /**
-     * Specifies if two colors are approximately equal in value
-     * @param color1 first color to compare to
-     * @param color2 second color to compare to
-     * @param epsilon threshold value
-     * @returns boolean specifying if the colors are approximately equal in value
-     */
-    private static _FuzzyEquals;
-    /**
-     * Gets the materials from a Babylon scene and converts them to glTF materials
-     * @param exportMaterials
-     * @param mimeType texture mime type
-     * @param hasTextureCoords specifies if texture coordinates are present on the material
-     * @returns promise that resolves after all materials have been converted
-     */
-    _convertMaterialsToGLTFAsync(exportMaterials: Set<Material>, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<void>;
-    /**
-     * Makes a copy of the glTF material without the texture parameters
-     * @param originalMaterial original glTF material
-     * @returns glTF material without texture parameters
-     */
-    _stripTexturesFromMaterial(originalMaterial: IMaterial): IMaterial;
-    /**
-     * Specifies if the material has any texture parameters present
-     * @param material glTF Material
-     * @returns boolean specifying if texture parameters are present
-     */
-    _hasTexturesPresent(material: IMaterial): boolean;
-    _getTextureInfo(babylonTexture: Nullable<BaseTexture>): Nullable<ITextureInfo>;
-    /**
-     * Converts a Babylon StandardMaterial to a glTF Metallic Roughness Material
-     * @param babylonStandardMaterial
-     * @returns glTF Metallic Roughness Material representation
-     */
-    _convertToGLTFPBRMetallicRoughness(babylonStandardMaterial: StandardMaterial): IMaterialPbrMetallicRoughness;
-    /**
-     * Computes the metallic factor
-     * @param diffuse diffused value
-     * @param specular specular value
-     * @param oneMinusSpecularStrength one minus the specular strength
-     * @returns metallic value
-     */
-    static _SolveMetallic(diffuse: number, specular: number, oneMinusSpecularStrength: number): number;
-    /**
-     * Sets the glTF alpha mode to a glTF material from the Babylon Material
-     * @param glTFMaterial glTF material
-     * @param babylonMaterial Babylon material
-     */
-    private static _SetAlphaMode;
-    /**
-     * Converts a Babylon Standard Material to a glTF Material
-     * @param babylonStandardMaterial BJS Standard Material
-     * @param mimeType mime type to use for the textures
-     * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
-     * @returns promise, resolved with the material
-     */
-    _convertStandardMaterialAsync(babylonStandardMaterial: StandardMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
-    private _finishMaterial;
-    /**
-     * Converts an image typed array buffer to a base64 image
-     * @param buffer typed array buffer
-     * @param width width of the image
-     * @param height height of the image
-     * @param mimeType mimetype of the image
-     * @returns base64 image string
-     */
+    constructor(_exporter: GLTFExporter);
+    getTextureInfo(babylonTexture: Nullable<BaseTexture>): Nullable<ITextureInfo>;
+    exportStandardMaterialAsync(babylonStandardMaterial: StandardMaterial, mimeType: ImageMimeType, hasUVs: boolean): Promise<number>;
+    private _convertToGLTFPBRMetallicRoughness;
+    private _finishMaterialAsync;
     private _getImageDataAsync;
-    /**
-     * Generates a white texture based on the specified width and height
-     * @param width width of the texture in pixels
-     * @param height height of the texture in pixels
-     * @param scene babylonjs scene
-     * @returns white texture
-     */
-    private _createWhiteTexture;
     /**
      * Resizes the two source textures to the same dimensions.  If a texture is null, a default white texture is generated.  If both textures are null, returns null
      * @param texture1 first texture to resize
@@ -116,17 +36,10 @@ export declare class _GLTFMaterialExporter {
      * @returns resized textures or null
      */
     private _resizeTexturesToSameDimensions;
-    /**
-     * Converts an array of pixels to a Float32Array
-     * Throws an error if the pixel format is not supported
-     * @param pixels - array buffer containing pixel values
-     * @returns Float32 of pixels
-     */
-    private _convertPixelArrayToFloat32;
     /**
      * Convert Specular Glossiness Textures to Metallic Roughness
      * See link below for info on the material conversions from PBR Metallic/Roughness and Specular/Glossiness
-     * @link https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Archived/KHR_materials_pbrSpecularGlossiness/examples/convert-between-workflows-bjs/js/babylon.pbrUtilities.js
+     * @see https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Archived/KHR_materials_pbrSpecularGlossiness/examples/convert-between-workflows-bjs/js/babylon.pbrUtilities.js
      * @param diffuseTexture texture used to store diffuse information
      * @param specularGlossinessTexture texture used to store specular and glossiness information
      * @param factors specular glossiness material factors
@@ -157,7 +70,7 @@ export declare class _GLTFMaterialExporter {
      * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
      * @param mimeType mime type to use for the textures
      * @param glTFPbrMetallicRoughness glTF PBR Metallic Roughness interface
-     * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
+     * @param hasUVs specifies if texture coordinates are present on the submesh to determine if textures should be applied
      * @returns glTF PBR Metallic Roughness factors
      */
     private _convertMetalRoughFactorsToMetallicRoughnessAsync;
@@ -168,28 +81,15 @@ export declare class _GLTFMaterialExporter {
      * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
      * @param mimeType mime type to use for the textures
      * @param pbrMetallicRoughness glTF PBR Metallic Roughness interface
-     * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
+     * @param hasUVs specifies if texture coordinates are present on the submesh to determine if textures should be applied
      * @returns glTF PBR Metallic Roughness factors
      */
     private _convertSpecGlossFactorsToMetallicRoughnessAsync;
-    /**
-     * Converts a Babylon PBR Base Material to a glTF Material
-     * @param babylonPBRMaterial BJS PBR Base Material
-     * @param mimeType mime type to use for the textures
-     * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
-     * @returns async glTF Material representation
-     */
-    _convertPBRMaterialAsync(babylonPBRMaterial: PBRBaseMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
-    private _setMetallicRoughnessPbrMaterial;
+    exportPBRMaterialAsync(babylonPBRMaterial: PBRBaseMaterial, mimeType: ImageMimeType, hasUVs: boolean): Promise<number>;
+    private _setMetallicRoughnessPbrMaterialAsync;
     private _getPixelsFromTexture;
-    /**
-     * Extracts a texture from a Babylon texture into file data and glTF data
-     * @param babylonTexture Babylon texture to extract
-     * @param mimeType Mime Type of the babylonTexture
-     * @returns glTF texture info, or null if the texture format is not supported
-     */
-    _exportTextureAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
-    _exportTextureInfoAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
+    exportTextureAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
+    private _exportTextureInfoAsync;
     private _exportImage;
     private _exportTextureInfo;
     private _exportTextureSampler;