@loaders.gl/gltf 4.2.0-alpha.3 → 4.2.0-alpha.5

package/dist/lib/extensions/KHR_texture_transform.js

@@ -1,183 +1,223 @@
+/**
+ * https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Khronos/KHR_texture_transform/README.md
+ */
 import { Vector3, Matrix3 } from '@math.gl/core';
 import { getAccessorArrayTypeAndLength } from "../gltf-utils/gltf-utils.js";
 import { BYTES, COMPONENTS } from "../gltf-utils/gltf-constants.js";
-import "../types/gltf-json-schema.js";
 import { GLTFScenegraph } from "../api/gltf-scenegraph.js";
+/** Extension name */
 const EXT_MESHOPT_TRANSFORM = 'KHR_texture_transform';
 export const name = EXT_MESHOPT_TRANSFORM;
 const scratchVector = new Vector3();
 const scratchRotationMatrix = new Matrix3();
 const scratchScaleMatrix = new Matrix3();
+/**
+ * The extension entry to process the transformation
+ * @param gltfData gltf buffers and json
+ * @param options GLTFLoader options
+ */
 export async function decode(gltfData, options) {
-  var _options$gltf;
-  const gltfScenegraph = new GLTFScenegraph(gltfData);
-  const hasExtension = gltfScenegraph.hasExtension(EXT_MESHOPT_TRANSFORM);
-  if (!hasExtension || !((_options$gltf = options.gltf) !== null && _options$gltf !== void 0 && _options$gltf.loadBuffers)) {
-    return;
-  }
-  const materials = gltfData.json.materials || [];
-  for (let i = 0; i < materials.length; i++) {
-    transformTexCoords(i, gltfData);
-  }
+    const gltfScenegraph = new GLTFScenegraph(gltfData);
+    const hasExtension = gltfScenegraph.hasExtension(EXT_MESHOPT_TRANSFORM);
+    if (!hasExtension || !options.gltf?.loadBuffers) {
+        return;
+    }
+    const materials = gltfData.json.materials || [];
+    for (let i = 0; i < materials.length; i++) {
+        transformTexCoords(i, gltfData);
+    }
 }
+/**
+ * Transform TEXCOORD by material
+ * @param materialIndex processing material index
+ * @param gltfData gltf buffers and json
+ */
 function transformTexCoords(materialIndex, gltfData) {
-  var _gltfData$json$materi, _material$pbrMetallic, _material$pbrMetallic2;
-  const processedTexCoords = [];
-  const material = (_gltfData$json$materi = gltfData.json.materials) === null || _gltfData$json$materi === void 0 ? void 0 : _gltfData$json$materi[materialIndex];
-  const baseColorTexture = material === null || material === void 0 ? void 0 : (_material$pbrMetallic = material.pbrMetallicRoughness) === null || _material$pbrMetallic === void 0 ? void 0 : _material$pbrMetallic.baseColorTexture;
-  if (baseColorTexture) {
-    transformPrimitives(gltfData, materialIndex, baseColorTexture, processedTexCoords);
-  }
-  const emisiveTexture = material === null || material === void 0 ? void 0 : material.emissiveTexture;
-  if (emisiveTexture) {
-    transformPrimitives(gltfData, materialIndex, emisiveTexture, processedTexCoords);
-  }
-  const normalTexture = material === null || material === void 0 ? void 0 : material.normalTexture;
-  if (normalTexture) {
-    transformPrimitives(gltfData, materialIndex, normalTexture, processedTexCoords);
-  }
-  const occlusionTexture = material === null || material === void 0 ? void 0 : material.occlusionTexture;
-  if (occlusionTexture) {
-    transformPrimitives(gltfData, materialIndex, occlusionTexture, processedTexCoords);
-  }
-  const metallicRoughnessTexture = material === null || material === void 0 ? void 0 : (_material$pbrMetallic2 = material.pbrMetallicRoughness) === null || _material$pbrMetallic2 === void 0 ? void 0 : _material$pbrMetallic2.metallicRoughnessTexture;
-  if (metallicRoughnessTexture) {
-    transformPrimitives(gltfData, materialIndex, metallicRoughnessTexture, processedTexCoords);
-  }
+    // Save processed texCoords in order no to process the same twice
+    const processedTexCoords = [];
+    const material = gltfData.json.materials?.[materialIndex];
+    const baseColorTexture = material?.pbrMetallicRoughness?.baseColorTexture;
+    if (baseColorTexture) {
+        transformPrimitives(gltfData, materialIndex, baseColorTexture, processedTexCoords);
+    }
+    const emisiveTexture = material?.emissiveTexture;
+    if (emisiveTexture) {
+        transformPrimitives(gltfData, materialIndex, emisiveTexture, processedTexCoords);
+    }
+    const normalTexture = material?.normalTexture;
+    if (normalTexture) {
+        transformPrimitives(gltfData, materialIndex, normalTexture, processedTexCoords);
+    }
+    const occlusionTexture = material?.occlusionTexture;
+    if (occlusionTexture) {
+        transformPrimitives(gltfData, materialIndex, occlusionTexture, processedTexCoords);
+    }
+    const metallicRoughnessTexture = material?.pbrMetallicRoughness?.metallicRoughnessTexture;
+    if (metallicRoughnessTexture) {
+        transformPrimitives(gltfData, materialIndex, metallicRoughnessTexture, processedTexCoords);
+    }
 }
+/**
+ * Transform primitives of the particular material
+ * @param gltfData gltf data
+ * @param materialIndex primitives with this material will be transformed
+ * @param texture texture object
+ * @param processedTexCoords storage to save already processed texCoords
+ */
 function transformPrimitives(gltfData, materialIndex, texture, processedTexCoords) {
-  const transformParameters = getTransformParameters(texture, processedTexCoords);
-  if (!transformParameters) {
-    return;
-  }
-  const meshes = gltfData.json.meshes || [];
-  for (const mesh of meshes) {
-    for (const primitive of mesh.primitives) {
-      const material = primitive.material;
-      if (Number.isFinite(material) && materialIndex === material) {
-        transformPrimitive(gltfData, primitive, transformParameters);
-      }
+    const transformParameters = getTransformParameters(texture, processedTexCoords);
+    if (!transformParameters) {
+        return;
+    }
+    const meshes = gltfData.json.meshes || [];
+    for (const mesh of meshes) {
+        for (const primitive of mesh.primitives) {
+            const material = primitive.material;
+            if (Number.isFinite(material) && materialIndex === material) {
+                transformPrimitive(gltfData, primitive, transformParameters);
+            }
+        }
     }
-  }
 }
+/**
+ * Get parameters for TEXCOORD transformation
+ * @param texture texture object
+ * @param processedTexCoords storage to save already processed texCoords
+ * @returns texCoord couple and transformation matrix
+ */
 function getTransformParameters(texture, processedTexCoords) {
-  var _texture$extensions;
-  const textureInfo = (_texture$extensions = texture.extensions) === null || _texture$extensions === void 0 ? void 0 : _texture$extensions[EXT_MESHOPT_TRANSFORM];
-  const {
-    texCoord: originalTexCoord = 0
-  } = texture;
-  const {
-    texCoord = originalTexCoord
-  } = textureInfo;
-  const isProcessed = processedTexCoords.findIndex(_ref => {
-    let [original, newTexCoord] = _ref;
-    return original === originalTexCoord && newTexCoord === texCoord;
-  }) !== -1;
-  if (!isProcessed) {
-    const matrix = makeTransformationMatrix(textureInfo);
-    if (originalTexCoord !== texCoord) {
-      texture.texCoord = texCoord;
+    const textureInfo = texture.extensions?.[EXT_MESHOPT_TRANSFORM];
+    const { texCoord: originalTexCoord = 0 } = texture;
+    // If texCoord is not set in the extension, original attribute data will be replaced
+    const { texCoord = originalTexCoord } = textureInfo;
+    // Make sure that couple [originalTexCoord, extensionTexCoord] is not processed twice
+    const isProcessed = processedTexCoords.findIndex(([original, newTexCoord]) => original === originalTexCoord && newTexCoord === texCoord) !== -1;
+    if (!isProcessed) {
+        const matrix = makeTransformationMatrix(textureInfo);
+        if (originalTexCoord !== texCoord) {
+            texture.texCoord = texCoord;
+        }
+        processedTexCoords.push([originalTexCoord, texCoord]);
+        return { originalTexCoord, texCoord, matrix };
     }
-    processedTexCoords.push([originalTexCoord, texCoord]);
-    return {
-      originalTexCoord,
-      texCoord,
-      matrix
-    };
-  }
-  return null;
+    return null;
 }
+/**
+ * Transform `TEXCOORD_0` attribute in the primitive
+ * @param gltfData gltf data
+ * @param primitive primitive object
+ * @param transformParameters texCoord couple and transformation matrix
+ */
 function transformPrimitive(gltfData, primitive, transformParameters) {
-  const {
-    originalTexCoord,
-    texCoord,
-    matrix
-  } = transformParameters;
-  const texCoordAccessor = primitive.attributes[`TEXCOORD_${originalTexCoord}`];
-  if (Number.isFinite(texCoordAccessor)) {
-    var _gltfData$json$access;
-    const accessor = (_gltfData$json$access = gltfData.json.accessors) === null || _gltfData$json$access === void 0 ? void 0 : _gltfData$json$access[texCoordAccessor];
-    if (accessor && accessor.bufferView) {
-      var _gltfData$json$buffer;
-      const bufferView = (_gltfData$json$buffer = gltfData.json.bufferViews) === null || _gltfData$json$buffer === void 0 ? void 0 : _gltfData$json$buffer[accessor.bufferView];
-      if (bufferView) {
-        const {
-          arrayBuffer,
-          byteOffset: bufferByteOffset
-        } = gltfData.buffers[bufferView.buffer];
-        const byteOffset = (bufferByteOffset || 0) + (accessor.byteOffset || 0) + (bufferView.byteOffset || 0);
-        const {
-          ArrayType,
-          length
-        } = getAccessorArrayTypeAndLength(accessor, bufferView);
-        const bytes = BYTES[accessor.componentType];
-        const components = COMPONENTS[accessor.type];
-        const elementAddressScale = bufferView.byteStride || bytes * components;
-        const result = new Float32Array(length);
-        for (let i = 0; i < accessor.count; i++) {
-          const uv = new ArrayType(arrayBuffer, byteOffset + i * elementAddressScale, 2);
-          scratchVector.set(uv[0], uv[1], 1);
-          scratchVector.transformByMatrix3(matrix);
-          result.set([scratchVector[0], scratchVector[1]], i * components);
+    const { originalTexCoord, texCoord, matrix } = transformParameters;
+    const texCoordAccessor = primitive.attributes[`TEXCOORD_${originalTexCoord}`];
+    if (Number.isFinite(texCoordAccessor)) {
+        // Get accessor of the `TEXCOORD_0` attribute
+        const accessor = gltfData.json.accessors?.[texCoordAccessor];
+        if (accessor && accessor.bufferView) {
+            // Get `bufferView` of the `accessor`
+            const bufferView = gltfData.json.bufferViews?.[accessor.bufferView];
+            if (bufferView) {
+                // Get `arrayBuffer` the `bufferView` look at
+                const { arrayBuffer, byteOffset: bufferByteOffset } = gltfData.buffers[bufferView.buffer];
+                // Resulting byteOffset is sum of the buffer, accessor and bufferView byte offsets
+                const byteOffset = (bufferByteOffset || 0) + (accessor.byteOffset || 0) + (bufferView.byteOffset || 0);
+                // Deduce TypedArray type and its length from `accessor` and `bufferView` data
+                const { ArrayType, length } = getAccessorArrayTypeAndLength(accessor, bufferView);
+                // Number of bytes each component occupies
+                const bytes = BYTES[accessor.componentType];
+                // Number of components. For the `TEXCOORD_0` with `VEC2` type, it must return 2
+                const components = COMPONENTS[accessor.type];
+                // Multiplier to calculate the address of the `TEXCOORD_0` element in the arrayBuffer
+                const elementAddressScale = bufferView.byteStride || bytes * components;
+                // Data transform to Float32Array
+                const result = new Float32Array(length);
+                for (let i = 0; i < accessor.count; i++) {
+                    // Take [u, v] couple from the arrayBuffer
+                    const uv = new ArrayType(arrayBuffer, byteOffset + i * elementAddressScale, 2);
+                    // Set and transform Vector3 per https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_texture_transform#overview
+                    scratchVector.set(uv[0], uv[1], 1);
+                    scratchVector.transformByMatrix3(matrix);
+                    // Save result in Float32Array
+                    result.set([scratchVector[0], scratchVector[1]], i * components);
+                }
+                // If texCoord the same, replace gltf structural data
+                if (originalTexCoord === texCoord) {
+                    updateGltf(accessor, bufferView, gltfData.buffers, result);
+                }
+                else {
+                    // If texCoord change, create new attribute
+                    createAttribute(texCoord, accessor, primitive, gltfData, result);
+                }
+            }
         }
-        if (originalTexCoord === texCoord) {
-          updateGltf(accessor, bufferView, gltfData.buffers, result);
-        } else {
-          createAttribute(texCoord, accessor, primitive, gltfData, result);
-        }
-      }
     }
-  }
 }
+/**
+ * Update GLTF structural objects with new data as we create new `Float32Array` for `TEXCOORD_0`.
+ * @param accessor accessor to change
+ * @param bufferView bufferView to change
+ * @param buffers binary buffers
+ * @param newTexcoordArray typed array with data after transformation
+ */
 function updateGltf(accessor, bufferView, buffers, newTexCoordArray) {
-  accessor.componentType = 5126;
-  buffers.push({
-    arrayBuffer: newTexCoordArray.buffer,
-    byteOffset: 0,
-    byteLength: newTexCoordArray.buffer.byteLength
-  });
-  bufferView.buffer = buffers.length - 1;
-  bufferView.byteLength = newTexCoordArray.buffer.byteLength;
-  bufferView.byteOffset = 0;
-  delete bufferView.byteStride;
+    accessor.componentType = 5126;
+    buffers.push({
+        arrayBuffer: newTexCoordArray.buffer,
+        byteOffset: 0,
+        byteLength: newTexCoordArray.buffer.byteLength
+    });
+    bufferView.buffer = buffers.length - 1;
+    bufferView.byteLength = newTexCoordArray.buffer.byteLength;
+    bufferView.byteOffset = 0;
+    delete bufferView.byteStride;
 }
+/**
+ *
+ * @param newTexCoord new `texCoord` value
+ * @param originalAccessor original accessor object, that store data before transformation
+ * @param primitive primitive object
+ * @param gltfData gltf data
+ * @param newTexCoordArray typed array with data after transformation
+ * @returns
+ */
 function createAttribute(newTexCoord, originalAccessor, primitive, gltfData, newTexCoordArray) {
-  gltfData.buffers.push({
-    arrayBuffer: newTexCoordArray.buffer,
-    byteOffset: 0,
-    byteLength: newTexCoordArray.buffer.byteLength
-  });
-  const bufferViews = gltfData.json.bufferViews;
-  if (!bufferViews) {
-    return;
-  }
-  bufferViews.push({
-    buffer: gltfData.buffers.length - 1,
-    byteLength: newTexCoordArray.buffer.byteLength,
-    byteOffset: 0
-  });
-  const accessors = gltfData.json.accessors;
-  if (!accessors) {
-    return;
-  }
-  accessors.push({
-    bufferView: (bufferViews === null || bufferViews === void 0 ? void 0 : bufferViews.length) - 1,
-    byteOffset: 0,
-    componentType: 5126,
-    count: originalAccessor.count,
-    type: 'VEC2'
-  });
-  primitive.attributes[`TEXCOORD_${newTexCoord}`] = accessors.length - 1;
+    gltfData.buffers.push({
+        arrayBuffer: newTexCoordArray.buffer,
+        byteOffset: 0,
+        byteLength: newTexCoordArray.buffer.byteLength
+    });
+    const bufferViews = gltfData.json.bufferViews;
+    if (!bufferViews) {
+        return;
+    }
+    bufferViews.push({
+        buffer: gltfData.buffers.length - 1,
+        byteLength: newTexCoordArray.buffer.byteLength,
+        byteOffset: 0
+    });
+    const accessors = gltfData.json.accessors;
+    if (!accessors) {
+        return;
+    }
+    accessors.push({
+        bufferView: bufferViews?.length - 1,
+        byteOffset: 0,
+        componentType: 5126,
+        count: originalAccessor.count,
+        type: 'VEC2'
+    });
+    primitive.attributes[`TEXCOORD_${newTexCoord}`] = accessors.length - 1;
 }
+/**
+ * Construct transformation matrix from the extension data (transition, rotation, scale)
+ * @param extensionData extension data
+ * @returns transformation matrix
+ */
 function makeTransformationMatrix(extensionData) {
-  const {
-    offset = [0, 0],
-    rotation = 0,
-    scale = [1, 1]
-  } = extensionData;
-  const translationMatrix = new Matrix3().set(1, 0, 0, 0, 1, 0, offset[0], offset[1], 1);
-  const rotationMatrix = scratchRotationMatrix.set(Math.cos(rotation), Math.sin(rotation), 0, -Math.sin(rotation), Math.cos(rotation), 0, 0, 0, 1);
-  const scaleMatrix = scratchScaleMatrix.set(scale[0], 0, 0, 0, scale[1], 0, 0, 0, 1);
-  return translationMatrix.multiplyRight(rotationMatrix).multiplyRight(scaleMatrix);
+    const { offset = [0, 0], rotation = 0, scale = [1, 1] } = extensionData;
+    const translationMatrix = new Matrix3().set(1, 0, 0, 0, 1, 0, offset[0], offset[1], 1);
+    const rotationMatrix = scratchRotationMatrix.set(Math.cos(rotation), Math.sin(rotation), 0, -Math.sin(rotation), Math.cos(rotation), 0, 0, 0, 1);
+    const scaleMatrix = scratchScaleMatrix.set(scale[0], 0, 0, 0, scale[1], 0, 0, 0, 1);
+    return translationMatrix.multiplyRight(rotationMatrix).multiplyRight(scaleMatrix);
 }
-//# sourceMappingURL=KHR_texture_transform.js.map

package/dist/lib/extensions/deprecated/EXT_feature_metadata.d.ts

@@ -1,5 +1,5 @@
-import type { GLTF } from '../../types/gltf-json-schema';
-import { GLTFLoaderOptions } from '../../../gltf-loader';
+import type { GLTF } from "../../types/gltf-json-schema.js";
+import { GLTFLoaderOptions } from "../../../gltf-loader.js";
 export declare const name = "EXT_feature_metadata";
 export declare function decode(gltfData: {
     json: GLTF;

package/dist/lib/extensions/deprecated/EXT_feature_metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EXT_feature_metadata.d.ts","sourceRoot":"","sources":["../../../../src/lib/extensions/deprecated/EXT_feature_metadata.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,IAAI,EAA0B,MAAM,8BAA8B,CAAC;AAchF,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAevD,eAAO,MAAM,IAAI,yBAA4B,CAAC;AAE9C,wBAAsB,MAAM,CAAC,QAAQ,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9F"}
+{"version":3,"file":"EXT_feature_metadata.d.ts","sourceRoot":"","sources":["../../../../src/lib/extensions/deprecated/EXT_feature_metadata.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,IAAI,EAA0B,wCAAqC;AAchF,OAAO,EAAC,iBAAiB,EAAC,gCAA6B;AAevD,eAAO,MAAM,IAAI,yBAA4B,CAAC;AAE9C,wBAAsB,MAAM,CAAC,QAAQ,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9F"}