@loaders.gl/ply 4.0.0-alpha.5 → 4.0.0-alpha.6

package/dist/index.d.ts

@@ -1,30 +1,13 @@
-import type { LoaderWithParser } from '@loaders.gl/loader-utils';
+import type { LoaderOptions, LoaderWithParser } from '@loaders.gl/loader-utils';
+import type { PLYMesh } from './lib/ply-types';
 import { PLYLoader as PLYWorkerLoader } from './ply-loader';
-import parsePLY from './lib/parse-ply';
-import parsePLYInBatches from './lib/parse-ply-in-batches';
+import { ParsePLYOptions } from './lib/parse-ply';
 export { PLYWorkerLoader };
+export type PLYLoaderOptions = LoaderOptions & {
+    ply?: ParsePLYOptions;
+};
 /**
  * Loader for PLY - Polygon File Format
  */
-export declare const PLYLoader: {
-    parse: (arrayBuffer: any, options: any) => Promise<import("./lib/ply-types").PLYMesh>;
-    parseTextSync: typeof parsePLY;
-    parseSync: typeof parsePLY;
-    parseInBatches: typeof parsePLYInBatches;
-    name: string;
-    id: string;
-    module: string;
-    shapes: string[];
-    version: any;
-    worker: boolean;
-    extensions: string[];
-    mimeTypes: string[];
-    text: boolean;
-    binary: boolean;
-    tests: string[];
-    options: {
-        ply: {};
-    };
-};
-export declare const _typecheckPLYLoader: LoaderWithParser;
+export declare const PLYLoader: LoaderWithParser<PLYMesh, any, PLYLoaderOptions>;
 //# 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,EAAC,SAAS,IAAI,eAAe,EAAC,MAAM,cAAc,CAAC;AAC1D,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,iBAAiB,MAAM,4BAA4B,CAAC;AAI3D,OAAO,EAAC,eAAe,EAAC,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;CAOrB,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAC9E,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAC,SAAS,IAAI,eAAe,EAAC,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAC,eAAe,EAAW,MAAM,iBAAiB,CAAC;AAK1D,OAAO,EAAC,eAAe,EAAC,CAAC;AAEzB,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAOtE,CAAC"}

package/dist/index.js

@@ -1,12 +1,19 @@
-import { PLYLoader as PLYWorkerLoader } from './ply-loader';
-import parsePLY from './lib/parse-ply';
-import parsePLYInBatches from './lib/parse-ply-in-batches';
-export { PLYWorkerLoader };
-export const PLYLoader = { ...PLYWorkerLoader,
-  parse: async (arrayBuffer, options) => parsePLY(arrayBuffer, options),
-  parseTextSync: parsePLY,
-  parseSync: parsePLY,
-  parseInBatches: parsePLYInBatches
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLYLoader = exports.PLYWorkerLoader = void 0;
+const ply_loader_1 = require("./ply-loader");
+Object.defineProperty(exports, "PLYWorkerLoader", { enumerable: true, get: function () { return ply_loader_1.PLYLoader; } });
+const parse_ply_1 = require("./lib/parse-ply");
+const parse_ply_in_batches_1 = require("./lib/parse-ply-in-batches");
+/**
+ * Loader for PLY - Polygon File Format
+ */
+exports.PLYLoader = {
+    ...ply_loader_1.PLYLoader,
+    // Note: parsePLY supports both text and binary
+    parse: async (arrayBuffer, options) => (0, parse_ply_1.parsePLY)(arrayBuffer, options?.ply),
+    parseTextSync: (arrayBuffer, options) => (0, parse_ply_1.parsePLY)(arrayBuffer, options?.ply),
+    parseSync: (arrayBuffer, options) => (0, parse_ply_1.parsePLY)(arrayBuffer, options?.ply),
+    parseInBatches: (arrayBuffer, options) => (0, parse_ply_in_batches_1.parsePLYInBatches)(arrayBuffer, options?.ply)
 };
-export const _typecheckPLYLoader = PLYLoader;
-//# sourceMappingURL=index.js.map

package/dist/lib/get-ply-schema.js

@@ -1,27 +1,37 @@
-import { deduceMeshSchema } from '@loaders.gl/schema';
-export function getPLYSchema(plyHeader, attributes) {
-  const metadataMap = makeMetadataFromPlyHeader(plyHeader);
-  const schema = deduceMeshSchema(attributes, metadataMap);
-  return schema;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPLYSchema = void 0;
+const schema_1 = require("@loaders.gl/schema");
+/**
+ * Gets schema from PLY header
+ * @param plyHeader
+ * @param metadata
+ * @returns Schema
+ */
+function getPLYSchema(plyHeader, attributes) {
+    const metadata = makeMetadataFromPlyHeader(plyHeader);
+    const schema = (0, schema_1.deduceMeshSchema)(attributes, metadata);
+    return schema;
 }
-
+exports.getPLYSchema = getPLYSchema;
+/**
+ * Make arrow like schema metadata by PlyHeader properties
+ * @param plyHeader
+ * @returns
+ */
 function makeMetadataFromPlyHeader(plyHeader) {
-  const metadataMap = new Map();
-  metadataMap.set('ply_comments', JSON.stringify(plyHeader.comments));
-  metadataMap.set('ply_elements', JSON.stringify(plyHeader.elements));
-
-  if (plyHeader.format !== undefined) {
-    metadataMap.set('ply_format', plyHeader.format);
-  }
-
-  if (plyHeader.version !== undefined) {
-    metadataMap.set('ply_version', plyHeader.version);
-  }
-
-  if (plyHeader.headerLength !== undefined) {
-    metadataMap.set('ply_headerLength', plyHeader.headerLength.toString(10));
-  }
-
-  return metadataMap;
+    /* eslint-disable camelcase */
+    const metadata = {};
+    metadata.ply_comments = JSON.stringify(plyHeader.comments);
+    metadata.ply_elements = JSON.stringify(plyHeader.elements);
+    if (plyHeader.format !== undefined) {
+        metadata.ply_format = plyHeader.format;
+    }
+    if (plyHeader.version !== undefined) {
+        metadata.ply_version = plyHeader.version;
+    }
+    if (plyHeader.headerLength !== undefined) {
+        metadata.ply_headerLength = plyHeader.headerLength.toString(10);
+    }
+    return metadata;
 }
-//# sourceMappingURL=get-ply-schema.js.map

package/dist/lib/normalize-ply.js

@@ -1,69 +1,80 @@
-import { getMeshBoundingBox } from '@loaders.gl/schema';
-import { getPLYSchema } from './get-ply-schema';
-export default function normalizePLY(plyHeader, plyAttributes, options) {
-  const attributes = getMeshAttributes(plyAttributes);
-  const boundingBox = getMeshBoundingBox(attributes);
-  const vertexCount = plyAttributes.indices.length || plyAttributes.vertices.length / 3;
-  const isTriangles = plyAttributes.indices && plyAttributes.indices.length > 0;
-  const mode = isTriangles ? 4 : 0;
-  const topology = isTriangles ? 'triangle-list' : 'point-list';
-  const schema = getPLYSchema(plyHeader, attributes);
-  const plyMesh = {
-    loader: 'ply',
-    loaderData: plyHeader,
-    header: {
-      vertexCount,
-      boundingBox
-    },
-    schema,
-    attributes,
-    indices: {
-      value: new Uint32Array(0),
-      size: 0
-    },
-    mode,
-    topology
-  };
-
-  if (plyAttributes.indices.length > 0) {
-    plyMesh.indices = {
-      value: new Uint32Array(plyAttributes.indices),
-      size: 1
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@loaders.gl/schema");
+const get_ply_schema_1 = require("./get-ply-schema");
+/**
+ * @param header
+ * @param attributes
+ * @returns data and header
+ */
+function normalizePLY(plyHeader, plyAttributes, options) {
+    const attributes = getMeshAttributes(plyAttributes);
+    const boundingBox = (0, schema_1.getMeshBoundingBox)(attributes);
+    const vertexCount = plyAttributes.indices.length || plyAttributes.vertices.length / 3;
+    // TODO - how to detect POINT CLOUDS vs MESHES?
+    // TODO - For Meshes, PLY quadrangles must be split?
+    const isTriangles = plyAttributes.indices && plyAttributes.indices.length > 0;
+    const mode = isTriangles ? 4 : 0; // TRIANGLES vs POINTS
+    const topology = isTriangles ? 'triangle-list' : 'point-list';
+    const schema = (0, get_ply_schema_1.getPLYSchema)(plyHeader, attributes);
+    const plyMesh = {
+        loader: 'ply',
+        loaderData: plyHeader,
+        header: {
+            vertexCount,
+            boundingBox
+        },
+        schema,
+        attributes,
+        indices: { value: new Uint32Array(0), size: 0 },
+        mode,
+        topology
     };
-  }
-
-  return plyMesh;
+    if (plyAttributes.indices.length > 0) {
+        plyMesh.indices = { value: new Uint32Array(plyAttributes.indices), size: 1 };
+    }
+    return plyMesh;
 }
-
+exports.default = normalizePLY;
+/**
+ * @param attributes
+ * @returns accessors []
+ */
+// eslint-disable-next-line complexity
 function getMeshAttributes(attributes) {
-  const accessors = {};
-  accessors.POSITION = {
-    value: new Float32Array(attributes.vertices),
-    size: 3
-  };
-
-  if (attributes.normals.length > 0) {
-    accessors.NORMAL = {
-      value: new Float32Array(attributes.normals),
-      size: 3
-    };
-  }
-
-  if (attributes.uvs.length > 0) {
-    accessors.TEXCOORD_0 = {
-      value: new Float32Array(attributes.uvs),
-      size: 2
-    };
-  }
-
-  if (attributes.colors.length > 0) {
-    accessors.COLOR_0 = {
-      value: new Uint8Array(attributes.colors),
-      size: 3,
-      normalized: true
-    };
-  }
-
-  return accessors;
+    const accessors = {};
+    for (const attributeName of Object.keys(attributes)) {
+        switch (attributeName) {
+            case 'vertices':
+                if (attributes.vertices.length > 0) {
+                    accessors.POSITION = { value: new Float32Array(attributes.vertices), size: 3 };
+                }
+                break;
+            // optional attributes data
+            case 'normals':
+                if (attributes.normals.length > 0) {
+                    accessors.NORMAL = { value: new Float32Array(attributes.normals), size: 3 };
+                }
+                break;
+            case 'uvs':
+                if (attributes.uvs.length > 0) {
+                    accessors.TEXCOORD_0 = { value: new Float32Array(attributes.uvs), size: 2 };
+                }
+                break;
+            case 'colors':
+                if (attributes.colors.length > 0) {
+                    // TODO - normalized shoud be based on `uchar` flag in source data?
+                    accessors.COLOR_0 = { value: new Uint8Array(attributes.colors), size: 3, normalized: true };
+                }
+                break;
+            case 'indices':
+                break;
+            default:
+                if (attributes[attributeName].length > 0) {
+                    accessors[attributeName] = { value: new Float32Array(attributes[attributeName]), size: 1 };
+                }
+                break;
+        }
+    }
+    return accessors;
 }
-//# sourceMappingURL=normalize-ply.js.map

package/dist/lib/parse-ply-in-batches.d.ts

@@ -4,5 +4,5 @@ import { PLYMesh } from './ply-types';
  * @param iterator
  * @param options
  */
-export default function parsePLYInBatches(iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options: any): AsyncIterable<PLYMesh>;
+export declare function parsePLYInBatches(iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options: any): AsyncIterable<PLYMesh>;
 //# sourceMappingURL=parse-ply-in-batches.d.ts.map

package/dist/lib/parse-ply-in-batches.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-ply-in-batches.d.ts","sourceRoot":"","sources":["../../src/lib/parse-ply-in-batches.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAC,OAAO,EAAyC,MAAM,aAAa,CAAC;AAI5E;;;;GAIG;AACH,wBAA+B,iBAAiB,CAC9C,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,EAC5D,OAAO,EAAE,GAAG,GACX,aAAa,CAAC,OAAO,CAAC,CAexB"}
+{"version":3,"file":"parse-ply-in-batches.d.ts","sourceRoot":"","sources":["../../src/lib/parse-ply-in-batches.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAC,OAAO,EAAoD,MAAM,aAAa,CAAC;AAIvF;;;;GAIG;AACH,wBAAuB,iBAAiB,CACtC,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,EAC5D,OAAO,EAAE,GAAG,GACX,aAAa,CAAC,OAAO,CAAC,CAexB"}