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

package/dist/lib/encoders/encode-glb.js

@@ -1,54 +1,68 @@
+/* eslint-disable camelcase, max-statements */
 import { copyPaddedStringToDataView, copyPaddedArrayBufferToDataView } from '@loaders.gl/loader-utils';
-const MAGIC_glTF = 0x46546c67;
-const MAGIC_JSON = 0x4e4f534a;
-const MAGIC_BIN = 0x004e4942;
-const LE = true;
-export function encodeGLBSync(glb, dataView) {
-  let byteOffset = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-  let options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
-  const {
-    magic = MAGIC_glTF,
-    version = 2,
-    json = {},
-    binary
-  } = glb;
-  const byteOffsetStart = byteOffset;
-  if (dataView) {
-    dataView.setUint32(byteOffset + 0, magic, LE);
-    dataView.setUint32(byteOffset + 4, version, LE);
-    dataView.setUint32(byteOffset + 8, 0, LE);
-  }
-  const byteOffsetFileLength = byteOffset + 8;
-  byteOffset += 12;
-  const byteOffsetJsonHeader = byteOffset;
-  if (dataView) {
-    dataView.setUint32(byteOffset + 0, 0, LE);
-    dataView.setUint32(byteOffset + 4, MAGIC_JSON, LE);
-  }
-  byteOffset += 8;
-  const jsonString = JSON.stringify(json);
-  byteOffset = copyPaddedStringToDataView(dataView, byteOffset, jsonString, 4);
-  if (dataView) {
-    const jsonByteLength = byteOffset - byteOffsetJsonHeader - 8;
-    dataView.setUint32(byteOffsetJsonHeader + 0, jsonByteLength, LE);
-  }
-  if (binary) {
-    const byteOffsetBinHeader = byteOffset;
+// import type {GLB} from '../types/glb-types';
+const MAGIC_glTF = 0x46546c67; // glTF in ASCII
+const MAGIC_JSON = 0x4e4f534a; // JSON in ASCII
+const MAGIC_BIN = 0x004e4942; // BIN\0 in ASCII
+const LE = true; // Binary GLTF is little endian.
+/**
+ * Encode the full GLB buffer with header etc
+ *
+ * @param glb
+ * @param dataView - if `null`, does not encode but just calculates length
+ * @param byteOffset
+ * @param options
+ * @returns
+ *
+ * @see https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#glb-file-format-specification
+ * @todo type GLB argument
+ */
+export function encodeGLBSync(glb, dataView, byteOffset = 0, options = {}) {
+    const { magic = MAGIC_glTF, version = 2, json = {}, binary } = glb;
+    const byteOffsetStart = byteOffset;
+    // Write GLB Header
     if (dataView) {
-      dataView.setUint32(byteOffset + 0, 0, LE);
-      dataView.setUint32(byteOffset + 4, MAGIC_BIN, LE);
+        dataView.setUint32(byteOffset + 0, magic, LE); // Magic number (the ASCII string 'glTF').
+        dataView.setUint32(byteOffset + 4, version, LE); // Version 2 of binary glTF container format uint32
+        dataView.setUint32(byteOffset + 8, 0, LE); // Total byte length of generated file (uint32), will be set last
     }
-    byteOffset += 8;
-    byteOffset = copyPaddedArrayBufferToDataView(dataView, byteOffset, binary, 4);
+    const byteOffsetFileLength = byteOffset + 8;
+    byteOffset += 12; // GLB_FILE_HEADER_SIZE
+    // Write the JSON chunk header
+    const byteOffsetJsonHeader = byteOffset;
     if (dataView) {
-      const binByteLength = byteOffset - byteOffsetBinHeader - 8;
-      dataView.setUint32(byteOffsetBinHeader + 0, binByteLength, LE);
+        dataView.setUint32(byteOffset + 0, 0, LE); // Byte length of json chunk (will be written later)
+        dataView.setUint32(byteOffset + 4, MAGIC_JSON, LE); // Chunk type
     }
-  }
-  if (dataView) {
-    const fileByteLength = byteOffset - byteOffsetStart;
-    dataView.setUint32(byteOffsetFileLength, fileByteLength, LE);
-  }
-  return byteOffset;
+    byteOffset += 8; // GLB_CHUNK_HEADER_SIZE
+    // Write the JSON chunk
+    const jsonString = JSON.stringify(json);
+    byteOffset = copyPaddedStringToDataView(dataView, byteOffset, jsonString, 4);
+    // Now we know the JSON chunk length so we can write it.
+    if (dataView) {
+        const jsonByteLength = byteOffset - byteOffsetJsonHeader - 8; // GLB_CHUNK_HEADER_SIZE
+        dataView.setUint32(byteOffsetJsonHeader + 0, jsonByteLength, LE); // Byte length of json chunk (uint32)
+    }
+    // Write the BIN chunk if present. The BIN chunk is optional.
+    if (binary) {
+        const byteOffsetBinHeader = byteOffset;
+        // Write the BIN chunk header
+        if (dataView) {
+            dataView.setUint32(byteOffset + 0, 0, LE); // Byte length BIN (uint32)
+            dataView.setUint32(byteOffset + 4, MAGIC_BIN, LE); // Chunk type
+        }
+        byteOffset += 8; // GLB_CHUNK_HEADER_SIZE
+        byteOffset = copyPaddedArrayBufferToDataView(dataView, byteOffset, binary, 4);
+        // Now we know the BIN chunk length so we can write it.
+        if (dataView) {
+            const binByteLength = byteOffset - byteOffsetBinHeader - 8; // GLB_CHUNK_HEADER_SIZE
+            dataView.setUint32(byteOffsetBinHeader + 0, binByteLength, LE); // Byte length BIN (uint32)
+        }
+    }
+    // Now we know the glb file length so we can write it.
+    if (dataView) {
+        const fileByteLength = byteOffset - byteOffsetStart;
+        dataView.setUint32(byteOffsetFileLength, fileByteLength, LE); // Total byte length of generated file (uint32)
+    }
+    return byteOffset;
 }
-//# sourceMappingURL=encode-glb.js.map

package/dist/lib/encoders/encode-gltf.js

@@ -1,14 +1,28 @@
 import { encodeGLBSync } from "./encode-glb.js";
+/**
+ * Encode the full glTF file as a binary GLB file
+ * Returns an ArrayBuffer that represents the complete GLB image that can be saved to file
+ *
+ * @todo - Does not support encoding to non-GLB versions of glTF format. Other formats
+ * - Encode as a textual JSON file with binary data in base64 data URLs.
+ * - Encode as a JSON with all images (and buffers?) in separate binary files
+ *
+ * glb-file-format-specification
+ * @see https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#
+ *
+ * @param gltf
+ * @param arrayBuffer
+ * @param byteOffset
+ * @param options
+ * @returns
+ */
 export function encodeGLTFSync(gltf, arrayBuffer, byteOffset, options) {
-  convertBuffersToBase64(gltf);
-  return encodeGLBSync(gltf, arrayBuffer, byteOffset, options);
+    convertBuffersToBase64(gltf);
+    // TODO: Copy buffers to binary
+    return encodeGLBSync(gltf, arrayBuffer, byteOffset, options);
 }
-function convertBuffersToBase64(gltf) {
-  let {
-    firstBuffer = 0
-  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  if (gltf.buffers && gltf.buffers.length > firstBuffer) {
-    throw new Error('encodeGLTF: multiple buffers not yet implemented');
-  }
+function convertBuffersToBase64(gltf, { firstBuffer = 0 } = {}) {
+    if (gltf.buffers && gltf.buffers.length > firstBuffer) {
+        throw new Error('encodeGLTF: multiple buffers not yet implemented');
+    }
 }
-//# sourceMappingURL=encode-gltf.js.map

package/dist/lib/extensions/EXT_mesh_features.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_mesh_features";
 export declare function decode(gltfData: {
     json: GLTF;

package/dist/lib/extensions/EXT_mesh_features.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EXT_mesh_features.d.ts","sourceRoot":"","sources":["../../../src/lib/extensions/EXT_mesh_features.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,IAAI,EAAoB,MAAM,2BAA2B,CAAC;AACvE,OAAO,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAUpD,eAAO,MAAM,IAAI,sBAAyB,CAAC;AAE3C,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_mesh_features.d.ts","sourceRoot":"","sources":["../../../src/lib/extensions/EXT_mesh_features.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,IAAI,EAAoB,qCAAkC;AACvE,OAAO,EAAC,iBAAiB,EAAC,6BAA0B;AAUpD,eAAO,MAAM,IAAI,sBAAyB,CAAC;AAE3C,wBAAsB,MAAM,CAAC,QAAQ,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9F"}

package/dist/lib/extensions/EXT_mesh_features.js

@@ -3,43 +3,65 @@ import { getPrimitiveTextureData } from "./utils/3d-tiles-utils.js";
 const EXT_MESH_FEATURES_NAME = 'EXT_mesh_features';
 export const name = EXT_MESH_FEATURES_NAME;
 export async function decode(gltfData, options) {
-  const scenegraph = new GLTFScenegraph(gltfData);
-  decodeExtMeshFeatures(scenegraph, options);
+    const scenegraph = new GLTFScenegraph(gltfData);
+    decodeExtMeshFeatures(scenegraph, options);
 }
+/**
+ * Decodes feature metadata from extension.
+ * @param {GLTFScenegraph} scenegraph - Instance of the class for structured access to GLTF data.
+ * @param {GLTFLoaderOptions} options - GLTFLoader options.
+ */
 function decodeExtMeshFeatures(scenegraph, options) {
-  const json = scenegraph.gltf.json;
-  if (!json.meshes) {
-    return;
-  }
-  for (const mesh of json.meshes) {
-    for (const primitive of mesh.primitives) {
-      processMeshPrimitiveFeatures(scenegraph, primitive, options);
+    const json = scenegraph.gltf.json;
+    if (!json.meshes) {
+        return;
+    }
+    // Iterate through all meshes/primitives.
+    for (const mesh of json.meshes) {
+        for (const primitive of mesh.primitives) {
+            processMeshPrimitiveFeatures(scenegraph, primitive, options);
+        }
     }
-  }
 }
+/**
+ * Takes data from EXT_mesh_features and store it in 'data' property of featureIds.
+ * If combined with EXT_structural_metadata, corresponding data are taken from the property tables of that extension.
+ * @param {GLTFScenegraph} scenegraph - Instance of the class for structured access to GLTF data.
+ * @param {GLTFMeshPrimitive} primitive - Primitive that contains extensions.
+ * @param {GLTFLoaderOptions} options - GLTFLoader options.
+ */
 function processMeshPrimitiveFeatures(scenegraph, primitive, options) {
-  var _options$gltf, _primitive$extensions;
-  if (!(options !== null && options !== void 0 && (_options$gltf = options.gltf) !== null && _options$gltf !== void 0 && _options$gltf.loadBuffers)) {
-    return;
-  }
-  const extension = (_primitive$extensions = primitive.extensions) === null || _primitive$extensions === void 0 ? void 0 : _primitive$extensions[EXT_MESH_FEATURES_NAME];
-  const featureIds = extension === null || extension === void 0 ? void 0 : extension.featureIds;
-  if (!featureIds) {
-    return;
-  }
-  for (const featureId of featureIds) {
-    var _options$gltf2;
-    let featureIdData;
-    if (typeof featureId.attribute !== 'undefined') {
-      const accessorKey = `_FEATURE_ID_${featureId.attribute}`;
-      const accessorIndex = primitive.attributes[accessorKey];
-      featureIdData = scenegraph.getTypedArrayForAccessor(accessorIndex);
-    } else if (typeof featureId.texture !== 'undefined' && options !== null && options !== void 0 && (_options$gltf2 = options.gltf) !== null && _options$gltf2 !== void 0 && _options$gltf2.loadImages) {
-      featureIdData = getPrimitiveTextureData(scenegraph, featureId.texture, primitive);
-    } else {
-      featureIdData = [];
+    // Processing of mesh primitive features requires buffers to be loaded.
+    if (!options?.gltf?.loadBuffers) {
+        return;
+    }
+    const extension = primitive.extensions?.[EXT_MESH_FEATURES_NAME];
+    const featureIds = extension?.featureIds;
+    if (!featureIds) {
+        return;
+    }
+    for (const featureId of featureIds) {
+        let featureIdData;
+        // Process "Feature ID by Vertex"
+        if (typeof featureId.attribute !== 'undefined') {
+            const accessorKey = `_FEATURE_ID_${featureId.attribute}`;
+            const accessorIndex = primitive.attributes[accessorKey];
+            featureIdData = scenegraph.getTypedArrayForAccessor(accessorIndex);
+        }
+        // Process "Feature ID by Texture Coordinates"
+        else if (typeof featureId.texture !== 'undefined' && options?.gltf?.loadImages) {
+            featureIdData = getPrimitiveTextureData(scenegraph, featureId.texture, primitive);
+        }
+        // Process "Feature ID by Index"
+        else {
+            /*
+            When both featureId.attribute and featureId.texture are undefined,
+            then the feature ID value for each vertex is given implicitly, via the index of the vertex.
+            In this case, the featureCount must match the number of vertices of the mesh primitive.
+            */
+            // TODO: At the moment of writing we don't have a tileset with the data of that kind. Implement it later.
+            featureIdData = [];
+        }
+        featureId.data = featureIdData;
     }
-    featureId.data = featureIdData;
-  }
 }
-//# sourceMappingURL=EXT_mesh_features.js.map

package/dist/lib/extensions/EXT_meshopt_compression.d.ts

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

package/dist/lib/extensions/EXT_meshopt_compression.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EXT_meshopt_compression.d.ts","sourceRoot":"","sources":["../../../src/lib/extensions/EXT_meshopt_compression.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,IAAI,EAA+C,MAAM,2BAA2B,CAAC;AAClG,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAczD,eAAO,MAAM,IAAI,4BAA0B,CAAC;AAE5C,wBAAsB,MAAM,CAAC,QAAQ,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,EAAE,OAAO,EAAE,iBAAiB,iBAiB9E"}
+{"version":3,"file":"EXT_meshopt_compression.d.ts","sourceRoot":"","sources":["../../../src/lib/extensions/EXT_meshopt_compression.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,IAAI,EAA+C,qCAAkC;AAClG,OAAO,KAAK,EAAC,iBAAiB,EAAC,6BAA0B;AAczD,eAAO,MAAM,IAAI,4BAA0B,CAAC;AAE5C,wBAAsB,MAAM,CAAC,QAAQ,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,EAAE,OAAO,EAAE,iBAAiB,iBAiB9E"}

package/dist/lib/extensions/EXT_meshopt_compression.js

@@ -1,41 +1,37 @@
 import { GLTFScenegraph } from "../api/gltf-scenegraph.js";
 import { meshoptDecodeGltfBuffer } from "../../meshopt/meshopt-decoder.js";
+// @ts-ignore
+// eslint-disable-next-line
 const DEFAULT_MESHOPT_OPTIONS = {
-  byteOffset: 0,
-  filter: 'NONE'
+    byteOffset: 0,
+    filter: 'NONE'
 };
+/** Extension name */
 const EXT_MESHOPT_COMPRESSION = 'EXT_meshopt_compression';
 export const name = EXT_MESHOPT_COMPRESSION;
 export async function decode(gltfData, options) {
-  var _options$gltf, _options$gltf2;
-  const scenegraph = new GLTFScenegraph(gltfData);
-  if (!(options !== null && options !== void 0 && (_options$gltf = options.gltf) !== null && _options$gltf !== void 0 && _options$gltf.decompressMeshes) || !((_options$gltf2 = options.gltf) !== null && _options$gltf2 !== void 0 && _options$gltf2.loadBuffers)) {
-    return;
-  }
-  const promises = [];
-  for (const bufferViewIndex of gltfData.json.bufferViews || []) {
-    promises.push(decodeMeshoptBufferView(scenegraph, bufferViewIndex));
-  }
-  await Promise.all(promises);
-  scenegraph.removeExtension(EXT_MESHOPT_COMPRESSION);
+    const scenegraph = new GLTFScenegraph(gltfData);
+    if (!options?.gltf?.decompressMeshes || !options.gltf?.loadBuffers) {
+        return;
+    }
+    const promises = [];
+    for (const bufferViewIndex of gltfData.json.bufferViews || []) {
+        promises.push(decodeMeshoptBufferView(scenegraph, bufferViewIndex));
+    }
+    // Decompress meshes in parallel
+    await Promise.all(promises);
+    // We have now decompressed all primitives, so remove the top-level extension
+    scenegraph.removeExtension(EXT_MESHOPT_COMPRESSION);
 }
+/** Decode one meshopt buffer view */
 async function decodeMeshoptBufferView(scenegraph, bufferView) {
-  const meshoptExtension = scenegraph.getObjectExtension(bufferView, EXT_MESHOPT_COMPRESSION);
-  if (meshoptExtension) {
-    const {
-      byteOffset = 0,
-      byteLength = 0,
-      byteStride,
-      count,
-      mode,
-      filter = 'NONE',
-      buffer: bufferIndex
-    } = meshoptExtension;
-    const buffer = scenegraph.gltf.buffers[bufferIndex];
-    const source = new Uint8Array(buffer.arrayBuffer, buffer.byteOffset + byteOffset, byteLength);
-    const result = new Uint8Array(scenegraph.gltf.buffers[bufferView.buffer].arrayBuffer, bufferView.byteOffset, bufferView.byteLength);
-    await meshoptDecodeGltfBuffer(result, count, byteStride, source, mode, filter);
-    scenegraph.removeObjectExtension(bufferView, EXT_MESHOPT_COMPRESSION);
-  }
+    const meshoptExtension = scenegraph.getObjectExtension(bufferView, EXT_MESHOPT_COMPRESSION);
+    if (meshoptExtension) {
+        const { byteOffset = 0, byteLength = 0, byteStride, count, mode, filter = 'NONE', buffer: bufferIndex } = meshoptExtension;
+        const buffer = scenegraph.gltf.buffers[bufferIndex];
+        const source = new Uint8Array(buffer.arrayBuffer, buffer.byteOffset + byteOffset, byteLength);
+        const result = new Uint8Array(scenegraph.gltf.buffers[bufferView.buffer].arrayBuffer, bufferView.byteOffset, bufferView.byteLength);
+        await meshoptDecodeGltfBuffer(result, count, byteStride, source, mode, filter);
+        scenegraph.removeObjectExtension(bufferView, EXT_MESHOPT_COMPRESSION);
+    }
 }
-//# sourceMappingURL=EXT_meshopt_compression.js.map

package/dist/lib/extensions/EXT_structural_metadata.d.ts

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

package/dist/lib/extensions/EXT_structural_metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EXT_structural_metadata.d.ts","sourceRoot":"","sources":["../../../src/lib/extensions/EXT_structural_metadata.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,IAAI,EAA6C,MAAM,2BAA2B,CAAC;AAYhG,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAgBzD,eAAO,MAAM,IAAI,4BAA+B,CAAC;AAEjD,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_structural_metadata.d.ts","sourceRoot":"","sources":["../../../src/lib/extensions/EXT_structural_metadata.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,IAAI,EAA6C,qCAAkC;AAYhG,OAAO,KAAK,EAAC,iBAAiB,EAAC,6BAA0B;AAgBzD,eAAO,MAAM,IAAI,4BAA+B,CAAC;AAEjD,wBAAsB,MAAM,CAAC,QAAQ,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9F"}