@loaders.gl/obj 3.1.3 → 3.1.4

package/dist/index.d.ts

@@ -1,12 +1,16 @@
 import type { LoaderWithParser } from '@loaders.gl/loader-utils';
-import loadOBJ from './lib/load-obj';
+import type { OBJLoaderOptions } from './obj-loader';
 import { OBJLoader as OBJWorkerLoader } from './obj-loader';
+import type { MTLLoaderOptions } from './mtl-loader';
 export { OBJWorkerLoader };
 /**
  * Loader for the OBJ geometry format
  */
 export declare const OBJLoader: {
-    parse: (arrayBuffer: any, options: any) => Promise<{
+    parse: (arrayBuffer: ArrayBuffer, options?: OBJLoaderOptions | undefined) => Promise<{
+        /**
+         * Loader for the MTL material format
+         */
         loaderData: {
             header: {};
         };
@@ -18,7 +22,21 @@ export declare const OBJLoader: {
         mode: number;
         attributes: import("@loaders.gl/schema").MeshAttributes;
     }>;
-    parseTextSync: typeof loadOBJ;
+    parseTextSync: (text: string, options?: OBJLoaderOptions | undefined) => {
+        /**
+         * Loader for the MTL material format
+         */
+        loaderData: {
+            header: {};
+        };
+        schema: import("@loaders.gl/schema").Schema;
+        header: {
+            vertexCount: number;
+            boundingBox: [[number, number, number], [number, number, number]];
+        };
+        mode: number;
+        attributes: import("@loaders.gl/schema").MeshAttributes;
+    };
     name: string;
     id: string;
     module: string;
@@ -26,10 +44,29 @@ export declare const OBJLoader: {
     worker: boolean;
     extensions: string[];
     mimeTypes: string[];
-    testText: (text: any) => boolean;
+    testText: (text: string) => boolean;
     options: {
         obj: {};
     };
 };
+/**
+ * Loader for the MTL material format
+ */
+export declare const MTLLoader: {
+    parse: (arrayBuffer: ArrayBuffer, options?: MTLLoaderOptions | undefined) => Promise<import("./lib/parse-mtl").MTLMaterial[]>;
+    parseTextSync: (text: string, options?: MTLLoaderOptions | undefined) => import("./lib/parse-mtl").MTLMaterial[];
+    name: string;
+    id: string;
+    module: string;
+    version: any;
+    worker: boolean;
+    extensions: string[];
+    mimeTypes: string[];
+    testText: (text: string) => boolean;
+    options: {
+        mtl: {};
+    };
+};
 export declare const _typecheckOBJLoader: LoaderWithParser;
+export declare const _typecheckMTLLoader: LoaderWithParser;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAC/D,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAC,SAAS,IAAI,eAAe,EAAC,MAAM,cAAc,CAAC;AAI1D,OAAO,EAAC,eAAe,EAAC,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;CAIrB,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAG/D,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,cAAc,CAAC;AACnD,OAAO,EAAC,SAAS,IAAI,eAAe,EAAC,MAAM,cAAc,CAAC;AAC1D,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,cAAc,CAAC;AAKnD,OAAO,EAAC,eAAe,EAAC,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,SAAS;yBAEO,WAAW;QAOxC;;WAEG;;;;;;;;;;;;0BAPqB,MAAM;QAK9B;;WAEG;;;;;;;;;;;;;;;;;;;;;;;CANF,CAAC;AAIF;;GAEG;AACH,eAAO,MAAM,SAAS;yBAEO,WAAW;0BAEhB,MAAM;;;;;;;;;;;;CAC7B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAA4B,CAAC;AAC/D,eAAO,MAAM,mBAAmB,EAAE,gBAA4B,CAAC"}

package/dist/index.js

@@ -1,18 +1,27 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._typecheckOBJLoader = exports.OBJLoader = exports.OBJWorkerLoader = void 0;
-const load_obj_1 = __importDefault(require("./lib/load-obj"));
+exports._typecheckMTLLoader = exports._typecheckOBJLoader = exports.MTLLoader = exports.OBJLoader = exports.OBJWorkerLoader = void 0;
+const parse_obj_1 = require("./lib/parse-obj");
+const parse_mtl_1 = require("./lib/parse-mtl");
 const obj_loader_1 = require("./obj-loader");
 Object.defineProperty(exports, "OBJWorkerLoader", { enumerable: true, get: function () { return obj_loader_1.OBJLoader; } });
+const mtl_loader_1 = require("./mtl-loader");
 /**
  * Loader for the OBJ geometry format
  */
 exports.OBJLoader = {
     ...obj_loader_1.OBJLoader,
-    parse: async (arrayBuffer, options) => (0, load_obj_1.default)(new TextDecoder().decode(arrayBuffer), options),
-    parseTextSync: load_obj_1.default
+    parse: async (arrayBuffer, options) => (0, parse_obj_1.parseOBJ)(new TextDecoder().decode(arrayBuffer), options),
+    parseTextSync: (text, options) => (0, parse_obj_1.parseOBJ)(text, options)
+};
+// MTLLoader
+/**
+ * Loader for the MTL material format
+ */
+exports.MTLLoader = {
+    ...mtl_loader_1.MTLLoader,
+    parse: async (arrayBuffer, options) => (0, parse_mtl_1.parseMTL)(new TextDecoder().decode(arrayBuffer), options?.mtl),
+    parseTextSync: (text, options) => (0, parse_mtl_1.parseMTL)(text, options?.mtl)
 };
 exports._typecheckOBJLoader = exports.OBJLoader;
+exports._typecheckMTLLoader = exports.MTLLoader;

package/dist/lib/parse-mtl.d.ts

@@ -0,0 +1,34 @@
+export declare type MTLMaterial = {
+    name: string;
+    ambientColor?: [number, number, number];
+    diffuseColor?: [number, number, number];
+    specularColor?: [number, number, number];
+    emissiveColor?: [number, number, number];
+    shininess?: number;
+    refraction?: number;
+    illumination?: number;
+    diffuseTextureUrl?: string;
+    emissiveTextureUrl?: string;
+    specularTextureUrl?: string;
+};
+/**
+ * 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 declare 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
+ */
+export declare function parseMTL(text: string, options?: ParseMTLOptions): MTLMaterial[];
+//# sourceMappingURL=parse-mtl.d.ts.map

package/dist/lib/parse-mtl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-mtl.d.ts","sourceRoot":"","sources":["../../src/lib/parse-mtl.ts"],"names":[],"mappings":"AAMA,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAIF;;;;;GAKG;AACH,oBAAY,eAAe,GAAG;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;;;GAOG;AAEH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,WAAW,EAAE,CA2H/E"}

package/dist/lib/parse-mtl.js

@@ -0,0 +1,201 @@
+"use strict";
+// loaders.gl, MIT license
+// Forked from THREE.js under MIT license
+// https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/MTLLoader.js
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseMTL = void 0;
+const DELIMITER_PATTERN = /\s+/;
+/**
+ * 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
+function parseMTL(text, options) {
+    // const materialsInfo: Record<string, MTLMaterial> = {};
+    const materials = [];
+    let currentMaterial = { 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;
+}
+exports.parseMTL = parseMTL;
+function parseColor(value, options) {
+    const rgb = value.split(DELIMITER_PATTERN, 3);
+    const color = [
+        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;
+  }
+*/

package/dist/lib/parse-obj-meshes.d.ts

@@ -0,0 +1,5 @@
+export declare function parseOBJMeshes(text: any): {
+    meshes: never[];
+    materials: never[];
+};
+//# sourceMappingURL=parse-obj-meshes.d.ts.map

package/dist/lib/parse-obj-meshes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-obj-meshes.d.ts","sourceRoot":"","sources":["../../src/lib/parse-obj-meshes.ts"],"names":[],"mappings":"AAgTA,wBAAgB,cAAc,CAAC,IAAI,KAAA;;;EA4NlC"}