@loaders.gl/obj 4.0.0-alpha.4 → 4.0.0-alpha.6

package/dist/workers/obj-worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=obj-worker.d.ts.map

package/dist/workers/obj-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"obj-worker.d.ts","sourceRoot":"","sources":["../../src/workers/obj-worker.ts"],"names":[],"mappings":""}

package/dist/workers/obj-worker.js

@@ -1,4 +1,5 @@
-import {createLoaderWorker} from '@loaders.gl/loader-utils';
-import {OBJLoader} from '../index';
-
-createLoaderWorker(OBJLoader);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const index_1 = require("../index");
+(0, loader_utils_1.createLoaderWorker)(index_1.OBJLoader);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/obj",
-  "version": "4.0.0-alpha.4",
+  "version": "4.0.0-alpha.6",
   "description": "Framework-independent loader for the OBJ format",
   "license": "MIT",
   "publishConfig": {
@@ -18,9 +18,9 @@
     "point cloud",
     "OBJ"
   ],
-  "types": "src/index.ts",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "main": "dist/es5/index.js",
+  "module": "dist/esm/index.js",
   "sideEffects": false,
   "files": [
     "src",
@@ -29,13 +29,13 @@
   ],
   "scripts": {
     "pre-build": "npm run build-worker && npm run build-bundle",
-    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/bundle.js",
-    "build-worker": "esbuild src/workers/obj-worker.js --bundle --outfile=dist/obj-worker.js"
+    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js",
+    "build-worker": "esbuild src/workers/obj-worker.ts --bundle --outfile=dist/obj-worker.js --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
     "@babel/runtime": "^7.3.1",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.4",
-    "@loaders.gl/schema": "4.0.0-alpha.4"
+    "@loaders.gl/loader-utils": "4.0.0-alpha.6",
+    "@loaders.gl/schema": "4.0.0-alpha.6"
   },
-  "gitHead": "53026061b3c8871f7e96d3a5826125cc6613bddc"
+  "gitHead": "acc1985050dfaa0f1f0c066f8da5bce7454a046c"
 }

package/src/index.ts

@@ -1,7 +1,14 @@
 import type {LoaderWithParser} from '@loaders.gl/loader-utils';
-import loadOBJ from './lib/load-obj';
+import type {Mesh} from '@loaders.gl/schema';
+import {parseOBJ} from './lib/parse-obj';
+import type {OBJLoaderOptions} from './obj-loader';
 import {OBJLoader as OBJWorkerLoader} from './obj-loader';
 
+import type {MTLMaterial} from './lib/parse-mtl';
+import {parseMTL} from './lib/parse-mtl';
+import type {MTLLoaderOptions} from './mtl-loader';
+import {MTLLoader as MTLWorkerLoader} from './mtl-loader';
+
 // OBJLoader
 
 export {OBJWorkerLoader};
@@ -9,10 +16,24 @@ export {OBJWorkerLoader};
 /**
  * Loader for the OBJ geometry format
  */
-export const OBJLoader = {
+export const OBJLoader: LoaderWithParser<Mesh, never, OBJLoaderOptions> = {
   ...OBJWorkerLoader,
-  parse: async (arrayBuffer, options) => loadOBJ(new TextDecoder().decode(arrayBuffer), options),
-  parseTextSync: loadOBJ
+  parse: async (arrayBuffer: ArrayBuffer, options?: OBJLoaderOptions) =>
+    parseOBJ(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: OBJLoaderOptions) => parseOBJ(text, options)
+};
+
+// MTLLoader
+
+/**
+ * Loader for the MTL material format
+ */
+export const MTLLoader: LoaderWithParser<MTLMaterial[], never, MTLLoaderOptions> = {
+  ...MTLWorkerLoader,
+  parse: async (arrayBuffer: ArrayBuffer, options?: MTLLoaderOptions) =>
+    parseMTL(new TextDecoder().decode(arrayBuffer), options?.mtl),
+  parseTextSync: (text: string, options?: MTLLoaderOptions) => parseMTL(text, options?.mtl)
 };
 
 export const _typecheckOBJLoader: LoaderWithParser = OBJLoader;
+export const _typecheckMTLLoader: LoaderWithParser = MTLLoader;

package/src/lib/get-obj-schema.ts

@@ -1,39 +1,43 @@
-import {Schema, Field, FixedSizeList, getArrowTypeFromTypedArray} from '@loaders.gl/schema';
+// loaders.gl, MIT license
 
-export function getOBJSchema(attributes, metadata = {}) {
-  let metadataMap;
+import type {Schema, SchemaMetadata, Field, MeshAttribute} from '@loaders.gl/schema';
+import {getDataTypeFromArray} from '@loaders.gl/schema';
+
+/** Get Mesh Schema */
+export function getOBJSchema(
+  attributes: Record<string, MeshAttribute>,
+  metadata: Record<string, unknown> = {}
+): Schema {
+  const stringMetadata: SchemaMetadata = {};
   for (const key in metadata) {
-    metadataMap = metadataMap || new Map();
     if (key !== 'value') {
-      metadataMap.set(key, JSON.stringify(metadata[key]));
+      stringMetadata[key] = JSON.stringify(metadata[key]);
     }
   }
 
   const fields: Field[] = [];
   for (const attributeName in attributes) {
     const attribute = attributes[attributeName];
-    const field = getArrowFieldFromAttribute(attributeName, attribute);
+    const field = getFieldFromAttribute(attributeName, attribute);
     fields.push(field);
   }
-  return new Schema(fields, metadataMap);
+
+  return {fields, metadata: stringMetadata};
 }
 
-function getArrowFieldFromAttribute(attributeName, attribute) {
-  const metadataMap = new Map();
+/** Get a Field describing the column from an OBJ attribute */
+function getFieldFromAttribute(name: string, attribute: MeshAttribute): Field {
+  const metadata: Record<string, string> = {};
   for (const key in attribute) {
     if (key !== 'value') {
-      metadataMap.set(key, JSON.stringify(attribute[key]));
+      metadata[key] = JSON.stringify(attribute[key]);
     }
   }
 
-  const type = getArrowTypeFromTypedArray(attribute.value);
-  const isSingleValue = !('size' in attribute) || attribute.size === 1;
-  return isSingleValue
-    ? new Field(attributeName, type, false, metadataMap)
-    : new Field(
-      attributeName,
-      new FixedSizeList(attribute.size, new Field('value', type)),
-      false,
-      metadataMap
-    );
+  let {type} = getDataTypeFromArray(attribute.value);
+  const isSingleValue = attribute.size === 1 || attribute.size === undefined;
+  if (!isSingleValue) {
+    type = {type: 'fixed-size-list', listSize: attribute.size, children: [{name: 'values', type}]};
+  }
+  return {name, type, nullable: false, metadata};
 }

package/src/lib/parse-mtl.ts

@@ -0,0 +1,246 @@
+// loaders.gl, MIT license
+// Forked from THREE.js under MIT license
+// https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/MTLLoader.js
+
+// import type {DiffuseMaterial} from '@loaders.gl/schema';
+
+export type MTLMaterial = {
+  name: string;
+  ambientColor?: [number, number, number];
+  diffuseColor?: [number, number, number];
+  specularColor?: [number, number, number];
+  emissiveColor?: [number, number, number];
+  // specular?: number;
+  shininess?: number;
+  refraction?: number;
+  illumination?: number;
+  diffuseTextureUrl?: string;
+  emissiveTextureUrl?: string;
+  specularTextureUrl?: string;
+};
+
+const DELIMITER_PATTERN = /\s+/;
+
+/**
+ * Set of options on how to construct materials
+ * @param normalizeRGB: RGBs need to be normalized to 0-1 from 0-255 (Default: false, assumed to be already normalized)
+ * @param ignoreZeroRGBs: Ignore values of RGBs (Ka,Kd,Ks) that are all 0's Default: false
+ * @param baseUrl - Url relative to which textures are loaded
+ */
+export type ParseMTLOptions = {
+  normalizeRGB?: boolean;
+  ignoreZeroRGBs?: boolean;
+  baseUrl?: string;
+};
+
+/**
+ * Parses a MTL file.
+ * Parses a Wavefront .mtl file specifying materials
+ * http://paulbourke.net/dataformats/mtl/
+ * https://www.loc.gov/preservation/digital/formats/fdd/fdd000508.shtml
+ *
+ * @param  text - Content of MTL file
+ */
+// eslint-disable-next-line complexity
+export function parseMTL(text: string, options?: ParseMTLOptions): MTLMaterial[] {
+  // const materialsInfo: Record<string, MTLMaterial> = {};
+  const materials: MTLMaterial[] = [];
+
+  let currentMaterial: MTLMaterial = {name: 'placeholder'};
+
+  const lines = text.split('\n');
+  for (let line of lines) {
+    line = line.trim();
+
+    if (line.length === 0 || line.charAt(0) === '#') {
+      // Blank line or comment ignore
+      continue; // eslint-disable-line no-continue
+    }
+
+    const pos = line.indexOf(' ');
+
+    let key = pos >= 0 ? line.substring(0, pos) : line;
+    key = key.toLowerCase();
+
+    let value = pos >= 0 ? line.substring(pos + 1) : '';
+    value = value.trim();
+
+    switch (key) {
+      case 'newmtl':
+        // New material
+        currentMaterial = {name: value};
+        // insert into map
+        materials.push(currentMaterial);
+        break;
+
+      case 'ka': // Ka
+        currentMaterial.ambientColor = parseColor(value);
+        break;
+
+      case 'kd':
+        // Kd: Diffuse color (color under white light) using RGB values
+        currentMaterial.diffuseColor = parseColor(value);
+        break;
+      case 'map_kd':
+        // Diffuse texture map
+        currentMaterial.diffuseTextureUrl = value;
+        //         setMapForType('map', value);
+        break;
+
+      case 'ks':
+        // Specular color (color when light is reflected from shiny surface) using RGB values
+        currentMaterial.specularColor = parseColor(value);
+        break;
+      case 'map_ks':
+        // Specular map
+        currentMaterial.specularTextureUrl = value;
+        // setMapForType('specularMap', value);
+        break;
+
+      case 'ke':
+        // Emissive using RGB values
+        currentMaterial.emissiveColor = parseColor(value);
+        break;
+      case 'map_ke':
+        // Emissive map
+        currentMaterial.emissiveTextureUrl = value;
+        // setMapForType('emissiveMap', value);
+        break;
+
+      case 'ns':
+        // Ns is material specular exponent (defines the focus of the specular highlight)
+        // A high exponent results in a tight, concentrated highlight. Ns values normally range from 0 to 1000.
+        currentMaterial.shininess = parseFloat(value);
+        break;
+      case 'map_ns':
+        // Ns is material specular exponent
+        // TODO?
+        // currentMaterial.shininessMap = parseFloat(value);
+        break;
+      case 'ni':
+        currentMaterial.refraction = parseFloat(value);
+        break;
+      case 'illum':
+        currentMaterial.illumination = parseFloat(value);
+        break;
+
+      default:
+        // log unknown message?
+        break;
+
+      /*
+      case 'norm':
+        setMapForType('normalMap', value);
+        break;
+
+      case 'map_bump':
+      case 'bump':
+        // Bump texture map
+        setMapForType('bumpMap', value);
+        break;
+
+      case 'd':
+        n = parseFloat(value);
+        if (n < 1) {
+          params.opacity = n;
+          params.transparent = true;
+        }
+        break;
+
+      case 'map_d':
+        // Alpha map
+        setMapForType('alphaMap', value);
+        params.transparent = true;
+        break;
+
+      case 'tr':
+        n = parseFloat(value);
+        if (this.options && this.options.invertTrProperty) n = 1 - n;
+        if (n > 0) {
+          params.opacity = 1 - n;
+          params.transparent = true;
+        }
+      */
+    }
+  }
+
+  return materials;
+}
+
+function parseColor(value: string, options?: ParseMTLOptions): [number, number, number] {
+  const rgb = value.split(DELIMITER_PATTERN, 3);
+  const color: [number, number, number] = [
+    parseFloat(rgb[0]),
+    parseFloat(rgb[1]),
+    parseFloat(rgb[2])
+  ];
+  // TODO auto detect big values?
+  // if (this.options && this.options.normalizeRGB) {
+  //   value = [ value[ 0 ] / 255, value[ 1 ] / 255, value[ 2 ] / 255 ];
+  // }
+
+  // if (this.options && this.options.ignoreZeroRGBs) {
+  //   if (value[ 0 ] === 0 && value[ 1 ] === 0 && value[ 2 ] === 0) {
+  //     // ignore
+  //     save = false;
+  //   }
+  // }
+  return color;
+}
+
+/* TODO parse url options
+function parseTexture(value, matParams) {
+  const texParams = {
+    scale: new Vector2(1, 1),
+    offset: new Vector2(0, 0)
+  };
+
+  const items = value.split(/\s+/);
+  let pos;
+
+  pos = items.indexOf('-bm');
+  if (pos >= 0) {
+    matParams.bumpScale = parseFloat(items[ pos + 1 ]);
+    items.splice(pos, 2);
+  }
+
+  pos = items.indexOf('-s');
+  if (pos >= 0) {
+    texParams.scale.set(parseFloat(items[ pos + 1 ]), parseFloat(items[ pos + 2 ]));
+    items.splice(pos, 4); // we expect 3 parameters here!
+
+  }
+
+  pos = items.indexOf('-o');
+
+  if (pos >= 0) {
+    texParams.offset.set(parseFloat(items[ pos + 1 ]), parseFloat(items[ pos + 2 ]));
+    items.splice(pos, 4); // we expect 3 parameters here!
+  }
+
+  texParams.url = items.join(' ').trim();
+  return texParams;
+}
+
+ *function resolveURL(baseUrl, url) {
+ * baseUrl?: string;
+    // Absolute URL
+    if (/^https?:\/\//i.test(url)) return url;
+    return baseUrl + url;
+  }
+
+  function setMapForType(mapType, value) {
+    if (params[ mapType ]) return; // Keep the first encountered texture
+
+    const texParams = scope.getTextureParams(value, params);
+    const map = scope.loadTexture(resolveURL(scope.baseUrl, texParams.url));
+
+    map.repeat.copy(texParams.scale);
+    map.offset.copy(texParams.offset);
+
+    map.wrapS = scope.wrap;
+    map.wrapT = scope.wrap;
+
+    params[ mapType ] = map;
+  }
+*/