babylonjs-serializers 5.7.0 → 5.8.2

package/babylonjs.serializers.d.ts

@@ -1,5 +1,28 @@
 
 declare module BABYLON {
+    /**
+     * [Specification](https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Vendor/EXT_mesh_gpu_instancing/README.md)
+     */
+    export class EXT_mesh_gpu_instancing implements IGLTFExporterExtensionV2 {
+        /** Name of this extension */
+        readonly name = "EXT_mesh_gpu_instancing";
+        /** Defines whether this extension is enabled */
+        enabled: boolean;
+        /** Defines whether this extension is required */
+        required: boolean;
+        private _exporter;
+        private _wasUsed;
+        constructor(exporter: _Exporter);
+        dispose(): void;
+        /** @hidden */
+        get wasUsed(): boolean;
+        postExportNodeAsync?(context: string, node: Nullable<BABYLON.GLTF2.INode>, babylonNode: Node, nodeMap?: {
+            [key: number]: number;
+        }, binaryWriter?: _BinaryWriter): Promise<Nullable<BABYLON.GLTF2.INode>>;
+        private _buildAccessor;
+    }
+
+
 
 
     /**
@@ -578,7 +601,7 @@ declare module BABYLON {
         _extensionsPostExportMeshPrimitiveAsync(context: string, meshPrimitive: BABYLON.GLTF2.IMeshPrimitive, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<Nullable<BABYLON.GLTF2.IMeshPrimitive>>;
         _extensionsPostExportNodeAsync(context: string, node: Nullable<BABYLON.GLTF2.INode>, babylonNode: Node, nodeMap?: {
             [key: number]: number;
-        }): Promise<Nullable<BABYLON.GLTF2.INode>>;
+        }, binaryWriter?: _BinaryWriter): Promise<Nullable<BABYLON.GLTF2.INode>>;
         _extensionsPostExportMaterialAsync(context: string, material: Nullable<BABYLON.GLTF2.IMaterial>, babylonMaterial: Material): Promise<Nullable<BABYLON.GLTF2.IMaterial>>;
         _extensionsPostExportMaterialAdditionalTextures(context: string, material: BABYLON.GLTF2.IMaterial, babylonMaterial: Material): BaseTexture[];
         _extensionsPostExportTextures(context: string, textureInfo: BABYLON.GLTF2.ITextureInfo, babylonTexture: BaseTexture): void;
@@ -595,6 +618,7 @@ declare module BABYLON {
          */
         constructor(babylonScene?: Nullable<Scene>, options?: IExportOptions);
         dispose(): void;
+        get options(): IExportOptions;
         /**
          * Registers a glTF exporter extension
          * @param name Name of the extension to export
@@ -899,6 +923,18 @@ declare module BABYLON {
          * @param byteOffset If defined, specifies where to set the value as an offset.
          */
         setUInt32(entry: number, byteOffset?: number): void;
+        /**
+         * Stores an Int16 in the array buffer
+         * @param entry
+         * @param byteOffset If defined, specifies where to set the value as an offset.
+         */
+        setInt16(entry: number, byteOffset?: number): void;
+        /**
+         * Stores a byte in the array buffer
+         * @param entry
+         * @param byteOffset If defined, specifies where to set the value as an offset.
+         */
+        setByte(entry: number, byteOffset?: number): void;
     }
 
 
@@ -942,7 +978,7 @@ declare module BABYLON {
          */
         postExportNodeAsync?(context: string, node: Nullable<BABYLON.GLTF2.INode>, babylonNode: Node, nodeMap?: {
             [key: number]: number;
-        }): Promise<Nullable<BABYLON.GLTF2.INode>>;
+        }, binaryWriter?: _BinaryWriter): Promise<Nullable<BABYLON.GLTF2.INode>>;
         /**
          * Define this method to modify the default behavior when exporting a material
          * @param material glTF material

package/babylonjs.serializers.js

@@ -492,6 +492,156 @@ var OBJExport = /** @class */ (function () {
 
 
 
+/***/ }),
+
+/***/ "../../../lts/serializers/dist/glTF/2.0/Extensions/EXT_mesh_gpu_instancing.js":
+/*!************************************************************************************!*\
+  !*** ../../../lts/serializers/dist/glTF/2.0/Extensions/EXT_mesh_gpu_instancing.js ***!
+  \************************************************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "EXT_mesh_gpu_instancing": () => (/* binding */ EXT_mesh_gpu_instancing)
+/* harmony export */ });
+/* harmony import */ var _glTFExporter__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../glTFExporter */ "../../../lts/serializers/dist/glTF/2.0/glTFExporter.js");
+/* harmony import */ var core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! core/Buffers/buffer */ "core/Maths/math.vector");
+/* harmony import */ var core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__);
+
+
+
+
+
+var NAME = "EXT_mesh_gpu_instancing";
+/**
+ * [Specification](https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Vendor/EXT_mesh_gpu_instancing/README.md)
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+var EXT_mesh_gpu_instancing = /** @class */ (function () {
+    function EXT_mesh_gpu_instancing(exporter) {
+        /** Name of this extension */
+        this.name = NAME;
+        /** Defines whether this extension is enabled */
+        this.enabled = true;
+        /** Defines whether this extension is required */
+        this.required = false;
+        this._wasUsed = false;
+        this._exporter = exporter;
+    }
+    EXT_mesh_gpu_instancing.prototype.dispose = function () { };
+    Object.defineProperty(EXT_mesh_gpu_instancing.prototype, "wasUsed", {
+        /** @hidden */
+        get: function () {
+            return this._wasUsed;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    EXT_mesh_gpu_instancing.prototype.postExportNodeAsync = function (context, node, babylonNode, nodeMap, binaryWriter) {
+        var _this = this;
+        return new Promise(function (resolve) {
+            if (node && babylonNode instanceof core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.Mesh) {
+                if (babylonNode.hasThinInstances && binaryWriter) {
+                    _this._wasUsed = true;
+                    var noTranslation = core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.Vector3.Zero();
+                    var noRotation = core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.Quaternion.Identity();
+                    var noScale = core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.Vector3.One();
+                    // retreive all the instance world matrix
+                    var matrix = babylonNode.thinInstanceGetWorldMatrices();
+                    var iwt = core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.TmpVectors.Vector3[2];
+                    var iwr = core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.TmpVectors.Quaternion[1];
+                    var iws = core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.TmpVectors.Vector3[3];
+                    var hasAnyInstanceWorldTranslation = false;
+                    var hasAnyInstanceWorldRotation = false;
+                    var hasAnyInstanceWorldScale = false;
+                    // prepare temp buffers
+                    var translationBuffer = new Float32Array(babylonNode.thinInstanceCount * 3);
+                    var rotationBuffer = new Float32Array(babylonNode.thinInstanceCount * 4);
+                    var scaleBuffer = new Float32Array(babylonNode.thinInstanceCount * 3);
+                    var i = 0;
+                    for (var _i = 0, matrix_1 = matrix; _i < matrix_1.length; _i++) {
+                        var m = matrix_1[_i];
+                        m.decompose(iws, iwr, iwt);
+                        // fill the temp buffer
+                        translationBuffer.set(iwt.asArray(), i * 3);
+                        rotationBuffer.set(iwr.normalize().asArray(), i * 4); // ensure the quaternion is normalized
+                        scaleBuffer.set(iws.asArray(), i * 3);
+                        // this is where we decide if there is any transformation
+                        hasAnyInstanceWorldTranslation = hasAnyInstanceWorldTranslation || !iwt.equalsWithEpsilon(noTranslation);
+                        hasAnyInstanceWorldRotation = hasAnyInstanceWorldRotation || !iwr.equalsWithEpsilon(noRotation);
+                        hasAnyInstanceWorldScale = hasAnyInstanceWorldScale || !iws.equalsWithEpsilon(noScale);
+                        i++;
+                    }
+                    var extension = {
+                        attributes: {},
+                    };
+                    // do we need to write TRANSLATION ?
+                    if (hasAnyInstanceWorldTranslation) {
+                        extension.attributes["TRANSLATION"] = _this._buildAccessor(translationBuffer, "VEC3" /* VEC3 */, babylonNode.thinInstanceCount, binaryWriter, 5126 /* FLOAT */);
+                    }
+                    // do we need to write ROTATION ?
+                    if (hasAnyInstanceWorldRotation) {
+                        var componentType = 5126 /* FLOAT */; // we decided to stay on FLOAT for now see https://github.com/BabylonJS/Babylon.js/pull/12495
+                        extension.attributes["ROTATION"] = _this._buildAccessor(rotationBuffer, "VEC4" /* VEC4 */, babylonNode.thinInstanceCount, binaryWriter, componentType);
+                    }
+                    // do we need to write SCALE ?
+                    if (hasAnyInstanceWorldScale) {
+                        extension.attributes["SCALE"] = _this._buildAccessor(scaleBuffer, "VEC3" /* VEC3 */, babylonNode.thinInstanceCount, binaryWriter, 5126 /* FLOAT */);
+                    }
+                    /* eslint-enable @typescript-eslint/naming-convention*/
+                    node.extensions = node.extensions || {};
+                    node.extensions[NAME] = extension;
+                }
+            }
+            resolve(node);
+        });
+    };
+    EXT_mesh_gpu_instancing.prototype._buildAccessor = function (buffer, type, count, binaryWriter, componentType) {
+        // write the buffer
+        var bufferOffset = binaryWriter.getByteOffset();
+        switch (componentType) {
+            case 5126 /* FLOAT */: {
+                for (var i = 0; i != buffer.length; i++) {
+                    binaryWriter.setFloat32(buffer[i]);
+                }
+                break;
+            }
+            case 5120 /* BYTE */: {
+                for (var i = 0; i != buffer.length; i++) {
+                    binaryWriter.setByte(buffer[i] * 127);
+                }
+                break;
+            }
+            case 5122 /* SHORT */: {
+                for (var i = 0; i != buffer.length; i++) {
+                    binaryWriter.setInt16(buffer[i] * 32767);
+                }
+                break;
+            }
+        }
+        // build the buffer view
+        var bv = { buffer: 0, byteOffset: bufferOffset, byteLength: buffer.length * core_Meshes_mesh__WEBPACK_IMPORTED_MODULE_1__.VertexBuffer.GetTypeByteLength(componentType) };
+        var bufferViewIndex = this._exporter._bufferViews.length;
+        this._exporter._bufferViews.push(bv);
+        // finally build the accessor
+        var accessorIndex = this._exporter._accessors.length;
+        var accessor = {
+            bufferView: bufferViewIndex,
+            componentType: componentType,
+            count: count,
+            type: type,
+            normalized: componentType == 5120 /* BYTE */ || componentType == 5122 /* SHORT */,
+        };
+        this._exporter._accessors.push(accessor);
+        return accessorIndex;
+    };
+    return EXT_mesh_gpu_instancing;
+}());
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+_glTFExporter__WEBPACK_IMPORTED_MODULE_0__._Exporter.RegisterExtension(NAME, function (exporter) { return new EXT_mesh_gpu_instancing(exporter); });
+
+
 /***/ }),
 
 /***/ "../../../lts/serializers/dist/glTF/2.0/Extensions/KHR_lights_punctual.js":
@@ -1589,6 +1739,7 @@ _glTFExporter__WEBPACK_IMPORTED_MODULE_1__._Exporter.RegisterExtension(NAME, fun
 
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "EXT_mesh_gpu_instancing": () => (/* reexport safe */ _EXT_mesh_gpu_instancing__WEBPACK_IMPORTED_MODULE_10__.EXT_mesh_gpu_instancing),
 /* harmony export */   "KHR_lights_punctual": () => (/* reexport safe */ _KHR_lights_punctual__WEBPACK_IMPORTED_MODULE_1__.KHR_lights_punctual),
 /* harmony export */   "KHR_materials_clearcoat": () => (/* reexport safe */ _KHR_materials_clearcoat__WEBPACK_IMPORTED_MODULE_2__.KHR_materials_clearcoat),
 /* harmony export */   "KHR_materials_ior": () => (/* reexport safe */ _KHR_materials_ior__WEBPACK_IMPORTED_MODULE_6__.KHR_materials_ior),
@@ -1610,6 +1761,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _KHR_materials_specular__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(/*! ./KHR_materials_specular */ "../../../lts/serializers/dist/glTF/2.0/Extensions/KHR_materials_specular.js");
 /* harmony import */ var _KHR_materials_volume__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(/*! ./KHR_materials_volume */ "../../../lts/serializers/dist/glTF/2.0/Extensions/KHR_materials_volume.js");
 /* harmony import */ var _KHR_materials_transmission__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(/*! ./KHR_materials_transmission */ "../../../lts/serializers/dist/glTF/2.0/Extensions/KHR_materials_transmission.js");
+/* harmony import */ var _EXT_mesh_gpu_instancing__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(/*! ./EXT_mesh_gpu_instancing */ "../../../lts/serializers/dist/glTF/2.0/Extensions/EXT_mesh_gpu_instancing.js");
+
 
 
 
@@ -2666,8 +2819,8 @@ var _Exporter = /** @class */ (function () {
     _Exporter.prototype._extensionsPostExportMeshPrimitiveAsync = function (context, meshPrimitive, babylonSubMesh, binaryWriter) {
         return this._applyExtensions(meshPrimitive, function (extension, node) { return extension.postExportMeshPrimitiveAsync && extension.postExportMeshPrimitiveAsync(context, node, babylonSubMesh, binaryWriter); });
     };
-    _Exporter.prototype._extensionsPostExportNodeAsync = function (context, node, babylonNode, nodeMap) {
-        return this._applyExtensions(node, function (extension, node) { return extension.postExportNodeAsync && extension.postExportNodeAsync(context, node, babylonNode, nodeMap); });
+    _Exporter.prototype._extensionsPostExportNodeAsync = function (context, node, babylonNode, nodeMap, binaryWriter) {
+        return this._applyExtensions(node, function (extension, node) { return extension.postExportNodeAsync && extension.postExportNodeAsync(context, node, babylonNode, nodeMap, binaryWriter); });
     };
     _Exporter.prototype._extensionsPostExportMaterialAsync = function (context, material, babylonMaterial) {
         return this._applyExtensions(material, function (extension, node) { return extension.postExportMaterialAsync && extension.postExportMaterialAsync(context, node, babylonMaterial); });
@@ -2744,6 +2897,13 @@ var _Exporter = /** @class */ (function () {
             extension.dispose();
         }
     };
+    Object.defineProperty(_Exporter.prototype, "options", {
+        get: function () {
+            return this._options;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Registers a glTF exporter extension
      * @param name Name of the extension to export
@@ -4203,7 +4363,7 @@ var _Exporter = /** @class */ (function () {
             promiseChain = promiseChain.then(function () {
                 var convertToRightHandedSystem = _this._convertToRightHandedSystemMap[babylonNode.uniqueId];
                 return _this._createNodeAsync(babylonNode, binaryWriter, convertToRightHandedSystem).then(function (node) {
-                    var promise = _this._extensionsPostExportNodeAsync("createNodeAsync", node, babylonNode, nodeMap);
+                    var promise = _this._extensionsPostExportNodeAsync("createNodeAsync", node, babylonNode, nodeMap, binaryWriter);
                     if (promise == null) {
                         core_Maths_math_vector__WEBPACK_IMPORTED_MODULE_1__.Tools.Warn("Not exporting node ".concat(babylonNode.name));
                         return Promise.resolve();
@@ -4552,6 +4712,50 @@ var _BinaryWriter = /** @class */ (function () {
             this._byteOffset += 4;
         }
     };
+    /**
+     * Stores an Int16 in the array buffer
+     * @param entry
+     * @param byteOffset If defined, specifies where to set the value as an offset.
+     */
+    _BinaryWriter.prototype.setInt16 = function (entry, byteOffset) {
+        if (byteOffset != null) {
+            if (byteOffset < this._byteOffset) {
+                this._dataView.setInt16(byteOffset, entry, true);
+            }
+            else {
+                core_Maths_math_vector__WEBPACK_IMPORTED_MODULE_1__.Tools.Error("BinaryWriter: byteoffset is greater than the current binary buffer length!");
+            }
+        }
+        else {
+            if (this._byteOffset + 2 > this._arrayBuffer.byteLength) {
+                this._resizeBuffer(this._arrayBuffer.byteLength * 2);
+            }
+            this._dataView.setInt16(this._byteOffset, entry, true);
+            this._byteOffset += 2;
+        }
+    };
+    /**
+     * Stores a byte in the array buffer
+     * @param entry
+     * @param byteOffset If defined, specifies where to set the value as an offset.
+     */
+    _BinaryWriter.prototype.setByte = function (entry, byteOffset) {
+        if (byteOffset != null) {
+            if (byteOffset < this._byteOffset) {
+                this._dataView.setInt8(byteOffset, entry);
+            }
+            else {
+                core_Maths_math_vector__WEBPACK_IMPORTED_MODULE_1__.Tools.Error("BinaryWriter: byteoffset is greater than the current binary buffer length!");
+            }
+        }
+        else {
+            if (this._byteOffset + 1 > this._arrayBuffer.byteLength) {
+                this._resizeBuffer(this._arrayBuffer.byteLength * 2);
+            }
+            this._dataView.setInt8(this._byteOffset, entry);
+            this._byteOffset++;
+        }
+    };
     return _BinaryWriter;
 }());
 
@@ -5928,6 +6132,7 @@ var _GLTFUtilities = /** @class */ (function () {
 
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "EXT_mesh_gpu_instancing": () => (/* reexport safe */ _Extensions_index__WEBPACK_IMPORTED_MODULE_7__.EXT_mesh_gpu_instancing),
 /* harmony export */   "GLTF2Export": () => (/* reexport safe */ _glTFSerializer__WEBPACK_IMPORTED_MODULE_5__.GLTF2Export),
 /* harmony export */   "GLTFData": () => (/* reexport safe */ _glTFData__WEBPACK_IMPORTED_MODULE_1__.GLTFData),
 /* harmony export */   "KHR_lights_punctual": () => (/* reexport safe */ _Extensions_index__WEBPACK_IMPORTED_MODULE_7__.KHR_lights_punctual),
@@ -6017,6 +6222,7 @@ var __IGLTFExporterExtension = 0; // I am here to allow dts to be created
 
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "EXT_mesh_gpu_instancing": () => (/* reexport safe */ _2_0_index__WEBPACK_IMPORTED_MODULE_1__.EXT_mesh_gpu_instancing),
 /* harmony export */   "GLTF2Export": () => (/* reexport safe */ _2_0_index__WEBPACK_IMPORTED_MODULE_1__.GLTF2Export),
 /* harmony export */   "GLTFData": () => (/* reexport safe */ _2_0_index__WEBPACK_IMPORTED_MODULE_1__.GLTFData),
 /* harmony export */   "KHR_lights_punctual": () => (/* reexport safe */ _2_0_index__WEBPACK_IMPORTED_MODULE_1__.KHR_lights_punctual),
@@ -6054,6 +6260,7 @@ __webpack_require__.r(__webpack_exports__);
 
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "EXT_mesh_gpu_instancing": () => (/* reexport safe */ _glTF_index__WEBPACK_IMPORTED_MODULE_1__.EXT_mesh_gpu_instancing),
 /* harmony export */   "GLTF2Export": () => (/* reexport safe */ _glTF_index__WEBPACK_IMPORTED_MODULE_1__.GLTF2Export),
 /* harmony export */   "GLTFData": () => (/* reexport safe */ _glTF_index__WEBPACK_IMPORTED_MODULE_1__.GLTFData),
 /* harmony export */   "KHR_lights_punctual": () => (/* reexport safe */ _glTF_index__WEBPACK_IMPORTED_MODULE_1__.KHR_lights_punctual),
@@ -6095,6 +6302,7 @@ __webpack_require__.r(__webpack_exports__);
 
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "EXT_mesh_gpu_instancing": () => (/* reexport safe */ _glTF_2_0_index__WEBPACK_IMPORTED_MODULE_4__.EXT_mesh_gpu_instancing),
 /* harmony export */   "GLTF2Export": () => (/* reexport safe */ _glTF_2_0_index__WEBPACK_IMPORTED_MODULE_4__.GLTF2Export),
 /* harmony export */   "GLTFData": () => (/* reexport safe */ _glTF_2_0_index__WEBPACK_IMPORTED_MODULE_4__.GLTFData),
 /* harmony export */   "KHR_lights_punctual": () => (/* reexport safe */ _glTF_2_0_index__WEBPACK_IMPORTED_MODULE_4__.KHR_lights_punctual),
@@ -6232,6 +6440,7 @@ if (typeof globalObject !== "undefined") {
 
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "EXT_mesh_gpu_instancing": () => (/* reexport safe */ _legacy_glTF2Serializer__WEBPACK_IMPORTED_MODULE_1__.EXT_mesh_gpu_instancing),
 /* harmony export */   "GLTF2Export": () => (/* reexport safe */ _legacy_glTF2Serializer__WEBPACK_IMPORTED_MODULE_1__.GLTF2Export),
 /* harmony export */   "GLTFData": () => (/* reexport safe */ _legacy_glTF2Serializer__WEBPACK_IMPORTED_MODULE_1__.GLTFData),
 /* harmony export */   "KHR_lights_punctual": () => (/* reexport safe */ _legacy_glTF2Serializer__WEBPACK_IMPORTED_MODULE_1__.KHR_lights_punctual),