@loaders.gl/ply 3.4.0-alpha.2 → 3.4.0-alpha.3

package/dist/lib/normalize-ply.js

@@ -40,19 +40,41 @@ 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 };
-    // optional attributes data
-    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) {
-        // TODO - normalized shoud be based on `uchar` flag in source data?
-        accessors.COLOR_0 = { value: new Uint8Array(attributes.colors), size: 3, normalized: true };
+    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;
 }

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"}

package/dist/lib/parse-ply-in-batches.js

@@ -25,6 +25,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePLYInBatches = void 0;
 const loader_utils_1 = require("@loaders.gl/loader-utils");
 const normalize_ply_1 = __importDefault(require("./normalize-ply"));
 let currentElement;
@@ -47,7 +48,7 @@ async function* parsePLYInBatches(iterator, options) {
     }
     yield (0, normalize_ply_1.default)(header, attributes, options);
 }
-exports.default = parsePLYInBatches;
+exports.parsePLYInBatches = parsePLYInBatches;
 /**
  * Parses header
  * @param lineIterator
@@ -112,22 +113,22 @@ async function parsePLYHeader(lineIterator, options) {
     }
     return header;
 }
-function makePLYElementProperty(propertValues, propertyNameMapping) {
-    const property = {
-        type: propertValues[0]
-    };
-    if (property.type === 'list') {
-        property.name = propertValues[3];
-        property.countType = propertValues[1];
-        property.itemType = propertValues[2];
-    }
-    else {
-        property.name = propertValues[1];
-    }
-    if (propertyNameMapping && property.name in propertyNameMapping) {
-        property.name = propertyNameMapping[property.name];
+function makePLYElementProperty(propertyValues, propertyNameMapping) {
+    const type = propertyValues[0];
+    switch (type) {
+        case 'list':
+            return {
+                type,
+                name: propertyValues[3],
+                countType: propertyValues[1],
+                itemType: propertyValues[2]
+            };
+        default:
+            return {
+                type,
+                name: propertyValues[1]
+            };
     }
-    return property;
 }
 // ASCII PARSING
 /**
@@ -153,7 +154,7 @@ async function parseASCII(lineIterator, header) {
                 currentElement++;
                 currentElementCount = 0;
             }
-            const element = parseASCIIElement(header.elements[currentElement].properties, line);
+            const element = parsePLYElement(header.elements[currentElement].properties, line);
             handleElement(attributes, header.elements[currentElement].name, element);
             currentElementCount++;
         }
@@ -197,7 +198,7 @@ function parseASCIINumber(n, type) {
  * @param line
  * @returns element
  */
-function parseASCIIElement(properties, line) {
+function parsePLYElement(properties, line) {
     const values = line.split(/\s+/);
     const element = {};
     for (let i = 0; i < properties.length; i++) {

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

@@ -1,8 +1,11 @@
 import type { PLYMesh } from './ply-types';
+export type ParsePLYOptions = {
+    propertyNameMapping?: Record<string, string>;
+};
 /**
  * @param data
  * @param options
  * @returns
  */
-export default function parsePLY(data: ArrayBuffer | string, options?: {}): PLYMesh;
+export declare function parsePLY(data: ArrayBuffer | string, options?: ParsePLYOptions): PLYMesh;
 //# sourceMappingURL=parse-ply.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"parse-ply.d.ts","sourceRoot":"","sources":["../../src/lib/parse-ply.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EACV,OAAO,EAMR,MAAM,aAAa,CAAC;AAGrB;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,OAAO,KAAK,GAAG,OAAO,CAclF"}
+{"version":3,"file":"parse-ply.d.ts","sourceRoot":"","sources":["../../src/lib/parse-ply.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EACV,OAAO,EAMR,MAAM,aAAa,CAAC;AAGrB,MAAM,MAAM,eAAe,GAAG;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAc3F"}

package/dist/lib/parse-ply.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePLY = void 0;
 const normalize_ply_1 = __importDefault(require("./normalize-ply"));
 /**
  * @param data
@@ -23,7 +24,7 @@ function parsePLY(data, options = {}) {
     }
     return (0, normalize_ply_1.default)(header, attributes);
 }
-exports.default = parsePLY;
+exports.parsePLY = parsePLY;
 /**
  * @param data
  * @param options
@@ -48,6 +49,7 @@ function parseHeader(data, options) {
  * @param options
  * @returns header
  */
+// eslint-disable-next-line complexity
 function parseHeaderLines(lines, headerLength, options) {
     const header = {
         comments: [],
@@ -76,6 +78,7 @@ function parseHeaderLines(lines, headerLength, options) {
                 header.comments.push(line);
                 break;
             case 'element':
+                // Start new element, store previous element
                 if (currentElement) {
                     header.elements.push(currentElement);
                 }
@@ -86,42 +89,82 @@ function parseHeaderLines(lines, headerLength, options) {
                 };
                 break;
             case 'property':
-                if (!currentElement) {
-                    break;
+                if (currentElement) {
+                    const property = makePLYElementProperty(lineValues);
+                    if (options?.propertyNameMapping && property.name in options?.propertyNameMapping) {
+                        property.name = options?.propertyNameMapping[property.name];
+                    }
+                    currentElement.properties.push(property);
                 }
-                currentElement.properties.push(makePLYElementProperty(lineValues, options.propertyNameMapping));
                 break;
             default:
                 // eslint-disable-next-line
                 console.log('unhandled', lineType, lineValues);
         }
     }
-    if (currentElement !== undefined) {
+    // Store in-progress element
+    if (currentElement) {
         header.elements.push(currentElement);
     }
     return header;
 }
+/** Generate attributes arrays from the header */
+// eslint-disable-next-line complexity
+function getPLYAttributes(header) {
+    // TODO Generate only the attribute arrays actually in the header
+    const attributes = {
+        indices: [],
+        vertices: [],
+        normals: [],
+        uvs: [],
+        colors: []
+    };
+    for (const element of header.elements) {
+        if (element.name === 'vertex') {
+            for (const property of element.properties) {
+                switch (property.name) {
+                    case 'x':
+                    case 'y':
+                    case 'z':
+                    case 'nx':
+                    case 'ny':
+                    case 'nz':
+                    case 's':
+                    case 't':
+                    case 'red':
+                    case 'green':
+                    case 'blue':
+                        break;
+                    default:
+                        // Add any non-geometry attributes
+                        attributes[property.name] = [];
+                        break;
+                }
+            }
+        }
+    }
+    return attributes;
+}
 /**
- * @param propertValues
- * @param propertyNameMapping
+ * @param propertyValues
  * @returns property of ply element
  */
-function makePLYElementProperty(propertValues, propertyNameMapping) {
-    const property = {
-        type: propertValues[0]
-    };
-    if (property.type === 'list') {
-        property.name = propertValues[3];
-        property.countType = propertValues[1];
-        property.itemType = propertValues[2];
-    }
-    else {
-        property.name = propertValues[1];
-    }
-    if (propertyNameMapping && property.name in propertyNameMapping) {
-        property.name = propertyNameMapping[property.name];
+function makePLYElementProperty(propertyValues) {
+    const type = propertyValues[0];
+    switch (type) {
+        case 'list':
+            return {
+                type,
+                name: propertyValues[3],
+                countType: propertyValues[1],
+                itemType: propertyValues[2]
+            };
+        default:
+            return {
+                type,
+                name: propertyValues[1]
+            };
     }
-    return property;
 }
 /**
  * Parses ASCII number
@@ -159,7 +202,7 @@ function parseASCIINumber(n, type) {
  * @param line
  * @returns ASCII element
  */
-function parseASCIIElement(properties, line) {
+function parsePLYElement(properties, line) {
     const values = line.split(/\s+/);
     const element = {};
     for (let i = 0; i < properties.length; i++) {
@@ -184,13 +227,7 @@ function parseASCIIElement(properties, line) {
  */
 function parseASCII(data, header) {
     // PLY ascii format specification, as per http://en.wikipedia.org/wiki/PLY_(file_format)
-    const attributes = {
-        indices: [],
-        vertices: [],
-        normals: [],
-        uvs: [],
-        colors: []
-    };
+    const attributes = getPLYAttributes(header);
     let result;
     const patternBody = /end_header\s([\s\S]*)$/;
     let body = '';
@@ -208,7 +245,7 @@ function parseASCII(data, header) {
                 currentElement++;
                 currentElementCount = 0;
             }
-            const element = parseASCIIElement(header.elements[currentElement].properties, line);
+            const element = parsePLYElement(header.elements[currentElement].properties, line);
             handleElement(attributes, header.elements[currentElement].name, element);
             currentElementCount++;
         }
@@ -223,15 +260,40 @@ function parseASCII(data, header) {
 // eslint-disable-next-line complexity
 function handleElement(buffer, elementName, element = {}) {
     if (elementName === 'vertex') {
-        buffer.vertices.push(element.x, element.y, element.z);
-        if ('nx' in element && 'ny' in element && 'nz' in element) {
-            buffer.normals.push(element.nx, element.ny, element.nz);
-        }
-        if ('s' in element && 't' in element) {
-            buffer.uvs.push(element.s, element.t);
-        }
-        if ('red' in element && 'green' in element && 'blue' in element) {
-            buffer.colors.push(element.red, element.green, element.blue);
+        for (const propertyName of Object.keys(element)) {
+            switch (propertyName) {
+                case 'x':
+                    buffer.vertices.push(element.x, element.y, element.z);
+                    break;
+                case 'y':
+                case 'z':
+                    break;
+                case 'nx':
+                    if ('nx' in element && 'ny' in element && 'nz' in element) {
+                        buffer.normals.push(element.nx, element.ny, element.nz);
+                    }
+                    break;
+                case 'ny':
+                case 'nz':
+                    break;
+                case 's':
+                    if ('s' in element && 't' in element) {
+                        buffer.uvs.push(element.s, element.t);
+                    }
+                    break;
+                case 't':
+                    break;
+                case 'red':
+                    if ('red' in element && 'green' in element && 'blue' in element) {
+                        buffer.colors.push(element.red, element.green, element.blue);
+                    }
+                    break;
+                case 'green':
+                case 'blue':
+                    break;
+                default:
+                    buffer[propertyName].push(element[propertyName]);
+            }
         }
     }
     else if (elementName === 'face') {
@@ -326,13 +388,7 @@ function binaryReadElement(dataview, at, properties, littleEndian) {
  * @returns [attributes] of data
  */
 function parseBinary(data, header) {
-    const attributes = {
-        indices: [],
-        vertices: [],
-        normals: [],
-        uvs: [],
-        colors: []
-    };
+    const attributes = getPLYAttributes(header);
     const littleEndian = header.format === 'binary_little_endian';
     const body = new DataView(data, header.headerLength);
     let result;

package/dist/lib/ply-types.d.ts

@@ -1,29 +1,37 @@
 import type { Mesh } from '@loaders.gl/schema';
+/** A parsed PLY mesh */
+export type PLYMesh = Mesh & {
+    loader: 'ply';
+    loaderData: PLYHeader;
+};
+/** A PLY header */
 export type PLYHeader = {
     format?: string;
     comments: string[];
-    elements: any[];
+    elements: PLYElement[];
     version?: string;
     headerLength?: number;
 };
-/** A parsed PLY mesh */
-export type PLYMesh = Mesh & {
-    loader: 'ply';
-    loaderData: PLYHeader;
-};
+/** A general mesh header */
 export type MeshHeader = {
     vertexCount?: number;
     boundingBox?: [[number, number, number], [number, number, number]];
 };
+/** The parsed columnar values */
 export type PLYAttributes = {
     [index: string]: number[];
 };
-export type PLYProperty = {
-    [index: string]: string;
-};
-export type ASCIIElement = {
+/** A top level PLY element (vertex, face,  ...) */
+export type PLYElement = {
     name: string;
     count: number;
-    properties: any[];
+    properties: PLYProperty[];
+};
+/** One property in a top-level PLY element */
+export type PLYProperty = {
+    name: string;
+    type: string;
+    countType?: string;
+    itemType?: string;
 };
 //# sourceMappingURL=ply-types.d.ts.map

package/dist/lib/ply-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ply-types.d.ts","sourceRoot":"","sources":["../../src/lib/ply-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,oBAAoB,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,GAAG,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,wBAAwB;AACxB,MAAM,MAAM,OAAO,GAAG,IAAI,GAAG;IAC3B,MAAM,EAAE,KAAK,CAAC;IACd,UAAU,EAAE,SAAS,CAAC;CACvB,CAAC;AAIF,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACpE,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,GAAG,EAAE,CAAC;CACnB,CAAC"}
+{"version":3,"file":"ply-types.d.ts","sourceRoot":"","sources":["../../src/lib/ply-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,oBAAoB,CAAC;AAE7C,wBAAwB;AACxB,MAAM,MAAM,OAAO,GAAG,IAAI,GAAG;IAC3B,MAAM,EAAE,KAAK,CAAC;IACd,UAAU,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,mBAAmB;AACnB,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAIF,4BAA4B;AAC5B,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACpE,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,WAAW,EAAE,CAAC;CAC3B,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}