Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.47 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.47 KB

parse-ply

A streaming PLY parser written in JavaScript.

Usages

First, install using npm:

npm install parse-ply

Then you can create a stream using require. For example, here is some code that parses a PLY file from stdin and dumps the result to stdout:

require("parse-ply")(process.stdin, function(ply) {
  console.log(ply);
});

The properties within the file are all encoded as appropriate typed arrays.

require("parse-ply")(stream, cb)

This creates a streaming PLY parser. To use it, pipe in a stream containing your mesh. When it is done, it will emit a data event that has the parsed PLY file as the main argument.

  • stream is a stream object
  • cb(err, data) is callback that is executed once the PLY is fully parsed

Data structure

The returned data field contains the contents of the completely parsed PLY file and has the two fields:

  • vertex: An object whose properties are the attributes of each vertex.
  • face: An object whose properties are the attributes of each face.

More Information

To learn more about the PLY file format, here are some links:

You can also view PLY files using standard tools, like MeshLab:

Credits

(c) 2013 Mikola Lysenko. BSD License