@loaders.gl/gltf 4.0.0-alpha.23 → 4.0.0-alpha.24

package/dist/lib/gltf-utils/gltf-utils.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMemoryUsageGLTF = exports.getAccessorArrayTypeAndLength = exports.getComponentTypeFromArray = exports.getAccessorTypeFromSize = void 0;
-const assert_1 = require("../utils/assert");
-/**
- * Memory needed to store texture and all mipmap levels 1 + 1/4 + 1/16 + 1/64 + ...
- * Minimum 1.33, but due to GPU layout may be 1.5
- */
-const MIPMAP_FACTOR = 1.33;
-const TYPES = ['SCALAR', 'VEC2', 'VEC3', 'VEC4'];
-const ARRAY_CONSTRUCTOR_TO_WEBGL_CONSTANT = [
-    [Int8Array, 5120],
-    [Uint8Array, 5121],
-    [Int16Array, 5122],
-    [Uint16Array, 5123],
-    [Uint32Array, 5125],
-    [Float32Array, 5126],
-    [Float64Array, 5130]
-];
-const ARRAY_TO_COMPONENT_TYPE = new Map(ARRAY_CONSTRUCTOR_TO_WEBGL_CONSTANT);
-const ATTRIBUTE_TYPE_TO_COMPONENTS = {
-    SCALAR: 1,
-    VEC2: 2,
-    VEC3: 3,
-    VEC4: 4,
-    MAT2: 4,
-    MAT3: 9,
-    MAT4: 16
-};
-const ATTRIBUTE_COMPONENT_TYPE_TO_BYTE_SIZE = {
-    5120: 1,
-    5121: 1,
-    5122: 2,
-    5123: 2,
-    5125: 4,
-    5126: 4
-};
-const ATTRIBUTE_COMPONENT_TYPE_TO_ARRAY = {
-    5120: Int8Array,
-    5121: Uint8Array,
-    5122: Int16Array,
-    5123: Uint16Array,
-    5125: Uint32Array,
-    5126: Float32Array
-};
-function getAccessorTypeFromSize(size) {
-    const type = TYPES[size - 1];
-    return type || TYPES[0];
-}
-exports.getAccessorTypeFromSize = getAccessorTypeFromSize;
-function getComponentTypeFromArray(typedArray) {
-    const componentType = ARRAY_TO_COMPONENT_TYPE.get(typedArray.constructor);
-    if (!componentType) {
-        throw new Error('Illegal typed array');
-    }
-    return componentType;
-}
-exports.getComponentTypeFromArray = getComponentTypeFromArray;
-function getAccessorArrayTypeAndLength(accessor, bufferView) {
-    const ArrayType = ATTRIBUTE_COMPONENT_TYPE_TO_ARRAY[accessor.componentType];
-    const components = ATTRIBUTE_TYPE_TO_COMPONENTS[accessor.type];
-    const bytesPerComponent = ATTRIBUTE_COMPONENT_TYPE_TO_BYTE_SIZE[accessor.componentType];
-    const length = accessor.count * components;
-    const byteLength = accessor.count * components * bytesPerComponent;
-    (0, assert_1.assert)(byteLength >= 0 && byteLength <= bufferView.byteLength);
-    return { ArrayType, length, byteLength };
-}
-exports.getAccessorArrayTypeAndLength = getAccessorArrayTypeAndLength;
-/**
- * Calculate the GPU memory used by a GLTF tile, for both buffer and texture memory
- * @param gltf - the gltf content of a GLTF tile
- * @returns - total memory usage in bytes
- */
-function getMemoryUsageGLTF(gltf) {
-    let { images, bufferViews } = gltf;
-    images = images || [];
-    bufferViews = bufferViews || [];
-    const imageBufferViews = images.map((i) => i.bufferView);
-    bufferViews = bufferViews.filter((view) => !imageBufferViews.includes(view));
-    const bufferMemory = bufferViews.reduce((acc, view) => acc + view.byteLength, 0);
-    // Assume each pixel of the texture is 4 channel with mimmaps (which add 33%)
-    // TODO correctly handle compressed textures
-    const pixelCount = images.reduce((acc, image) => {
-        // @ts-ignore
-        const { width, height } = image.image;
-        return acc + width * height;
-    }, 0);
-    return bufferMemory + Math.ceil(4 * pixelCount * MIPMAP_FACTOR);
-}
-exports.getMemoryUsageGLTF = getMemoryUsageGLTF;

package/dist/lib/gltf-utils/resolve-url.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveUrl = void 0;
-// Resolves a relative url against a baseUrl
-// If url is absolute, return it unchanged
-function resolveUrl(url, options) {
-    // TODO: Use better logic to handle all protocols plus not delay on data
-    const absolute = url.startsWith('data:') || url.startsWith('http:') || url.startsWith('https:');
-    if (absolute) {
-        return url;
-    }
-    const baseUrl = options.baseUri || options.uri;
-    if (!baseUrl) {
-        throw new Error(`'baseUri' must be provided to resolve relative url ${url}`);
-    }
-    return baseUrl.substr(0, baseUrl.lastIndexOf('/') + 1) + url;
-}
-exports.resolveUrl = resolveUrl;

package/dist/lib/parsers/parse-glb.js

@@ -1,166 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseGLBSync = exports.isGLB = void 0;
-const loader_utils_1 = require("@loaders.gl/loader-utils");
-/** Binary GLTF is little endian. */
-const LITTLE_ENDIAN = true;
-/** 'glTF' in Big-Endian ASCII */
-const MAGIC_glTF = 0x676c5446;
-const GLB_FILE_HEADER_SIZE = 12;
-const GLB_CHUNK_HEADER_SIZE = 8;
-const GLB_CHUNK_TYPE_JSON = 0x4e4f534a;
-const GLB_CHUNK_TYPE_BIN = 0x004e4942;
-const GLB_V1_CONTENT_FORMAT_JSON = 0x0;
-/** @deprecated - Backward compatibility for old xviz files */
-const GLB_CHUNK_TYPE_JSON_XVIZ_DEPRECATED = 0;
-/** @deprecated - Backward compatibility for old xviz files */
-const GLB_CHUNK_TYPE_BIX_XVIZ_DEPRECATED = 1;
-function getMagicString(dataView, byteOffset = 0) {
-    return `\
-${String.fromCharCode(dataView.getUint8(byteOffset + 0))}\
-${String.fromCharCode(dataView.getUint8(byteOffset + 1))}\
-${String.fromCharCode(dataView.getUint8(byteOffset + 2))}\
-${String.fromCharCode(dataView.getUint8(byteOffset + 3))}`;
-}
-/** Check if the contents of an array buffer contains GLB byte markers */
-function isGLB(arrayBuffer, byteOffset = 0, options = {}) {
-    const dataView = new DataView(arrayBuffer);
-    // Check that GLB Header starts with the magic number
-    const { magic = MAGIC_glTF } = options;
-    const magic1 = dataView.getUint32(byteOffset, false);
-    return magic1 === magic || magic1 === MAGIC_glTF;
-}
-exports.isGLB = isGLB;
-/**
- * Synchronously parse a GLB
- * @param glb - Target, Output is stored there
- * @param arrayBuffer - Input data
- * @param byteOffset - Offset into arrayBuffer to start parsing from (for "embedded" GLBs, e.g. in 3D tiles)
- * @param options
- * @returns
- */
-function parseGLBSync(glb, arrayBuffer, byteOffset = 0, options = {}) {
-    // Check that GLB Header starts with the magic number
-    const dataView = new DataView(arrayBuffer);
-    // Compare format with GLBLoader documentation
-    const type = getMagicString(dataView, byteOffset + 0);
-    const version = dataView.getUint32(byteOffset + 4, LITTLE_ENDIAN); // Version 2 of binary glTF container format
-    const byteLength = dataView.getUint32(byteOffset + 8, LITTLE_ENDIAN); // Total byte length of binary file
-    Object.assign(glb, {
-        // Put less important stuff in a header, to avoid clutter
-        header: {
-            byteOffset,
-            byteLength,
-            hasBinChunk: false
-        },
-        type,
-        version,
-        json: {},
-        binChunks: []
-    });
-    byteOffset += GLB_FILE_HEADER_SIZE;
-    switch (glb.version) {
-        case 1:
-            return parseGLBV1(glb, dataView, byteOffset);
-        case 2:
-            return parseGLBV2(glb, dataView, byteOffset, (options = {}));
-        default:
-            throw new Error(`Invalid GLB version ${glb.version}. Only supports version 1 and 2.`);
-    }
-}
-exports.parseGLBSync = parseGLBSync;
-/**
- * Parse a V1 GLB
- * @param glb - target, output is stored in this object
- * @param dataView - Input, memory to be parsed
- * @param byteOffset - Offset of first byte of GLB data in the data view
- * @returns Number of bytes parsed (there could be additional non-GLB data after the GLB)
- */
-function parseGLBV1(glb, dataView, byteOffset) {
-    // Sanity: ensure file is big enough to hold at least the headers
-    (0, loader_utils_1.assert)(glb.header.byteLength > GLB_FILE_HEADER_SIZE + GLB_CHUNK_HEADER_SIZE);
-    // Explanation of GLB structure:
-    // https://cloud.githubusercontent.com/assets/3479527/22600725/36b87122-ea55-11e6-9d40-6fd42819fcab.png
-    const contentLength = dataView.getUint32(byteOffset + 0, LITTLE_ENDIAN); // Byte length of chunk
-    const contentFormat = dataView.getUint32(byteOffset + 4, LITTLE_ENDIAN); // Chunk format as uint32
-    byteOffset += GLB_CHUNK_HEADER_SIZE;
-    // GLB v1 only supports a single chunk type
-    (0, loader_utils_1.assert)(contentFormat === GLB_V1_CONTENT_FORMAT_JSON);
-    parseJSONChunk(glb, dataView, byteOffset, contentLength);
-    // No need to call the function padToBytes() from parseJSONChunk()
-    byteOffset += contentLength;
-    byteOffset += parseBINChunk(glb, dataView, byteOffset, glb.header.byteLength);
-    return byteOffset;
-}
-/**
- * Parse a V2 GLB
- * @param glb - target, output is stored in this object
- * @param dataView - Input, memory to be parsed
- * @param byteOffset - Offset of first byte of GLB data in the data view
- * @returns Number of bytes parsed (there could be additional non-GLB data after the GLB)
- */
-function parseGLBV2(glb, dataView, byteOffset, options) {
-    // Sanity: ensure file is big enough to hold at least the first chunk header
-    (0, loader_utils_1.assert)(glb.header.byteLength > GLB_FILE_HEADER_SIZE + GLB_CHUNK_HEADER_SIZE);
-    parseGLBChunksSync(glb, dataView, byteOffset, options);
-    return byteOffset + glb.header.byteLength;
-}
-/** Iterate over GLB chunks and parse them */
-function parseGLBChunksSync(glb, dataView, byteOffset, options) {
-    // Per spec we must iterate over chunks, ignoring all except JSON and BIN
-    // Iterate as long as there is space left for another chunk header
-    while (byteOffset + 8 <= glb.header.byteLength) {
-        const chunkLength = dataView.getUint32(byteOffset + 0, LITTLE_ENDIAN); // Byte length of chunk
-        const chunkFormat = dataView.getUint32(byteOffset + 4, LITTLE_ENDIAN); // Chunk format as uint32
-        byteOffset += GLB_CHUNK_HEADER_SIZE;
-        // Per spec we must iterate over chunks, ignoring all except JSON and BIN
-        switch (chunkFormat) {
-            case GLB_CHUNK_TYPE_JSON:
-                parseJSONChunk(glb, dataView, byteOffset, chunkLength);
-                break;
-            case GLB_CHUNK_TYPE_BIN:
-                parseBINChunk(glb, dataView, byteOffset, chunkLength);
-                break;
-            // Backward compatibility for very old xviz files
-            case GLB_CHUNK_TYPE_JSON_XVIZ_DEPRECATED:
-                if (!options.strict) {
-                    parseJSONChunk(glb, dataView, byteOffset, chunkLength);
-                }
-                break;
-            case GLB_CHUNK_TYPE_BIX_XVIZ_DEPRECATED:
-                if (!options.strict) {
-                    parseBINChunk(glb, dataView, byteOffset, chunkLength);
-                }
-                break;
-            default:
-                // Ignore, per spec
-                // console.warn(`Unknown GLB chunk type`); // eslint-disable-line
-                break;
-        }
-        byteOffset += (0, loader_utils_1.padToNBytes)(chunkLength, 4);
-    }
-    return byteOffset;
-}
-/* Parse a GLB JSON chunk */
-function parseJSONChunk(glb, dataView, byteOffset, chunkLength) {
-    // 1. Create a "view" of the binary encoded JSON data inside the GLB
-    const jsonChunk = new Uint8Array(dataView.buffer, byteOffset, chunkLength);
-    // 2. Decode the JSON binary array into clear text
-    const textDecoder = new TextDecoder('utf8');
-    const jsonText = textDecoder.decode(jsonChunk);
-    // 3. Parse the JSON text into a JavaScript data structure
-    glb.json = JSON.parse(jsonText);
-    return (0, loader_utils_1.padToNBytes)(chunkLength, 4);
-}
-/** Parse a GLB BIN chunk */
-function parseBINChunk(glb, dataView, byteOffset, chunkLength) {
-    // Note: BIN chunk can be optional
-    glb.header.hasBinChunk = true;
-    glb.binChunks.push({
-        byteOffset,
-        byteLength: chunkLength,
-        arrayBuffer: dataView.buffer
-        // TODO - copy, or create typed array view?
-    });
-    return (0, loader_utils_1.padToNBytes)(chunkLength, 4);
-}

package/dist/lib/parsers/parse-gltf.js

@@ -1,185 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseGLTF = exports.isGLTF = void 0;
-const loader_utils_1 = require("@loaders.gl/loader-utils");
-const images_1 = require("@loaders.gl/images");
-const textures_1 = require("@loaders.gl/textures");
-const assert_1 = require("../utils/assert");
-const parse_glb_1 = require("./parse-glb");
-const resolve_url_1 = require("../gltf-utils/resolve-url");
-const get_typed_array_1 = require("../gltf-utils/get-typed-array");
-const gltf_extensions_1 = require("../api/gltf-extensions");
-const normalize_gltf_v1_1 = require("../api/normalize-gltf-v1");
-/** Check if an array buffer appears to contain GLTF data */
-function isGLTF(arrayBuffer, options) {
-    const byteOffset = 0;
-    return (0, parse_glb_1.isGLB)(arrayBuffer, byteOffset, options);
-}
-exports.isGLTF = isGLTF;
-async function parseGLTF(gltf, arrayBufferOrString, byteOffset = 0, options, context) {
-    parseGLTFContainerSync(gltf, arrayBufferOrString, byteOffset, options);
-    (0, normalize_gltf_v1_1.normalizeGLTFV1)(gltf, { normalize: options?.gltf?.normalize });
-    (0, gltf_extensions_1.preprocessExtensions)(gltf, options, context);
-    // Load linked buffers asynchronously and decodes base64 buffers in parallel
-    if (options?.gltf?.loadBuffers && gltf.json.buffers) {
-        await loadBuffers(gltf, options, context);
-    }
-    // loadImages and decodeExtensions should not be running in parallel, because
-    // decodeExtensions uses data from images taken during the loadImages call.
-    if (options?.gltf?.loadImages) {
-        await loadImages(gltf, options, context);
-    }
-    await (0, gltf_extensions_1.decodeExtensions)(gltf, options, context);
-    return gltf;
-}
-exports.parseGLTF = parseGLTF;
-/**
- *
- * @param gltf
- * @param data - can be ArrayBuffer (GLB), ArrayBuffer (Binary JSON), String (JSON), or Object (parsed JSON)
- * @param byteOffset
- * @param options
- */
-function parseGLTFContainerSync(gltf, data, byteOffset, options) {
-    // Initialize gltf container
-    if (options.uri) {
-        gltf.baseUri = options.uri;
-    }
-    // If data is binary and starting with magic bytes, assume binary JSON text, convert to string
-    if (data instanceof ArrayBuffer && !(0, parse_glb_1.isGLB)(data, byteOffset, options)) {
-        const textDecoder = new TextDecoder();
-        data = textDecoder.decode(data);
-    }
-    if (typeof data === 'string') {
-        // If string, try to parse as JSON
-        gltf.json = (0, loader_utils_1.parseJSON)(data);
-    }
-    else if (data instanceof ArrayBuffer) {
-        // If still ArrayBuffer, parse as GLB container
-        const glb = {};
-        byteOffset = (0, parse_glb_1.parseGLBSync)(glb, data, byteOffset, options.glb);
-        (0, assert_1.assert)(glb.type === 'glTF', `Invalid GLB magic string ${glb.type}`);
-        gltf._glb = glb;
-        gltf.json = glb.json;
-    }
-    else {
-        (0, assert_1.assert)(false, 'GLTF: must be ArrayBuffer or string');
-    }
-    // Populate buffers
-    // Create an external buffers array to hold binary data
-    const buffers = gltf.json.buffers || [];
-    gltf.buffers = new Array(buffers.length).fill(null);
-    // Populates JSON and some bin chunk info
-    if (gltf._glb && gltf._glb.header.hasBinChunk) {
-        const { binChunks } = gltf._glb;
-        gltf.buffers[0] = {
-            arrayBuffer: binChunks[0].arrayBuffer,
-            byteOffset: binChunks[0].byteOffset,
-            byteLength: binChunks[0].byteLength
-        };
-        // TODO - this modifies JSON and is a post processing thing
-        // gltf.json.buffers[0].data = gltf.buffers[0].arrayBuffer;
-        // gltf.json.buffers[0].byteOffset = gltf.buffers[0].byteOffset;
-    }
-    // Populate images
-    const images = gltf.json.images || [];
-    gltf.images = new Array(images.length).fill({});
-}
-/** Asynchronously fetch and parse buffers, store in buffers array outside of json
- * TODO - traverse gltf and determine which buffers are actually needed
- */
-async function loadBuffers(gltf, options, context) {
-    // TODO
-    const buffers = gltf.json.buffers || [];
-    for (let i = 0; i < buffers.length; ++i) {
-        const buffer = buffers[i];
-        if (buffer.uri) {
-            const { fetch } = context;
-            (0, assert_1.assert)(fetch);
-            const uri = (0, resolve_url_1.resolveUrl)(buffer.uri, options);
-            const response = await context?.fetch?.(uri);
-            const arrayBuffer = await response?.arrayBuffer?.();
-            gltf.buffers[i] = {
-                arrayBuffer,
-                byteOffset: 0,
-                byteLength: arrayBuffer.byteLength
-            };
-            delete buffer.uri;
-        }
-        else if (gltf.buffers[i] === null) {
-            gltf.buffers[i] = {
-                arrayBuffer: new ArrayBuffer(buffer.byteLength),
-                byteOffset: 0,
-                byteLength: buffer.byteLength
-            };
-        }
-    }
-}
-/**
- * Loads all images
- * TODO - traverse gltf and determine which images are actually needed
- * @param gltf
- * @param options
- * @param context
- * @returns
- */
-async function loadImages(gltf, options, context) {
-    const imageIndices = getReferencesImageIndices(gltf);
-    const images = gltf.json.images || [];
-    const promises = [];
-    for (const imageIndex of imageIndices) {
-        promises.push(loadImage(gltf, images[imageIndex], imageIndex, options, context));
-    }
-    return await Promise.all(promises);
-}
-/** Make sure we only load images that are actually referenced by textures */
-function getReferencesImageIndices(gltf) {
-    const imageIndices = new Set();
-    const textures = gltf.json.textures || [];
-    for (const texture of textures) {
-        if (texture.source !== undefined) {
-            imageIndices.add(texture.source);
-        }
-    }
-    return Array.from(imageIndices).sort();
-}
-/** Asynchronously fetches and parses one image, store in images array outside of json */
-async function loadImage(gltf, image, index, options, context) {
-    let arrayBuffer;
-    if (image.uri && !image.hasOwnProperty('bufferView')) {
-        const uri = (0, resolve_url_1.resolveUrl)(image.uri, options);
-        const { fetch } = context;
-        const response = await fetch(uri);
-        arrayBuffer = await response.arrayBuffer();
-        image.bufferView = {
-            data: arrayBuffer
-        };
-    }
-    if (Number.isFinite(image.bufferView)) {
-        const array = (0, get_typed_array_1.getTypedArrayForBufferView)(gltf.json, gltf.buffers, image.bufferView);
-        arrayBuffer = (0, loader_utils_1.sliceArrayBuffer)(array.buffer, array.byteOffset, array.byteLength);
-    }
-    (0, assert_1.assert)(arrayBuffer, 'glTF image has no data');
-    // Call `parse`
-    let parsedImage = (await (0, loader_utils_1.parseFromContext)(arrayBuffer, [images_1.ImageLoader, textures_1.BasisLoader], {
-        ...options,
-        mimeType: image.mimeType,
-        basis: options.basis || { format: (0, textures_1.selectSupportedBasisFormat)() }
-    }, context));
-    if (parsedImage && parsedImage[0]) {
-        parsedImage = {
-            compressed: true,
-            // @ts-expect-error
-            mipmaps: false,
-            width: parsedImage[0].width,
-            height: parsedImage[0].height,
-            data: parsedImage[0]
-        };
-    }
-    // TODO making sure ImageLoader is overridable by using array of loaders
-    // const parsedImage = await parse(arrayBuffer, [ImageLoader]);
-    // Store the loaded image
-    gltf.images = gltf.images || [];
-    // @ts-expect-error TODO - sort out image typing asap
-    gltf.images[index] = parsedImage;
-}

package/dist/lib/types/glb-types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/types/gltf-ext-mesh-features-schema.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/types/gltf-ext-structural-metadata-schema.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/types/gltf-json-schema.js

@@ -1,4 +0,0 @@
-"use strict";
-// Types forked from https://github.com/bwasty/gltf-loader-ts under MIT license
-// Generated from official JSON schema using `npm run generate-interface` on 2018-02-24
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/types/gltf-postprocessed-schema.js

@@ -1,4 +0,0 @@
-"use strict";
-// Types forked from https://github.com/bwasty/gltf-loader-ts under MIT license
-// Generated from official JSON schema using `npm run generate-type` = on 2018-02-24
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/types/gltf-types.js

@@ -1,3 +0,0 @@
-"use strict";
-/* eslint-disable camelcase */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/utils/assert.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assert = void 0;
-// Replacement for the external assert method to reduce bundle size
-// Note: We don't use the second "message" argument in calling code,
-// so no need to support it here
-function assert(condition, message) {
-    if (!condition) {
-        throw new Error(message || 'assert failed: gltf');
-    }
-}
-exports.assert = assert;

package/dist/lib/utils/version.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VERSION = void 0;
-// Version constant cannot be imported, it needs to correspond to the build version of **this** module.
-// __VERSION__ is injected by babel-plugin-version-inline
-// @ts-ignore TS2304: Cannot find name '__VERSION__'.
-exports.VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';