Skip to content

Add PLY Exporter Documentation Page #14148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 29, 2018
Merged

Add PLY Exporter Documentation Page #14148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
764fb01
Add initial doc for ply exporter
gkjohnson May 25, 2018
95a7760
Updates
gkjohnson May 25, 2018
1a28ebc
more changes
gkjohnson May 25, 2018
d1fd56d
grammar
gkjohnson May 25, 2018
4c4365b
Remove incorrect GLTFExporter documentation
gkjohnson May 26, 2018
7191936
Add PLYExporter to the pages list
gkjohnson May 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples/exporters/GLTFExporter.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h2>Example</h2>

<code>
// Instantiate a exporter
var exporter = new THREE.GLTFExporter( defaultOptions );
var exporter = new THREE.GLTFExporter();

// Parse the input and generate the glTF output
exporter.parse( scene, function ( gltf ) {
Expand Down
62 changes: 62 additions & 0 deletions docs/examples/exporters/PLYExporter.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">
An exporter for *PLY*.
<br /><br />
<a href="https://www.khronos.org/gltf">PLY</a> (Polygon or Stanford Triangle Format) is a
file format for efficient delivery and loading of simple, static 3D content in a dense format.
Both binary and ascii formats are supported. PLY can store vertex positions, colors, normals and
uv coordinates. No textures or texture references are saved.
</p>

<h2>Example</h2>

<code>
// Instantiate an exporter
var exporter = new THREE.PLYExporter();

// Parse the input and generate the ply output
var data = exporter.parse( scene, options );
downloadFile(data);
</code>

<h2>Constructor</h2>

<h3>[name]()</h3>
<p>
</p>
<p>
Creates a new [name].
</p>

<h2>Methods</h2>

<h3>[method:null parse]( [param:Object3D input], [param:Object options] )</h3>
<p>
[page:Object input] — Object3D<br />
[page:Options options] — Export options<br />
<ul>
<li>excludeAttributes - array. Which properties to explicitly exclude from the exported PLY file. Valid values are 'color', 'normal', 'uv', and 'index'. If triangle indices are excluded, then a point cloud is exported. Default is an empty array.</li>
<li>binary - bool. Export in binary format, returning an ArrayBuffer. Default is false.</li>
</ul>
</p>
<p>
Generates ply file data as string or ArrayBuffer (ascii or binary) output from the input object.
If the object is composed of multiple children and geometry, they are merged into a single mesh in the file.
</p>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/examples/js/exporters/PLYExporter.js examples/js/exporters/PLYExporter.js]
</body>
</html>
3 changes: 2 additions & 1 deletion docs/list.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@ var list = {
},

"Exporters": {
"GLTFExporter": "examples/exporters/GLTFExporter"
"GLTFExporter": "examples/exporters/GLTFExporter",
"PLYExporter": "examples/exporters/PLYExporter"
},

"Plugins": {
Expand Down