@babylonjs/serializers 9.26.2 → 9.27.0

package/glTF/2.0/glTFSerializer.d.ts

@@ -1,11 +1,84 @@
 import { type Node } from "@babylonjs/core/node.js";
 import { type Scene } from "@babylonjs/core/scene.js";
 import { type Animation } from "@babylonjs/core/Animations/animation.js";
+import { type AnimationGroup } from "@babylonjs/core/Animations/animationGroup.js";
+import { type Camera } from "@babylonjs/core/Cameras/camera.js";
+import { type Material } from "@babylonjs/core/Materials/material.js";
+import { type IKHRInteractivity } from "babylonjs-gltf2interface";
 import { type GLTFData } from "./glTFData.js";
+/**
+ * Indexed glTF root collections that KHR_interactivity references can target.
+ */
+export type KhrInteractivityRootCollection = "nodes" | "animations" | "cameras" | "materials" | "meshes" | "textures" | "images" | "samplers" | "skins" | "scenes";
 /**
  * Mesh compression methods.
  */
 export type MeshCompressionMethod = "None" | "Draco";
+/**
+ * Final entity remapping context exposed to a KHR_interactivity export provider.
+ */
+export interface IKHRInteractivityExportContext {
+    /**
+     * Gets the final number of glTF nodes.
+     * @returns final glTF node count
+     */
+    getNodeCount(): number;
+    /**
+     * Gets the final glTF node index for a Babylon node.
+     * @param node Babylon node to resolve
+     * @returns final glTF node index, or undefined when the node was not exported
+     */
+    getNodeIndex(node: Node): number | undefined;
+    /**
+     * Gets the final glTF animation index for a Babylon animation group.
+     * @param animation Babylon animation group to resolve
+     * @returns final glTF animation index, or undefined when the animation was not exported
+     */
+    getAnimationIndex(animation: AnimationGroup): number | undefined;
+    /**
+     * Gets the final glTF camera index for a Babylon camera.
+     * @param camera Babylon camera to resolve
+     * @returns final glTF camera index, or undefined when the camera was not exported
+     */
+    getCameraIndex(camera: Camera): number | undefined;
+    /**
+     * Gets the final glTF material index for a Babylon material.
+     * @param material Babylon material to resolve
+     * @returns final glTF material index, or undefined when the material was not exported
+     */
+    getMaterialIndex(material: Material): number | undefined;
+    /**
+     * Gets the final glTF index for an imported Babylon entity in a root collection.
+     * @param collection target glTF root collection
+     * @param entity imported Babylon entity associated with the source entry
+     * @returns final glTF index, or undefined when the entity was not exported uniquely
+     */
+    getRootIndex?(collection: KhrInteractivityRootCollection, entity: object): number | undefined;
+    /**
+     * Writes a companion extension on an already-exported glTF node.
+     * @param nodeIndex final glTF node index
+     * @param extensionName companion extension name
+     * @param value companion extension payload
+     */
+    setNodeExtension(nodeIndex: number, extensionName: string, value: unknown): void;
+}
+/**
+ * Supplies a detached canonical KHR_interactivity document to the glTF serializer.
+ */
+export interface IKHRInteractivityExportProvider {
+    /** Whether KHR_interactivity must be listed in extensionsRequired. */
+    readonly required: boolean;
+    /** Additional operation or companion extensions referenced by the graph. */
+    readonly additionalExtensionsUsed: readonly string[];
+    /** Additional extensions that must be listed in extensionsRequired. */
+    readonly additionalExtensionsRequired: readonly string[];
+    /**
+     * Builds the extension after final glTF entity indices are available.
+     * @param context final serializer remapping context
+     * @returns canonical KHR_interactivity extension payload
+     */
+    build(context: IKHRInteractivityExportContext): IKHRInteractivity;
+}
 /**
  * Holds a collection of exporter options and parameters
  */
@@ -42,7 +115,8 @@ export interface IExportOptions {
      */
     exportUnusedUVs?: boolean;
     /**
-     * Remove no-op root nodes when possible. Defaults to true.
+     * Remove no-op root nodes when possible. Defaults to true. No-op roots are preserved when
+     * {@link khrInteractivity} is provided because the graph may reference them.
      */
     removeNoopRootNodes?: boolean;
     /**
@@ -54,6 +128,11 @@ export interface IExportOptions {
      * Indicates what compression method to apply to mesh data.
      */
     meshCompressionMethod?: MeshCompressionMethod;
+    /**
+     * Canonical KHR_interactivity export provider. The provider is evaluated only after scene
+     * nodes and animations have their final glTF indices.
+     */
+    khrInteractivity?: IKHRInteractivityExportProvider;
 }
 /**
  * Class for generating glTF data from a Babylon scene.

package/glTF/2.0/glTFSerializer.js.map

@@ -1 +1 @@
-{"version":3,"file":"glTFSerializer.js","sourceRoot":"","sources":["../../../../../dev/serializers/src/glTF/2.0/glTFSerializer.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAiE9C;;GAEG;AACH,MAAM,OAAO,WAAW;IACpB;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAY,EAAE,QAAgB,EAAE,OAAwB;QAClF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;YACpD,MAAM,KAAK,CAAC,cAAc,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;QACjF,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAY,EAAE,QAAgB,EAAE,OAAwB;QACjF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;YACpD,MAAM,KAAK,CAAC,cAAc,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;QAChF,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEnB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ","sourcesContent":["import { type Node } from \"core/node\";\r\nimport { type Scene } from \"core/scene\";\r\nimport { type Animation } from \"core/Animations/animation\";\r\nimport { type GLTFData } from \"./glTFData\";\r\nimport { GLTFExporter } from \"./glTFExporter\";\r\n\r\n/**\r\n * Mesh compression methods.\r\n */\r\nexport type MeshCompressionMethod = \"None\" | \"Draco\";\r\n\r\n/**\r\n * Holds a collection of exporter options and parameters\r\n */\r\nexport interface IExportOptions {\r\n    /**\r\n     * Function which indicates whether a babylon node should be exported or not\r\n     * @param node source Babylon node. It is used to check whether it should be exported to glTF or not\r\n     * @returns boolean, which indicates whether the node should be exported (true) or not (false)\r\n     */\r\n    shouldExportNode?(node: Node): boolean;\r\n\r\n    /**\r\n     * Function which indicates whether an animation on the scene should be exported or not\r\n     * @param animation source animation\r\n     * @returns boolean, which indicates whether the animation should be exported (true) or not (false)\r\n     */\r\n    shouldExportAnimation?(animation: Animation): boolean;\r\n\r\n    /**\r\n     * Function to extract the part of the scene or node's `metadata` that will populate the corresponding\r\n     * glTF object's `extras` field. If not defined, `node.metadata.gltf.extras` will be used.\r\n     * @param metadata source metadata to read from\r\n     * @returns the data to store into the glTF extras field\r\n     */\r\n    metadataSelector?(metadata: any): any;\r\n\r\n    /**\r\n     * The sample rate to bake animation curves. Defaults to 1 / 60.\r\n     */\r\n    animationSampleRate?: number;\r\n\r\n    /**\r\n     * Begin serialization without waiting for the scene to be ready. Defaults to false.\r\n     */\r\n    exportWithoutWaitingForScene?: boolean;\r\n\r\n    /**\r\n     * Indicates if unused vertex uv attributes should be included in export. Defaults to false.\r\n     */\r\n    exportUnusedUVs?: boolean;\r\n\r\n    /**\r\n     * Remove no-op root nodes when possible. Defaults to true.\r\n     */\r\n    removeNoopRootNodes?: boolean;\r\n\r\n    /**\r\n     * Indicates if coordinate system swapping root nodes should be included in export. Defaults to false.\r\n     * @deprecated Please use removeNoopRootNodes instead\r\n     */\r\n    includeCoordinateSystemConversionNodes?: boolean;\r\n\r\n    /**\r\n     * Indicates what compression method to apply to mesh data.\r\n     */\r\n    meshCompressionMethod?: MeshCompressionMethod;\r\n}\r\n\r\n/**\r\n * Class for generating glTF data from a Babylon scene.\r\n */\r\nexport class GLTF2Export {\r\n    /**\r\n     * Exports the scene to .gltf file format\r\n     * @param scene Babylon scene\r\n     * @param fileName Name to use for the .gltf file\r\n     * @param options Exporter options\r\n     * @returns Returns the exported data\r\n     */\r\n    public static async GLTFAsync(scene: Scene, fileName: string, options?: IExportOptions): Promise<GLTFData> {\r\n        if (!options || !options.exportWithoutWaitingForScene) {\r\n            await scene.whenReadyAsync();\r\n        }\r\n\r\n        const exporter = new GLTFExporter(scene, options);\r\n        const data = await exporter.generateGLTFAsync(fileName.replace(/\\.[^/.]+$/, \"\"));\r\n        exporter.dispose();\r\n\r\n        return data;\r\n    }\r\n\r\n    /**\r\n     * Exports the scene to .glb file format\r\n     * @param scene Babylon scene\r\n     * @param fileName Name to use for the .glb file\r\n     * @param options Exporter options\r\n     * @returns Returns the exported data\r\n     */\r\n    public static async GLBAsync(scene: Scene, fileName: string, options?: IExportOptions): Promise<GLTFData> {\r\n        if (!options || !options.exportWithoutWaitingForScene) {\r\n            await scene.whenReadyAsync();\r\n        }\r\n\r\n        const exporter = new GLTFExporter(scene, options);\r\n        const data = await exporter.generateGLBAsync(fileName.replace(/\\.[^/.]+$/, \"\"));\r\n        exporter.dispose();\r\n\r\n        return data;\r\n    }\r\n}\r\n"]}
+{"version":3,"file":"glTFSerializer.js","sourceRoot":"","sources":["../../../../../dev/serializers/src/glTF/2.0/glTFSerializer.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAgJ9C;;GAEG;AACH,MAAM,OAAO,WAAW;IACpB;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAY,EAAE,QAAgB,EAAE,OAAwB;QAClF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;YACpD,MAAM,KAAK,CAAC,cAAc,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;QACjF,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAY,EAAE,QAAgB,EAAE,OAAwB;QACjF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;YACpD,MAAM,KAAK,CAAC,cAAc,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;QAChF,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEnB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ","sourcesContent":["import { type Node } from \"core/node\";\r\nimport { type Scene } from \"core/scene\";\r\nimport { type Animation } from \"core/Animations/animation\";\r\nimport { type AnimationGroup } from \"core/Animations/animationGroup\";\r\nimport { type Camera } from \"core/Cameras/camera\";\r\nimport { type Material } from \"core/Materials/material\";\r\nimport { type IKHRInteractivity } from \"babylonjs-gltf2interface\";\r\nimport { type GLTFData } from \"./glTFData\";\r\nimport { GLTFExporter } from \"./glTFExporter\";\r\n\r\n/**\r\n * Indexed glTF root collections that KHR_interactivity references can target.\r\n */\r\nexport type KhrInteractivityRootCollection = \"nodes\" | \"animations\" | \"cameras\" | \"materials\" | \"meshes\" | \"textures\" | \"images\" | \"samplers\" | \"skins\" | \"scenes\";\r\n\r\n/**\r\n * Mesh compression methods.\r\n */\r\nexport type MeshCompressionMethod = \"None\" | \"Draco\";\r\n\r\n/**\r\n * Final entity remapping context exposed to a KHR_interactivity export provider.\r\n */\r\nexport interface IKHRInteractivityExportContext {\r\n    /**\r\n     * Gets the final number of glTF nodes.\r\n     * @returns final glTF node count\r\n     */\r\n    getNodeCount(): number;\r\n    /**\r\n     * Gets the final glTF node index for a Babylon node.\r\n     * @param node Babylon node to resolve\r\n     * @returns final glTF node index, or undefined when the node was not exported\r\n     */\r\n    getNodeIndex(node: Node): number | undefined;\r\n    /**\r\n     * Gets the final glTF animation index for a Babylon animation group.\r\n     * @param animation Babylon animation group to resolve\r\n     * @returns final glTF animation index, or undefined when the animation was not exported\r\n     */\r\n    getAnimationIndex(animation: AnimationGroup): number | undefined;\r\n    /**\r\n     * Gets the final glTF camera index for a Babylon camera.\r\n     * @param camera Babylon camera to resolve\r\n     * @returns final glTF camera index, or undefined when the camera was not exported\r\n     */\r\n    getCameraIndex(camera: Camera): number | undefined;\r\n    /**\r\n     * Gets the final glTF material index for a Babylon material.\r\n     * @param material Babylon material to resolve\r\n     * @returns final glTF material index, or undefined when the material was not exported\r\n     */\r\n    getMaterialIndex(material: Material): number | undefined;\r\n    /**\r\n     * Gets the final glTF index for an imported Babylon entity in a root collection.\r\n     * @param collection target glTF root collection\r\n     * @param entity imported Babylon entity associated with the source entry\r\n     * @returns final glTF index, or undefined when the entity was not exported uniquely\r\n     */\r\n    getRootIndex?(collection: KhrInteractivityRootCollection, entity: object): number | undefined;\r\n    /**\r\n     * Writes a companion extension on an already-exported glTF node.\r\n     * @param nodeIndex final glTF node index\r\n     * @param extensionName companion extension name\r\n     * @param value companion extension payload\r\n     */\r\n    setNodeExtension(nodeIndex: number, extensionName: string, value: unknown): void;\r\n}\r\n\r\n/**\r\n * Supplies a detached canonical KHR_interactivity document to the glTF serializer.\r\n */\r\nexport interface IKHRInteractivityExportProvider {\r\n    /** Whether KHR_interactivity must be listed in extensionsRequired. */\r\n    readonly required: boolean;\r\n    /** Additional operation or companion extensions referenced by the graph. */\r\n    readonly additionalExtensionsUsed: readonly string[];\r\n    /** Additional extensions that must be listed in extensionsRequired. */\r\n    readonly additionalExtensionsRequired: readonly string[];\r\n    /**\r\n     * Builds the extension after final glTF entity indices are available.\r\n     * @param context final serializer remapping context\r\n     * @returns canonical KHR_interactivity extension payload\r\n     */\r\n    build(context: IKHRInteractivityExportContext): IKHRInteractivity;\r\n}\r\n\r\n/**\r\n * Holds a collection of exporter options and parameters\r\n */\r\nexport interface IExportOptions {\r\n    /**\r\n     * Function which indicates whether a babylon node should be exported or not\r\n     * @param node source Babylon node. It is used to check whether it should be exported to glTF or not\r\n     * @returns boolean, which indicates whether the node should be exported (true) or not (false)\r\n     */\r\n    shouldExportNode?(node: Node): boolean;\r\n\r\n    /**\r\n     * Function which indicates whether an animation on the scene should be exported or not\r\n     * @param animation source animation\r\n     * @returns boolean, which indicates whether the animation should be exported (true) or not (false)\r\n     */\r\n    shouldExportAnimation?(animation: Animation): boolean;\r\n\r\n    /**\r\n     * Function to extract the part of the scene or node's `metadata` that will populate the corresponding\r\n     * glTF object's `extras` field. If not defined, `node.metadata.gltf.extras` will be used.\r\n     * @param metadata source metadata to read from\r\n     * @returns the data to store into the glTF extras field\r\n     */\r\n    metadataSelector?(metadata: any): any;\r\n\r\n    /**\r\n     * The sample rate to bake animation curves. Defaults to 1 / 60.\r\n     */\r\n    animationSampleRate?: number;\r\n\r\n    /**\r\n     * Begin serialization without waiting for the scene to be ready. Defaults to false.\r\n     */\r\n    exportWithoutWaitingForScene?: boolean;\r\n\r\n    /**\r\n     * Indicates if unused vertex uv attributes should be included in export. Defaults to false.\r\n     */\r\n    exportUnusedUVs?: boolean;\r\n\r\n    /**\r\n     * Remove no-op root nodes when possible. Defaults to true. No-op roots are preserved when\r\n     * {@link khrInteractivity} is provided because the graph may reference them.\r\n     */\r\n    removeNoopRootNodes?: boolean;\r\n\r\n    /**\r\n     * Indicates if coordinate system swapping root nodes should be included in export. Defaults to false.\r\n     * @deprecated Please use removeNoopRootNodes instead\r\n     */\r\n    includeCoordinateSystemConversionNodes?: boolean;\r\n\r\n    /**\r\n     * Indicates what compression method to apply to mesh data.\r\n     */\r\n    meshCompressionMethod?: MeshCompressionMethod;\r\n\r\n    /**\r\n     * Canonical KHR_interactivity export provider. The provider is evaluated only after scene\r\n     * nodes and animations have their final glTF indices.\r\n     */\r\n    khrInteractivity?: IKHRInteractivityExportProvider;\r\n}\r\n\r\n/**\r\n * Class for generating glTF data from a Babylon scene.\r\n */\r\nexport class GLTF2Export {\r\n    /**\r\n     * Exports the scene to .gltf file format\r\n     * @param scene Babylon scene\r\n     * @param fileName Name to use for the .gltf file\r\n     * @param options Exporter options\r\n     * @returns Returns the exported data\r\n     */\r\n    public static async GLTFAsync(scene: Scene, fileName: string, options?: IExportOptions): Promise<GLTFData> {\r\n        if (!options || !options.exportWithoutWaitingForScene) {\r\n            await scene.whenReadyAsync();\r\n        }\r\n\r\n        const exporter = new GLTFExporter(scene, options);\r\n        const data = await exporter.generateGLTFAsync(fileName.replace(/\\.[^/.]+$/, \"\"));\r\n        exporter.dispose();\r\n\r\n        return data;\r\n    }\r\n\r\n    /**\r\n     * Exports the scene to .glb file format\r\n     * @param scene Babylon scene\r\n     * @param fileName Name to use for the .glb file\r\n     * @param options Exporter options\r\n     * @returns Returns the exported data\r\n     */\r\n    public static async GLBAsync(scene: Scene, fileName: string, options?: IExportOptions): Promise<GLTFData> {\r\n        if (!options || !options.exportWithoutWaitingForScene) {\r\n            await scene.whenReadyAsync();\r\n        }\r\n\r\n        const exporter = new GLTFExporter(scene, options);\r\n        const data = await exporter.generateGLBAsync(fileName.replace(/\\.[^/.]+$/, \"\"));\r\n        exporter.dispose();\r\n\r\n        return data;\r\n    }\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@babylonjs/serializers",
-    "version": "9.26.2",
+    "version": "9.27.0",
     "main": "index.js",
     "module": "index.js",
     "types": "index.d.ts",
@@ -18,10 +18,10 @@
         "postcompile": "build-tools -c add-js-to-es6"
     },
     "devDependencies": {
-        "@babylonjs/core": "9.26.2",
+        "@babylonjs/core": "9.27.0",
         "@dev/build-tools": "^1.0.0",
         "@dev/serializers": "^1.0.0",
-        "babylonjs-gltf2interface": "9.26.2"
+        "babylonjs-gltf2interface": "9.27.0"
     },
     "peerDependencies": {
         "@babylonjs/core": "^9.0.0",
@@ -46,6 +46,7 @@
         "glTF/2.0/Extensions/EXT_texture_avif.js",
         "glTF/2.0/Extensions/EXT_texture_webp.js",
         "glTF/2.0/Extensions/KHR_draco_mesh_compression.js",
+        "glTF/2.0/Extensions/KHR_interactivity.js",
         "glTF/2.0/Extensions/KHR_lights_punctual.js",
         "glTF/2.0/Extensions/KHR_materials_anisotropy.js",
         "glTF/2.0/Extensions/KHR_materials_diffuse_roughness.js",