Skip to content
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

Jump to bottom

GLTFExporter Doc: Clean up #13476

Merged
merged 1 commit into from
Mar 2, 2018
Merged

GLTFExporter Doc: Clean up #13476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 16 additions & 15 deletions docs/examples/exporters/GLTFExporter.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ <h2>Example</h2>

<h2>Constructor</h2>

<h3>[name]( )</h3>
<h3>[name]()</h3>
<div>
</div>
<div>
Expand All @@ -47,33 +47,34 @@ <h3>[name]( )</h3>

<h2>Methods</h2>

<h3>[method:null parse]( [param:Object input], [param:Function onCompleted], [param:Object options] )</h3>
<h3>[method:null parse]( [param:Object3D input], [param:Function onCompleted], [param:Object options] )</h3>
<div>
[page:Object input] — Scenes or objects to export. Valid options:<br />
<ul>
<li>
Export scenes
<code>
exporter.parse( scene1, ...)
exporter.parse( [ scene1, scene2 ], ...)
exporter.parse( scene1, ... )
exporter.parse( [ scene1, scene2 ], ... )
Copy link
Collaborator Author

@takahirox takahirox Mar 2, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This non-aligned indent here and below is on purpose to display aligned indent.
Browser's or CSS's issue of code tag in li tag?

</code>
</li>
<li>
Export objects (It will create a new Scene to hold all the objects)
<code>
exporter.parse( object1, ...)
exporter.parse( [ object1, object2 ], ...)
</code>
Export objects (It will create a new Scene to hold all the objects)
<code>
exporter.parse( object1, ... )
exporter.parse( [ object1, object2 ], ... )
</code>
</li>
<li>
Mix scenes and objects (It will export the scenes as usual but it will create a new scene to hold all the single objects).
<code>
exporter.parse( [ scene1, object1, object2, scene2 ], ...)
</code>
Mix scenes and objects (It will export the scenes as usual but it will create a new scene to hold all the single objects).
<code>
exporter.parse( [ scene1, object1, object2, scene2 ], ... )
</code>
</li>
</ul>

[page:Function onCompleted] — Will be called when the export completes. The argument will be the generated glTF JSON or binary ArrayBuffer.<br />
[page:Options options] - Export options<br />
[page:Options options] — Export options<br />
<ul>
<li>trs - bool. Export position, rotation and scale instead of matrix per node. Default is false</li>
<li>onlyVisible - bool. Export only visible objects. Default is true.</li>
Expand All @@ -86,7 +87,7 @@ <h3>[method:null parse]( [param:Object input], [param:Function onCompleted], [pa
</ul>
</div>
<div>
Generates a .gltf (JSON) or .glb (binary) output from the input (Scene or Objects)
Generates a .gltf (JSON) or .glb (binary) output from the input (Scenes or Objects)
</div>

<h2>Source</h2>
Expand Down