@loaders.gl/gltf 4.0.0-alpha.1 → 4.0.0-alpha.11

package/src/index.ts

@@ -1,5 +1,7 @@
 /* eslint-disable camelcase, indent */
 export type {GLB} from './lib/types/glb-types';
+
+// Raw GLTF Types (i.e. not post-processed)
 export type {
   GLTF,
   GLTFAccessor,
@@ -14,13 +16,32 @@ export type {
   GLTFSkin,
   GLTFTexture,
   GLTFImage,
+  GLTFObject,
   // The following extensions are handled by the GLTFLoader and removed from the parsed glTF (disable via options.gltf.excludeExtensions)
   GLTF_KHR_binary_glTF,
   GLTF_KHR_draco_mesh_compression,
   GLTF_KHR_texture_basisu,
   GLTF_EXT_meshopt_compression,
-  GLTF_EXT_texture_webp
-} from './lib/types/gltf-types';
+  GLTF_EXT_texture_webp,
+  GLTF_EXT_feature_metadata,
+  GLTF_EXT_feature_metadata_primitive,
+  GLTF_EXT_feature_metadata_attribute,
+  GLTF_EXT_mesh_features
+} from './lib/types/gltf-json-schema';
+
+// Postprocessed types (modified GLTF types)
+export type {
+  GLTFPostprocessed,
+  GLTFAccessorPostprocessed,
+  GLTFNodePostprocessed,
+  GLTFMaterialPostprocessed,
+  GLTFMeshPostprocessed,
+  GLTFMeshPrimitivePostprocessed,
+  GLTFImagePostprocessed,
+  GLTFTexturePostprocessed
+} from './lib/types/gltf-postprocessed-schema';
+
+export type {GLTFWithBuffers} from './lib/types/gltf-types';
 
 // glTF loader/writer definition objects
 export {GLTFLoader} from './gltf-loader';
@@ -31,7 +52,15 @@ export {GLBLoader} from './glb-loader';
 export {GLBWriter} from './glb-writer';
 
 // glTF Data Access Helper Class
-export {default as GLTFScenegraph} from './lib/api/gltf-scenegraph';
+export {GLTFScenegraph} from './lib/api/gltf-scenegraph';
 export {postProcessGLTF} from './lib/api/post-process-gltf';
-export type {Mesh} from './lib/types/gltf-json-schema';
-export type {GLTFObject} from './lib/types/gltf-types';
+export {getMemoryUsageGLTF as _getMemoryUsageGLTF} from './lib/gltf-utils/gltf-utils';
+
+/** @deprecated */
+// export type {GLTFMesh as Mesh} from './lib/types/gltf-json-schema';
+/** @deprecated */
+// export type {GLTFNodePostprocessed as Node} from './lib/types/gltf-postprocessed-schema';
+/** @deprecated */
+// export type {GLTFAccessorPostprocessed as Accessor} from './lib/types/gltf-postprocessed-schema';
+// /** @deprecated */
+// export type {GLTFImagePostprocessed as Image} from './lib/types/gltf-postprocessed-schema';

package/src/lib/api/gltf-extensions.ts

@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-import {GLTF} from '../types/gltf-types';
+import {GLTF} from '../types/gltf-json-schema';
 import type {GLTFLoaderOptions} from '../../gltf-loader';
 
 // GLTF 1.0 extensions (decode only)
@@ -10,18 +10,27 @@ import * as EXT_meshopt_compression from '../extensions/EXT_meshopt_compression'
 import * as EXT_texture_webp from '../extensions/EXT_texture_webp';
 import * as KHR_texture_basisu from '../extensions/KHR_texture_basisu';
 import * as KHR_draco_mesh_compression from '../extensions/KHR_draco_mesh_compression';
+import * as KHR_texture_transform from '../extensions/KHR_texture_transform';
 
 // Deprecated. These should be handled by rendering library (e.g. luma.gl), not the loader.
 import * as KHR_lights_punctual from '../extensions/deprecated/KHR_lights_punctual';
 import * as KHR_materials_unlit from '../extensions/deprecated/KHR_materials_unlit';
 import * as KHR_techniques_webgl from '../extensions/deprecated/KHR_techniques_webgl';
+import * as EXT_feature_metadata from '../extensions/deprecated/EXT_feature_metadata';
 
 // Vendor extensions
 
 type GLTFExtensionPlugin = {
   name: string;
   preprocess?: (gltfData: {json: GLTF}, options: GLTFLoaderOptions, context) => void;
-  decode?: (gltfData: {json: GLTF}, options: GLTFLoaderOptions, context) => Promise<void>;
+  decode?: (
+    gltfData: {
+      json: GLTF;
+      buffers: {arrayBuffer: ArrayBuffer; byteOffset: number; byteLength: number}[];
+    },
+    options: GLTFLoaderOptions,
+    context
+  ) => Promise<void>;
   encode?: (gltfData: {json: GLTF}, options: GLTFLoaderOptions) => void;
 };
 
@@ -43,7 +52,9 @@ export const EXTENSIONS: GLTFExtensionPlugin[] = [
   KHR_draco_mesh_compression,
   KHR_lights_punctual,
   KHR_materials_unlit,
-  KHR_techniques_webgl
+  KHR_techniques_webgl,
+  KHR_texture_transform,
+  EXT_feature_metadata
 ];
 
 /** Call before any resource loading starts */

package/src/lib/api/gltf-scenegraph.ts

@@ -1,3 +1,6 @@
+// loaders.gl, MIT license
+
+import type {GLTFWithBuffers} from '../types/gltf-types';
 import type {
   GLTF,
   GLTFScene,
@@ -11,7 +14,7 @@ import type {
   GLTFImage,
   GLTFBuffer,
   GLTFBufferView
-} from '../types/gltf-types';
+} from '../types/gltf-json-schema';
 
 import {getBinaryImageMetadata} from '@loaders.gl/images';
 import {padToNBytes, copyToArray} from '@loaders.gl/loader-utils';
@@ -22,35 +25,38 @@ import {
   getComponentTypeFromArray
 } from '../gltf-utils/gltf-utils';
 
-type GLTFWithBuffers = {
-  json: GLTF;
-  buffers: any[];
-  binary?: ArrayBuffer;
-};
+type Extension = {[key: string]: any};
 
-const DEFAULT_GLTF_JSON: GLTF = {
-  asset: {
-    version: '2.0',
-    generator: 'loaders.gl'
-  },
-  buffers: []
-};
+function makeDefaultGLTFJson(): GLTF {
+  return {
+    asset: {
+      version: '2.0',
+      generator: 'loaders.gl'
+    },
+    buffers: [],
+    extensions: {},
+    extensionsRequired: [],
+    extensionsUsed: []
+  };
+}
 
-type Extension = {[key: string]: any};
 /**
  * Class for structured access to GLTF data
  */
-export default class GLTFScenegraph {
+export class GLTFScenegraph {
   // internal
   gltf: GLTFWithBuffers;
   sourceBuffers: any[];
   byteLength: number;
 
-  constructor(gltf?: {json: GLTF; buffers?: any[]}) {
-    // @ts-ignore
-    this.gltf = gltf || {
-      json: {...DEFAULT_GLTF_JSON},
-      buffers: []
+  // TODO - why is this not GLTFWithBuffers - what happens to images?
+  constructor(gltf?: {json: GLTF; buffers?: any[]; images?: any[]}) {
+    // Declare locally so
+
+    this.gltf = {
+      json: gltf?.json || makeDefaultGLTFJson(),
+      buffers: gltf?.buffers || [],
+      images: gltf?.images || []
     };
     this.sourceBuffers = [];
     this.byteLength = 0;
@@ -68,22 +74,28 @@ export default class GLTFScenegraph {
     return this.gltf.json;
   }
 
-  getApplicationData(key: string): {[key: string]: any} {
+  getApplicationData(key: string): unknown {
     // TODO - Data is already unpacked by GLBParser
     const data = this.json[key];
     return data;
   }
 
-  getExtraData(key: string): {[key: string]: any} {
+  getExtraData(key: string): {[key: string]: unknown} {
     // TODO - Data is already unpacked by GLBParser
     const extras = this.json.extras || {};
     return extras[key];
   }
 
+  hasExtension(extensionName: string): boolean {
+    const isUsedExtension = this.getUsedExtensions().find((name) => name === extensionName);
+    const isRequiredExtension = this.getRequiredExtensions().find((name) => name === extensionName);
+    return typeof isUsedExtension === 'string' || typeof isRequiredExtension === 'string';
+  }
+
   getExtension<T = Extension>(extensionName: string): T | null {
     const isExtension = this.getUsedExtensions().find((name) => name === extensionName);
     const extensions = this.json.extensions || {};
-    return isExtension ? extensions[extensionName] || true : null;
+    return isExtension ? (extensions[extensionName] as T) : null;
   }
 
   getRequiredExtension<T = Extension>(extensionName: string): T | null {
@@ -99,6 +111,10 @@ export default class GLTFScenegraph {
     return this.json.extensionsUsed || [];
   }
 
+  getRemovedExtensions(): string[] {
+    return (this.json.extensionsRemoved || []) as string[];
+  }
+
   getObjectExtension<T = Extension>(object: {[key: string]: any}, extensionName: string): T | null {
     const extensions = object.extensions || {};
     return extensions[extensionName];
@@ -157,7 +173,7 @@ export default class GLTFScenegraph {
     if (typeof index === 'object') {
       return index;
     }
-    const object = this.json[array] && this.json[array][index];
+    const object = this.json[array] && (this.json[array] as {}[])[index];
     if (!object) {
       throw new Error(`glTF file error: Could not find ${array}[${index}]`); // eslint-disable-line
     }
@@ -234,7 +250,7 @@ export default class GLTFScenegraph {
    */
   addExtraData(key: string, data: object): GLTFScenegraph {
     this.json.extras = this.json.extras || {};
-    this.json.extras[key] = data;
+    (this.json.extras as Record<string, unknown>)[key] = data;
     return this;
   }
 
@@ -248,19 +264,24 @@ export default class GLTFScenegraph {
     return this;
   }
 
-  setObjectExtension(object: object, extensionName: string, data: object): void {
-    // @ts-ignore
+  setObjectExtension(object: any, extensionName: string, data: object): void {
     const extensions = object.extensions || {};
     extensions[extensionName] = data;
     // TODO - add to usedExtensions...
   }
 
-  removeObjectExtension(object: object, extensionName: string): object {
-    // @ts-ignore
-    const extensions = object.extensions || {};
-    const extension = extensions[extensionName];
+  removeObjectExtension(object: any, extensionName: string): void {
+    const extensions = object?.extensions || {};
+
+    if (extensions[extensionName]) {
+      this.json.extensionsRemoved = this.json.extensionsRemoved || [];
+      const extensionsRemoved = this.json.extensionsRemoved as string[];
+      if (!extensionsRemoved.includes(extensionName)) {
+        extensionsRemoved.push(extensionName);
+      }
+    }
+
     delete extensions[extensionName];
-    return extension;
   }
 
   /**
@@ -309,15 +330,22 @@ export default class GLTFScenegraph {
    * Removes an extension from the top-level list
    */
   removeExtension(extensionName: string): void {
+    if (this.json.extensions?.[extensionName]) {
+      this.json.extensionsRemoved = this.json.extensionsRemoved || [];
+      const extensionsRemoved = this.json.extensionsRemoved as string[];
+      if (!extensionsRemoved.includes(extensionName)) {
+        extensionsRemoved.push(extensionName);
+      }
+    }
+    if (this.json.extensions) {
+      delete this.json.extensions[extensionName];
+    }
     if (this.json.extensionsRequired) {
       this._removeStringFromArray(this.json.extensionsRequired, extensionName);
     }
     if (this.json.extensionsUsed) {
       this._removeStringFromArray(this.json.extensionsUsed, extensionName);
     }
-    if (this.json.extensions) {
-      delete this.json.extensions[extensionName];
-    }
   }
 
   /**
@@ -344,7 +372,7 @@ export default class GLTFScenegraph {
    *   `name`, `extensions`, `extras`, `camera`, `children`, `skin`, `rotation`, `scale`, `translation`, `weights`
    *   https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#node
    */
-  addNode(node: {meshIndex: number; matrix: number[]}): number {
+  addNode(node: {meshIndex: number; matrix?: number[]}): number {
     const {meshIndex, matrix} = node;
     this.json.nodes = this.json.nodes || [];
     const nodeData = {mesh: meshIndex};
@@ -357,7 +385,7 @@ export default class GLTFScenegraph {
   }
 
   /** Adds a mesh to the json part */
-  addMesh(mesh: {attributes: object; indices: object; material: number; mode: number}): number {
+  addMesh(mesh: {attributes: object; indices?: object; material?: number; mode?: number}): number {
     const {attributes, indices, material, mode = 4} = mesh;
     const accessors = this._addAttributes(attributes);
 
@@ -434,7 +462,7 @@ export default class GLTFScenegraph {
    * Add one untyped source buffer, create a matching glTF `bufferView`, and return its index
    * @param buffer
    */
-  addBufferView(buffer: any): number {
+  addBufferView(buffer: any, bufferIndex = 0, byteOffset = this.byteLength): number {
     const byteLength = buffer.byteLength;
     assert(Number.isFinite(byteLength));
 
@@ -443,9 +471,9 @@ export default class GLTFScenegraph {
     this.sourceBuffers.push(buffer);
 
     const glTFBufferView = {
-      buffer: 0,
+      buffer: bufferIndex,
       // Write offset from the start of the binary body
-      byteOffset: this.byteLength,
+      byteOffset,
       byteLength
     };
 

package/src/lib/api/{normalize-gltf-v1.js → normalize-gltf-v1.ts}

@@ -80,22 +80,24 @@ const GLTF_KEYS = {
  * Converts (normalizes) glTF v1 to v2
  */
 class GLTFV1Normalizer {
-  constructor(gltf) {
-    this.idToIndexMap = {
-      animations: {},
-      accessors: {},
-      buffers: {},
-      bufferViews: {},
-      images: {},
-      materials: {},
-      meshes: {},
-      nodes: {},
-      samplers: {},
-      scenes: {},
-      skins: {},
-      textures: {}
-    };
-  }
+  idToIndexMap = {
+    animations: {},
+    accessors: {},
+    buffers: {},
+    bufferViews: {},
+    images: {},
+    materials: {},
+    meshes: {},
+    nodes: {},
+    samplers: {},
+    scenes: {},
+    skins: {},
+    textures: {}
+  };
+
+  json;
+
+  // constructor() {}
 
   /**
    * Convert (normalize) glTF < 2.0 to glTF 2.0
@@ -296,7 +298,8 @@ class GLTFV1Normalizer {
         roughnessFactor: 1
       };
 
-      const textureId = material.values && material.values.tex;
+      const textureId =
+        material.values?.tex || material.values?.texture2d_0 || material.values?.diffuseTex;
       const textureIndex = json.textures.findIndex((texture) => texture.id === textureId);
       if (textureIndex !== -1) {
         material.pbrMetallicRoughness.baseColorTexture = {index: textureIndex};