@xeokit/xeokit-convert/types/parsers/parsePLYIntoXKTModel.d.ts

JavaScript utilities to create .XKT files

/**
 * @desc Parses PLY file data into an {@link XKTModel}.
 *
 * ## Usage
 *
 * In the example below we'll create an {@link XKTModel}, then load a PLY model into it.
 *
 * ````javascript
 * utils.loadArraybuffer("./models/ply/test.ply", async (data) => {
 *
 *     const xktModel = new XKTModel();
 *
 *     parsePLYIntoXKTModel({data, xktModel}).then(()=>{
 *        xktModel.finalize();
 *     },
 *     (msg) => {
 *         console.error(msg);
 *     });
 * });
 * ````
 *
 * @param {Object} params Parsing params.
 * @param {ArrayBuffer} params.data PLY file data.
 * @param {XKTModel} params.xktModel XKTModel to parse into.
 * @param {Object} [params.stats] Collects statistics.
 * @param {function} [params.log] Logging callback.
 @returns {Promise} Resolves when PLY has been parsed.
 */
export function parsePLYIntoXKTModel({ data, xktModel, stats, log }: {
    data: ArrayBuffer;
    xktModel: XKTModel;
    stats?: Object | undefined;
    log?: Function | undefined;
}): Promise<any>;