Doni/ModelHandle
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
b4f10e2ca1
ModelHandle/website/info/index.html

359 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8">
<meta name="viewport" content="width=device-width, user-scalable=no">
<link rel="icon" type="image/png" href="../assets/images/3dviewer_net_favicon.ico">
<title>Online 3D Viewer Manual</title>
<link rel="stylesheet" type="text/css" href="../o3dv/css/icons.css">
<link rel="stylesheet" type="text/css" href="info.css">
<!-- meta start -->
<!-- meta end -->
<!-- analytics start -->
<!-- analytics end -->
</head>
<body>
<div class="main">
<h1><a href=".">Online 3D Viewer Manual</a></h1>
<p>
This is the user manual for the <a href="https://3dviewer.net">3dviewer.net</a> website.
The website can open several 3D file formats and visualize the model in your browser.
It supports obj, 3ds, stl, ply, gltf, glb, off, 3dm, fbx, and more.
</p>
<p>
<ol>
<li><a href="#supported_file_formats">Supported file formats</a></li>
<li><a href="#loading_models">Loading models</a></li>
<ol>
<li><a href="#loading_models_computer">Loading models from your computer</a></li>
<li><a href="#loading_models_server">Loading models hosted on a web server</a></li>
<li><a href="#loading_models_github">Loading models models hosted on GitHub</a></li>
<li><a href="#loading_models_dropbox">Loading models models hosted on DropBox</a></li>
<li><a href="#loading_models_missing_files">Missing files</a></li>
</ol>
<li><a href="#sharing_and_embedding_models">Sharing and embedding models</a></li>
<li><a href="#settings_panel">Model and visualization settings</a></li>
<li><a href="#exporting_models">Exporting models</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
<li><a href="#embed_selfhost">Self-hosted viewer</a></li>
<li><a href="#cookies_policy">Cookies policy</a></li>
</ol>
</p>
<h2 id="supported_file_formats">Supported file formats</h2>
<p>
The website supports several file formats for import and export. If a file format has text and binary version,
usually it's recommended to use the binary version.
</p>
<p>
<table>
<tr>
<th>Format</th>
<th>Extension</th>
<th>Type</th>
<th>Import</th>
<th>Export</th>
<th>Source</th>
<th>Comment</th>
</tr>
<tr>
<td>Wavefront</td>
<td>obj</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td>3D Studio</td>
<td>3ds</td>
<td>binary</td>
<td class="center green">&#x2713</td>
<td class="center red">&#x2717</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td rowspan="2">Stereolithography</td>
<td rowspan="2">stl</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td>binary</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td rowspan="2">Polygon File Format</td>
<td rowspan="2">ply</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td>binary</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td rowspan="2">glTF</td>
<td>gltf</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td>glb</td>
<td>binary</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td rowspan="2">Object File Format</td>
<td rowspan="2">off</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td>binary</td>
<td class="center red">&#x2717</td>
<td class="center red">&#x2717</td>
<td>Native</td>
<td></td>
</tr>
<tr>
<td>Rhinoceros 3D</td>
<td>3dm</td>
<td>binary</td>
<td class="center green">&#x2713</td>
<td class="center green">&#x2713</td>
<td><a href="https://github.com/mcneel/rhino3dm">rhino3dm</a></td>
<td>experimental</td>
</tr>
<tr>
<td rowspan="2">Filmbox</td>
<td rowspan="2">fbx</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center red">&#x2717</td>
<td><a href="https://github.com/mrdoob/three.js">three.js</a></td>
<td>experimental</td>
</tr>
<tr>
<td>binary</td>
<td class="center green">&#x2713</td>
<td class="center red">&#x2717</td>
<td><a href="https://github.com/mrdoob/three.js">three.js</a></td>
<td>experimental</td>
</tr>
<tr>
<td>Collada</td>
<td>dae</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center red">&#x2717</td>
<td><a href="https://github.com/mrdoob/three.js">three.js</a></td>
<td>experimental</td>
</tr>
<tr>
<td>Virtual Reality Modeling Language</td>
<td>wrl</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center red">&#x2717</td>
<td><a href="https://github.com/mrdoob/three.js">three.js</a></td>
<td>experimental</td>
</tr>
<tr>
<td>3D Manufacturing Format</td>
<td>3mf</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center red">&#x2717</td>
<td><a href="https://github.com/mrdoob/three.js">three.js</a></td>
<td>experimental</td>
</tr>
<tr>
<td>Industry Foundation Classes</td>
<td>ifc</td>
<td>text</td>
<td class="center green">&#x2713</td>
<td class="center red">&#x2717</td>
<td><a href="https://github.com/tomvandig/web-ifc">web-ifc</a></td>
<td>highly experimental</td>
</tr>
</table>
</p>
<h2 id="loading_models">Loading models</h2>
<p>
There are several ways to load models. You can use files from your computer or load files hosted on an external web server.
</p>
<p class="info">
Please note, that some 3D models are built up from multiple files (for example an obj file usually comes with an mtl file,
and some texture files). For the correct visualization you have to import all of the required files. See the <a href="#loading_models_missing_files">Missing files</a>
section for more details.
</p>
<h3 id="loading_models_computer">Loading models from your computer</h3>
<p>
You can load models from your computer. In this case the model won't be uploaded to any web server,
the whole visualization happens in your browser.
</p>
<p>
There are two ways to load models from your computer:
<ol>
<li>
Use the open button (<i class="icon icon-open"></i>) on the toolbar. Here you can select all the relevant files.
</li>
<li>
Drag and drop all the relevant files into the browser window.
</li>
</ol>
</p>
<p>
Please note that you can not only open model files, but a zip file containing all your models. With drag and drop
it's also possible to load an entire folder from your computer.
</p>
<p>
If multiple files can be loaded, a dialog will appear, where you can select which file would you like to import.
</p>
<h3 id="loading_models_server">Loading models hosted on a web server</h3>
<p>
You can load models by url with the open url button (<i class="icon icon-open_url"></i>) on the toolbar.
Here you can list all of the model files. You should place every file in a separate line.
</p>
<p class="info">
To make this work, CORS (Cross-Origin Resource Sharing) must be enabled on the server.
</p>
<h3 id="loading_models_github">Loading models hosted on GitHub</h3>
<p>
To load a model hosted on GitHub follow the steps below:
</p>
<p>
<ol>
<li>Commit models to GitHub with all the required files.</li>
<li>Go to <a href="https://3dviewer.net">3dviewer.net</a>, and click on the open url button (<i class="icon icon-open_url"></i>) on the toolbar.</li>
<li>
Open the files on GitHub, copy the link of the file from the address bar, and paste it in the dialog. See the example below.
<div class="code">
https://github.com/kovacsv/Online3DViewer/blob/master/test/testfiles/3ds/cube_four_instances.3ds<br>
https://github.com/kovacsv/Online3DViewer/blob/master/test/testfiles/3ds/texture.png
</div>
</li>
<li>Click on OK.</li>
</ol>
</p>
<h3 id="loading_models_dropbox">Loading models hosted on DropBox</h3>
<p>
To load a model hosted on DropBox follow the steps below:
</p>
<p>
<ol>
<li>Upload models to DropBox with all the required files.</li>
<li>Go to <a href="https://3dviewer.net">3dviewer.net</a>, and click on the open url button (<i class="icon icon-open_url"></i>) on the toolbar.</li>
<li>
Get the sharing link from DropBox for all of the files, and paste it in the dialog. See the example below.
<div class="code">
https://www.dropbox.com/s/wd6lt7h4xa8fuv0/cube_four_instances.3ds?dl=0<br>
https://www.dropbox.com/s/6dfk1jveevbofxm/texture.png?dl=0
</div>
</li>
<li>Click on OK.</li>
</ol>
</p>
<h3 id="loading_models_missing_files">Missing files</h3>
<p>
Sometimes you see missing files in the tree. It means that your model
refers to another files, but they are not selected to import. To solve the issue you have to import the model again together with the referenced
files, or just import the missing files on their own.
</p>
<h2 id="sharing_and_embedding_models">Sharing and embedding models</h2>
<p>
If your models are hosted on a web server, you can share the link with others, or you can generate embedding code to integrate the viewer in your website.
To get the sharing link or the embedding code, click on the share model button (<i class="icon icon-share"></i>) on the toolbar.
</p>
<h2 id="settings_panel">Model and visualization settings</h2>
<p>
You can access model and visualization settings by opening the settings panel (<i class="icon icon-settings"></i>) on the right.
</p>
<p>
<ul>
<li>
Background Color: This will change the background color of the canvas. It has no effect on model export,
but the background color will be visible when you export a png image.
</li>
<li>
Default Color: This color is used when there is no material information in the model (for example in case
of stl files). Changing this value regenerates the model in the background, so the model will be exported
with the chosen color.
</li>
<li>
Edge Display: Here you can set the edge display parameters. If edges are visible, you can choose a color
for all edges, and a threshold angle. Edges will be visible only if the angle between the adjoining faces
exceeds the threshold.
</li>
<li>
Appearance: Switch between light and dark themes.
</li>
</ul>
</p>
<h2 id="troubleshooting">Troubleshooting</h2>
<p>
If you have issues, you can check the <a href="faq.html">Frequently Asked Questions</a> page, or you can <a href="https://github.com/kovacsv/Online3DViewer/issues">create an issue on GitHub</a>.
</p>
<h2 id="exporting_models">Exporting models</h2>
<p>
You can export your model in several file formats. To achieve this, click on the export button (<i class="icon icon-export"></i>) on the toolbar.
After that, select the format you would like to export to, and download the resulting files one by one.
</p>
<h2 id="embed_selfhost">Self-hosted viewer</h2>
<p>
You can use the code without involving the official website.
In this case you should self-host the viewer code and the models as well.
See the <a href="https://github.com/kovacsv/Online3DViewer/wiki">developer documentation</a> for details.
</p>
<h2 id="cookies_policy">Cookies policy</h2>
<p>
You can check the policy at the <a href="cookies.html">Cookies Policy</a> page.
</p>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink